|
|
|
|
PROCEDURE ControlCommand
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS) : ControlMessage;
(**
ControlCommand - Retrieves a 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 : SYSTEM.ADDRESS
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.
*)
PROCEDURE CurrentDialogID
(CONST msgData : SYSTEM.ADDRESS) : CARDINAL;
(**
CurrentDialogID - Retrieves the ID of 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 : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
EXIT -
dialogID : CARDINAL
The ID of the dialog receiving a message.
*)
PROCEDURE CurrentControlID
(CONST msgData : SYSTEM.ADDRESS) : CARDINAL;
(**
CurrentControlID - Retrieves the ID of 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 : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
EXIT -
controlID : CARDINAL
The ID of the control.
*)
PROCEDURE OwnerDrawBMP
(CONST msgData : SYSTEM.ADDRESS;
CONST bmpFileName : ARRAY OF CHAR;
CONST proportionate : BOOLEAN);
(**
OwnerDrawBMP - Fill owner draw button when DrawItem message is received.
This procedure causes the owner draw button to be filled with the
contents of the BMP file when the Dialog.DrawItem message has
been received. This command is received when the control is first
initialized or after the CtrlBttn.RedrawControl procedure for that
control is called. The BMP file will be stretched to be
proportionate to its original dimensions if the 'proportionate'
argument is TRUE, or it will be stretched across the entire contents
of the button if otherwise.
*)
PROCEDURE OwnerDrawBMPData
(CONST msgData : SYSTEM.ADDRESS;
CONST bmpData : ARRAY OF CHAR;
CONST bmpSize : CARDINAL;
CONST proportionate : BOOLEAN);
(**
OwnerDrawBMPData - Fill owner draw button when DrawItem message is received.
This procedure causes the owner draw button to be filled with the
contents of the 'bmpData' when the Dialog.DrawItem message has
been received. This data is the same as the contents of a BMP file.
This command is received when the control is first
initialized or after the CtrlBttn.RedrawControl procedure for that
control is called. The BMP file will be stretched to be
proportionate to its original dimensions if the 'proportionate'
argument is TRUE, or it will be stretched across the entire contents
of the button if otherwise.
*)
PROCEDURE OwnerDrawRes
(CONST msgData : SYSTEM.ADDRESS;
CONST resourceID : CARDINAL;
CONST proportionate : BOOLEAN);
(**
OwnerDrawRes - Fill owner draw button when DrawItem message is received.
This procedure causes the owner draw button to be filled with the
BMP resource identified by the 'resourceID' when the Dialog.DrawItem
message has been received. This command is received when the control
is first initialized or after the CtrlBttn.RedrawControl procedure
for that control is called. The BMP file will be stretched to be
proportionate to its original dimensions if the 'proportionate'
argument is TRUE, or it will be stretched across the entire contents
of the button if otherwise.
*)
PROCEDURE OwnerDrawRes2
(CONST msgData : SYSTEM.ADDRESS;
CONST resourceID : CARDINAL;
CONST proportionate : BOOLEAN;
CONST resInstance : WIN32.HINSTANCE);
PROCEDURE IsEnabled
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL) : BOOLEAN;
(**
IsEnabled - Checks to see if a control is enabled.
This routine will determine whether a control is enabled or
disabled (grayed).
CALLING SEQUENCE -
status := IsEnabled (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
status : BOOLEAN
TRUE if the control is enabled.
*)
PROCEDURE EnableControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
EnableControl - Enables a control.
This routine will enable the specified control.
CALLING SEQUENCE -
EnableControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE DisableControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
DisableControl - Disables a control.
This routine will disable (gray) the specified control.
CALLING SEQUENCE -
DisableControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE HideControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
HideControl - Hides a control.
This routine will hide the specified control.
CALLING SEQUENCE -
HideControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE ShowControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
ShowControl - Shows a control.
This routine will show the specified control.
CALLING SEQUENCE -
ShowControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE SetFocus
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
SetFocus - Sets to focus to a control.
This routine will give the specified control focus.
CALLING SEQUENCE -
SetFocus (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE RedrawControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
RedrawControl - Redraws a control.
This routine will redraw the specified control.
CALLING SEQUENCE -
RedrawControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE GetText
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
VAR Text : ARRAY OF CHAR);
(**
GetText - Retrieves the label text and text length from the control.
This routine will return the label and label length of the specified
SageBttn control.
CALLING SEQUENCE -
GetText (dialogID, controlID, text)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
text : ARRAY OF CHAR
The label text from the control.
textLength : CARDINAL
The length ot the label text returned.
*)
PROCEDURE MakeDefault
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
MakeDefault - Makes a SageBttn the default button.
This routine will make a SageBttn the default button. The default
button has a dark outline around it and is automatically pressed
when the user presses the Enter key.
CALLING SEQUENCE -
MakeDefault (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE SetText
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Text : ARRAY OF CHAR);
(**
SetText - Sets the label text of the control.
This routine will place the given text string in the specified SageBttn
control label.
CALLING SEQUENCE -
SetText (dialogID, controlID, text)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
text : ARRAY OF CHAR
The label text to set in the control.
EXIT -
None
*)
PROCEDURE SetToolTip
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Text : ARRAY OF CHAR);
(**
SetToolTip - Sets the tooltip text of the control.
This routine will place the given text string in the specified SageBttn
control tooltip.
CALLING SEQUENCE -
SetToolTip (dialogID, controlID, text)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
text : ARRAY OF CHAR
The tooltip text to set in the control.
EXIT -
None
N/A
*)
PROCEDURE PostLeftButtonClick
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
PostLeftButtonClick - Simulates left click of a button.
This routine will simulate the left click of a button. The action
is *posted*, not sent, so the message currently being processed
will be completed and then a button click message will be generated,
just as if the user had actually pressed the button.
CALLING SEQUENCE -
PostLeftButtonClick (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance