JawsMako::IOptionalContentConfiguration Class Reference

A configuration for optional content. More...

#include <optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentConfiguration:

Classes
class	COrderEntry
	Class for presenting the order that groups should be displayed in a user interface. May be arranged in a tree. More...

Public Types
enum	eListMode { eLMAllPages , eLMVisiblePages }
	Defines the modes for displaying groups in a user interface. More...

Public Member Functions
virtual IOptionalContentConfigurationPtr	clone () const =0
	Clone the configuration.
virtual void	setName (const U8String &name)=0
	Set the name of the configuration. May be an empty string.
virtual U8String	getName () const =0
	Get the name of the configuration. An empty string is returned if no name is present.
virtual void	setCreator (const U8String &creator)=0
	Set the "creator" of the configuration. May be an empty string.
virtual U8String	getCreator () const =0
	Get the "creator" of the configuration. An empty string is returned if no name is present.
virtual void	setBaseState (eOptionalContentVisibility visibility)=0
	Get the base visibility state of the optional content groups in the document.
virtual eOptionalContentVisibility	getBaseState () const =0
	Get the base visibility state of the optional content groups in the document.
virtual void	setDefaultVisibleGroups (const COptionalContentGroupReferenceVect &groups)=0
	Set the vector of optional content group references that should be visible by default.
virtual COptionalContentGroupReferenceVect	getDefaultVisibleGroups () const =0
	Get the vector of optional content groups references that should be visible by default.
virtual bool	groupInVisibleGroups (const IOptionalContentGroupReferencePtr &groupRef) const =0
	Is the given group present in the visible groups?
virtual void	setDefaultInvisibleGroups (const COptionalContentGroupReferenceVect &groups)=0
	Set the vector of optional content group references that should be invisible by default.
virtual COptionalContentGroupReferenceVect	getDefaultInvisibleGroups () const =0
	Get the vector of optional content groups references that should be invisible by default.
virtual bool	groupInInvisibleGroups (const IOptionalContentGroupReferencePtr &groupRef) const =0
	Is the given group present in the invisible groups?
virtual void	setIntent (const U8String &intent)=0
	Set the intent for this configuration Pass an empty string to remove the intent.
virtual void	setIntents (const CU8StringVect &intents)=0
	Set an array of intents for this configuration. If set to an empty array, all groups will be considered visible, regardless of any other status information. To remove the intents entry, use setIntent above with an empty string.
virtual CU8StringVect	getIntents () const =0
	Get the intents for this configuration. Usually this will be a single entry for most real world cases. A default of "View" will be returned if the entry is not present.
virtual bool	intentInIntents (const U8String &intent) const =0
	Determine if the given intent is present in the list of intents. If the intents specify All then all intents will match. intent must not be an empty string.
virtual void	setAutoStates (const COptionalContentGroupUsageApplicationVect &applications)=0
	Set the usage applications that apply to this configuration.
virtual COptionalContentGroupUsageApplicationVect	getAutoStates () const =0
	Get the usage applications that apply to this configuration.
virtual void	setOrder (const COrderEntryVect &order)=0
	Set the order that groups should be shown in a user interface.
virtual COrderEntryVect	getOrder () const =0
	Get the order that groups should be shown in a user interface. An independent copy will be returned.
virtual void	setListMode (eListMode listMode)=0
	Set which optional content groups should be shown in the consuming application's user interface.
virtual eListMode	getListMode () const =0
	Get which optional content groups should be shown in the consuming application's user interface.
virtual void	setRadioButtonGroups (const CEDLVector< COptionalContentGroupReferenceVect > &rbGroups)=0
	Set the "Radio Button" optional content groups for this configuration.
virtual CEDLVector< COptionalContentGroupReferenceVect >	getRadioButtonGroups () const =0
	Get the "Radio Button" optional content groups for this configuration.
virtual void	setLockedGroups (const COptionalContentGroupReferenceVect &lockedGroups)=0
	Set the optional content groups that should be locked in the user interface.
virtual COptionalContentGroupReferenceVect	getLockedGroups () const =0
	Get the optional content groups that should be locked in the user interface.
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 IOptionalContentConfigurationPtr	create (const IJawsMakoPtr &jawsMako)
	Create a new configuration.

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

Detailed Description

A configuration for optional content.

