|
|
|
|
| ControlCommand | Create | CurrentControlID |
| CurrentDialogID | SetDefault | SetText |
type ControlMessage is (Unknown); -- Unknown command
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 : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The ID of the control.
--
function SetDefault
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
index : in ModSys.S_Natural) return boolean;
--*
-- SetDefault - Sets one of the SageSBars to receive all DisplayMessages.
--
--
-- This routine allows the user to specidfy which SageSBar will
-- display the DisplayMessage messages. SageError messages will also
-- be linked to this status bar. Setting DialogId to 0 will disable
-- this function.
--
-- CALLING SEQUENCE -
--
-- status := SetDefault (DialogId, ControlId, index)
--
-- ENTRY -
--
-- DialogId : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- The ID of the SageSBar.
--
-- index : ModSys.S_Natural
-- 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
(windowID : in ModSys.S_Natural;
parts : in ModSys.S_Natural;
partArray : in DisplayW.CellType_u_array) return boolean;
--*
-- Create - Creates a SageSBar control on the specified window.
--
--
-- This routine allows the user to create a SageSBar control on the
-- specified window. SageSBar controls for dialogs should be created
-- in the resource editor.
--
-- CALLING SEQUENCE -
--
-- status := Create (windowID, parts, partArray)
--
-- ENTRY -
--
-- windowID : ModSys.S_Natural
-- The ID of the window.
--
-- parts : ModSys.S_Natural
-- The number of cells which the SageSBar is to have. The maximum
-- is 10.
--
-- partArray : DisplayW.CellType_u_array
-- An array containing the following information about each cell -
--
-- percent - ModSys.S_Natural -- 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
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Text : in string;
cellIndex : in ModSys.S_Natural);
--*
-- 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 (DialogId, ControlId, text, cellIndex)
--
-- ENTRY -
--
-- DialogId : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- The control resource identifier.
--
-- text : string
-- The text to set in the status bar.
--
-- cellIndex : ModSys.S_Natural
-- The index (1..n) of the cell to put the text in.
--
-- 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