JawsMako::IOptionalContentGroupUsageApplication Class Reference

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 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.

Member Function Documentation

addGroup()

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

pure virtual

Add the given group to the list of affected groups. It should not already be present.

Parameters

groupRef

The reference to the group to add.

categoriesInCategories()

virtual bool JawsMako::IOptionalContentGroupUsageApplication::categoriesInCategories ( const COCCategoryVect & categories ) const

pure virtual

Does the usage categories include all the given categories? Convenience.

Parameters

categories

The vector of categories to check.

Returns

bool True if all the categories are included, false otherwise.

categoryInCategories()

virtual bool JawsMako::IOptionalContentGroupUsageApplication::categoryInCategories ( eOptionalContentCategory category ) const

pure virtual

Does the usage categories include the given category?

Parameters

category

The category to check.

Returns

bool True if the category is included, false otherwise.

clone()

virtual IOptionalContentGroupUsageApplicationPtr JawsMako::IOptionalContentGroupUsageApplication::clone ( ) const

pure virtual

Clone the usage application information.

Returns

IOptionalContentGroupUsageApplicationPtr The cloned usage application information.

create()

static JAWSMAKO_API IOptionalContentGroupUsageApplicationPtr JawsMako::IOptionalContentGroupUsageApplication::create ( const IJawsMakoPtr & jawsMako, eOptionalContentEvent event = eOCEView )

static

Create usage application information.

Parameters

jawsMako	The IJawsMako object.
event	The event for which the usage should be applied.

Returns

IOptionalContentGroupUsageApplicationPtr The new usage application information.

getAffectedOptionalContentGroups()

virtual COptionalContentGroupReferenceVect JawsMako::IOptionalContentGroupUsageApplication::getAffectedOptionalContentGroups ( ) const

pure virtual

Get the optional content groups for which the usage information should be applied.

Returns

COptionalContentGroupReferenceVect The vector of optional content group references.

getCategories()

virtual COCCategoryVect JawsMako::IOptionalContentGroupUsageApplication::getCategories ( ) const

pure virtual

Get the categories from the optional content groups that should be consulted to determine visibility.

Returns

COCCategoryVect The vector of categories.

getEvent()

virtual eOptionalContentEvent JawsMako::IOptionalContentGroupUsageApplication::getEvent ( ) const

pure virtual

Get the event for which the optional content usage should be applied.

Returns

eOptionalContentEvent The event for which the usage should be applied.

groupIsAffected()

virtual bool JawsMako::IOptionalContentGroupUsageApplication::groupIsAffected ( const IOptionalContentGroupReferencePtr & groupRef ) const

pure virtual

Is the given group affected by this usage application?

Parameters

groupRef

The reference to the group to check.

Returns

bool True if the group is affected, false otherwise.

setAffectedOptionalContentGroups()

virtual void JawsMako::IOptionalContentGroupUsageApplication::setAffectedOptionalContentGroups ( const COptionalContentGroupReferenceVect & groups )

pure virtual

Set the optional content groups (by reference) for which the usage information should be applied.

Parameters

groups

The vector of optional content group references to set.

setCategories()

virtual void JawsMako::IOptionalContentGroupUsageApplication::setCategories ( const COCCategoryVect & categories )

pure virtual

Set the categories from the optional content groups that should be consulted to determine visibility.

Parameters

categories

The vector of categories to set.

setEvent()

virtual void JawsMako::IOptionalContentGroupUsageApplication::setEvent ( eOptionalContentEvent event )

pure virtual

Set the event for which the optional content usage should be applied. Must not be eOCEUnknown.

Parameters

event

The event for which the usage should be applied.

---

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

• optionalcontent.h