CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
CFxAppInfo Class Referenceabstract

#include <FxAppInfo.h>

Inheritance diagram for CFxAppInfo:
OdRxObject

Public Types

enum  _ApplicationType {
  eUnknown = 0x0 , eARX = 0x1 , eLISP = 0x2 , eDLL = 0x4 ,
  eDRX = 0x8 , eALL = eARX | eLISP | eDLL | eDRX
}
 
enum  _LoadReasons {
  eOnProxyDetection = 0x1 , eOnDWGDirectStartup = 0x2 , eOnCommandInvocation = 0x4 , eOnLoadRequest = 0x8 ,
  eLoadDisabled = 0x10 , eTransparentlyLoadable = 0x20
}
 
enum  _Status {
  eUnloaded = 0x1 , eLoaded = 0x2 , eNotFound = 0x3 , eError = 0x4 ,
  eAlreadyLoaded = 0x5
}
 
typedef enum CFxAppInfo::_ApplicationType ApplicationType
 
typedef enum CFxAppInfo::_LoadReasons LoadReasons
 
typedef enum CFxAppInfo::_Status Status
 

Public Member Functions

 CFxAppInfo ()
 
 ~CFxAppInfo (void) override
 
 ODRX_DECLARE_MEMBERS (CFxAppInfo)
 
virtual ApplicationType GetType () const =0
 
virtual void SetType (ApplicationType type)=0
 
virtual LoadReasons GetLoadReasons () const =0
 
virtual void SetLoadReasons (LoadReasons reasons)=0
 
virtual const CFxStringGetFileName () const =0
 
virtual void SetFileName (const CFxString &strName)=0
 
virtual const CFxStringGetAppName () const =0
 
virtual void SetAppName (const CFxString &strName)=0
 
virtual const CFxStringGetAppDesc () const =0
 
virtual void SetAppDesc (const CFxString &strName)=0
 
virtual void SetManaged (bool bManaged)=0
 
virtual bool IsManaged () const =0
 
virtual bool Load (CFxSettings *settings, const CFxString &strKey)=0
 
virtual bool Save (CFxSettings *settings, const CFxString &strKey)=0
 
virtual void SetGlobalCommandNames (const CFxStringArray &names)=0
 
virtual void GetGlobalCommandNames (CFxStringArray &names) const =0
 
virtual void SetLocalCommandNames (const CFxStringArray &names)=0
 
virtual void GetLocalCommandNames (CFxStringArray &names) const =0
 
virtual void SetGroupNames (const CFxStringArray &names)=0
 
virtual void GetGroupNames (CFxStringArray &names) const =0
 
virtual Status GetStatus () const =0
 
void addRef () override
 
void release () override
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Description: Represents Application Information. Library: DDKERNEL

Definition at line 33 of file FxAppInfo.h.

Member Typedef Documentation

◆ ApplicationType

◆ LoadReasons

◆ Status

Member Enumeration Documentation

◆ _ApplicationType

Enumerator
eUnknown 
eARX 
eLISP 
eDLL 
eDRX 
eALL 

Definition at line 41 of file FxAppInfo.h.

◆ _LoadReasons

Enumerator
eOnProxyDetection 
eOnDWGDirectStartup 
eOnCommandInvocation 
eOnLoadRequest 
eLoadDisabled 
eTransparentlyLoadable 

Definition at line 51 of file FxAppInfo.h.

◆ _Status

Enumerator
eUnloaded 
eLoaded 
eNotFound 
eError 
eAlreadyLoaded 

Definition at line 61 of file FxAppInfo.h.

Constructor & Destructor Documentation

◆ CFxAppInfo()

CFxAppInfo::CFxAppInfo ( )

◆ ~CFxAppInfo()

CFxAppInfo::~CFxAppInfo ( void  )
override

Member Function Documentation

◆ addRef()

void CFxAppInfo::addRef ( )
inlineoverridevirtual

Declares the method incrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Implements OdRxObject.

Definition at line 102 of file FxAppInfo.h.

◆ GetAppDesc()

virtual const CFxString& CFxAppInfo::GetAppDesc ( ) const
pure virtual

◆ GetAppName()

virtual const CFxString& CFxAppInfo::GetAppName ( ) const
pure virtual

◆ GetFileName()

virtual const CFxString& CFxAppInfo::GetFileName ( ) const
pure virtual

◆ GetGlobalCommandNames()

virtual void CFxAppInfo::GetGlobalCommandNames ( CFxStringArray names) const
pure virtual

◆ GetGroupNames()

virtual void CFxAppInfo::GetGroupNames ( CFxStringArray names) const
pure virtual

◆ GetLoadReasons()

virtual LoadReasons CFxAppInfo::GetLoadReasons ( ) const
pure virtual

◆ GetLocalCommandNames()

virtual void CFxAppInfo::GetLocalCommandNames ( CFxStringArray names) const
pure virtual

◆ GetStatus()

virtual Status CFxAppInfo::GetStatus ( ) const
pure virtual

◆ GetType()

virtual ApplicationType CFxAppInfo::GetType ( ) const
pure virtual

◆ IsManaged()

virtual bool CFxAppInfo::IsManaged ( ) const
pure virtual

◆ Load()

virtual bool CFxAppInfo::Load ( CFxSettings settings,
const CFxString strKey 
)
pure virtual

◆ ODRX_DECLARE_MEMBERS()

CFxAppInfo::ODRX_DECLARE_MEMBERS ( CFxAppInfo  )

◆ release()

void CFxAppInfo::release ( )
inlineoverridevirtual

Declares the method decrementing the reference counter in objects derived from this class.

Remarks
It is the pure virtual method that does not have an implementation. You must redefine it in the derived class.
See also
<link smart_pointers_overview.html, Overview of Smart Pointer Classes>

Implements OdRxObject.

Definition at line 103 of file FxAppInfo.h.

◆ Save()

virtual bool CFxAppInfo::Save ( CFxSettings settings,
const CFxString strKey 
)
pure virtual

◆ SetAppDesc()

virtual void CFxAppInfo::SetAppDesc ( const CFxString strName)
pure virtual

◆ SetAppName()

virtual void CFxAppInfo::SetAppName ( const CFxString strName)
pure virtual

◆ SetFileName()

virtual void CFxAppInfo::SetFileName ( const CFxString strName)
pure virtual

◆ SetGlobalCommandNames()

virtual void CFxAppInfo::SetGlobalCommandNames ( const CFxStringArray names)
pure virtual

◆ SetGroupNames()

virtual void CFxAppInfo::SetGroupNames ( const CFxStringArray names)
pure virtual

◆ SetLoadReasons()

virtual void CFxAppInfo::SetLoadReasons ( LoadReasons  reasons)
pure virtual

◆ SetLocalCommandNames()

virtual void CFxAppInfo::SetLocalCommandNames ( const CFxStringArray names)
pure virtual

◆ SetManaged()

virtual void CFxAppInfo::SetManaged ( bool  bManaged)
pure virtual

◆ SetType()

virtual void CFxAppInfo::SetType ( ApplicationType  type)
pure virtual

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