All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Config.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2020 by PDFTron Systems Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 #ifndef PDFTRON_H_CPPPDFOCGConfig
6 #define PDFTRON_H_CPPPDFOCGConfig
7 
8 #include <SDF/Obj.h>
9 //#include <PDF/PDFDoc.h>
10 #include <C/PDF/OCG/TRN_OCGConfig.h>
11 
12 namespace pdftron {
13  namespace PDF {
14 
15  class PDFDoc;
16 
17  namespace OCG {
18 
35 class Config
36 {
37 public:
38 
47  static Config Create(PDFDoc& doc, bool default_config);
48 
52  Config(SDF::Obj ocg_config);
53 
57  bool IsValid() const { return mp_obj !=0; }
58 
66  SDF::Obj GetOrder() const;
67 
76  void SetOrder(SDF::Obj ocgs_array);
77 
82  UString GetName() const;
83 
90  void SetName(const UString& name);
91 
97  UString GetCreator() const;
98 
104  void SetCreator(const UString& name);
105 
120  const char* GetInitBaseState() const;
121 
128  SDF::Obj GetInitOnStates() const;
129 
136  SDF::Obj GetInitOffStates() const;
137 
142  void SetInitBaseState(const char* state = "ON");
143 
149  void SetInitOnStates(SDF::Obj on_array);
150 
156  void SetInitOffStates(SDF::Obj off_array);
157 
167  SDF::Obj GetIntent() const;
168 
174  void SetIntent(SDF::Obj intent);
175 
181  SDF::Obj GetLockedOCGs() const;
182 
191  void SetLockedOCGs(SDF::Obj locked_ocg_array);
192 
196  SDF::Obj GetSDFObj () const;
197 
201  Config (const Config& g);
202  Config& operator=(const Config& g);
203 
204  #ifndef SWIGHIDDEN
205  Config(TRN_OCGConfig c) : mp_obj(c) {}
206  TRN_OCGConfig mp_obj;
207  #endif
208 };
209 
210  }; // namespace OCG
211  }; // namespace PDF
212 }; // namespace pdftron
213 
214 #include <Impl/PDFDoc.inl>
215 
216 #endif // PDFTRON_H_CPPPDFOCGConfig
UString GetName() const
Config(SDF::Obj ocg_config)
Config(TRN_OCGConfig c)
Definition: Config.h:205
SDF::Obj GetSDFObj() const
SDF::Obj GetIntent() const
void SetInitOnStates(SDF::Obj on_array)
SDF::Obj GetLockedOCGs() const
void SetName(const UString &name)
UString GetCreator() const
void SetOrder(SDF::Obj ocgs_array)
Config & operator=(const Config &g)
void SetCreator(const UString &name)
static Config Create(PDFDoc &doc, bool default_config)
void SetLockedOCGs(SDF::Obj locked_ocg_array)
void SetInitBaseState(const char *state="ON")
SDF::Obj GetOrder() const
SDF::Obj GetInitOnStates() const
TRN_OCGConfig mp_obj
Definition: Config.h:206
void SetIntent(SDF::Obj intent)
const char * GetInitBaseState() const
SDF::Obj GetInitOffStates() const
void SetInitOffStates(SDF::Obj off_array)
bool IsValid() const
Definition: Config.h:57