CFx SDK Documentation  2020SP3
FxAppInfo.h
Go to the documentation of this file.
1 //
2 // (C) Copyright 2005-2020 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 "FxString.h"
23 
24 #include <RxObject.h>
25 
26 class CFxSettings;
27 
34 {
35 public:
37  ~CFxAppInfo(void) override;
38 
40 
41  typedef enum _ApplicationType
42  {
43  eUnknown = 0x0,
44  eARX = 0x1,
45  eLISP = 0x2,
46  eDLL = 0x4,
47  eDRX = 0x8,
48  eALL = eARX | eLISP | eDLL | eDRX
49  } ApplicationType;
50 
51  typedef enum _LoadReasons
52  {
53  eOnProxyDetection = 0x1,
54  eOnDWGDirectStartup = 0x2,
55  eOnCommandInvocation = 0x4,
56  eOnLoadRequest = 0x8,
57  eLoadDisabled = 0x10,
58  eTransparentlyLoadable = 0x20,
60 
61  typedef enum _Status
62  {
63  eUnloaded = 0x1,
64  eLoaded = 0x2,
65  eNotFound = 0x3,
66  eError = 0x4,
67  eAlreadyLoaded = 0x5,
68  } Status;
69 
70  virtual ApplicationType GetType() const = 0;
71  virtual void SetType(ApplicationType type) = 0;
72 
73  virtual LoadReasons GetLoadReasons() const = 0;
74  virtual void SetLoadReasons(LoadReasons reasons) = 0;
75 
76  virtual const CFxString& GetFileName() const = 0;
77  virtual void SetFileName(const CFxString& strName) = 0;
78 
79  virtual const CFxString& GetAppName() const = 0;
80  virtual void SetAppName(const CFxString& strName) = 0;
81 
82  virtual const CFxString& GetAppDesc() const = 0;
83  virtual void SetAppDesc(const CFxString& strName) = 0;
84 
85  virtual void SetManaged(bool bManaged) = 0;
86  virtual bool IsManaged() const = 0;
87 
88  virtual bool Load( CFxSettings* settings, const CFxString& strKey ) = 0;
89  virtual bool Save( CFxSettings* settings, const CFxString& strKey ) = 0;
90 
91  virtual void SetGlobalCommandNames( const CFxStringArray& names ) = 0;
92  virtual void GetGlobalCommandNames( CFxStringArray& names ) const = 0;
93 
94  virtual void SetLocalCommandNames( const CFxStringArray& names ) = 0;
95  virtual void GetLocalCommandNames( CFxStringArray& names ) const = 0;
96 
97  virtual void SetGroupNames( const CFxStringArray& names ) = 0;
98  virtual void GetGroupNames( CFxStringArray& names ) const = 0;
99 
100  virtual Status GetStatus() const = 0;
101 
102  void addRef() override {};
103  void release() override {};
104 };
105 
107 
108 #include "FxPragmaPop.h"
FxPragmaPop.h
CFxSettings
Definition: FxSettings.h:35
CFxAppInfo::_ApplicationType
_ApplicationType
Definition: FxAppInfo.h:42
CFxAppInfo::GetGlobalCommandNames
virtual void GetGlobalCommandNames(CFxStringArray &names) const =0
type
GLuint GLsizei GLsizei GLint GLenum * type
Definition: gles2_ext.h:274
CFxAppInfo
Definition: FxAppInfo.h:34
OdRxObject
Definition: RxObject.h:564
CFxAppInfo::~CFxAppInfo
~CFxAppInfo(void) override
CFxAppInfo::GetGroupNames
virtual void GetGroupNames(CFxStringArray &names) const =0
CFxAppInfo::IsManaged
virtual bool IsManaged() const =0
CFxAppInfo::GetType
virtual ApplicationType GetType() const =0
DDKERNEL.h
OdaApp::LoadReasons
LoadReasons
Definition: LoadReasons.h:41
CFxAppInfo::SetAppName
virtual void SetAppName(const CFxString &strName)=0
CFxAppInfoPtr
OdSmartPtr< CFxAppInfo > CFxAppInfoPtr
Definition: FxAppInfo.h:106
CFxStringArray
std::vector< CFxString > CFxStringArray
Definition: FxString.h:34
FxString.h
RxObject.h
CFxAppInfo::Load
virtual bool Load(CFxSettings *settings, const CFxString &strKey)=0
CFxAppInfo::release
void release() override
Definition: FxAppInfo.h:103
CFxAppInfo::GetAppName
virtual const CFxString & GetAppName() const =0
CFxAppInfo::CFxAppInfo
CFxAppInfo()
OdSmartPtr
Definition: SmartPtr.h:58
CFxString
Definition: FxString.h:48
CFxAppInfo::_Status
_Status
Definition: FxAppInfo.h:62
CFxAppInfo::SetGlobalCommandNames
virtual void SetGlobalCommandNames(const CFxStringArray &names)=0
CFxAppInfo::LoadReasons
enum CFxAppInfo::_LoadReasons LoadReasons
CFxAppInfo::GetAppDesc
virtual const CFxString & GetAppDesc() const =0
CFxAppInfo::SetType
virtual void SetType(ApplicationType type)=0
DDKERNEL_API
#define DDKERNEL_API
Definition: DDKERNEL.h:32
CFxAppInfo::SetLocalCommandNames
virtual void SetLocalCommandNames(const CFxStringArray &names)=0
CFxAppInfo::GetStatus
virtual Status GetStatus() const =0
CFxAppInfo::Save
virtual bool Save(CFxSettings *settings, const CFxString &strKey)=0
CFxAppInfo::SetFileName
virtual void SetFileName(const CFxString &strName)=0
CFxAppInfo::SetManaged
virtual void SetManaged(bool bManaged)=0
CFxAppInfo::SetLoadReasons
virtual void SetLoadReasons(LoadReasons reasons)=0
CFxAppInfo::SetAppDesc
virtual void SetAppDesc(const CFxString &strName)=0
CFxAppInfo::SetGroupNames
virtual void SetGroupNames(const CFxStringArray &names)=0
CFxAppInfo::ODRX_DECLARE_MEMBERS
ODRX_DECLARE_MEMBERS(CFxAppInfo)
CFxAppInfo::GetLoadReasons
virtual LoadReasons GetLoadReasons() const =0
CFxAppInfo::_LoadReasons
_LoadReasons
Definition: FxAppInfo.h:52
FxPragmaPush.h
CFxAppInfo::GetLocalCommandNames
virtual void GetLocalCommandNames(CFxStringArray &names) const =0
CFxAppInfo::addRef
void addRef() override
Definition: FxAppInfo.h:102
CFxAppInfo::Status
enum CFxAppInfo::_Status Status
CFxAppInfo::ApplicationType
enum CFxAppInfo::_ApplicationType ApplicationType
CFxAppInfo::GetFileName
virtual const CFxString & GetFileName() const =0