All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Group.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_CPPPDFOCGGroup
6 #define PDFTRON_H_CPPPDFOCGGroup
7 
8 #include <PDF/OCG/Config.h>
9 #include <C/PDF/OCG/TRN_OCG.h>
10 
11 namespace pdftron {
12  namespace PDF {
13  class PDFDoc;
14  namespace OCG {
15  class Context;
16 
51 class Group
52 {
53 public:
54 
61  static Group Create(PDFDoc& doc, const UString& name);
62 
67  Group(SDF::Obj ocg);
68 
72  bool IsValid() const;
73 
77  UString GetName() const;
78 
83  void SetName(const UString& name);
84 
90  bool GetCurrentState(const class Context& context) const;
91 
97  void SetCurrentState(class Context& context, bool state);
98 
108  bool GetInitialState(const class Config& config) const;
109 
117  void SetInitialState(class Config& config, bool state);
118 
128  SDF::Obj GetIntent() const;
129 
135  void SetIntent(SDF::Obj intent);
136 
142  bool IsLocked(const Config& config) const;
143 
151  void SetLocked(const Config& config, bool locked);
152 
156  bool HasUsage() const;
157 
166  SDF::Obj GetUsage(const char* key) const;
167 
171  SDF::Obj GetSDFObj () const;
172 
176  Group (const Group& g);
177  Group& operator=(const Group& g);
178 
179  #ifndef SWIGHIDDEN
180  Group(TRN_OCG g) : mp_obj(g) {}
181  TRN_OCG mp_obj;
182  #endif
183 };
184 
185  }; // namespace OCG
186  }; // namespace PDF
187 }; // namespace pdftron
188 
189 #endif // PDFTRON_H_CPPPDFOCGGroup
Group(TRN_OCG g)
Definition: Group.h:180
void SetIntent(SDF::Obj intent)
SDF::Obj GetUsage(const char *key) const
Group & operator=(const Group &g)
bool IsLocked(const Config &config) const
void SetName(const UString &name)
void SetCurrentState(class Context &context, bool state)
void SetLocked(const Config &config, bool locked)
SDF::Obj GetIntent() const
UString GetName() const
void SetInitialState(class Config &config, bool state)
bool GetInitialState(const class Config &config) const
bool GetCurrentState(const class Context &context) const
static Group Create(PDFDoc &doc, const UString &name)
SDF::Obj GetSDFObj() const