class MStringResourceId

Jump to documentation

Documentation

Description

The MStringResourceId class implements a string lookup key to be used in conjunction with the MStringResource class.

Functions

MStringResourceId:: MStringResourceId ()

Description

The Class constructor. Initializes the new MStringResourceId instance to the empty string. This constructor will not be used in practice.

MStringResourceId:: MStringResourceId ( const char* pluginId, const char* keyString, const MString &defaultValue )

Description

Class constructor. Create a new instance of an MStringResourceId. This object can then be used to register and retrieve MStringResource's.

The unique resource key is formed from a pair of strings: the name of the plugin the string is associated with and a unique Id for this particular string. The resourceId also contains the string's default value.

Arguments

• pluginId the name of this plugin
• keyString the unique string Id (within this plugin)
• defaultValue the default value for the string resource

MStringResourceId:: MStringResourceId ( const MStringResourceId & other )

Description

Copy constructor. Create a new MStringResourceId instance by copying another.

Arguments

• other the MStringResourceId to copy from.

MStringResourceId:: ~MStringResourceId ()

Description

The class destructor.

MStringResourceId & MStringResourceId:: operator = (const MStringResourceId & other )

Description

Assignment operator. Allows assignment between MStringResourceId instances.

bool MStringResourceId:: operator == (const MStringResourceId & other ) const

Description

Equality operator. Allows 2 MStringResourceIds to be compared to see if they contain identical values.

bool MStringResourceId:: operator != (const MStringResourceId & other ) const

Description Inequality operator. Allows 2 MStringResourceIds to be compared to see if they differ.

This class has no child classes.