|
|
|
|
type ControlMessage is (Unknown, -- Unknown command
DataChange, -- Edit control value has changed. This message is sent
-- before the Edit box is visually updated.
EnterControl, -- Edit control received focus
ExitControl, -- Edit control lost focus
Click, -- Button, Check Box, or Radio Button control left button
-- single click
DoubleClick, -- Button, Check Box, or Radio Button control left button
-- double click
ThumbTrack, -- The thumb is being dragged
ScrollLocChange); -- Track/scroll bar location changed message
function ControlCommand
(msgType : in DisplayW.DisplayMessageType;
msgData : in System.Address) return 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 : DisplayW.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.
--
function CurrentDialogID
(msgData : in System.Address) return ModSys.S_Natural;
--*
-- 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 : S_long_integer
-- The ID of the dialog receiving a message.
--
function CurrentControlID
(msgData : in System.Address) return ModSys.S_Natural;
--*
-- CurrentControlID - Retrieves the 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 : System.Address
-- The msgData parameter which was passed into the ActionProc.
--
-- EXIT -
--
-- ControlId : S_long_integer
-- The ID of the control.
--
function IsEnabled
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural) return 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- status : boolean
-- TRUE if the control is enabled.
--
procedure EnableControl
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- EnableControl - Enables a control.
--
--
-- This routine will enable the specified control.
--
-- CALLING SEQUENCE -
--
-- EnableControl (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure DisableControl
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- DisableControl - Disables a control.
--
--
-- This routine will disable (gray) the specified control.
--
-- CALLING SEQUENCE -
--
-- DisableControl (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure HideControl
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- HideControl - Hides a control.
--
--
-- This routine will hide the specified control.
--
-- CALLING SEQUENCE -
--
-- HideControl (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure ShowControl
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- ShowControl - Shows a control.
--
--
-- This routine will show the specified control.
--
-- CALLING SEQUENCE -
--
-- ShowControl (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure SetFocus
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- SetFocus - Sets to focus to a control.
--
--
-- This routine will give the specified control focus.
--
-- CALLING SEQUENCE -
--
-- SetFocus (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure RedrawControl
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- RedrawControl - Redraws a control.
--
--
-- This routine will redraw the specified control.
--
-- CALLING SEQUENCE -
--
-- RedrawControl (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure GetText
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Text : in out string);
--*
-- GetText - Retrieves the text or label text length from control.
--
--
-- This routine will return the text or label text and text length of
-- the specified control.
--
-- CALLING SEQUENCE -
--
-- GetText (DialogId, ControlId, text)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- text : string
-- The text or label text from the control.
--
procedure SetText
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Text : in string);
--*
-- 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- text : string
-- The text or label text to set in the control.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Check
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- Check - Set checkbox/radiobutton to checked/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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Gray
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
function IsChecked
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural) return boolean;
--*
-- IsChecked - Determines if 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- 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
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- UnCheck - Sets the checkbox/radiobutton to unchecked/unselected.
--
--
-- This routine will remove a check a checkbox control, or will
-- unselect a radio button.
--
-- CALLING SEQUENCE -
--
-- UnCheck (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure MakeDefault
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure ProgressSetRange
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
bRange : in ModSys.S_Natural);
--*
-- 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- bRange : S_long_integer
-- The total number of part of the progress bar.
--
-- EXIT -
--
-- None
-- N/A
--
procedure ProgressSetStep
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Step : in ModSys.S_Natural);
--*
-- 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- Step : S_long_integer
-- The number of steps the progress bar is to be incremented.
--
-- EXIT -
--
-- None
-- N/A
--
procedure ProgressReset
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- ProgressReset - Reset the progress bar.
--
--
-- This routine will reset the progress bar.
--
-- CALLING SEQUENCE -
--
-- ProgressReset (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure ProgressStepIt
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- 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 : S_long_integer
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : S_long_integer
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetRange
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
iMin : in ModSys.S_Natural;
iMax : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose range will be set.
--
-- iMin : Modsys.S_Natural
-- The minimum value of the trackbar range.
--
-- iMax : Modsys.S_Natural
-- The maximum value of the trackbar range.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetPageSize
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
size : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose position will be set.
--
-- size : Modsys.S_Natural
-- The size of the page for this control.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetLineSize
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
size : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose position will be set.
--
-- size : Modsys.S_Natural
-- The size of the line for this control.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetSelectionRange
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
iMin : in ModSys.S_Natural;
iMax : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose SelectionRange will be set.
--
-- iMin : Modsys.S_Natural
-- The minimum value of the trackbar SelectionRange.
--
-- iMax : Modsys.S_Natural
-- The maximum value of the trackbar SelectionRange.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetTicPos
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Position : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose position will be set.
--
-- position : Modsys.S_Natural
-- The position of the first tic mark on the track bar.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetTicFreq
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
frequency : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose position will be set.
--
-- frequency : Modsys.S_Natural
-- The frequncy of tic marks on the track bar.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackSetPosition
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Pos : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose position will be set.
--
-- pos : Modsys.S_Natural
-- The position of the trackbar.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackGetPosition
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Pos : in out ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose position will be returned.
--
-- EXIT -
--
-- pos : Modsys.S_Natural
-- The position of the trackbar.
--
procedure TrackClear
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- TrackClear - Clears the current track selection.
--
--
-- This routine will clear the selection area on a track bar.
--
-- CALLING SEQUENCE -
--
-- TrackClear (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose selection will be cleared.
--
-- EXIT -
--
-- None
-- N/A
--
procedure TrackClearTics
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The ID of the dialog containing the trackbar control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the control whose tics will be cleared.
--
-- EXIT -
--
-- None
-- N/A
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance