CFxDocument Class Reference

#include <FxDocument.h>

Inheritance diagram for CFxDocument:

Public Member Functions
	ODRX_DECLARE_MEMBERS (CFxDocument)
	CFxDocument ()
	~CFxDocument () override
virtual CFxDisplayDevice *	GetFxDisplayDevice ()=0
virtual CFxDatabase *	GetFxDatabase () noexcept=0
virtual const CFxDatabase *	GetFxDatabase () const noexcept=0
virtual CFxAPI *	GetFxAPI ()=0
virtual CFxUserIO *	GetFxUserIO ()=0
virtual CFxView *	GetActiveFxView ()=0
virtual CFxSelectionSet *	GetFxMainSelectionSet ()=0
virtual CFxSelectionSet *	GetFxWorkingSelectionSet ()=0
virtual CFxSelectionSet *	CreateSelectionSet (bool bRegenAbortAllowed, bool bSubEntitySelect=false)=0
virtual CFxInputPointManager *	GetFxInputPointManager ()=0
virtual const CFxHistoryObjectArray &	GetHistory () const =0
virtual CFxString	GetCommandWindowHistory () const =0
virtual void	AttachDatabase (CFxDatabasePtr pDatabase)=0
virtual CFxContainerWidget *	GetOverallWindow ()=0
virtual FxWId	GetOverallWindowHandle () const =0
virtual CFxContainerWidget *	GetDocumentWindow ()=0
virtual const CFxContainerWidget *	GetDocumentWindow () const =0
virtual FxWId	GetDocumentWindowHandle () const =0
virtual CFxScriptEngine *	GetFxScriptEngine ()=0
virtual const CFxCommandContext *	GetFxCommandContext () const =0
virtual OdUInt16	GetFxNumber () const =0
virtual bool	IsInsideSelect () const =0
virtual bool	IsInsideEntsel () const =0
virtual bool	IsInsideNEntsel () const =0
virtual bool	IsInsideDragSelectSequence () const =0
virtual bool	IsInsideDragDropSequence () const =0
virtual bool	IsValid () const =0
virtual void	Redraw ()=0
virtual void	ShrinkMemory ()=0
virtual CFxActionRecorder *	GetActionRecorder ()=0
virtual bool	IsRefeditActive () const =0
virtual bool	IsBEditActive () const =0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Friends
class	CFxInputPointManager

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

Description: Represents a base a class for a document. Library: DDKERNEL

Definition at line 46 of file FxDocument.h.

Constructor & Destructor Documentation

CFxDocument()

CFxDocument::CFxDocument

(

)

Constructor

~CFxDocument()

CFxDocument::~CFxDocument ( )

override

Destructor

Member Function Documentation

AttachDatabase()

virtual void CFxDocument::AttachDatabase ( CFxDatabasePtr  pDatabase )

pure virtual

Description: Attachs the document to database.

CreateSelectionSet()

virtual CFxSelectionSet * CFxDocument::CreateSelectionSet ( bool  bRegenAbortAllowed, bool  bSubEntitySelect = false  )

pure virtual

Description: Returns new selection set.

Parameters

bRegenAbortAllowed	Aborts any operation depending on 'regenAbort' state. Set this to true only if you are selecting from interactive operation ( like CFxTracker::Update() )
bSubEntitySelect

GetActionRecorder()

virtual CFxActionRecorder * CFxDocument::GetActionRecorder ( )

pure virtual

Description: Returns action recorder.

GetActiveFxView()

virtual CFxView * CFxDocument::GetActiveFxView ( )

pure virtual

Description: Returns the current active view.

GetCommandWindowHistory()

virtual CFxString CFxDocument::GetCommandWindowHistory ( ) const

pure virtual

Description: Returns the command window history .

GetDocumentWindow() [1/2]

virtual const CFxContainerWidget * CFxDocument::GetDocumentWindow ( ) const

pure virtual

Description: Returns document window.

GetDocumentWindow() [2/2]

virtual CFxContainerWidget * CFxDocument::GetDocumentWindow ( )

pure virtual

Description: Returns document window.

GetDocumentWindowHandle()

virtual FxWId CFxDocument::GetDocumentWindowHandle ( ) const

pure virtual

Description: Returns the document window handle.

GetFxAPI()

virtual CFxAPI * CFxDocument::GetFxAPI ( )

pure virtual

Description: Returns the current API.

GetFxCommandContext()

virtual const CFxCommandContext * CFxDocument::GetFxCommandContext ( ) const

pure virtual

Description: Returns the command context when executed.

GetFxDatabase() [1/2]

virtual const CFxDatabase * CFxDocument::GetFxDatabase ( ) const

pure virtualnoexcept

Description: Returns DWG database if this is a DWG database.

GetFxDatabase() [2/2]

virtual CFxDatabase * CFxDocument::GetFxDatabase ( )

pure virtualnoexcept

Description: Remarks: gcc requires inline functions to be in the header.

GetFxDisplayDevice()

virtual CFxDisplayDevice * CFxDocument::GetFxDisplayDevice ( )

pure virtual

Description: Renders a device

GetFxInputPointManager()

virtual CFxInputPointManager * CFxDocument::GetFxInputPointManager ( )

pure virtual

GetFxMainSelectionSet()

virtual CFxSelectionSet * CFxDocument::GetFxMainSelectionSet ( )

pure virtual

Description: Returns selection set.

GetFxNumber()

virtual OdUInt16 CFxDocument::GetFxNumber ( ) const

pure virtual

Description: Returns database's number, given on creation.

GetFxScriptEngine()

virtual CFxScriptEngine * CFxDocument::GetFxScriptEngine ( )

pure virtual

Description: Returns a script object.

GetFxUserIO()

virtual CFxUserIO * CFxDocument::GetFxUserIO ( )

pure virtual

Description: Returns the user input/output.

GetFxWorkingSelectionSet()

virtual CFxSelectionSet * CFxDocument::GetFxWorkingSelectionSet ( )

pure virtual

Description: Working selection set is used in refedit/bedit to limit number of available entities It is applied as a filter to any selection

GetHistory()

virtual const CFxHistoryObjectArray & CFxDocument::GetHistory ( ) const

pure virtual

Description: Returns the commands history.

GetOverallWindow()

virtual CFxContainerWidget * CFxDocument::GetOverallWindow ( )

pure virtual

Description: Returns overall window.

GetOverallWindowHandle()

virtual FxWId CFxDocument::GetOverallWindowHandle ( ) const

pure virtual

Description: Returns the overall window handle.

IsBEditActive()

virtual bool CFxDocument::IsBEditActive ( ) const

pure virtual

Description: Checks if document is in BEdit mode

IsInsideDragDropSequence()

virtual bool CFxDocument::IsInsideDragDropSequence ( ) const

pure virtual

Description: Returns true if user has started a geometry drag & drop sequence.

IsInsideDragSelectSequence()

virtual bool CFxDocument::IsInsideDragSelectSequence ( ) const

pure virtual

Description: Returns true if user has started a drag-select sequence in eFence, eWindowPolygon, eCrossingPolygon selection modes.

IsInsideEntsel()

virtual bool CFxDocument::IsInsideEntsel ( ) const

pure virtual

Description: Returns true if user is inside command option select by entsel or nentsel.

IsInsideNEntsel()

virtual bool CFxDocument::IsInsideNEntsel ( ) const

pure virtual

Description: Returns true if user is inside command option select by entsel or nentsel.

IsInsideSelect()

virtual bool CFxDocument::IsInsideSelect ( ) const

pure virtual

Description: Returns true if user is inside command option select.

IsRefeditActive()

virtual bool CFxDocument::IsRefeditActive ( ) const

pure virtual

Description: Checks if document is in RefEdit mode

IsValid()

virtual bool CFxDocument::IsValid ( ) const

pure virtual

ODRX_DECLARE_MEMBERS()

CFxDocument::ODRX_DECLARE_MEMBERS

(

CFxDocument

)

Redraw()

virtual void CFxDocument::Redraw ( )

pure virtual

Description: Redraws overall window.

ShrinkMemory()

virtual void CFxDocument::ShrinkMemory ( )

pure virtual

Description: Releases memory resources.

Friends And Related Function Documentation

CFxInputPointManager

friend class CFxInputPointManager

friend

Definition at line 48 of file FxDocument.h.

---

The documentation for this class was generated from the following file:

• FxDocument.h