DisplayRulesManager.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 
12 #include "DgnPlatform.h"
13 #include "Bentley/RefCounted.h"
14 
15 #include <ECObjects/ECObjects.h>
17 #include <DgnPlatform/DgnCore.h>
19 
20 #include <Bentley/bvector.h>
21 #include <Bentley/WString.h>
22 
24 
25 
26 //=======================================================================================
58 //=======================================================================================
60  {
61 
62  /*---------------------------------------------------------------------------------**/
67  public: DGNPLATFORM_EXPORT static DisplayRuleSetCPVector const GetDisplayRuleSetsInFile (DgnFileR dgnFile);
68 
69  /*---------------------------------------------------------------------------------**/
76  public: DGNPLATFORM_EXPORT static DisplayRuleSetCP GetDisplayRuleSetByIndex (DisplayRuleSetCPVector::size_type index, DgnFileR dgnFile);
77 
78  /*---------------------------------------------------------------------------------**/
85  public: DGNPLATFORM_EXPORT static DisplayRuleSetCP GetDisplayRuleSetByName (WCharCP name, DgnFileR dgnFile);
86 
87  /*---------------------------------------------------------------------------------**/
96  public: DGNPLATFORM_EXPORT static DisplayRuleSetCP WriteDisplayRuleSetToFile (DisplayRuleSetCR displayRuleSet, DgnFileR destinationDgnFile, bool notifyListeners);
97 
98  /*---------------------------------------------------------------------------------**/
106  public: DGNPLATFORM_EXPORT static StatusInt RenameDisplayRuleSetInFile (WCharCP originalName, WCharCP newName, DgnFileR dgnFile);
107 
108  /*---------------------------------------------------------------------------------**/
115  public: DGNPLATFORM_EXPORT static void RemoveDisplayRuleSetFromFile (WCharCP ruleSetName, DgnFileR dgnFile);
116 
117  /*---------------------------------------------------------------------------------**/
122  public: DGNPLATFORM_EXPORT static void SetDisplayRuleSetToDisplayStyle (DisplayRuleSetCR displayRuleSet, DisplayStyleR displayStyle);
123 
124  /*---------------------------------------------------------------------------------**/
128  public: DGNPLATFORM_EXPORT static DisplayRuleSetCP GetDisplayRuleSetFromDisplayStyle (DisplayStyleCR displayStyle);
129 
130  }; // DisplayRulesManager
131 
135 
#define END_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:69
struct DgnPlatform::DisplayStyle const & DisplayStyleCR
Definition: DgnPlatform.h:241
#define DGNPLATFORM_EXPORT
Definition: DgnPlatform/ExportMacros.h:58
A DgnFile is an in-memory representation of a physical file, regardless of its format.
Definition: DgnFile.h:308
wchar_t const * WCharCP
Definition: Bentley.h:224
struct DgnPlatform::DisplayRuleSet const * DisplayRuleSetCP
Definition: DgnPlatform.h:558
struct DgnPlatform::DisplayRuleSet const & DisplayRuleSetCR
Definition: DgnPlatform.h:558
#define BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE
Definition: DgnPlatformBaseType.r.h:68
int StatusInt
Definition: Bentley.h:222
Provides static methods for reading, writing, and modifying display rules sets in files...
Definition: DisplayRulesManager.h:59
A display style is a collection of view-related settings that can be applied to the whole or part of ...
Definition: DisplayStyleManager.h:386
bvector< DisplayRuleSetCP > DisplayRuleSetCPVector
A collection of DisplayRuleSetCP.
Definition: DisplayRules.h:34

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.