AccumulatorEntry
#include<kfbxusernotification.h>

List of all members.

Detailed Description

This class defines one entry object held by theKFbxUserNotificationclass.

Direct manipulation of this object should not be required. At most, access to its members can be granted for querying purposes.

Definition at line69of filekfbxusernotification.h.


Public Member Functions

 AccumulatorEntry(AEClass pAEClass, constKString&pName, constKString&pDescr,KStringpDetail="", bool pMuteState=true)
 Constructor.
 AccumulatorEntry(constAccumulatorEntry&pAE, bool pSkipDetails)
 Copy Constructor.
 ~AccumulatorEntry()
 Destructor.
AEClass GetClass() const
 Returns the class of this entry.
KString GetName() const
 Returns the name of this entry.
KString GetDescription() const
 Returns the description of this entry.
int GetDetailsCount() const
 Returns the number of details stored.
constKStringGetDetail(int id) const
 Returns a pointer to one specific detail string (or NULL if the id is invalid).
bool IsMuted() const
 Returns True if this entry is muted.

Constructor&Destructor Documentation

AccumulatorEntry(AEClass pAEClass,
constKStringpName,
constKStringpDescr,
KString pDetail="",
bool pMuteState=true 
)

Constructor.

Parameters:
pAEClass Specify the category for this entry.
pName Identifies this entry (more than one object can have the same name).
pDescr The description of the entry. This is the common message. The details are added separately by theKFbxUserNotificationclasses.
pDetail A list of detail string that will be copied into the local array.
pMuteState Whether this entry is muted.
Remarks:
By default the object is muted so it does not get processed by the lowlevel output routines of the UserNotification accumulator. The entry gets activated (unmuted) by the calls to AddDetail() in the accumulator.

AccumulatorEntry(constAccumulatorEntrypAE,
bool pSkipDetails 
)

Copy Constructor.

Destructor.

Member Function Documentation

AEClass GetClass( ) const

Returns the class of this entry.

KStringGetName( ) const

Returns the name of this entry.

KStringGetDescription( ) const

Returns the description of this entry.

int GetDetailsCount( ) const

Returns the number of details stored.

constKString* GetDetail(int id ) const

Returns a pointer to one specific detail string (or NULL if the id is invalid).

bool IsMuted( ) const

Returns True if this entry is muted.