Mako 7.4.0 API
Loading...
Searching...
No Matches
JawsMako::IOptionalContentGroup Class Referenceabstract

Interface for an optional content group. More...

#include <optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentGroup:

Public Member Functions

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


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