wxPdfDocument  0.9.3
Public Member Functions | Protected Member Functions
wxPdfLayerMembership Class Reference

Class for a layer with optional content. More...

#include <pdflayer.h>

Inheritance diagram for wxPdfLayerMembership:
wxPdfOcg

List of all members.

Public Member Functions

 wxPdfLayerMembership ()
 Constructor.
virtual ~wxPdfLayerMembership ()
 Destructor.
bool AddMember (wxPdfLayer *layer)
 Add layer.
wxPdfArrayLayer GetMembers () const
 Get a list of the layers.
void SetVisibilityPolicy (wxPdfOcgPolicy policy)
 Set visibility policy.
wxPdfOcgPolicy GetVisibilityPolicy () const
 Get the visibility policy.
- Public Member Functions inherited from wxPdfOcg
 wxPdfOcg ()
 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.

Protected Member Functions

 wxPdfLayerMembership (const wxPdfLayerMembership &layer)
 Copy constructor.
wxPdfLayerMembershipoperator= (const wxPdfLayerMembership &layer)
 Assignment operator.

Additional Inherited Members

- Protected Attributes inherited from wxPdfOcg
wxPdfOcgType m_type
 Type of OCG.

Detailed Description

Class for a layer with optional content.


Constructor & Destructor Documentation

wxPdfLayerMembership::wxPdfLayerMembership ( )

Constructor.

virtual wxPdfLayerMembership::~wxPdfLayerMembership ( )
virtual

Destructor.

wxPdfLayerMembership::wxPdfLayerMembership ( const wxPdfLayerMembership layer)
protected

Copy constructor.


Member Function Documentation

bool wxPdfLayerMembership::AddMember ( wxPdfLayer layer)

Add layer.

Adds a new member to the layer.

Parameters:
layerthe new member to the layer
wxPdfArrayLayer wxPdfLayerMembership::GetMembers ( ) const

Get a list of the layers.

wxPdfOcgPolicy wxPdfLayerMembership::GetVisibilityPolicy ( ) const

Get the visibility policy.

wxPdfLayerMembership& wxPdfLayerMembership::operator= ( const wxPdfLayerMembership layer)
protected

Assignment operator.

void wxPdfLayerMembership::SetVisibilityPolicy ( wxPdfOcgPolicy  policy)

Set visibility policy.

Sets the visibility policy for content belonging to this membership dictionary. Possible values are wxPDF_OCGPOLICY_ALLON, wxPDF_OCGPOLICY_ANYON, wxPDF_OCGPOLICY_ANYOFF and wxPDF_OCGPOLICY_ALLOFF. The default value is wxPDF_OCGPOLICY_ANYON.

Parameters:
policythe visibility policy

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