CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
FxDocument.h
Go to the documentation of this file.
1//
2// (C) Copyright 2005-2023 by Graebert GmbH.
3//
4// Permission to use, copy, modify, and distribute this software in
5// object code form for any purpose and without fee is hereby granted,
6// provided that the above copyright notice appears in all copies and
7// that both that copyright notice and the limited warranty and
8// restricted rights notice below appear in all supporting
9// documentation.
10//
11// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
12// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
13// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. GRAEBERT GMBH
14// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
15// UNINTERRUPTED OR ERROR FREE.
16
17#pragma once
18
19#include "FxPragmaPush.h"
20
21#include "DDKERNEL.h"
22#include "FxPlatformSettings.h"
23#include "FxDisplayDevice.h"
24#include "FxDatabase.h"
25
26#include <RxObject.h>
27
28#include <vector>
29
30class CFxAPI;
31class CFxUserIO;
32class CFxSelectionSet;
33class CFxScriptEngine;
36class CFxActionRecorder;
37
39typedef std::vector<CFxHistoryObject*> CFxHistoryObjectArray;
40
47{
49
50public:
52
55
57 ~CFxDocument() override;
58
63
67 virtual CFxDatabase* GetFxDatabase() noexcept = 0;
68
72 virtual const CFxDatabase* GetFxDatabase() const noexcept = 0;
73
77 virtual CFxAPI* GetFxAPI() = 0;
78
82 virtual CFxUserIO* GetFxUserIO() = 0;
83
87 virtual CFxView* GetActiveFxView() = 0;
88
92 virtual CFxSelectionSet* GetFxMainSelectionSet() = 0;
93
98 virtual CFxSelectionSet* GetFxWorkingSelectionSet() = 0;
99
107 virtual CFxSelectionSet* CreateSelectionSet( bool bRegenAbortAllowed, bool bSubEntitySelect = false ) = 0;
108
109 // Return the document's input point manager.
110 virtual CFxInputPointManager* GetFxInputPointManager() = 0;
111
115 virtual const CFxHistoryObjectArray& GetHistory() const = 0;
116
120 virtual CFxString GetCommandWindowHistory() const = 0;
121
125 virtual void AttachDatabase( CFxDatabasePtr pDatabase ) = 0;
126
130 virtual CFxContainerWidget* GetOverallWindow() = 0;
131
135 virtual FxWId GetOverallWindowHandle() const = 0;
136
140 virtual CFxContainerWidget* GetDocumentWindow() = 0;
141
145 virtual const CFxContainerWidget* GetDocumentWindow() const = 0;
146
150 virtual FxWId GetDocumentWindowHandle() const = 0;
151
156
160 virtual const CFxCommandContext* GetFxCommandContext() const = 0;
161
165 virtual OdUInt16 GetFxNumber() const = 0;
166
170 virtual bool IsInsideSelect() const = 0;
171
175 virtual bool IsInsideEntsel() const = 0;
176
180 virtual bool IsInsideNEntsel() const = 0;
181
185 virtual bool IsInsideDragSelectSequence() const = 0;
186
190 virtual bool IsInsideDragDropSequence() const = 0;
191
192 virtual bool IsValid() const = 0;
193
197 virtual void Redraw() = 0;
198
202 virtual void ShrinkMemory() = 0;
203
207 virtual CFxActionRecorder* GetActionRecorder() = 0;
208
212 virtual bool IsRefeditActive() const = 0;
213
217 virtual bool IsBEditActive() const = 0;
218};
219
221
223
224#include "FxPragmaPop.h"
#define DDKERNEL_API
Definition: DDKERNEL.h:32
false
Definition: DimVarDefs.h:165
DDKERNEL_API CFxSelectionSet * CreateSelectionSet(OdEdCommandContext *pCmdCtx)
DDKERNEL_API CFxCommandContext * GetFxCommandContext(OdEdCommandContext *pCmdCtx)
std::vector< CFxHistoryObject * > CFxHistoryObjectArray
Definition: FxDocument.h:39
DDKERNEL_API CFxDocument * ACTIVE_DOCUMENT()
int FxWId
#define CFxContainerWidget
DDKERNEL_API CFxUserIO * GetFxUserIO(OdEdCommandContext *pCmdCtx)
DDKERNEL_API CFxView * GetActiveFxView(OdEdCommandContext *pCmdCtx)
unsigned short OdUInt16
virtual CFxDisplayDevice * GetFxDisplayDevice()=0
~CFxDocument() override
ODRX_DECLARE_MEMBERS(CFxDocument)
virtual CFxDatabase * GetFxDatabase() noexcept=0
DDKERNEL_API CFxScriptEngine * GetFxScriptEngine()