ISettings.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
9 DGNPLATFORM_TYPEDEFS (IDgnSettings)
10 DGNPLATFORM_TYPEDEFS (TransparencySettings)
11 DGNPLATFORM_TYPEDEFS (CustomizeSettings)
12 DGNPLATFORM_TYPEDEFS (DetailingSymbolSettings)
13 DGNPLATFORM_TYPEDEFS (GradientSettings)
14 
15 BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
16 
17 /*=================================================================================**/
43 /*=================================================================================**/
48 struct ApplicationSettings
49 {
50 private:
51  ElementRefP m_elRef;
52 
53 public:
54 /*------------------------------------------------------------------------*/
59 DGNPLATFORM_EXPORT ElementRefP GetElementRef ();
60 
61 /*------------------------------------------------------------------------*/
72 DGNPLATFORM_EXPORT void SaveSetting (DgnPlatform::XAttributeHandlerId handlerId, UInt32 settingId, void const* settingData, UInt32 size);
73 };
74 
75 /*=================================================================================**/
80 struct IDgnSettings
81 {
82 private:
83  virtual void MakeClassAbstract() = 0;
84 public:
85 public:
86 /*------------------------------------------------------------------------*/
92 DGNPLATFORM_EXPORT ApplicationSettings GetFileApplicationSettings (DgnFileR file);
93 
94 /*------------------------------------------------------------------------*/
101 DGNPLATFORM_EXPORT ApplicationSettings GetFileApplicationSettings (DgnModelRefR modelref);
102 
103 /*------------------------------------------------------------------------*/
109 DGNPLATFORM_EXPORT ApplicationSettings GetModelApplicationSettings (DgnModelR cache);
110 
111 /*------------------------------------------------------------------------*/
119 DGNPLATFORM_EXPORT ApplicationSettings GetModelApplicationSettings (DgnModelRefR modelref);
120 
121 /*------------------------------------------------------------------------*/
127 DGNPLATFORM_EXPORT bool DoesModelSettingsElmExist (DgnModelR cache);
128 
129 /*------------------------------------------------------------------------*/
135 DGNPLATFORM_EXPORT static IDgnSettingsR GetCurrentSettings();
136 
137 };
138 
139 
141 END_BENTLEY_DGNPLATFORM_NAMESPACE
142 
Bentley::DgnPlatform::ApplicationSettings
Holds application settings for a file or model.
Definition: ISettings.h:48
END_BENTLEY_DGNPLATFORM_NAMESPACE
#define END_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:69
DGNPLATFORM_EXPORT
#define DGNPLATFORM_EXPORT
Definition: DgnPlatform/ExportMacros.h:58
Bentley::DgnPlatform::DgnFile
A DgnFile is an in-memory representation of a physical file, regardless of its format.
Definition: DgnFile.h:308
UInt32
uint32_t UInt32
Definition: Bentley.r.h:128
Bentley::DgnPlatform::XAttributeHandlerId
A two-part ID used by XAttribute Handlers.
Definition: DgnCore.h:74
Bentley::DgnPlatform::DgnModel
A DgnModel represents a DgnModel in memory.
Definition: DgnModel.h:236
Bentley::DgnPlatform::DgnModelRef
A DgnModelRef provides access to a model in a Bentley::DgnPlatform::DgnFile.
Definition: DgnModelRef.h:172
DGNPLATFORM_TYPEDEFS
#define DGNPLATFORM_TYPEDEFS(_name_)
Definition: DgnPlatform.h:73
Bentley::DgnPlatform::IDgnSettings
Interface to find persistent "settings" information stored on a per file or per model basis...
Definition: ISettings.h:80
Bentley::DgnPlatform::ElementRefBase
Interface that provides direct and efficient access to element data.
Definition: ElementRefBase.h:120
BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
#define BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:68
size
size_type size() const
Definition: stdcxx/bstdmap.h:214
Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.