|
|
|
|
| ControlCommand | Create | CurrentControlID | CurrentDialogID |
| STRSetText | SetDefault | SetText |
function ControlCommand
(const msgType : DWSpec.DisplayMessageType;
const msgData : pointer) : ControlMessage; stdcall;
exports ControlCommand name 'CtrlSBar_ControlCommand';
//*
// ControlCommand - Retrieves command which has been sent from a control.
//
//
// This routine will retrieve a command which has been sent from the
// control to the ActionProc.
//
// CALLING SEQUENCE -
//
// command := ControlCommand (msgType, msgData)
//
// ENTRY -
//
// msgType : DWSpec.DisplayMessageType
// The msgType parameter which was passed into the ActionProc.
//
// msgData : pointer
// The msgData parameter which was passed into the ActionProc.
//
// EXIT -
//
// command : ControlMessage
// The command which has been sent. Must be one of the Control
// Messages defined for the control receiving the command. The
// command Unknown indicates an undefined command has been sent.
//
function CurrentDialogID
(const msgData : pointer) : cardinal; stdcall;
exports CurrentDialogID name 'CtrlSBar_CurrentDialogID';
//*
// CurrentDialogID - Retrieves ID of a dialog to which a message was sent.
//
//
// This routine will retrieve a the ID of a dialog to which a message
// has been sent.
//
// CALLING SEQUENCE -
//
// dialogID := CurrentDialogID (msgData)
//
// ENTRY -
//
// msgData : pointer
// The msgData parameter which was passed into the ActionProc.
//
// EXIT -
//
// dialogID : cardinal
// The ID of the dialog receiving a message.
//
function CurrentControlID
(const msgData : pointer) : cardinal; stdcall;
exports CurrentControlID name 'CtrlSBar_CurrentControlID';
//*
// CurrentControlID - Retrieves ID of a control for which a message is intended.
//
//
// This routine will retrieve the ID of a control for which a message
// is intended.
//
// CALLING SEQUENCE -
//
// controlID := CurrentControlID (msgData)
//
// ENTRY -
//
// msgData : pointer
// The msgData parameter which was passed into the ActionProc.
//
// EXIT -
//
// controlID : cardinal
// The ID of the control.
//
function SetDefault
(const FormID : cardinal;
const controlID : cardinal;
const index : cardinal) : boolean; stdcall;
exports SetDefault name 'CtrlSBar_SetDefault';
//*
// SetDefault - Sets one of the SageSBars to receive all DisplayMessages.
//
//
// This routine allows the user to specify which SageSBar will
// display the DisplayMessage messages. Sage.SageError messages will also
// be linked to this status bar. Calling this routine with a
// formID value of 0 will disable this function.
//
// CALLING SEQUENCE -
//
// status := SetDefault (formID, controlID, index)
//
// ENTRY -
//
// formID : cardinal
// The number of the dialog box or window containing the
// control.
//
// controlID : cardinal
// The ID of the SageSBar. Set to 0 if the status bar is on
// a window.
//
// index : cardinal
// The index (1 .. n) of the cell in the status bar to display the
// message.
//
// EXIT -
//
// status : boolean
// True if the operation was successful.
//
function Create
(const windowID : cardinal;
const parts : cardinal;
const partArray : SBarCellArrayType) : boolean; stdcall;
exports Create name 'CtrlSBar_Create';
//*
// Create - Creates a SageSBar control on a window.
//
//
// This routine allows the user to create a SageSBar control on a
// window. SageSBar controls for dialogs should be created in the
// resource editor.
//
// CALLING SEQUENCE -
//
// status := Create (windowID, parts, partArray)
//
// ENTRY -
//
// windowID : cardinal
// The ID of the window.
//
// parts : cardinal
// The number of cells which the SageSBar is to have. The maximum
// is 10.
//
// partArray : SBarCellArrayType
// An array containing the following information about each cell -
//
// percent - cardinal -- percent of the total SageSBar that this cell
// takes up
// raised - boolean -- True = Raised, False = Lowered
// pType - char -- Not Used, set to N
//
// EXIT -
//
// status : boolean
// True if the operation was successful.
//
procedure SetText
(const FormID : cardinal;
const controlID : cardinal;
const Text : array of char;
const cellIndex : cardinal); overload; stdcall;
exports SetText (const FormID : cardinal;
const controlID : cardinal;
const Text : array of char;
const cellIndex : cardinal) name 'CtrlSBar_SetText';
//*
// SetText - Sets the text for a cell of the SageSBar control.
//
//
// This routine will place the given text string in the specified
// SageSBar cell.
//
// CALLING SEQUENCE -
//
// SetText (formID, controlID, text, cellIndex)
//
// ENTRY -
//
// formID : cardinal
// The number of the dialog box or window containing the
// control.
//
// controlID : cardinal
// The status bar control resource identifier. This value should
// be zero for the status bar of a window.
//
// text : array of char
// The text to set in the status bar.
//
// cellIndex : cardinal
// The index (1 .. n) of the cell to put the text in.
//
procedure SetText
(const FormID : cardinal;
const controlID : cardinal;
const Text : string;
const cellIndex : cardinal); overload; stdcall;
exports SetText (const FormID : cardinal;
const controlID : cardinal;
const Text : string;
const cellIndex : cardinal) name 'CtrlSBar_STRSetText';
//*
// STRSetText - See documentation of SetText.
//
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance