|
|
|
|
type DialogMessage is (Unknown, -- Unknown command
Initialize, -- The dialog is being initialized
command, -- A Command message has been received
SysCommand, -- A SysCommand message has been received
SageListMessage, -- A message for a SageList has been received
SageEditMessage, -- A message for a SageEdit has been received
SageCBoxMessage, -- A message for a SageCBox has been received
SageBttnMessage, -- A message for a SageBttn has been received
SageCombMessage, -- A message for a SageComb has been received
SageRBtnMessage, -- A message for a SageRBtn has been received
SageTreeMessage, -- A message for a SageTree has been received
SageRichMessage, -- A message for a SageRich has been received
SageSBarMessage, -- A message for a SageSBar has been received
DrawItem, -- A DrawItem message for an owner-draw control
WinEdit, -- A message for a Windows Edit control has been received
WinButton, -- A message for a Windows Button control has been received
WinScroll, -- A message for a Windows Scroll bar has been received
TerminateMsg, -- The dialog is being closed
SageGridMessage, -- A message for a SageGrid has been received
ContextHelp, -- A message for a ContextHelp message has been received
TrackBar, -- A message for a Windows Track bar control
SageLVMessage); -- A message for a SageLV has been received
type ContextHelpType is (Context, -- Full help system
ContextPopup); -- popup help only
type ModalDialogProcType is access
procedure (messageType : in DisplayW.DisplayMessageType;
MessageValue : in System.Address;
done : in out boolean);
pragma Convention
(WIN32,
ModalDialogProcType);
type ModelessDialogProcType is access
procedure (messageType : in DisplayW.DisplayMessageType;
MessageValue : in System.Address;
done : in out boolean);
pragma Convention
(WIN32,
ModelessDialogProcType);
function DialogCommand
(msgType : in DisplayW.DisplayMessageType) return DialogMessage;
--*
-- DialogCommand - Retrieves a command which has been sent to a dialog.
--
--
-- This routine will retrieve a command which has been sent to the
-- dialog's ActionProc.
--
-- CALLING SEQUENCE -
--
-- command := DialogCommand (msgType)
--
-- ENTRY -
--
-- msgType : DisplayW.DisplayMessageType
-- The msgType parameter which was passed into the ActionProc.
--
-- EXIT -
--
-- command : DialogMessage
-- The command which has been sent. Must be one of the Dialog
-- Messages. The command Unknown indicates an undefined command
-- has been sent.
--
procedure Close
(dialogID : in ModSys.S_Natural);
--*
-- Close - Closes a dialog.
--
--
-- This routine will close the specified dialog. A Terminate message
-- will be sent to the ActionProc to allow clean up to occur before the
-- dialog is destroyed. If the user handles the Terminate message and
-- returns TRUE, this indicates that they wish for the dialog to continue
-- execution and the Terminate is canceled. If FALSE is returned, this
-- indicates that they are not going to override the Terminate and that
-- the Terminate will proceed as usual.
--
-- CALLING SEQUENCE -
--
-- Close (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
function CreateModal
(dialogID : in ModSys.S_Natural;
ModalDialogProc : in ModalDialogProcType) return ModSys.S_Natural;
--*
-- CreateModal - Creates a Modal dialog.
--
--
-- This routine is used to create a modal dialog and associate an
-- ActionProc with that dialog.
--
-- CALLING SEQUENCE -
--
-- status := CreateModal (DialogID, dialogProc)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The resource ID of the dialog box to create.
--
-- dialogProc : ActionProc
-- The user supplied ActionProc for the dialog.
--
-- EXIT -
--
-- status : BOOLEAN
-- TRUE if the dialog is was created successfully.
--
function CreateModeless
(dialogID : in ModSys.S_Natural;
ModelessDialogProc : in ModelessDialogProcType) return ModSys.S_Natural;
--*
-- CreateModeless - Creates a Modeless dialog.
--
--
-- This routine is used to create a modeless dialog and associate an
-- ActionProc with that dialog.
--
-- CALLING SEQUENCE -
--
-- status := CreateModeless (DialogID, dialogProc)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The resource ID of the dialog box to create.
--
-- dialogProc : ActionProc
-- The user supplied ActionProc for the dialog.
--
-- EXIT -
--
-- status : BOOLEAN
-- TRUE if the dialog is was created successfully.
--
function CurrentDialogID
(msgData : in System.Address) return ModSys.S_Natural;
--*
-- CurrentDialogID - Retrieves the unique ID of a dialog.
--
--
-- This routine will retrieve the unique ID of a dialog to which a message
-- has been sent. This will usually be the same number as the dialog's
-- resource ID; however, if multiple instances of the same dialog exist
-- simultaneously, then you will get a different, unique number for
-- each additional instance.
--
-- 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.
--
function GetOriginalDialogID
(dialogID : in ModSys.S_Natural) return ModSys.S_Natural;
--*
-- GetOriginalDialogID - Retrieves the resource ID of a dialog.
--
-- Given the run-time assigned number of a dialog, this routine returns
-- the resource ID that was used to create the dialog.
--
-- CALLING SEQUENCE -
--
-- DialogID := OriginalDialogID (msgData)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The unique dialog ID for an instance of a dialog.
--
-- EXIT -
--
-- resourceID : CARDINAL
-- The ID of the resource used to create the instance of the DialogID.
--
procedure Disable
(dialogID : in ModSys.S_Natural);
--*
-- Disable - Disables a dialog.
--
--
-- This routine will disable (prevent keyboard and mouse input) to
-- the specified dialog.
--
-- CALLING SEQUENCE -
--
-- Disable (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Enable
(dialogID : in ModSys.S_Natural);
--*
-- Enable - Enables a dialog.
--
--
-- This routine will enable the specified dialog.
--
-- CALLING SEQUENCE -
--
-- Enable (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Flush
(dialogID : in ModSys.S_Natural);
--*
-- Flush - Writes the contents of all the Sage controls to memory record.
--
--
-- This routine will cause all Sage controls on the dialog which are linked
-- to Sage tables and fields to have their contents written to the
-- current memory record. Note: Sage controls are automatically written
-- out when the dialog is terminated.
--
-- CALLING SEQUENCE -
--
-- Flush (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Hide
(dialogID : in ModSys.S_Natural);
--*
-- Hide - Hides a dialog.
--
--
-- This routine will hide the specified dialog.
--
-- CALLING SEQUENCE -
--
-- Hide (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
function IsEnabled
(dialogID : in ModSys.S_Natural) return boolean;
--*
-- IsEnabled - Checks to see if a dialog is enabled.
--
--
-- This routine will determine whether a dialog is enabled (receives
-- keyboard and mouse input) or is disabled.
--
-- CALLING SEQUENCE -
--
-- status := IsEnabled (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- status : BOOLEAN
-- TRUE if the dialog is enabled.
--
procedure Reset
(dialogID : in ModSys.S_Natural);
--*
-- Reset - Causes all the Sage controls on the dialog to reload themselves.
--
--
-- This routine will cause all Sage controls on the dialog which are linked
-- to Sage tables and fields to have their contents updated from the
-- current memory record. Note: Sage controls are automatically loaded
-- when the dialog is first created.
--
-- CALLING SEQUENCE -
--
-- Reset (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Redraw
(dialogID : in ModSys.S_Natural);
--*
-- Redraw - Redraws a dialog.
--
--
-- This routine will redraw the specified dialog.
--
-- CALLING SEQUENCE -
--
-- Redraw (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
procedure SetFocus
(dialogID : in ModSys.S_Natural);
--*
-- SetFocus - Sets to focus to a dialog.
--
--
-- This routine will give focus to the specified dialog.
--
-- CALLING SEQUENCE -
--
-- SetFocus (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
procedure Show
(dialogID : in ModSys.S_Natural);
--*
-- Show - Shows a dialog.
--
--
-- This routine will show the specified dialog.
--
-- CALLING SEQUENCE -
--
-- Show (DialogID)
--
-- ENTRY -
--
-- DialogID : CARDINAL
-- The ID of the dialog box.
--
-- EXIT -
--
-- None
-- N/A
--
function GetContextHelpControlID
(msgData : in System.Address) return ModSys.S_Natural;
--*
-- GetContextHelpControlID - Gets the ControlID pointed to by context help.
--
-- 09/12/1996
--
-- This routine will return the ControlID pointed to by context help.
--
-- CALLING SEQUENCE -
--
-- ControlID := GetContextHelpControlID (msgData)
--
-- ENTRY -
--
-- msgData : System.Address
-- The msgData passed in to the dialog proc.
--
-- EXIT -
--
-- ControlID : Modsys.S_Natural
-- The ID of the ControlID pointed to by context help.
--
function GetContextHelpID
(msgData : in System.Address) return ModSys.S_Natural;
--*
-- GetContextHelpID - Gets the help Id pointed to by context help.
--
-- 09/12/1996
--
-- This routine will return the helpId pointed to by context help.
--
-- CALLING SEQUENCE -
--
-- helpID := GetContextHelpID (msgData)
--
-- ENTRY -
--
-- msgData : System.Address
-- The msgData passed in to the dialog proc.
--
-- EXIT -
--
-- helpID : Modsys.S_Natural
-- The ID of the helpId pointed to by context help.
--
procedure SetContextHelpMsg
(helpID : in ModSys.S_Natural;
helpFile : in string;
helpType : in ContextHelpType;
msgData : in System.Address);
--*
-- SetContextHelpMsg - sets the Help message data.
--
-- 09/12/1996
--
-- This routine will set the needed items for context help.
--
-- CALLING SEQUENCE -
--
-- SetContextHelpMsg (201, "help.hlp", msgData)
--
-- ENTRY -
--
-- helpID : Modsys.S_Natural
-- The ID of where to point in the help file.
--
-- helpFile : string
-- The help file.
--
-- helpType : ContextHelpType
-- The type of help to display (context - full help functionality
-- contextPopup - popup only.)
--
-- msgData : System.Address
-- The msgData passed in to the dialog proc.
--
-- EXIT -
--
-- None
-- N/A
--
procedure GetDialogPositionInfo
(dialogID : in ModSys.S_Natural;
DialogXPos : out ModSys.S_Integer;
DialogYPos : out ModSys.S_Integer;
DialogWidth : out ModSys.S_Integer;
DialogHeight : out ModSys.S_Integer);
--*
-- GetDialogPositionInfo - Returns the position information on the specified dialog.
--
--
-- This routine gets the position information for the specified dialog.
--
-- CALLING SEQUENCE -
--
-- GetDialogPositionInfo (DialogID, DialogXPos, DialogYPos,
-- DialogWidth, DialogHeight);
--
-- ENTRY -
--
-- DialogID : Modsys.S_Natural
-- The ID of the window.
--
-- EXIT -
--
-- DialogXPos : Modsys.S_Integer
-- The X position of the dialog.
--
-- DialogYPos : Modsys.S_Integer
-- The Y position of the dialog.
--
-- DialogWidth : Modsys.S_Integer
-- The width of the current dialog.
--
-- DialogHeight : Modsys.S_Integer
-- The height of the current dialog.
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance