Mako 8.1.0 API
Loading...
Searching...
No Matches
JawsMako::IOptionalContentConfiguration::COrderEntry Class Reference

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

#include <optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentConfiguration::COrderEntry:

Public Member Functions

COrderEntryPtr clone ()
 Creates a deep copy.
 
- 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 COrderEntryPtr create ()
 Creates a new COrderEntryPtr instance.
 

Public Attributes

bool isGroup
 
IOptionalContentGroupReferencePtr groupRef
 Only valid if isGroup is true.
 
U8String name
 May be an empty string. Only valid if isGroup is false.
 
COrderEntryVect children
 Only valid if isGroup is false.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

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

Member Function Documentation

◆ clone()

COrderEntryPtr JawsMako::IOptionalContentConfiguration::COrderEntry::clone ( )

Creates a deep copy.

Returns
COrderEntryPtr A clone of the original.

◆ create()

static COrderEntryPtr JawsMako::IOptionalContentConfiguration::COrderEntry::create ( )
static

Creates a new COrderEntryPtr instance.

Returns
COrderEntryPtr A newly created COrderEntry object.

Member Data Documentation

◆ isGroup

bool JawsMako::IOptionalContentConfiguration::COrderEntry::isGroup

If true, this indicates that this entry merely represents a group, in which case only the groupRef entry is valid. If false, this entry represents an array of groups, that may have an optional name for the UI.


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