ICustStatus Class Reference
 
 
 
ICustStatus Class Reference

This reference page is linked to from the following overview topics: Methods and Classes of Custom Controls.


#include <custcont.h>

Inheritance diagram for ICustStatus:
ICustomControl InterfaceServer MaxHeapOperators

Class Description

See also:
Class ICustomControl, Custom Controls, Class ICustStatusEdit.

Description:
The custom status control provide a recessed area of the dialog which the developer may use as a status prompt display.

status.gif
To initialize the pointer to the control call: ICustStatus *GetICustStatus(HWND hCtrl);
To release the control call:
ReleaseICustStatus(ICustStatus *ics);
The value to use in the Class field of the Custom Control Properties dialog is: CustStatus

Public Member Functions

virtual void  SetText (const MCHAR *text)=0
virtual void  SetTextFormat (StatusTextFormat f)=0
virtual void  GetText (MSTR &text) const =0
virtual int  GetTextLength () const =0
virtual void  GetText (MCHAR *text, int ct)=0

Member Function Documentation

virtual void SetText ( const MCHAR *  text ) [pure virtual]
Remarks:
This method specifies the text message to display.
Parameters:
MCHAR *text

Points to the text to display.
virtual void SetTextFormat ( StatusTextFormat  f ) [pure virtual]
Remarks:
This methods controls the formatting of the text in the status control.
Parameters:
StatusTextFormat f

One of the following options:

STATUSTEXT_LEFT

Left justified in the control.

STATUSTEXT_CENTERED

Centered in the control.

STATUSTEXT_RIGHT

Right justified in the control.
virtual void GetText ( MSTR text ) const [pure virtual]
Remarks:
This retrieves the text entered into the control.
Parameters:
MSTR& text

Storage for the text to retrieve.
virtual int GetTextLength ( ) const [pure virtual]
Remarks:
This retrieves the length of the text entered into the control. It returns the length of the text in characters (so without the terminating NULL). Note that this value may be higher than the actual length of the text when it contains multi-byte characters.
virtual void GetText ( MCHAR *  text,
int  ct 
) [pure virtual]
Remarks:
Retrieves the text currently displayed in the custom status control.
Parameters:
MCHAR *text

A pointer to storage for the text to return.

int ct

The maximum length of the string to return.