|
|
|
|
function DisplayBackgroundW
(windowID : in ModSys.S_Natural;
bitmapID : in ModSys.S_Natural;
Format : in BackgroundFormat) return boolean;
--*
-- DisplayBackgroundW - Places a bitmap on the specified window.
--
--
-- A bitmap is drawn in the client area of the specified window according
-- to the format option supplied.
--
-- CALLING SEQUENCE -
--
-- b := DisplayBackgroundW (windowID, bitmapID, format)
--
-- ENTRY -
--
-- windowID : ModSys.S_Natural
-- The identifier of the window on which to draw the bitmap.
--
-- bitmapID : ModSys.S_Natural
-- The identifier from the resource of the bitmap to draw.
--
-- format : BackgroundFormat
-- The style by which the bitmap will be drawn. Must be one of the
-- following -
--
-- BF_Center Centers the bitmap in the form
-- BF_Tile Tiles the bitmap in the form
-- BF_Fill_Window Stretches the bitmap to fill the form
-- BF_Size_Window Resizes the form to fit the bitmap exactly
-- BF_None Clears the form
--
-- EXIT -
--
-- b : boolean
-- True if the bitmap was drawn.
--
function DisplayForm
(Form : in ModSys.S_Natural;
ActionProc : in ActionProcType) return ModSys.S_Natural;
--*
-- DisplayForm - Displays the specified form using defaults.
--
--
-- The function displays a form using the DefaultProcedure to
-- handle messages to the form. The user will not be able to
-- access any forms underneath this one until it is closed.
--
-- The "DisplayForm" procedure was created by instantiating the
-- procedure, "DisplayFormG", with the default procedure
-- supplied in this package and known as "DisplayW.DefaultProcedure".
--
-- CALLING SEQUENCE -
--
-- b := DisplayForm (Form)
--
-- ENTRY -
--
-- Form : ModSys.S_Natural
-- Identifier of the form to display.
--
-- EXIT -
--
-- b : ModSys.S_Natural
-- The dialogID of the displayed dialog. Same as 'dialogID' is
-- the first one, or a new ID.
--
function DisplayFormDefaultProc
(Form : in ModSys.S_Natural) return ModSys.S_Natural;
--*
-- DisplayFormDefaultProc - Displays the form using the default procedure.
--
--
-- See documentation of the DisplayForm routine. This procedure does the
-- same thing except instead of supplying an ActionProc the DefaultProcedure
-- is used.
--
function DisplayFormContinue
(Form : in ModSys.S_Natural;
FormContinueProc : in ActionProcType) return ModSys.S_Natural;
--*
-- DisplayFormContinue - Displays the specified form.
--
--
-- The function displays a form and sets up an Action procedure to
-- handle messages to the form. The form (dialog) is displayed as
-- a modeless dialog box which causes a return to you code, but the
-- form remains active and the associated 'FormContinueProc' is
-- called until the form is taken down by sending a terminate message
-- from the associated 'FormContinueProc'.
--
-- The user will be able to access any forms underneath this one.
--
-- This procedure is instantiated with an action procedure which
-- appears as follows:
--
-- proecdure FormContinueProc (messageType : in DisplayMessageType;
-- messageValue : in System.Address;
-- done : in out boolean);
--
-- The 'FormContinueProc' is a user supplied function for which
-- handles messages sent to the form. The user can choose whether
-- or not to respond to these messages please refer to the documentation
-- on FormProc for an explaination of how to handle messages sent
-- to the procedure
--
-- Please see the beginning of this document for information on messages
-- from Windows and Custom controls.
--
-- CALLING SEQUENCE -
--
-- b := DisplayW.DisplayFormContinue (Form, MyFormProc)
--
-- ENTRY -
--
-- Form : ModSys.S_Natural
-- Identifier of the form to display.
--
-- EXIT -
--
-- b : ModSys.S_Natural
-- The dialogID of the displayed dialog. Same as 'dialogID' is
-- the first one, or a new ID.
--
-- Sage.SageError : ModSys.S_Natural
-- An error flag indicating the result of the operation.
--
function DisplayFormContinueDefaultProc
(Form : in ModSys.S_Natural) return ModSys.S_Natural;
--*
-- DisplayFormContinueDefaultProc - Displays the form using the default procedure.
--
--
-- See documentation of the DisplayFormContinue routine. This procedure does the
-- same thing except instead of supplying an ActionProc the DefaultProcedure
-- is used.
--
function DisplayHelp
(Form : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
helpType : in DisplayHelpType;
Data : in ModSys.S_Natural;
helpStr : in string;
FileName : in string) return boolean;
--*
-- DisplayHelp - Displays the specified help file.
--
--
-- This function is used to Display a help file
--
-- CALLING SEQUENCE -
--
-- b := DisplayHelp (Form, ControlId, helpType, data, helpStr,
-- fileName)
--
-- ENTRY -
--
-- Form : ModSys.S_Natural
-- The number of the dialog box associated with the help.
--
-- ControlId : Modsys.S_Natural
-- The control number associated with the help.
--
-- helpType : DisplayHelpType
-- Contents
-- HelpOnHelp
-- Search
-- TopicIndex
-- TopicSearch
--
-- data : ModSys.S_Natural
-- Some data to associate with the help.
--
-- helpStr : string
-- Some string to associate with the help.
--
-- fileName : string
-- The name of the help file to display.
--
-- EXIT -
--
-- b : boolean
-- True if all is well, else false.
--
procedure DisplayMessage
(Message : in string;
Bell : in boolean);
--*
-- DisplayMessage - Displays a message in a box.
--
--
-- If the a window is not yet up, the message will be displayed
-- in a box with an OK button, and processing will not continue
-- until the user presses OK. If a window is up, a box is
-- displayed, but processing can continue. The user can choose close
-- on the system menu (top left corner of the box) to close it, or the
-- program can call DisplayMessage('', FALSE) to close the box. The box
-- will position itself where it was last closed or near the top left
-- of the screen if opened for the first time in the application.
-- If a DisplayMessageW box is up, this will change the text
-- in the box to message and turn off any timer.
--
-- CALLING SEQUENCE -
--
-- DisplayMessage (message, bell)
--
-- ENTRY -
--
-- message : string
-- The message to display in the box.
--
-- bell : boolean
-- Set to TRUE to beep when the message is displayed.
--
procedure ProcessMessages; --* -- ProcessMessages - Causes all messages in application queue to be processed. -- -- -- This procedure causes all messages in the applications message queue to be -- processed. -- -- CALLING SEQUENCE - -- -- ProcessMessages -- -- EXIT - -- -- None -- N/A --
function DisplayMessageW
(Title : in string;
Message : in string;
Bell : in boolean;
timeOut : in ModSys.S_Natural;
messageType : in MessageBoxFormat;
defaultButton : in MessageBoxDefault) return MessageBoxResponse;
--*
-- DisplayMessageW - Displays a multifunction message box.
--
--
-- Behavior depends on the messageType parameter. If messageType is
-- MBF_Normal, a message box exactly like the one resulting from a
-- call to DisplayMessage pops up, and the procedure will return
-- MR_Null. If messageType is MBF_Timed, the message box from
-- DisplayMessage will pop up except that it will disappear after
-- approximately timeOut milliseconds (1/1000 second). The remaining
-- options do not return immediately (without waiting for user input)
-- like MBF_Normal and MBF_Timed do. They display a message box with
-- the indicated buttons, wait for user response, and return the value
-- of the button pressed. The defaultButton parameter indicates which
-- button should be highlighted when the dialog comes up.
--
-- CALLING SEQUENCE -
--
-- m := MessageW (msgType, msgData)
--
-- ENTRY -
--
-- title : string
-- The title of the message box to be displayed.
--
-- message : string
-- The message to appear in the message box.
--
-- bell : boolean
-- Set to TRUE to beep when the message is displayed.
--
-- timeOut : ModSys.S_Natural
-- The amount of time the message box is to be displayed.
--
-- messageType : MessageBoxFormat
-- The format for the message box. Must be one of the following -
--
-- MBF_Normal Standard message box
-- MBF_Timed Timed message box
-- MBF_Ok Message box with OK button
-- MBF_OkCancel Message box with OK and Cancel buttons
-- MBF_YesNo Message box with Yes and No buttons
-- MBF_YesNoCancel Message box with Yes, No, and Cancel buttons
-- MBF_RetryCancel Message box with Retry and Cancel buttons
-- MBF_AbortRetryIgnore Message box with Abort, Retry, and Ignore
-- buttons
--
-- defaultButton : MessageBoxDefault
-- Specifies which button on a multi button message box will
-- receive the focus. Must be one of the following -
--
-- MBD_1 Give focus to the first button
-- MBD_2 Give focus to the second button
-- MBD_3 Give focus to the third button
--
-- EXIT -
--
-- m : MessageBoxResponse
-- One of the following identifiers depending on which button option was
-- used to exit the box -
-- MBR_Null The message box was closed without pressing a button
-- MBR_Abort The Abort button was pressed
-- MBR_Cancel The Cancel button was pressed
-- MBR_Ignore The Ignore button was pressed
-- MBR_No The No button was pressed
-- MBR_Ok The Ok button was pressed
-- MBR_Retry The Retry button was pressed
-- MBR_Yes The Yes button was pressed
--
function MessageW
(msgType : in DisplayMessageType;
msgData : in System.Address) return boolean;
--*
-- MessageW - Handles all messages to DisplayW.
--
--
-- Allows application programs to invoke behaviors of their programs
-- objects.
--
-- CALLING SEQUENCE -
--
-- b := MessageW (message, messageData)
--
-- ENTRY -
--
-- message : DisplayMessageType
-- One of the predefined messages as follows -
--
-- message- Check
-- Purpose- Checks a check box or radio button control.
-- messageData Type- BaseMessageInfo
-- Uses- CheckBox, RadioButton, SageCBox, SageRBtn
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to check.
-- Exit-
-- <none>
--
-- message- CheckGray
-- Purpose- Grays a three state check box control.
-- messageData Type- BaseMessageInfo
-- Uses- CheckBox, SageCBox
-- Entry-
-- DialogID The ID of the window containing the control.
-- resourceID The ID of the control to gray.
-- Exit-
-- <none>
--
-- message- Disable
-- Purpose- Disables a control.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to disable.
-- Exit-
-- <none>
--
-- message- Enable
-- Purpose- Enables a control.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to enable.
-- Exit-
-- <none>
--
-- message- GetText
-- Purpose- Get the text from a control.
-- messageData Type- msgData ControlTextInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageRBtn,
-- SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- ControlId- The control number of the control from which to
-- get text.
-- Exit-
-- text- The text retrieved from the control.
--
-- message- GiveFocus
-- Purpose- Gives the focus to a conttrol.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to give focus to.
-- Exit-
-- <none>
--
-- message- Hide
-- Purpose- Make a control invisible.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to hide.
-- Exit-
-- <none>
--
-- message- IsChecked
-- Purpose- Test to see if a check box or radio button is
-- checked.
-- messageData Type- BaseMessageInfo
-- Uses- CheckBox, RadioButton, SageCBox, SageRBtn
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to test.
-- Exit-
-- <none>
--
-- message- IsEnabled
-- Purpose- Tests the status of a conttrol.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to test.
-- Exit-
-- <none>
--
-- message- LookUp
-- Purpose- Returns the Windows handle to a control.
-- messageData Type- LookUpData
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- controlD- The control number of the control to look up. If
-- zero, then the handle of the dialog is returned.
-- Exit-
-- hwnd- The Windows handle to the control.
--
-- message- ReDraw
-- Purpose- Causes a control to redraw.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to redraw.
-- Exit-
-- <none>
--
-- message- SageFlush
-- Purpose- Causes a Sage control to flush its contents to
-- its associated memory record.
-- messageData Type- BaseMessageInfo
-- Uses- SageCBox, SageEdit, SageList, SageRBtn
-- Entry-
-- DialogID- The number of the dialog box that contains the
-- control to flush. If set to 0, all dialog boxes
-- will be flushed.
-- resourceID- The control number of the control to flush. If set
-- to zero, all controls on the specified dialog box
-- will be flushed
-- Exit-
-- <none>
--
-- message- SageReset
-- Purpose- Tell a Sage Control to reset its data from
-- its associated memory record.
-- messageData Type- BaseMessageInfo
-- Uses- SageCBox, SageEdit, SageList, SageRBtn, SageStat
-- Entry-
-- DialogID- The number of the dialog box that contains the
-- control to reset. If set to 0, all dialog boxes
-- will be reset.
-- resourceID- The control number of the control to reset. If set
-- to zero, all controls on the specified dialog box
-- will be reset
-- Exit-
-- <none>
--
-- message- SetText
-- Purpose- Set the text of a control.
-- messageData Type- ControlTextInfo
-- Uses- Button, CheckBox, Edit, RadioButton, SageBttn,
-- SageCBox, SageEdit, SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- ControlId- The control number which is to receive text.
-- text- The text to place in the control.
-- Exit-
-- <none>
--
-- message- Show
-- Purpose- Make a control visible.
-- messageData Type- BaseMessageInfo
-- Uses- Button, CheckBox, Edit, RadioButton,
-- SageBttn, SageCBox, SageEdit, SageList,
-- SageRBtn, SageStat, Static
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number of the control to show.
-- Exit-
-- <none>
--
-- message- TerminateMsg
-- Purpose- Terminates a dialog box or window.
-- messageData Type- BaseMessageInfo
-- Entry-
-- DialogID- The number of the dialog box or window to terminate.
-- Terminating the first window created causes the whole
-- application to terminate.
-- Exit-
-- <none>
--
-- message- UnCheck
-- Purpose- Unchecks a check box or radio button control.
-- messageData Type- BaseMessageInfo
-- Uses CheckBox, RadioButton,SageCBox, SageRBtn
-- Entry-
-- DialogID- The number of the dialog box containing the control.
-- resourceID- The control number the control to uncheck.
-- Exit-
-- <none>
--
-- messageData : System.Address
-- The address of the data structure containing information for the
-- the message. See above to determine which data structure is used
-- for a particular message.
--
-- EXIT -
--
-- b : boolean
-- True if the message was handled.
--
function SetPopupMenu
(Form : in ModSys.S_Natural;
menu : in ModSys.S_Natural) return boolean;
--*
-- SetPopupMenu - Sets the Popup menu for a window or dialog.
--
--
-- This procedure allows the user to set a popup menu for A window or
-- dialog. A right mouse click anywhere in the form will cause the popup menu
-- to appear. The ID of the selected item in the popup menu will be sent as
-- the resourceID of a SysCommand message to the Action Proc of the form.
-- SetPopupMenu must be called after the window or dialog has been created.
--
-- CALLING SEQUENCE -
--
-- b := SetMenu (form, menu)
--
-- ENTRY -
--
-- form : ModSys.S_Natural
-- Identifier of the form to contain the popup menu.
--
-- menu : ModSys.S_Natural
-- Identifier of menu to display. A value of 0 will disable the
-- popup menu for the form.
--
-- EXIT -
--
-- b : boolean
-- True if the menu was set.
--
function SetAccelerators
(accelerator : in ModSys.S_Natural) return boolean;
--*
-- SetAccelerators - Sets the main window's accelerator table.
--
--
-- This procedure sets the main window's accelerator table. The
-- accelerator table must have been previosly defined in the resource
-- file.
--
-- CALLING SEQUENCE -
--
-- b := SetAccelerator (accelerator)
--
-- ENTRY -
--
-- accelerator : ModSys.S_Natural
-- Identifier of accelerator table to set.
--
-- EXIT -
--
-- b : boolean
-- True if the accelerator table was set.
--
function SetCursor
(windowID : in ModSys.S_Natural;
cursor : in ModSys.S_Natural) return boolean;
--*
-- SetCursor - Sets the window's cursor.
--
--
-- This procedure sets the window's cursor. The cursor must have
-- been defined in the resource file, or be one of the predefined
-- Windows cursors.
--
-- CALLING SEQUENCE -
--
-- b := SetCursor (cursor)
--
-- ENTRY -
--
-- cursor : ModSys.S_Natural
-- Identifier of cursor to set. The identifier should not be
-- greater than 0x6FFF (28671) or it will conflict with cursor ID's
-- that have been reserved by Microsoft for standard (predefined)
-- cursors. A value of zero will result in the ArrowCursor becoming
-- the current cursor. The following is a list of predefined cursors
-- which may be used with SetCursor -
--
-- ArrowCursor Standard arrow
-- IBeamCursor I Beam for text editing
-- WaitCursor Hourglass
-- CrossCursor Crosshairs
-- UpArrowCursor Large arrow pointing straight up
-- SizeCursor 4 arrows pointing away from middle
-- IconCursor White square on a black field
-- SizeNWSECursor 2 arrows pointing up&left and down&right
-- SizeNESWCursor 2 arrows pointing up&right and down&left
-- SizeWECursor 2 arrows pointing right and left
-- SizeNSCursor 2 arrows pointing up and down
-- SizeAllCursor same as SizeCursor - 4 arrows
-- NoCursor Black circle with slash through it
-- AppStartCursor Arrow with hourglass next to it
-- HelpCursor
--
-- EXIT -
--
-- b : boolean
-- True if the cursor was set.
--
procedure SetDefaultEditIOProcs
(PutBlockProc : in PutBlockProcType;
GetBlockProc : in GetBlockProcType;
TruncateBlockProc : in TruncateBlockProcType);
--*
-- SetDefaultEditIOProcs - Define default SAGE rich text edit I/O.
--
--
-- This procedure sets the I/O procedures to be used by rich text
-- edit controls to 'Sage.PutBlock' and 'Sage.GetBlock'. This call
-- will cause the SAGE database to be linked in during compile and
-- bind (link) time. If this procedure is not called, then no
-- text I/O occurs related to rich edit controls unless the user
-- directly requests the data from the control and handles any
-- I/O process from there.
--
-- CALLING SEQUENCE -
--
-- SetDefaultEditIOProcs
--
function SetIcon
(windowID : in ModSys.S_Natural;
icon : in ModSys.S_Natural) return boolean;
--*
-- SetIcon - Sets the window's icon.
--
--
-- This procedure sets the window's icon. The icon must have
-- been defined in the resource file, or be one of the predefined icons.
--
-- CALLING SEQUENCE -
--
-- b := SetIcon (icon)
--
-- ENTRY -
--
-- icon : ModSys.S_Natural
-- Identifier of the icon to set. The identifier should not be
-- greater than 0x6FFF (28671) or it will conflict with icon ID's
-- that have been reserved by Microsoft for standard (predefined)
-- icons. A value of zero will set the applications icon to be the
-- stanard Windows application icon. The following is a list of
-- predefined icons which may be used with SetIcon -
--
-- ApplicationIcon White box with black frame
-- HandIcon Stop sign
-- QuestionIcon White ? in green circle
-- ExclamationIcon Black ! in yellow circle
-- AsteriskIcon White i in blue circle
-- WinLogoIcon
-- WarningIcon Black ! in yellow circle
-- ErrorIcon Stop sign
-- InformationIcon White i in blue circle
--
-- EXIT -
--
-- b : boolean
-- True if the icon was set.
--
function SetMenu
(windowID : in ModSys.S_Natural;
menu : in ModSys.S_Natural) return boolean;
--*
-- SetMenu - Sets the menu for the window.
--
--
-- This procedure sets the window's menu to the specified menu.
-- The menu must have been previosly defined in the resource file.
-- Messages for items selected on the menu will be sent to the
-- MessageProcedure of the window.
--
-- CALLING SEQUENCE -
--
-- b := SetMenu (menu)
--
-- ENTRY -
--
-- menu : ModSys.S_Natural
-- Identifier of menu to display. A value of 0 will result in no
-- menu being displayed.
--
-- EXIT -
--
-- b : boolean
-- True if the menu was set.
--
function SetTitle
(windowID : in ModSys.S_Natural;
Title : in string) return boolean;
--*
-- SetTitle - Sets the window title.
--
--
-- This procedure sets the window's title.
--
-- CALLING SEQUENCE -
--
-- b := SetTitle (title)
--
-- ENTRY -
--
-- title : string
-- Title for the window.
--
-- EXIT -
--
-- b : boolean
-- True if the title was set.
--
procedure SetVisibility
(windowID : in ModSys.S_Natural;
visible : in boolean);
--*
-- SetVisibility - Sets the visbility of the window.
--
--
-- This procedure sets the visibility of the window.
--
-- CALLING SEQUENCE -
--
-- SetVisibility (visible)
--
-- ENTRY -
--
-- visible : boolean
-- The visibility status for the window.
--
procedure SetDisplayMode
(windowID : in ModSys.S_Natural;
Minimized : in boolean;
Maximized : in boolean);
--*
-- SetDisplayMode - Sets the display mode (max, min, normal) of the specified window.
--
--
-- This procedure sets the display mode of the specified Window.
--
-- CALLING SEQUENCE -
--
-- SetDisplayMode (windowID, Minimized, Maximized)
--
-- ENTRY -
--
-- windowID : Modsys.S_Natural
-- The ID of the window.
--
-- Minimized : boolean
-- Should the window be changed to a minimized window?
--
-- Maximized : boolean
-- Should the window be changed to a maximized window?
--
-- NOTE - If both Minimized and Maximized are set to FALSE then the
-- window is changed to a Normal window.
--
function SetStatusBar
(windowID : in ModSys.S_Natural;
parts : in ModSys.S_Natural;
partArray : in CellType_u_array) return boolean;
--*
-- SetStatusBar - Sets the window's status bar.
--
--
-- This procedure sets up the window's status bar.
--
-- CALLING SEQUENCE -
--
-- b := SetStatusBar (parts, partArray)
--
-- ENTRY -
--
-- parts : ModSys.S_Natural
-- The number of parts for the status bar. The maximum supported is
-- 10.
--
-- partArray : System.Address
-- An array containing an element for each part of the status bar.
-- SageSBarCellType is defined as -
-- Raised (Y = Raised, N = Lowered)
-- Percent The percent of the total status bar that this part will
-- take up (0..100)
-- PType (N = Normal, S = Display Message, F = Fatal Error)
--
-- EXIT -
--
-- b : boolean
-- True if the status bar was set up.
--
function SetDefaultStatusBar
(dialogID : in ModSys.S_Natural;
controlID : in ModSys.S_Natural;
index : in ModSys.S_Natural) return boolean;
--*
-- SetDefaultStatusBar - Sets one of the status bars to receive all DisplayMessages.
--
--
-- This procedure allows the user to specidfy which status bar will
-- display the DisplayMessage messages. SageError messages will also
-- be linked to this status bar.
--
-- CALLING SEQUENCE -
--
-- SetDefaultStatusBar (DialogID, ControlId, index)
--
-- ENTRY -
--
-- DialogID : Modsys.S_Natural
-- The dialog containing the status bar.
--
-- ControlId : Modsys.S_Natural
-- The ID of the status bar.
--
-- index : ModSys.S_Natural
-- The index of the cell in the status bar to display the
-- message.
--
procedure GetDisplaySize
(width : in out ModSys.S_Natural;
height : in out ModSys.S_Natural);
--*
-- GetDisplaySize - Get the width and height of the display area.
--
--
-- This routine returns the width and height (in pixels) of the current
-- display resolution.
--
-- CALLING SEQUENCE -
--
-- GetDisplaySize (width, height)
--
-- ENTRY -
--
-- None
-- N/A
--
-- EXIT -
--
-- width : Modsys.S_Natural
-- The current width of the display area in pixels.
--
-- height : Modsys.S_Natural
-- The current height of the display area in pixels.
--
function GetActiveForm return ModSys.S_Natural; --* -- GetActiveForm - Get the ID of the active form. -- -- -- This routine returns the ID of the active form (the one with -- highlighted title bars). -- -- CALLING SEQUENCE - -- -- formID := GetDisplaySize () -- -- ENTRY - -- -- None -- N/A -- -- EXIT - -- -- formID : Modsys.S_Natural -- The ID of the active form. A value of 1 indicates the Main Window -- is active. Returns 0 on error or no form is active. --
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 : Modsys.S_Natural
-- The unique dialog ID for an instance of a dialog.
--
-- EXIT -
--
-- resourceID : Modsys.S_Natural
-- The ID of the resource used to create the instance of the DialogID.
--
procedure SetQuitFlag
(quit : in boolean);
--*
-- SetQuitFlag - Set the PostQuitMessage flag for DisplayW.
--
--
-- If the user does not want DisplayW to issue the PostQuitMessage when
-- the final window is destroyed, then set this flag to false. If true, then
-- DisplayW will issue the PostQuitMessage when the final window is destroyed.
-- This is normally set to false if the a routine is being called by
-- another app that has control nad will do the PostQuitMessage.
--
-- CALLING SEQUENCE -
--
-- SeqQuitFlag (quit)
--
-- ENTRY -
--
-- quit : BOOLEAN
-- The setting of the quit flag. True will issue the PostQuitMessage command.
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance