Class ICustStatus
See Also: Class ICustomControl, Custom Controls, Class ICustStatusEdit.
class ICustStatus : public ICustomControl
Description:
The custom status control provide a recessed area of the dialog which the developer may use as a status prompt display.
To initialize the pointer to the control call:
Prototype:
ICustStatus *GetICustStatus(HWND hCtrl);
To release the control call:
Prototype:
ReleaseICustStatus(ICustStatus *ics);
The value to use in the Class field of the Custom Control Properties dialog is: CustStatus
Methods:
Prototype:
virtual void SetText(TCHAR *text)=0;
Remarks:
This method specifies the text message to display.
Parameters:
TCHAR *text
Points to the text to display.
Prototype:
virtual void GetText(TCHAR *text, int ct)=0;
Remarks:
This method is available in release 2.0 and later only.
Retrieves the text currently displayed in the custom status control.
Parameters:
TCHAR *text
A pointer to storage for the text to return.
int ct
The maximum length of the string to return.
Prototype:
virtual void SetTextFormat(StatusTextFormat f)=0;
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.
Prototype:
virtual void SetTooltip(BOOL onOff, LPSTR text)=0;
Remarks:
This method is available in release 2.0 and later only.
Specifies the tooltip text to use for a custom status control and enables or disables its availability.
Parameters:
BOOL onOff
If TRUE the tooltip text may appear; if FALSE the tooltip will not appear.
LPSTR text
The text to use for the tooltip.