CommandLog Class Reference

CommandLog serves as the entry point to all command log objects. More...

Public Member Functions
void	clear ()
	Clears the command log. More...
void	setEnabled (bool)
	Enables or disables the command log. More...
bool	isEnabled ()
	Returns true if the command log is enabled, otherwise false. More...
int	getEntryCount ()
	Returns the command log entry count. More...
CommandLogEntry	getEntryAt (int)
	Returns the CommandLogEntry object at the specified index. More...
void	entryAdded (int)
	This event is emitted when an entry is added to the command log. More...

Detailed Description

CommandLog serves as the entry point to all command log objects.

Member Function Documentation

clear()

void CommandLog::clear

(

)

Clears the command log.

entryAdded()

void CommandLog::entryAdded

(

int

)

This event is emitted when an entry is added to the command log.

• index, the index of the added entry.

IPC event.

getEntryAt()

CommandLogEntry CommandLog::getEntryAt

(

int

)

Returns the CommandLogEntry object at the specified index.

Parameters

index,the

index of the CommandLogEntry object of interest.

Returns

CommandLogEntry, the CommandLogEntry object at the specified index.

getEntryCount()

int CommandLog::getEntryCount

(

)

Returns the command log entry count.

Returns

int, the command log entry count.

isEnabled()

bool CommandLog::isEnabled

(

)

Returns true if the command log is enabled, otherwise false.

Returns

bool, true if the command log is enabled, otherwise false.

setEnabled()

void CommandLog::setEnabled

(

bool

)

Enables or disables the command log.

Parameters

enabled,true

to enable the command log, false to disable it.

---

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

• CCommandLog.pki