CFx SDK Documentation  2023 SP0
BcfComponents.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2020, Open Design Alliance (the "Alliance").
3 // All rights reserved.
4 //
5 // This software and its documentation and related materials are owned by
6 // the Alliance. The software may only be incorporated into application
7 // programs owned by members of the Alliance, subject to a signed
8 // Membership Agreement and Supplemental Software License Agreement with the
9 // Alliance. The structure and organization of this software are the valuable
10 // trade secrets of the Alliance and its suppliers. The software is also
11 // protected by copyright law and international treaty provisions. Application
12 // programs incorporating this software must include the following statement
13 // with their copyright notices:
14 //
15 // This application incorporates Open Design Alliance software pursuant to a license
16 // agreement with Open Design Alliance.
17 // Open Design Alliance Copyright (C) 2002-2020 by Open Design Alliance.
18 // All rights reserved.
19 //
20 // By use of this software, its documentation or related materials, you
21 // acknowledge and accept the above terms.
23 
24 #ifndef _BFC_COMPONENTS_H
25 #define _BFC_COMPONENTS_H
26 
27 #include "BcfCommon.h"
28 
29 #include "BcfElement.h"
30 
34 namespace OdBcf {
35 
36  class OdBcfViewSetupHints;
38 
41 
44 
47 
48  class OdBcfSession;
49 
54  {
55  public:
56 
57  //DOM-IGNORE-BEGIN
59  //DOM-IGNORE-END
60 
70  const OdBcfComponentVisibilityPtr &pVisibility,
71  const OdBcfViewSetupHintsPtr &pViewSetupHints = OdBcfViewSetupHintsPtr(),
74 
80  virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;
81 
87  virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;
88 
93  virtual bool validate() const ODRX_OVERRIDE;
94 
95  DECLARE_CONST_ACCESSORS(ViewSetupHints, OdBcfViewSetupHintsPtr, m_pViewSetupHints);
99 
100  //DOM-IGNORE-BEGIN
101  protected:
102  OdBcfViewSetupHintsPtr m_pViewSetupHints;
106 
107  friend OdBcfSession;
108  //DOM-IGNORE-END
109  };
110 
115 
116 } //namespace OdBcf
117 
118 #endif // _BFC_COMPONENTS_H
#define DECLARE_CONST_ACCESSORS(MethodName, VariableType, VariableName)
Definition: BcfCommon.h:73
#define BCF_EXPORT
#define ODRX_OVERRIDE
OdResult
Definition: OdResult.h:29
virtual bool validate() const ODRX_OVERRIDE
ODRX_DECLARE_MEMBERS(OdBcfComponents)
static OdSmartPtr< OdBcfComponents > createObject(const OdBcfComponentVisibilityPtr &pVisibility, const OdBcfViewSetupHintsPtr &pViewSetupHints=OdBcfViewSetupHintsPtr(), const OdBcfComponentSelectionPtr &pSelection=OdBcfComponentSelectionPtr(), const OdBcfComponentColoringPtr &pColoring=OdBcfComponentColoringPtr())
virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE
virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE
OdSmartPtr< OdBcfComponentSelection > OdBcfComponentSelectionPtr
Definition: BcfComponents.h:39
OdSmartPtr< OdBcfViewSetupHints > OdBcfViewSetupHintsPtr
Definition: BcfComponents.h:36
OdSmartPtr< OdBcfComponentVisibility > OdBcfComponentVisibilityPtr
Definition: BcfComponents.h:42
OdSmartPtr< OdBcfComponentColoring > OdBcfComponentColoringPtr
Visibility
Definition: DbObject.h:144