Interface for controlling how IOptionalContentGroupUsage is applied, and for what groups. More...

#include <optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentGroupUsageApplication:

Public Member Functions
virtual IOptionalContentGroupUsageApplicationPtr	clone () const =0
	Clone the usage application information.

virtual void	setEvent (eOptionalContentEvent event)=0
	Set the event for which the the optional content usage should be applied. Must not be eOCEUnknown.

virtual eOptionalContentEvent	getEvent () const =0
	Get the event for which the optional content usage should be applied.

virtual void	setAffectedOptionalContentGroups (const COptionalContentGroupReferenceVect &groups)=0
	Set the optional content groups (by reference) for which the usage information should be applied.

virtual COptionalContentGroupReferenceVect	getAffectedOptionalContentGroups () const =0
	Get the optional content groups for which the usage information should be applied.

virtual void	addGroup (const IOptionalContentGroupReferencePtr &groupRef)=0
	Add the given group to the list of affected groups. It should not already be present.

virtual bool	groupIsAffected (const IOptionalContentGroupReferencePtr &groupRef) const =0
	Is the given group affected by this usage application?

virtual void	setCategories (const COCCategoryVect &categories)=0
	Set the categories from the optional content groups that should be consulted to determine visibility.

virtual COCCategoryVect	getCategories () const =0
	Get the categories from the optional content groups that should be consulted to determine visibility.

virtual bool	categoryInCategories (eOptionalContentCategory category) const =0
	Does the usage categories include the given category?

virtual bool	categoriesInCategories (const COCCategoryVect &categories) const =0
	Does the usage categories include all the given categories? Convenience.

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.

Static Public Member Functions
static JAWSMAKO_API IOptionalContentGroupUsageApplicationPtr	create (const IJawsMakoPtr &jawsMako, eOptionalContentEvent event=eOCEView)
	Create usage application information.

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

Detailed Description

Interface for controlling how IOptionalContentGroupUsage is applied, and for what groups.

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

optionalcontent.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description