- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

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-2025 by Apryse Software 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
198 SDF::Obj GetRBGroups() const;
199
206 void SetRBGroups(SDF::Obj rbgroups_array);
207
211 SDF::Obj GetSDFObj () const;
212
216 Config (const Config& g);
217 Config& operator=(const Config& g);
218
219 #ifndef SWIGHIDDEN
220 Config(TRN_OCGConfig c) : mp_obj(c) {}
221 TRN_OCGConfig mp_obj;
222 #endif
223 };
224
225 }; // namespace OCG
226 }; // namespace PDF
227 }; // namespace pdftron
228
229 #include <Impl/PDFDoc.inl>
230
231 #endif // PDFTRON_H_CPPPDFOCGConfig
pdftron::PDF::OCG::Config::GetName
UString GetName() const
pdftron::PDF::OCG::Config::Config
Config(SDF::Obj ocg_config)
pdftron::PDF::OCG::Config::Config
Config(TRN_OCGConfig c)
Definition: Config.h:220
pdftron::PDF::OCG::Config::GetSDFObj
SDF::Obj GetSDFObj() const
pdftron::PDF::OCG::Config::GetIntent
SDF::Obj GetIntent() const
pdftron::PDF::OCG::Config::SetInitOnStates
void SetInitOnStates(SDF::Obj on_array)
pdftron::PDF::OCG::Config::GetLockedOCGs
SDF::Obj GetLockedOCGs() const
pdftron::PDF::OCG::Config::SetName
void SetName(const UString &name)
pdftron::PDF::OCG::Config::GetCreator
UString GetCreator() const
pdftron::PDF::OCG::Config::GetRBGroups
SDF::Obj GetRBGroups() const
pdftron::PDF::OCG::Config::SetOrder
void SetOrder(SDF::Obj ocgs_array)
pdftron::PDF::PDFDoc
Definition: PDFDoc.h:71
pdftron::PDF::OCG::Config
Definition: Config.h:35
pdftron::PDF::OCG::Config::operator=
Config & operator=(const Config &g)
Obj.h
pdftron::PDF::OCG::Config::SetCreator
void SetCreator(const UString &name)
pdftron::PDF::OCG::Config::SetRBGroups
void SetRBGroups(SDF::Obj rbgroups_array)
pdftron::PDF::OCG::Config::Create
static Config Create(PDFDoc &doc, bool default_config)
pdftron::PDF::OCG::Config::SetLockedOCGs
void SetLockedOCGs(SDF::Obj locked_ocg_array)
pdftron::PDF::OCG::Config::SetInitBaseState
void SetInitBaseState(const char *state="ON")
pdftron::PDF::OCG::Config::GetOrder
SDF::Obj GetOrder() const
pdftron::PDF::OCG::Config::GetInitOnStates
SDF::Obj GetInitOnStates() const
pdftron::PDF::OCG::Config::mp_obj
TRN_OCGConfig mp_obj
Definition: Config.h:221
pdftron::SDF::Obj
Definition: Obj.h:40
pdftron::PDF::OCG::Config::SetIntent
void SetIntent(SDF::Obj intent)
pdftron::PDF::OCG::Config::GetInitBaseState
const char * GetInitBaseState() const
pdftron::UString
Definition: UString.h:27
pdftron::PDF::OCG::Config::GetInitOffStates
SDF::Obj GetInitOffStates() const
pdftron::PDF::OCG::Config::SetInitOffStates
void SetInitOffStates(SDF::Obj off_array)
pdftron::PDF::OCG::Config::IsValid
bool IsValid() const
Definition: Config.h:57