Interface for an optional content group. More...

#include <jawsmako/optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentGroup:

Public Member Functions
virtual	~IOptionalContentGroup ()
virtual IOptionalContentGroupPtr	clone ()=0
	Clone the group. Note that cloning the group will not result in a new reference being created.
virtual IOptionalContentGroupReferencePtr	getReference () const =0
	Get the reference to this group. This is used with several APIs to maintain a link to this group.
virtual void	setName (const U8String &name)=0
	Set the name of this group. Must not be an empty string.
virtual U8String	getName () const =0
	Get the name of this group.
virtual void	setIntent (const U8String &intent)=0
	Set the intent of the group, or an empty string to reset to the default.
virtual void	setIntents (const CU8StringVect &intents)=0
	Set an array of intents for this group.
virtual CU8StringVect	getIntents () const =0
	Get the intents for this group. 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 void	setUsage (const IOptionalContentGroupUsagePtr &usage)=0
	Set the Usage information for this group. Pass NULL to remove the usage information.
virtual IOptionalContentGroupUsagePtr	getUsage () const =0
	Get the Usage information for this group. May be NULL.
virtual U8String	getGTSProcStepsType () const =0
	Get the GTS_ProcStepsType property from the GTS_Metadata dictionary under this content group.
virtual void	setGTSProcStepsType (const U8String &procStepsType)=0
	Set the value of the GTS_ProcStepsType property in the GTS_Metadata dictionary of this content group.
virtual U8String	getGTSProcStepsGroup () const =0
	Get the GTS_ProcStepsGroup property from the GTS_Metadata dictionary under this content group.
virtual void	setGTSProcStepsGroup (const U8String &procStepsGroup)=0
	Set the value of the GTS_ProcStepsGroup property in the GTS_Metadata dictionary of this content group.
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 IOptionalContentGroupPtr	create (const IJawsMakoPtr &jawsMako, const U8String &name)
	Create an optional content group. A non-zero length name must be provided.

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

Detailed Description

Interface for an optional content group.

Constructor & Destructor Documentation

◆ ~IOptionalContentGroup()

virtual JawsMako::IOptionalContentGroup::~IOptionalContentGroup ( )

inlinevirtual

Member Function Documentation

◆ clone()

virtual IOptionalContentGroupPtr JawsMako::IOptionalContentGroup::clone ( )

pure virtual

Clone the group. Note that cloning the group will not result in a new reference being created.

Returns: IOptionalContentGroupPtr The cloned group.

◆ create()

JAWSMAKO_API IOptionalContentGroupPtr JawsMako::IOptionalContentGroup::create	(	const IJawsMakoPtr &	jawsMako,
		const U8String &	name )

static

Create an optional content group. A non-zero length name must be provided.

Parameters

jawsMako	The IJawsMako object.
name	The name of the group. Must not be an empty string.

Returns: IOptionalContentGroupPtr The new optional content group.

◆ getGTSProcStepsGroup()

virtual U8String JawsMako::IOptionalContentGroup::getGTSProcStepsGroup ( ) const

pure virtual

Get the GTS_ProcStepsGroup property from the GTS_Metadata dictionary under this content group.

Returns: U8String The property value.

◆ getGTSProcStepsType()

virtual U8String JawsMako::IOptionalContentGroup::getGTSProcStepsType ( ) const

pure virtual

Get the GTS_ProcStepsType property from the GTS_Metadata dictionary under this content group.

Returns: U8String The property value.

◆ getIntents()

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

pure virtual

Get the intents for this group. 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 intents for this group.

◆ getName()

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

pure virtual

Get the name of this group.

Returns: U8String The name of this group.

◆ getReference()

virtual IOptionalContentGroupReferencePtr JawsMako::IOptionalContentGroup::getReference ( ) const

pure virtual

Get the reference to this group. This is used with several APIs to maintain a link to this group.

Returns: IOptionalContentGroupReferencePtr The reference to this group.

◆ getUsage()

virtual IOptionalContentGroupUsagePtr JawsMako::IOptionalContentGroup::getUsage ( ) const

pure virtual

Get the Usage information for this group. May be NULL.

Returns: IOptionalContentGroupUsagePtr The usage information, or NULL if none is set.

◆ setGTSProcStepsGroup()

virtual void JawsMako::IOptionalContentGroup::setGTSProcStepsGroup ( const U8String & procStepsGroup )

pure virtual

Set the value of the GTS_ProcStepsGroup property in the GTS_Metadata dictionary of this content group.

Parameters

procStepsGroup The value of the GTS_ProcStepsGroup property.

◆ setGTSProcStepsType()

virtual void JawsMako::IOptionalContentGroup::setGTSProcStepsType ( const U8String & procStepsType )

pure virtual

Set the value of the GTS_ProcStepsType property in the GTS_Metadata dictionary of this content group.

Parameters

procStepsType The value of the GTS_ProcStepsType property.

◆ setIntent()

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

pure virtual

Set the intent of the group, or an empty string to reset to the default.

Parameters

intent The intent to set.

◆ setIntents()

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

pure virtual

Set an array of intents for this group.

Parameters

intents The intents to set.

◆ setName()

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

pure virtual

Set the name of this group. Must not be an empty string.

Parameters

name	The name to set.

◆ setUsage()

virtual void JawsMako::IOptionalContentGroup::setUsage ( const IOptionalContentGroupUsagePtr & usage )

pure virtual

Set the Usage information for this group. Pass NULL to remove the usage information.

Parameters

usage The usage information to set. May be NULL.

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

jawsmako/optionalcontent.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IOptionalContentGroup()

Member Function Documentation

◆ clone()

◆ create()

◆ getGTSProcStepsGroup()

◆ getGTSProcStepsType()

◆ getIntents()

◆ getName()

◆ getReference()

◆ getUsage()

◆ setGTSProcStepsGroup()

◆ setGTSProcStepsType()

◆ setIntent()

◆ setIntents()

◆ setName()

◆ setUsage()