Class xavax::MessageSet

Constructor Summary

MessageSet(MessageCatalog& catalog, const MessageSetData* setData)          Construct a MessageSet object.

MessageSet(MessageCatalog& catalog, UInt16 setNumber, UInt16 msgCount)          Construct an empty MessageSet object.

Method Summary
MessageCatalog&	catalog() const          Return the message catalog containing this set.
UInt16	count() const          Return the number of messages in this set.
const char*	defaultText(UInt16 msgNum)          Return the default text for a message.
bool	initialized() const          Returns true if this set is initialized.
Message*	message(UInt16 msgNumber)          Return a pointer to the specified message.
UInt16	set() const          Return the set number for this set.
const char*	text(UInt16 setNum, UInt16 msgNum)          Return the text for a message.

Related Classes

Message, MessageCatalog

Constructor Detail

MessageSet

Construct a MessageSet object from setData and add it to the specified message catalog. This constructor is used by the message catalog when loading default catalog data produced by the message editor.

Parameters:

catalog - a message catalog.

setData - default data for the message set.

MessageSet

Construct an empty MessageSet object with the specified set number and space for adding msgCount messages.

Parameters:

catalog - a message catalog.

setNumber - the set number for this object.

msgCount - the maximum number of messages.

Method Detail

catalog

MessageCatalog& catalog() const

Return the message catalog containing this message set.

Returns:

a message catalog.

count

UInt16 count() const

Return the number of messages in this message set.

Returns:

the number of messages in this message set.

defaultText

const char* defaultText(UInt16 msgNum)

Return the default text for the specified message. The default text is used when the message catalog file is not available.

Parameters:

msgNum - the message number.

Returns:

the default text for a message, or null if the message was not found.

initialized

bool initialized() const

Returns true if this set is initialized.

Returns:

true if this set is initialized.

message

Message message(UInt16 msgNum) const

Return the message specified by msgNum.

Parameters:

msgNum - the message number.

Returns:

a pointer to the specified message, or null if no message was found.

set

UInt16 set() const

Return the set number of this message set.

Returns:

the set number of this message set.

text

const char* text(UInt16 msgNum)

Return the message text for the specified message. If the message catalog file is not available, the default text is returned.

Parameters:

msgNum - the message number.

Returns:

the text for a message.

Example Code

Copyright © 2003 Xavax Inc. -- All Rights Reserved