wxPdfOcg Class Reference

Base class for Optional Content Groups (OCG). (For internal use only). More...

#include <pdflayer.h>

Inheritance diagram for wxPdfOcg:

Public Member Functions
	wxPdfOcg ()
	Default constructor.
virtual	~wxPdfOcg ()
	Destructor.
void	SetIndex (int index)
	Set OCG index.
int	GetIndex () const
	Get OCG index.
void	SetObjIndex (int n)
	Set object index.
int	GetObjIndex () const
	Get object index.
bool	IsOk () const
	Check whether OCG is initialized.
wxPdfOcgType	GetType () const
	Get OCG type.

Protected Attributes
wxPdfOcgType	m_type
	Type of OCG.

Detailed Description

Base class for Optional Content Groups (OCG). (For internal use only).

Optional Content Groups (OCG) allow controlling the visibility of content in a PDF document, enabling users or applications to toggle the display of specific layers or elements.

Constructor & Destructor Documentation

wxPdfOcg()

wxPdfOcg::wxPdfOcg

(

)

Default constructor.

~wxPdfOcg()

virtual wxPdfOcg::~wxPdfOcg ( )

virtual

Destructor.

Member Function Documentation

GetIndex()

int wxPdfOcg::GetIndex ( ) const

inline

Get OCG index.

Returns

The OCG index

GetObjIndex()

int wxPdfOcg::GetObjIndex ( ) const

inline

Get object index.

Returns

The object index

GetType()

wxPdfOcgType wxPdfOcg::GetType ( ) const

inline

Get OCG type.

Returns

The OCG type

IsOk()

bool wxPdfOcg::IsOk

(

)

const

Check whether OCG is initialized.

Returns

true if initialized, false otherwise

SetIndex()

void wxPdfOcg::SetIndex ( int index )

inline

Set OCG index.

Parameters

index

OCG index

SetObjIndex()

void wxPdfOcg::SetObjIndex ( int n )

inline

Set object index.

Parameters

n	object index

Member Data Documentation

m_type

wxPdfOcgType wxPdfOcg::m_type

protected

Type of OCG.

---

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

• E:/github/wxpdfdoc-current/include/wx/pdflayer.h