Planeshift
pawsChatHistory Class Reference

This stores the text the player has entered into their edit window. More...

#include <chatwindow.h>

Public Member Functions

unsigned int curLoc ()
 
csString * GetCommand (int n)
 Get a string that is in the history. More...
 
csString * GetNext ()
 return the next (temporally) command from history More...
 
csString * GetPrev ()
 return the prev (temporally) command from history More...
 
void Insert (const char *str)
 Insert a new string that the player has entered. More...
 
 pawsChatHistory ()
 
void SetGetLoc (unsigned int pos)
 
 ~pawsChatHistory ()
 

Detailed Description

This stores the text the player has entered into their edit window.

It keeps all the commands that the player has entered in sequential order. This can be normal chatting or different /commands.

Definition at line 351 of file chatwindow.h.

Constructor & Destructor Documentation

pawsChatHistory::pawsChatHistory ( )
pawsChatHistory::~pawsChatHistory ( )

Member Function Documentation

unsigned int pawsChatHistory::curLoc ( )
inline

Definition at line 375 of file chatwindow.h.

csString* pawsChatHistory::GetCommand ( int  n)

Get a string that is in the history.

Parameters
nThe index of the string to get.
Returns
The string if the value of n is in range. NULL otherwise.
csString* pawsChatHistory::GetNext ( )

return the next (temporally) command from history

csString* pawsChatHistory::GetPrev ( )

return the prev (temporally) command from history

void pawsChatHistory::Insert ( const char *  str)

Insert a new string that the player has entered.

Parameters
strThe new string to add to the history.
void pawsChatHistory::SetGetLoc ( unsigned int  pos)
inline

Definition at line 374 of file chatwindow.h.


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