|
|
|
|
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 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 : 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 ID of a control for which 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 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 ScrollTextPage
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST pageDown : BOOLEAN);
PROCEDURE SetText
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Text : ARRAY OF CHAR);
(**
SetText - Sets the text or label text of a control.
This routine will place the given text string in the specified
controls text area or 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 text or label text to set in the control.
EXIT -
None
*)
PROCEDURE Check
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
Check - Sets the state of checkbox to checked, or state of radiobutton to selected.
This routine will place a check in a checkbox control or will change
the state of a radio button to selected.
CALLING SEQUENCE -
Check (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 Gray
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
Gray - Sets the state of a checkbox to grayed.
This routine will fill the specified checkbox control with gray.
CALLING SEQUENCE -
Gray (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 IsChecked
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL) : BOOLEAN;
(**
IsChecked - Determines if a checkbox or radio button control is checked.
This routine will determine the checked/unchecked status of
a checkbox control, or the selected status of a radio button.
CALLING SEQUENCE -
checked := IsChecked (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
checked : BOOLEAN
TRUE if the checkbox is checked or grayed, or the radio button
is selected. FALSE if the checkbox is unchecked, or the radio
button is not selected.
*)
PROCEDURE UnCheck
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
UnCheck - Sets state of checkbox to unchecked or radiobutton to unselected.
This routine will remove a check a checkbox control, or will
unselect a radio button.
CALLING SEQUENCE -
UnCheck (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 MakeDefault
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
MakeDefault - Makes a button the default button.
This routine will make a button 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 ProgressSetRange
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Range : CARDINAL);
(**
ProgressSetRange - Sets the range of a progress bar.
This routine will set the range (minimum and maximum values)
of the progress bar and redraw the bar.
CALLING SEQUENCE -
ProgressSetRange (dialogID, controlID, Range)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
Range : CARDINAL
The total number of part of the progress bar.
EXIT -
None
*)
PROCEDURE ProgressSetStep
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Step : CARDINAL);
(**
ProgressSetStep - Sets the increment of a progress bar.
This routine specifies the step increment of the progress bar.
CALLING SEQUENCE -
ProgressSetRange (dialogID, controlID, Step)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
Step : CARDINAL
The number of steps the progress bar is to be incremented.
EXIT -
None
*)
PROCEDURE ProgressReset
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
ProgressReset - Reset the progress bar.
This routine will reset the progress bar.
CALLING SEQUENCE -
ProgressReset (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 ProgressStepIt
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
ProgressStepIt - Advance the position of the progress bar.
This routine will advance the current position of the progress
bar by the step increment and redraw it.
CALLING SEQUENCE -
ProgressStepIt (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 TrackSetRange
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST iMin : INTEGER;
CONST iMax : INTEGER);
(**
TrackSetRange - Sets the range of the trackbar control.
This routine will set the range of the trackbar control. The range
is the set of contiguous values that a trackbar can represent.
This is usually used when the trackbar is first created.
CALLING SEQUENCE -
TrackSetRange (dialogID, controlID, iMin, iMax)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose range will be set.
iMin : CARDINAL
The minimum value of the trackbar range.
iMax : CARDINAL
The maximum value of the trackbar range.
EXIT -
none
*)
PROCEDURE TrackSetPageSize
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST size : CARDINAL);
(**
TrackSetPageSize - Sets the size of the page for pageup and down comands.
This routine will set the page size that is to be used for page up and
down commands. The default is max - min divided by 5.
CALLING SEQUENCE -
TrackSetPageSize (dialogID, controlID, size)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose position will be set.
size : CARDINAL
The size of the page for this control.
EXIT -
none
*)
PROCEDURE TrackSetLineSize
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST size : CARDINAL);
(**
TrackSetLineSize - Sets the size of the line for the line left and right comands.
This routine will set the line size that is to be used for line left and right
commands.
CALLING SEQUENCE -
TrackSetLineSize (dialogID, controlID, size)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose position will be set.
size : CARDINAL
The size of the line for this control.
EXIT -
none
*)
PROCEDURE TrackSetSelectionRange
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST iMin : INTEGER;
CONST iMax : INTEGER);
(**
TrackSetSelectionRange - Sets the SelectionRange of the trackbar control.
This routine will set the SelectionRange of the trackbar control.
The SelectionRange is the colored area on the track bar that indicates
the optimum range for the control.
CALLING SEQUENCE -
TrackSetSelectionRange (dialogID, controlID, iMin, iMax)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose SelectionRange will be set.
iMin : CARDINAL
The minimum value of the trackbar SelectionRange.
iMax : CARDINAL
The maximum value of the trackbar SelectionRange.
EXIT -
none
*)
PROCEDURE TrackSetTicPos
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Position : CARDINAL);
(**
TrackSetTicPos - Sets tic mark position.
This routine will set the position of the tic marks on a
track bar.
CALLING SEQUENCE -
TrackSetTicPos (dialogID, controlID, position)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose position will be set.
position : CARDINAL
The position of the first tic mark on the track bar.
EXIT -
none
*)
PROCEDURE TrackSetTicFreq
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST frequency : CARDINAL);
(**
TrackSetTicFreq - Sets tic mark frequency.
This routine will set the frequency of the tic marks on a
track bar.
CALLING SEQUENCE -
TrackSetTicFreq (dialogID, controlID, frequency)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose position will be set.
frequency : CARDINAL
The frequncy of tic marks on the track bar.
EXIT -
none
*)
PROCEDURE TrackSetPosition
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST Pos : CARDINAL);
(**
TrackSetPosition - Sets the position of the trackbar control.
This routine will set the position of the trackbar control.
CALLING SEQUENCE -
TrackSetPosition (dialogID, controlID, pos)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose position will be set.
pos : CARDINAL
The position of the trackbar.
EXIT -
none
*)
PROCEDURE TrackGetPosition
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
VAR Pos : CARDINAL);
(**
TrackGetPosition - Returns the current position of the trackbar control.
This routine will return the current position (the value the user
has chosen) of the trackbar control.
CALLING SEQUENCE -
TrackGetPosition (dialogID, controlID, pos)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose position will be returned.
EXIT -
pos : CARDINAL
The position of the trackbar.
*)
PROCEDURE TrackClear
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
TrackClear - Clears the current track selection.
This routine will clear the selection area on a track bar.
CALLING SEQUENCE -
TrackClear (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose selection will be cleared.
EXIT -
none
*)
PROCEDURE TrackClearTics
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
TrackClearTics - Clears the current track bar tics.
This routine will clear the tics on the specified track bar.
CALLING SEQUENCE -
TrackClearTics (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The ID of the dialog containing the trackbar control.
controlID : CARDINAL
The ID of the control whose tics will be cleared.
EXIT -
none
*)
PROCEDURE PostMessageToControl
(CONST dId : CARDINAL;
CONST cId : CARDINAL;
CONST typeMsg : CARDINAL;
CONST msgId : CARDINAL;
CONST extra : CARDINAL);
PROCEDURE SendMessageToControl
(CONST dId : CARDINAL;
CONST cId : CARDINAL;
CONST typeMsg : CARDINAL;
CONST msgId : CARDINAL;
CONST extra : CARDINAL);
PROCEDURE PostCommandToWindow
(CONST windowID : CARDINAL;
CONST msgId : CARDINAL;
CONST extra : CARDINAL);
PROCEDURE SendCommandToWindow
(CONST windowID : CARDINAL;
CONST msgId : CARDINAL;
CONST extra : CARDINAL);
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance