Communicator UI: 2.3 ComplexMonikerClass: ComplexMoniker Messages

GEOS SDK TechDocs

2.2 ComplexMoniker Usage

3 Convenient Dialog Routines

MSG_COMPLEX_MONIKER_GET_MONIKER, MSG_COMPLEX_MONIKER_REPLACE_MONIKER

To retrieve a complex moniker, send the ComplexMoniker MSG_COMPLEX_MONIKER_GET_MONIKER . This message takes a single argument, a pointer to a structure of type GetComplexMoniker . The structure will be filled in with the relevant information by the message.

typedef struct {
    TextStyle				GCM_textStyle;
    byte				GCM_fontSize;
    ComplexMonikerText				GCM_topText;
    ComplexMonikerBitmap				GCM_iconBitmap;
} GetComplexMoniker;

Send MSG_COMPLEX_MONIKER_REPLACE_MONIKER to replace a complex moniker with a new moniker.

This message takes two arguments: a ReplaceComplexMoniker structure and a ReplaceComplexMonikerChunkHandles structure.

The ReplaceComplexMoniker structure should hold the parameters for the new moniker.

typedef struct {
    TextStyle				RCM_textStyleSet;
    TextStyle				RCM_textStyleClear;
    word				RCM_fontSize;
    dword				RCM_topTextSource;
    dword				RCM_iconBitmapSource;
    ComplexMonikerSourceType				RCM_topTextSourceType;
    ComplexMonikerSourceType				RCM_iconBitmapSourceType;
    word				RCM_iconBitmapSize;
    RCMOverwrite				RCM_overwrite;
} ReplaceComplexMoniker;

RCM_ textStyleSet stores a TextStyle record of styles that should be set (masked) on top of any currently existing styles.

RCM _textStyleClear stores a TextStyle record of styles that should be cleared if they are set among the currently existing styles.

RCM _fontSize stores the new font size. Pass 0 to indicate no change.

RCM _topTextSource stores a dword value containing, or pointing to, the source for the new text. The type of value stored here is indicated in RCM _topTextSourceType .

RCM _iconBitmapSource stores a dword value containing, or pointing to, the source for the new bitmap. The type of value stored here is indicated in RCM _iconBitmapSourceType.

RCM_ topTextSourceType stores the type of text reference contained in RCM_ topTextSource .

RCM _iconBitmapSourceType stores the type of bitmap reference contained in RCM_ iconBitmapSource .

RCM_iconBitmapSize stores the size of the icon bitmap, in bytes.

RCM _overwrite indicates whether the existing complex moniker chunks should be overwritten. Pass TRUE if you wish this occur.

MSG_COMPLEX_MONIKER_REPLACE_MONIKER also passes a ReplaceComplexMonikerChunkHandles structure. This structure is used to place returned chunk handles of the text and bitmap.

typedef struct {
    ChunkHandle			RCMCH_topText;
    word			RCMCH_unusedCX;
    ChunkHandle			RCMCH_iconBitmap;
    word			RCMCH_unusedBP;
} ReplaceComplexMonikerChunkHandles;

RCMCH _ topText contains the ChunkHandle of the text portion of the new complex moniker.

RCMCH _iconBitmap contains the ChunkHandle of the bitmap (graphics) portion of the new complex moniker.

GEOS SDK TechDocs

2.2 ComplexMoniker Usage

3 Convenient Dialog Routines