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-2023 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 
50 class Group
51 {
52 public:
53 
60  static Group Create(PDFDoc& doc, const UString& name);
61 
66  Group(SDF::Obj ocg);
67 
71  bool IsValid() const;
72 
76  UString GetName() const;
77 
82  void SetName(const UString& name);
83 
89  bool GetCurrentState(const class Context& context) const;
90 
96  void SetCurrentState(class Context& context, bool state);
97 
107  bool GetInitialState(const class Config& config) const;
108 
116  void SetInitialState(class Config& config, bool state);
117 
127  SDF::Obj GetIntent() const;
128 
134  void SetIntent(SDF::Obj intent);
135 
141  bool IsLocked(const Config& config) const;
142 
150  void SetLocked(const Config& config, bool locked);
151 
155  bool HasUsage() const;
156 
165  SDF::Obj GetUsage(const char* key) const;
166 
170  SDF::Obj GetSDFObj () const;
171 
175  Group (const Group& g);
176  Group& operator=(const Group& g);
177 
178  #ifndef SWIGHIDDEN
179  Group(TRN_OCG g) : mp_obj(g) {}
180  TRN_OCG mp_obj;
181  #endif
182 };
183 
184  }; // namespace OCG
185  }; // namespace PDF
186 }; // namespace pdftron
187 
188 #endif // PDFTRON_H_CPPPDFOCGGroup
Group(TRN_OCG g)
Definition: Group.h:179
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