CoinMessages Class Reference

Class to hold and manipulate an array of massaged messages. More...

#include <CoinMessageHandler.hpp>

Inheritance diagram for CoinMessages:

Inheritance graph
[legend]
Collaboration diagram for CoinMessages:

Collaboration graph
[legend]
List of all members.

Public Types

 us_en = 0
 uk_en
 it
enum  Language { us_en = 0, uk_en, it }
 Supported languages. More...

Public Member Functions

Constructors etc
 CoinMessages (int numberMessages=0)
 Constructor with number of messages.
 ~CoinMessages ()
 Destructor.
 CoinMessages (const CoinMessages &)
 The copy constructor.
CoinMessagesoperator= (const CoinMessages &)
 assignment operator.
Useful stuff
void addMessage (int messageNumber, const CoinOneMessage &message)
 Installs a new message in the specified index position.
void replaceMessage (int messageNumber, const char *message)
 Replaces the text of the specified message.
Language language () const
 Language.
void setLanguage (Language language)
 Set language.
void setDetailMessage (int newLevel, int messageNumber)
 Change detail level for one message.
void setDetailMessages (int newLevel, int numberMessages, int *messageNumbers)
 Change detail level for several messages.
void setDetailMessages (int newLevel, int low, int high)
 Change detail level for all messages with low <= ID number < high.
int getClass () const
 Returns class.

Public Attributes

member data
int numberMessages_
 Number of messages.
Language language_
 Language.
char source_ [5]
 Source (null-terminated string, maximum 4 characters).
int class_
 Class - see later on before CoinMessageHandler.
CoinOneMessage ** message_
 Messages.

Detailed Description

Class to hold and manipulate an array of massaged messages.

Note that the message index used to reference a message in the array of messages is completly distinct from the external ID number stored with the message.

Definition at line 124 of file CoinMessageHandler.hpp.


Member Enumeration Documentation

enum CoinMessages::Language

Supported languages.

These are the languages that are supported. At present only us_en is serious and the rest are for testing.

Enumerator:
us_en 
uk_en 
it 

Definition at line 132 of file CoinMessageHandler.hpp.


Constructor & Destructor Documentation

CoinMessages::CoinMessages ( int  numberMessages = 0  ) 

Constructor with number of messages.

CoinMessages::~CoinMessages (  ) 

Destructor.

CoinMessages::CoinMessages ( const CoinMessages  ) 

The copy constructor.


Member Function Documentation

CoinMessages& CoinMessages::operator= ( const CoinMessages  ) 

assignment operator.

void CoinMessages::addMessage ( int  messageNumber,
const CoinOneMessage message 
)

Installs a new message in the specified index position.

Any existing message is replaced, and a copy of the specified message is installed.

void CoinMessages::replaceMessage ( int  messageNumber,
const char *  message 
)

Replaces the text of the specified message.

Any existing text is deleted and the specified text is copied into the specified message.

Language CoinMessages::language (  )  const [inline]

Language.

Need to think about iso codes

Definition at line 165 of file CoinMessageHandler.hpp.

References language_.

void CoinMessages::setLanguage ( Language  language  )  [inline]

Set language.

Definition at line 168 of file CoinMessageHandler.hpp.

References language_.

void CoinMessages::setDetailMessage ( int  newLevel,
int  messageNumber 
)

Change detail level for one message.

void CoinMessages::setDetailMessages ( int  newLevel,
int  numberMessages,
int *  messageNumbers 
)

Change detail level for several messages.

messageNumbers is expected to contain the indices of the messages to be changed. If numberMessages >= 10000 or messageNumbers is NULL, the detail level is changed on all messages.

void CoinMessages::setDetailMessages ( int  newLevel,
int  low,
int  high 
)

Change detail level for all messages with low <= ID number < high.

int CoinMessages::getClass (  )  const [inline]

Returns class.

Definition at line 184 of file CoinMessageHandler.hpp.

References class_.


Member Data Documentation

int CoinMessages::numberMessages_

Number of messages.

Definition at line 191 of file CoinMessageHandler.hpp.

Language CoinMessages::language_

Language.

Definition at line 193 of file CoinMessageHandler.hpp.

Referenced by language(), and setLanguage().

char CoinMessages::source_[5]

Source (null-terminated string, maximum 4 characters).

Definition at line 195 of file CoinMessageHandler.hpp.

int CoinMessages::class_

Class - see later on before CoinMessageHandler.

Definition at line 197 of file CoinMessageHandler.hpp.

Referenced by getClass().

CoinOneMessage** CoinMessages::message_

Messages.

Definition at line 199 of file CoinMessageHandler.hpp.

Referenced by CoinMessageHandler::detail().


The documentation for this class was generated from the following file:
Generated on Thu May 15 22:00:30 2008 by  doxygen 1.4.7