Member Enumeration Documentation

eListMode

enum JawsMako::IOptionalContentConfiguration::eListMode

Defines the modes for displaying groups in a user interface.

Enumerator
eLMAllPages	All groups should be shown in the user interface, regardless of visibility.
eLMVisiblePages	Only the groups that are visible on the current page should be shown.

Member Function Documentation

clone()

virtual IOptionalContentConfigurationPtr JawsMako::IOptionalContentConfiguration::clone ( ) const

pure virtual

Clone the configuration.

Returns

IOptionalContentConfigurationPtr The cloned configuration.

create()

static JAWSMAKO_API IOptionalContentConfigurationPtr JawsMako::IOptionalContentConfiguration::create ( const IJawsMakoPtr & jawsMako )

static

Create a new configuration.

Parameters

jawsMako

The IJawsMako object.

Returns

IOptionalContentConfigurationPtr The new configuration.

getAutoStates()

virtual COptionalContentGroupUsageApplicationVect JawsMako::IOptionalContentConfiguration::getAutoStates ( ) const

pure virtual

Get the usage applications that apply to this configuration.

Returns

COptionalContentGroupUsageApplicationVect The vector of usage applications.

getBaseState()

virtual eOptionalContentVisibility JawsMako::IOptionalContentConfiguration::getBaseState ( ) const

pure virtual

Get the base visibility state of the optional content groups in the document.

Returns

eOptionalContentVisibility The base visibility state.

getCreator()

virtual U8String JawsMako::IOptionalContentConfiguration::getCreator ( ) const

pure virtual

Get the "creator" of the configuration. An empty string is returned if no name is present.

Returns

U8String The name of the creator of the configuration.

getDefaultInvisibleGroups()

virtual COptionalContentGroupReferenceVect JawsMako::IOptionalContentConfiguration::getDefaultInvisibleGroups ( ) const

pure virtual

Get the vector of optional content groups references that should be invisible by default.

Returns

COptionalContentGroupReferenceVect The vector of optional content group references.

getDefaultVisibleGroups()

virtual COptionalContentGroupReferenceVect JawsMako::IOptionalContentConfiguration::getDefaultVisibleGroups ( ) const

pure virtual

Get the vector of optional content groups references that should be visible by default.

Returns

COptionalContentGroupReferenceVect The vector of optional content group references.

getIntents()

virtual CU8StringVect JawsMako::IOptionalContentConfiguration::getIntents ( ) const

pure virtual

Get the intents for this configuration. Usually this will be a single entry for most real world cases. A default of "View" will be returned if the entry is not present.

Returns

CU8StringVect The array of intents for this configuration.

getListMode()

virtual eListMode JawsMako::IOptionalContentConfiguration::getListMode ( ) const

pure virtual

Get which optional content groups should be shown in the consuming application's user interface.

Returns

eListMode The list mode.

getLockedGroups()

virtual COptionalContentGroupReferenceVect JawsMako::IOptionalContentConfiguration::getLockedGroups ( ) const

pure virtual

Get the optional content groups that should be locked in the user interface.

Returns

COptionalContentGroupReferenceVect The vector of group references that should be locked.

getName()

virtual U8String JawsMako::IOptionalContentConfiguration::getName ( ) const

pure virtual

Get the name of the configuration. An empty string is returned if no name is present.

Returns

U8String The name of the configuration.

getOrder()

virtual COrderEntryVect JawsMako::IOptionalContentConfiguration::getOrder ( ) const

pure virtual

Get the order that groups should be shown in a user interface. An independent copy will be returned.

Returns

COrderEntryVect The vector of COrderEntry objects, which may be empty.

getRadioButtonGroups()

virtual CEDLVector< COptionalContentGroupReferenceVect > JawsMako::IOptionalContentConfiguration::getRadioButtonGroups ( ) const

pure virtual

Get the "Radio Button" optional content groups for this configuration.

This is a vector of vectors of group references. For each of the vectors of references, setting a group to Visible should result in all others to become invisible.

Returns

CEDLVector<COptionalContentGroupReferenceVect> The vector of vectors of group references.

groupInInvisibleGroups()

virtual bool JawsMako::IOptionalContentConfiguration::groupInInvisibleGroups ( const IOptionalContentGroupReferencePtr & groupRef ) const

