Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_Strings.h File Reference


Namespaces

namespace  CP_Strings

Get a localized string from the common table.

CP_String GetLocalizedString (const char *inKey, const char *inComment)
CP_String GetLocalizedString (const CP_String &inKey, const char *inComment)

Get a localized string from a specific table.

CP_String GetLocalizedStringFromTable (const char *inKey, const char *inTable, const char *inComment)
CP_String GetLocalizedStringFromTable (const CP_String &inKey, const char *inTable, const char *inComment)

Defines

#define GetLocalizedString(str, comment)   _CP_GetLocalizedString(str)
 Macro to map GetLocalizedString call with comment string to 'real' API, hiding the comment.
#define GetLocalizedStringFromTable(str, table, comment)   _CP_GetLocalizedString_FromTable(str, table)
 Macro to map GetLocalizedStringFromTable call with comment string to 'real' API, hiding the comment.

Functions

CP_String GetString (SInt16 inResID, SInt16 inIndex)

Define Documentation

#define GetLocalizedString str,
comment   )     _CP_GetLocalizedString(str)
 

#define GetLocalizedStringFromTable str,
table,
comment   )     _CP_GetLocalizedString_FromTable(str, table)
 


Function Documentation

CP_String CP_Strings::GetString SInt16  inResID,
SInt16  inIndex
 

Loads a string resource from the resource with the passed in inResID, and inIndex into the string resource.

Parameters:
inResID Resource id of the strings resource.
inIndex Index of the string in the strings resource.
Returns:
CP_String Returns a CP_String containing the string data. Returns an empty string if the string is not found.

CP_String GetLocalizedString const char *  inKey,
const char *  inComment
 

Pseudo API to get a localized string from the common string table. Fetches the string specified by inKey from the common string table (e.g. Localizable.strings on Mac OS). The comment parameter is only used by the genstrings tool to construct the string tables. It's hidden from the compiler using the macros defined below, which map this API to the comment-less private APIs that do the string fetching business.

Parameters:
inKey Specifies which string to fetch.
inComment Comment that will only appear in the string table to help localizers.
Exceptions:
none 
Returns:
CP_String The localized string or the key string if no localized string was found.

CP_String GetLocalizedString const CP_String inKey,
const char *  inComment
 

CP_String GetLocalizedStringFromTable const char *  inKey,
const char *  inTable,
const char *  inComment
 

Pseudo API to get a localized string from the speicified string table. Fetches the string specified by inKey from the specified string table (e.g. <name>.strings on Mac OS). The comment parameter is only used by the genstrings tool to construct the string tables. It's hidden from the compiler using the macros defined below, which map this API to the comment-less private APIs that do the string fetching business.

Parameters:
inKey Specifies which string to fetch.
inTable Specifies which string table to use (i.e. the name of the string table file).
inComment Comment that will only appear in the string table to help localizers.
Exceptions:
none 
Returns:
CP_String The localized string or the key string if no localized string was found.

CP_String GetLocalizedStringFromTable const CP_String inKey,
const char *  inTable,
const char *  inComment
 


Generated on Sat Sep 17 20:01:17 2005 for CPLAT by  doxygen 1.4.0