JawsMako::IOptionalContentVisibilityExpression Class Reference

An interface representing a PDF 1.6+ visibility expression. Please refer to table 4.4.9 of the PDF 1.7 specification for background and detail. More...

#include <optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentVisibilityExpression:

Public Types
enum	eVisibilityExpressionOperation { eVEOGroupState , eVEONot , eVEOAnd , eVEOOr }
	The operation of this expression. More...

Public Member Functions
virtual IOptionalContentVisibilityExpressionPtr	clone ()=0
	Clone this expression.
virtual eVisibilityExpressionOperation	getOperation () const =0
	Get the type of operation.
virtual IOptionalContentGroupReferencePtr	getGroup () const =0
	Get the group for eVEOGroupState operations. If the operation is something else, an exception will be thrown.
virtual COptionalContentVisibilityExpressionVect	getSubExpressions () const =0
	Get the subexpressions if the operation is eVEONot, eVEOAnd or eVEOOr. If the operation is something else, an exception will be thrown.
virtual eOptionalContentVisibility	evaluate (const IOptionalContentPtr &optionalContent, eOptionalContentEvent event) const =0
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 IOptionalContentVisibilityExpressionPtr	createGroupState (const IOptionalContentGroupReferencePtr &groupRef)
	Create a "Group State" expression. That is, the result of this expression is true if the given group is visible, and false otherwise.
static JAWSMAKO_API IOptionalContentVisibilityExpressionPtr	createNot (const IOptionalContentVisibilityExpressionPtr &subExpression)
	Create a "Not" expression. That is, the result of this expression is the inverse of the visibility of the given sub-expression.
static JAWSMAKO_API IOptionalContentVisibilityExpressionPtr	createAnd (const COptionalContentVisibilityExpressionVect &subExpressions)
	Create an "And" expression. That is, the result of this expression is the logical "and" of the result of all the sub-expressions.
static JAWSMAKO_API IOptionalContentVisibilityExpressionPtr	createOr (const COptionalContentVisibilityExpressionVect &subExpressions)
	Create an "Or" expression. That is, the result of this expression is the logical "or" of the result of all the sub-expressions.

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

Detailed Description

An interface representing a PDF 1.6+ visibility expression. Please refer to table 4.4.9 of the PDF 1.7 specification for background and detail.

Member Enumeration Documentation

eVisibilityExpressionOperation

enum JawsMako::IOptionalContentVisibilityExpression::eVisibilityExpressionOperation

The operation of this expression.

Enumerator
eVEOGroupState	The result of this expression is the state of the single group.
eVEONot	The result of this expression is the inverse of the sub-expression.
eVEOAnd	The result of this expression is the logical and of the result of the sub-expressions.
eVEOOr	The result of this expression is the logical or of the result of the sub-expressions.

Member Function Documentation

evaluate()

virtual eOptionalContentVisibility JawsMako::IOptionalContentVisibilityExpression::evaluate ( const IOptionalContentPtr & optionalContent, eOptionalContentEvent event ) const

pure virtual

Determine the result of the expression. The document's optional content must be provided.

---

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

• optionalcontent.h