Interface for objects used to tag content as optional. Instances of this class are set in IDOMGroup instances to make those objects optional, linking them to one or more optional content groups. More...

#include <optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentDetails:

[legend]

Public Types
enum	eVisibilityPolicy { eVPAllOn , eVPAnyOn , eVPAnyOff , eVPAllOff }
	The visibility policy controlling how the dependent optional content groups affect the visibility of this content. More...

Public Member Functions
virtual IOptionalContentDetailsPtr	clone () const =0
	Clone.

virtual bool	getIsVisible (eOptionalContentEvent event=eOCEView, const IOptionalContentPtr &optionalContent=IOptionalContentPtr()) const =0
	Determine the visibility of this content.

virtual void	addGroup (const IOptionalContentGroupReferencePtr &groupRef)=0
	Make the optional content dependent on the given group (if it is not already so). Optional content can be a member of multiple groups. The visibility policy or visibility expression (see below) controls how the visibility of this piece of optional content is calculated based on the groups upon which it depends.

virtual void	removeGroup (const IOptionalContentGroupReferencePtr &groupRef)=0
	Remove the dependence of the content on the given group.

virtual COptionalContentGroupReferenceVect	getGroupReferences () const =0
	Get all the groups that this content depends on.

virtual void	setVisibilityPolicy (eVisibilityPolicy policy)=0
	Set the visibility policy. If present, the visibility expression will take precedence.

virtual eVisibilityPolicy	getVisibilityPolicy () const =0
	Get the visibility policy.

virtual void	setVisibilityExpression (const IOptionalContentVisibilityExpressionPtr &expression)=0
	Set the visibility expression, which affords more powerful control of the visibility of this content via a logical expression. This takes precedence over the visibility policy for consumers that support visibility expressions.

virtual IOptionalContentVisibilityExpressionPtr	getVisibilityExpression ()=0
	Get the visibility expression.

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Public Member Functions inherited from JawsMako::IHashable
virtual uint64	hash () const
	Obtain a 64-bit hash of the receiving object.

virtual void	updateHash (uint64 &hash) const =0
	Update the given hash to include the receiver.

Static Public Member Functions
static JAWSMAKO_API IOptionalContentDetailsPtr	create (const IJawsMakoPtr jawsMako, const IOptionalContentGroupReferencePtr &groupRef=IOptionalContentGroupReferencePtr(), const IOptionalContentPtr &optionalContent=IOptionalContentPtr())
	Create using the given (optional) group.

static JAWSMAKO_API IOptionalContentDetailsPtr	create (const IJawsMakoPtr jawsMako, const COptionalContentGroupReferenceVect &groups, eVisibilityPolicy policy, const IOptionalContentVisibilityExpressionPtr &visibilityExpression=IOptionalContentVisibilityExpressionPtr(), const IOptionalContentPtr &optionalContent=IOptionalContentPtr())
	Create using the given groups, policy, and (optional) visibility expression.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface for objects used to tag content as optional. Instances of this class are set in IDOMGroup instances to make those objects optional, linking them to one or more optional content groups.

Member Enumeration Documentation

◆ eVisibilityPolicy

enum JawsMako::IOptionalContentDetails::eVisibilityPolicy

The visibility policy controlling how the dependent optional content groups affect the visibility of this content.

Enumerator
eVPAllOn	This content is visible if all the dependent groups are visible.
eVPAnyOn	This content is visible if any dependent group is visible.
eVPAnyOff	This content is visible if any dependent group is invisible.
eVPAllOff	This content is visible if all the dependent groups are invisible.

Member Function Documentation

◆ addGroup()

virtual void JawsMako::IOptionalContentDetails::addGroup ( const IOptionalContentGroupReferencePtr & groupRef )

pure virtual

Make the optional content dependent on the given group (if it is not already so). Optional content can be a member of multiple groups. The visibility policy or visibility expression (see below) controls how the visibility of this piece of optional content is calculated based on the groups upon which it depends.

Parameters

groupRef The group reference to add. Must not be NULL.

◆ clone()

virtual IOptionalContentDetailsPtr JawsMako::IOptionalContentDetails::clone ( ) const

pure virtual

Clone.

Returns: IOptionalContentDetailsPtr The cloned object.

◆ create() [1/2]

