PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
optional_content.h
1// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
2
3#ifndef PDFSDK_CXX_OPTIONAL_CONTENT_H_INCLUDED_
4#define PDFSDK_CXX_OPTIONAL_CONTENT_H_INCLUDED_
5
6#include <string>
7
9
10#include "forward_declarations.h"
11#include "wrapper_base.h"
12
13namespace PDF {
14
20class OCGroup : public detail::RefCountedHandle<PDOCG> {
21public:
27 static OCGroup CreateFromPdfObject(const Object& object);
28
34
40 bool Equals(const OCGroup& that) const;
41
46 void SetName(const std::wstring& name);
47
52 std::wstring GetName() const;
53
59
60 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCGroup, PDOCG)
61};
62
68class OCMembership : public detail::RefCountedHandle<PDOCMD> {
69public:
76
82
88 bool IsVisible(const OCConfig& config) const;
89
90 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCMembership, PDOCMD)
91};
92
98class OCConfig : public detail::RefCountedHandle<PDOCConfig> {
99public:
105 static OCConfig CreateFromPdfObject(const Object& object);
106
112
118
125 void SetOCGroupState(const OCGroup& ocg, bool state, bool preserveRB = true);
126
132 bool GetOCGroupState(const OCGroup& ocg) const;
133
134 PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCConfig, PDOCConfig)
135};
136
137} // namespace PDF
138
139#include "optional_content_impl.inl"
140
141#endif // PDFSDK_CXX_OPTIONAL_CONTENT_H_INCLUDED_
Optional content configuration.
Definition optional_content.h:98
Object GetPdfObject() const
Object GetOrder() const
void SetOCGroupState(const OCGroup &ocg, bool state, bool preserveRB=true)
bool GetOCGroupState(const OCGroup &ocg) const
static OCConfig CreateFromPdfObject(const Object &object)
Optional content group.
Definition optional_content.h:20
Object GetPdfObject() const
std::wstring GetName() const
void SetName(const std::wstring &name)
bool Equals(const OCGroup &that) const
OCMembership CreateOCMembership() const
static OCGroup CreateFromPdfObject(const Object &object)
Optional content membership.
Definition optional_content.h:68
static OCMembership CreateFromPdfObject(const Object &object)
Object GetPdfObject() const
bool IsVisible(const OCConfig &config) const
Represents a PDF object.
Definition object.h:20
Optional Content API.
struct PDOCMDRec_ * PDOCMD
Represents an optional content membership dictionary.
Definition optional_content.h:40
struct PDOCConfigRec_ * PDOCConfig
Definition optional_content.h:59
struct PDOCGRec_ * PDOCG
Represents an optional content group (OCG) in a PDF document.
Definition optional_content.h:28