pure virtual

Is the given group present in the invisible groups?

Parameters

groupRef

The reference to the group to check.

Returns

bool True if the group is present in the invisible groups, false otherwise.

groupInVisibleGroups()

virtual bool JawsMako::IOptionalContentConfiguration::groupInVisibleGroups ( const IOptionalContentGroupReferencePtr & groupRef ) const

pure virtual

Is the given group present in the visible groups?

Parameters

groupRef

The reference to the group to check.

Returns

bool True if the group is present in the visible groups, false otherwise.

intentInIntents()

virtual bool JawsMako::IOptionalContentConfiguration::intentInIntents ( const U8String & intent ) const

pure virtual

Determine if the given intent is present in the list of intents. If the intents specify All then all intents will match. intent must not be an empty string.

Parameters

intent

The intent to check.

Returns

bool True if the intent is present, false otherwise.

setAutoStates()

virtual void JawsMako::IOptionalContentConfiguration::setAutoStates ( const COptionalContentGroupUsageApplicationVect & applications )

pure virtual

Set the usage applications that apply to this configuration.

Parameters

applications

The vector of usage applications to set.

setBaseState()

virtual void JawsMako::IOptionalContentConfiguration::setBaseState ( eOptionalContentVisibility visibility )

pure virtual

Get the base visibility state of the optional content groups in the document.

Parameters

visibility

The visibility state to set.

setCreator()

virtual void JawsMako::IOptionalContentConfiguration::setCreator ( const U8String & creator )

pure virtual

Set the "creator" of the configuration. May be an empty string.

Parameters

creator

The name of the creator of the configuration.

setDefaultInvisibleGroups()

virtual void JawsMako::IOptionalContentConfiguration::setDefaultInvisibleGroups ( const COptionalContentGroupReferenceVect & groups )

pure virtual

Set the vector of optional content group references that should be invisible by default.

Parameters

groups

The vector of optional content group references to set.

setDefaultVisibleGroups()

virtual void JawsMako::IOptionalContentConfiguration::setDefaultVisibleGroups ( const COptionalContentGroupReferenceVect & groups )

pure virtual

Set the vector of optional content group references that should be visible by default.

Parameters

groups

The vector of optional content group references to set.

setIntent()

virtual void JawsMako::IOptionalContentConfiguration::setIntent ( const U8String & intent )

pure virtual

Set the intent for this configuration Pass an empty string to remove the intent.

Parameters

intent

The intent to set.

setIntents()

virtual void JawsMako::IOptionalContentConfiguration::setIntents ( const CU8StringVect & intents )

pure virtual

Set an array of intents for this configuration. If set to an empty array, all groups will be considered visible, regardless of any other status information. To remove the intents entry, use setIntent above with an empty string.

Parameters

intents

The array of intents to set.

setListMode()

virtual void JawsMako::IOptionalContentConfiguration::setListMode ( eListMode listMode )

pure virtual

Set which optional content groups should be shown in the consuming application's user interface.

Parameters

listMode

The list mode to set.

setLockedGroups()

virtual void JawsMako::IOptionalContentConfiguration::setLockedGroups ( const COptionalContentGroupReferenceVect & lockedGroups )

pure virtual

Set the optional content groups that should be locked in the user interface.

Parameters

lockedGroups

The vector of group references that should be locked.

setName()

virtual void JawsMako::IOptionalContentConfiguration::setName ( const U8String & name )

pure virtual

Set the name of the configuration. May be an empty string.

Parameters

name	The name of the configuration.

setOrder()

virtual void JawsMako::IOptionalContentConfiguration::setOrder ( const COrderEntryVect & order )

pure virtual

Set the order that groups should be shown in a user interface.

Parameters

order

A vector of COrderEntry objects, which may be empty.

setRadioButtonGroups()

virtual void JawsMako::IOptionalContentConfiguration::setRadioButtonGroups ( const CEDLVector< COptionalContentGroupReferenceVect > & rbGroups )

pure virtual

Set the "Radio Button" optional content groups for this configuration.

This is a vector of vectors of group references. For each of the vectors of references, setting a group to Visible should result in all others to become invisible. Pass an empty vector to remove this feature.

Parameters

rbGroups

The vector of vectors of group references.

---

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

• optionalcontent.h