static JAWSMAKO_API IOptionalContentDetailsPtr JawsMako::IOptionalContentDetails::create	(	const IJawsMakoPtr	jawsMako,
		const COptionalContentGroupReferenceVect &	groups,
		eVisibilityPolicy	policy,
		const IOptionalContentVisibilityExpressionPtr &	visibilityExpression = IOptionalContentVisibilityExpressionPtr(),
		const IOptionalContentPtr &	optionalContent = IOptionalContentPtr() )

static

Create using the given groups, policy, and (optional) visibility expression.

Parameters

jawsMako	The IJawsMako object.
groups	The groups to use. Must not be empty.
policy	The visibility policy to use. If not specified, the default is eAnyOn.
visibilityExpression	The visibility expression to use. May be omitted, in which case a default visibility expression will be created.
optionalContent	The optional content to use. May be omitted, in which case a new optional content object will be created.

Returns: IOptionalContentDetailsPtr The new optional content details object.

◆ create() [2/2]

static JAWSMAKO_API IOptionalContentDetailsPtr JawsMako::IOptionalContentDetails::create	(	const IJawsMakoPtr	jawsMako,
		const IOptionalContentGroupReferencePtr &	groupRef = IOptionalContentGroupReferencePtr(),
		const IOptionalContentPtr &	optionalContent = IOptionalContentPtr() )

static

Create using the given (optional) group.

Parameters

jawsMako	The IJawsMako object.
groupRef	The group reference to use. If NULL, no group will be set.
optionalContent	The optional content to use. May be omitted, in which case a new optional content object will be created.

Returns: IOptionalContentDetailsPtr The new optional content details object.

◆ getGroupReferences()

virtual COptionalContentGroupReferenceVect JawsMako::IOptionalContentDetails::getGroupReferences ( ) const

pure virtual

Get all the groups that this content depends on.

Returns: COptionalContentGroupReferenceVect The vector of group references.

◆ getIsVisible()

virtual bool JawsMako::IOptionalContentDetails::getIsVisible	(	eOptionalContentEvent	event = eOCEView,
		const IOptionalContentPtr &	optionalContent = IOptionalContentPtr() ) const

pure virtual

Determine the visibility of this content.

    Pass in the Optional Content for this document to obtain current
    results. Otherwise, the visibility returned will be either:
    - The optional content state at the time this object was created,
      if the IOptionalContent was passed at the time of creation
      (always the case for objects created directly from reading from
      a PDF, or if it was created using an IOptionalContent API function)
    - Otherwise, true is returned.

Parameters

event	The event representing the intended use. Pass eOCEUnknown if intended use is not known.
optionalContent	The optional content for the document. Pass NULL to use

Returns: bool True if the content is visible, false otherwise.

◆ getVisibilityExpression()

virtual IOptionalContentVisibilityExpressionPtr JawsMako::IOptionalContentDetails::getVisibilityExpression ( )

pure virtual

Get the visibility expression.

Returns: IOptionalContentVisibilityExpressionPtr The visibility expression, or NULL if none is set.

◆ getVisibilityPolicy()

virtual eVisibilityPolicy JawsMako::IOptionalContentDetails::getVisibilityPolicy ( ) const

pure virtual

Get the visibility policy.

Returns: eVisibilityPolicy The visibility policy.

◆ removeGroup()

virtual void JawsMako::IOptionalContentDetails::removeGroup ( const IOptionalContentGroupReferencePtr & groupRef )

pure virtual

Remove the dependence of the content on the given group.

Parameters

groupRef The group reference to remove. Must not be NULL.

◆ setVisibilityExpression()

virtual void JawsMako::IOptionalContentDetails::setVisibilityExpression ( const IOptionalContentVisibilityExpressionPtr & expression )

pure virtual

Set the visibility expression, which affords more powerful control of the visibility of this content via a logical expression. This takes precedence over the visibility policy for consumers that support visibility expressions.

Pass NULL to remove any existing expression.

Parameters

expression The visibility expression to set.

◆ setVisibilityPolicy()

virtual void JawsMako::IOptionalContentDetails::setVisibilityPolicy ( eVisibilityPolicy policy )

pure virtual

Set the visibility policy. If present, the visibility expression will take precedence.

The default is eAnyOn.

Parameters

policy The visibility policy to set.

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

optionalcontent.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ eVisibilityPolicy

Member Function Documentation

◆ addGroup()

◆ clone()

◆ create() [1/2]

◆ create() [2/2]

◆ getGroupReferences()

◆ getIsVisible()

◆ getVisibilityExpression()

◆ getVisibilityPolicy()

◆ removeGroup()

◆ setVisibilityExpression()

◆ setVisibilityPolicy()