PDF::OCGroup Class Reference

Optional content group. More...

#include <pdfsdk/cxx/optional_content.h>

Inheritance diagram for PDF::OCGroup:

Public Member Functions
Object	GetPdfObject () const
bool	Equals (const OCGroup &that) const
void	SetName (const std::wstring &name)
std::wstring	GetName () const
OCMembership	CreateOCMembership () const
	OCGroup (PDOCG handle, bool adopt=false) noexcept
	OCGroup (const OCGroup &rhs) noexcept
OCGroup &	operator= (const OCGroup &rhs) noexcept
	OCGroup (OCGroup &&rhs) noexcept
OCGroup &	operator= (OCGroup &&rhs) noexcept

Static Public Member Functions
static OCGroup	CreateFromPdfObject (const Object &object)

Detailed Description

Optional content group.

ISO 32000-2:2020 - 8.11.2 Optional content groups

Member Function Documentation

CreateFromPdfObject()

static OCGroup PDF::OCGroup::CreateFromPdfObject ( const Object & object )

static

Creates an OCGroup object from a PDF object.

Parameters

[in]

object

A reference to the PDF object representing the OC group.

Returns

The created OCGroup object.

CreateOCMembership()

OCMembership PDF::OCGroup::CreateOCMembership

(

)

const

Create an OCMembership object associated with this OCGroup.

Returns

The created OCMembership object.

Equals()

bool PDF::OCGroup::Equals

(

const OCGroup &

that

)

const

Check if this OCGroup is equal to another OCGroup.

Parameters

that	The OCGroup to compare with.

Returns

True if the OCGroups are equal, false otherwise.

GetName()

std::wstring PDF::OCGroup::GetName

(

)

const

Get the name of this OCGroup.

Returns

The name of the OCGroup.

GetPdfObject()

Object PDF::OCGroup::GetPdfObject

(

)

const

Gets the PDF object associated with this OC group.

Returns

The PDF object.

SetName()

void PDF::OCGroup::SetName

(

const std::wstring &

name

)

Set the name of this OCGroup.

Parameters

name	The name to set.

---

The documentation for this class was generated from the following file:

• include/pdfsdk/cxx/optional_content.h