|
|
|
|
type ControlMessage is (Unknown, -- Unknown command
Click, -- Button has been clicked
DoubleClick); -- Button has been double clicked
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.
--
procedure OwnerDrawBMP
(msgData : in System.Address;
bmpFileName : in string;
proportionate : in 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
(msgData : in System.Address;
bmpData : in string;
bmpSize : in ModSys.S_Natural;
proportionate : in 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
(msgData : in System.Address;
resourceID : in ModSys.S_Natural;
proportionate : in 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.
--
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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- 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 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- The control resource identifier.
--
-- EXIT -
--
-- text : string
-- The label text from the control.
--
procedure MakeDefault
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- 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 : Modsys.S_Natural
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : Modsys.S_Natural
-- The control resource identifier.
--
-- EXIT -
--
-- None
-- N/A
--
procedure SetText
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Text : in string);
--*
-- 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 : 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 label text to set in the control.
--
-- EXIT -
--
-- None
-- N/A
--
procedure SetToolTip
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
Text : in string);
--*
-- 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 : 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 tooltip text to set in the control.
--
-- EXIT -
--
-- None
-- N/A
--
procedure PostLeftButtonClick
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural);
--*
-- PostLeftButtonLick - 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 -
--
-- PostLeftButtonLick (DialogId, ControlId)
--
-- ENTRY -
--
-- DialogId : CARDINAL
-- The number of the dialog box or window containing the
-- control.
--
-- ControlId : CARDINAL
-- The control resource identifier.
--
-- 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