|
|
|
|
PROCEDURE ControlCommand
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS) : 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 : DWSpec.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.
*)
PROCEDURE CurrentDialogID
(CONST msgData : SYSTEM.ADDRESS) : CARDINAL;
(**
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 : CARDINAL
The ID of the dialog receiving a message.
*)
PROCEDURE CurrentControlID
(CONST msgData : SYSTEM.ADDRESS) : CARDINAL;
(**
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 : CARDINAL
The ID of the control.
*)
PROCEDURE IsEnabled
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL) : 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 : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
status : BOOLEAN
TRUE if the control is enabled.
*)
PROCEDURE EnableControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
EnableControl - Enables a control.
This routine will enable the specified control.
CALLING SEQUENCE -
EnableControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE DisableControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
DisableControl - Disables a control.
This routine will disable (gray) the specified control.
CALLING SEQUENCE -
DisableControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE HideControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
HideControl - Hides a control.
This routine will hide the specified control.
CALLING SEQUENCE -
HideControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE SetItemColors
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS;
CONST textColor : ListColorType;
CONST bkGndColor : ListColorType);
(**
SetItemColors - Sets the text and background colors.
Sets the text and background colors of an item of
a SageList which has been created with the Ownver
Draw property.
The SagesList sends a FindItem message in order to populate the SageList.
The programmer should use this routine to set text and background
colors for the item being requested.
CALLING SEQUENCE -
SetItemValue (msgType, msgData, textColor, bkGndColor)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
textColor : ListColorType
The color in which to display the text. Must be one of the
colors defined in ListColorType.
bkGndColor : ListColorType
The color in which to display the background. Must be one of the
colors defined in ListColorType.
EXIT -
None
*)
PROCEDURE ShowControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
ShowControl - Shows a control.
This routine will show the specified control.
CALLING SEQUENCE -
ShowControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE SetFocus
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
SetFocus - Sets to focus to a control.
This routine will give the specified control focus.
CALLING SEQUENCE -
SetFocus (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE RedrawControl
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
RedrawControl - Redraws a control.
This routine will redraw the specified control.
CALLING SEQUENCE -
RedrawControl (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE ClearAllMarks
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
ClearAllMarks - Unmarks all items in a SageList.
This routine will unmark all items in a SageList.
CALLING SEQUENCE -
ClearAllMarks (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE ClearMark
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST index : CARDINAL);
(**
ClearMark - Unmarks an item in a SageList.
This routine will unmark an item in a SageList. The programmer may
specify whether or not the SageList is immediately redrawn to
reflect the change.
CALLING SEQUENCE -
ClearMark (dialogID, controlID, index, redraw)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
index : CARDINAL
The position (1 .. n) of the item in the SageList to unmark.
If the SageList is single select, then the marked item will
be unmarked regardless of this value.
EXIT -
None
*)
PROCEDURE ClearSearch
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
ClearSearch - Clears the current SageList search string.
This routine will clear the internal search string for the
SageList and cause a SearchClear message to be sent to the
ActionProc. It is the programmers responsiblity to reposition
the selected SageList item if desired.
CALLING SEQUENCE -
ClearSearch (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE GetListInfo
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS;
VAR index : CARDINAL;
VAR lines : CARDINAL);
(**
GetListInfo - Gets the # of items which can be displayed in the visible part.
Gets the # of items which can be displayed in the
visible part of the list and the index of the item
at the top of the list.
The SageList sends a ListDone message when it is finished
responding to a user request to display data (i.e. the user
has moved the thumb position). This routine can be used
in response to a ListDone message to retrieve the # of items
displayed in the list and the index position of the item at
the top of the list.
CALLING SEQUENCE -
GetListInfo (msgType, msgData, index, lines)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
EXIT -
index : CARDINAL
The position of the top item displayed in the list with respect
to the entire list. The first position is 1.
lines : CARDINAL
The number of items which can be displayed in the visible part of
the list.
*)
PROCEDURE GetSearchValue
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS;
VAR Value : ARRAY OF CHAR);
(**
GetSearchValue - Retrieves the current search string from the SageList.
The SageList sends a SearchChange message when the search string
has changed. The programmer may use this routine to get the
current search string. The programmer can then use this value to
perform a search to find a new index to position the list at.
The SetSearchResult routine can then be used to tell the SageList
what the new position will be.
CALLING SEQUENCE -
GetSearchValue (msgType, msgData, value)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
value : ARRAY OF CHAR
The search string.
EXIT -
None
*)
PROCEDURE IsMarked
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST index : CARDINAL) : BOOLEAN;
(**
IsMarked - Checks the marked/unmarked status of an item in a SageList.
This routine will check the marked/unmarked status of an item
in a SageList.
CALLING SEQUENCE -
status := IsMarked (dialogID, controlID, index)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
index : CARDINAL
The position (1 .. n) of the item in the SageList to check.
EXIT -
status : BOOLEAN
True if the item is marked. False if the item is not marked.
*)
PROCEDURE ItemIndex
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS) : CARDINAL;
(**
ItemIndex - Gets index number of the item that FindItem is requesting.
The SagesList sends a FindItem message in order to determine
the value of an item in a SageList. The programmer should
use this routine to determine the index number (1 .. n) of the
item which is being requested by the FindItem message.
CALLING SEQUENCE -
index := ItemIndex (msgType, msgData)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
EXIT -
index : CARDINAL
The index number (1 .. n) of the item which was requested by the
FindItem message.
*)
PROCEDURE MarkedCount
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL) : CARDINAL;
(**
MarkedCount - Gets the number of items which have been marked.
This routine will return the number of items in the SageList
which are marked.
CALLING SEQUENCE -
count := MarkedCount (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
couht : CARDINAL
The number of marked items in the list. If no items are marked,
then count will be 0.
*)
PROCEDURE MarkItem
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST index : CARDINAL;
CONST Redraw : BOOLEAN);
(**
MarkItem - Marks an item in a SageList.
This routine will mark an item in a SageList. The list will be
scrolled to make the marked item visible. The programmer may
specify whether or not the SageList is immediately redrawn to
reflect the change.
CALLING SEQUENCE -
MarkItem (dialogID, controlID, index, redraw)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
index : CARDINAL
The position (1 .. n) of the item in the SageList to mark.
If the SageList is multiple select, then any list items
which are already selected will remain selected.
redraw : BOOLEAN
Set to TRUE to have the SageList immediately reflect the change.
If set to FALSE, the change will happen only after a redraw of
the SageList has occurred.
EXIT -
None
*)
PROCEDURE NextMarked
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST startPos : CARDINAL) : CARDINAL;
(**
NextMarked - Gets the index of the next marked item in a SageList.
This routine will get the index number (1 .. n) of the next marked
item in the SageList with respect to the value passed in for index.
CALLING SEQUENCE -
index := MarkedCount (dialogID, controlID, startPos)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
startPos : CARDINAL
The position (1 .. n) in the SageList (inclusive of this
position) from which the search for the next marked item
will start. If set to 1 the first marked item will be found.
EXIT -
index : CARDINAL
The position (1 .. n) in the SageList of the next marked item.
This value will be 0 if no more items in the SageList
are marked.
*)
PROCEDURE Reset
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL);
(**
Reset - Resets the control.
This routine will cause the control to be reset. This will result
in the list being cleared and a new Range message being sent.
CALLING SEQUENCE -
Reset (dialogID, controlID)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
EXIT -
None
*)
PROCEDURE SelectedItemIndex
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS) : CARDINAL;
(**
SelectedItemIndex - Gets the index (1 .. n) of the item which has been selected.
The SageList sends a DoubleClick, SelectedChange, or
SelectedCancel message when an item in the list has been selected.
The programmer can use this routine to get the index position of
the selected item.
CALLING SEQUENCE -
index := SelectedItemIndex (msgType, msgData)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
EXIT -
index : CARDINAL
The position in the list of the item which has been selected.
The first position is 1.
*)
PROCEDURE SetItemValue
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS;
CONST Value : ARRAY OF CHAR;
CONST Status : INTEGER);
(**
SetItemValue - Sets the value of the item that FindItem message is requesting.
The SagesList sends a FindItem message in order to determine
the value of an item in a SageList. The programmer should
use this routine to set that value.
CALLING SEQUENCE -
SetItemValue (msgType, msgData, value, status)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
value : ARRAY OF CHAR
The text string which will appear in the SageList.
status : INTEGER
Return one of the following values -
SLB_OK If able to obtain the value
SLB_ENDOFFILE If no more data is available (this will cause
the FindItem messages to stop)
SLB_ERR If there was a problem obtaining the data.
EXIT -
None
*)
PROCEDURE SetRange
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS;
CONST index : CARDINAL;
CONST Status : INTEGER);
(**
SetRange - Sets the number of items to be in the SageList.
The SagesList sends a Range message in order to determine
the total number of items that will be in the list. The
programmer should use this routine to respond to the Range
message.
CALLING SEQUENCE -
SetRange (msgType, msgData, index, status)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
index : CARDINAL
The total number of items to be placed in the list.
status : INTEGER
Return one of the following
SLB_OK If able to obtain the range
SLB_ERR If the range cannot be determined
EXIT -
None
*)
PROCEDURE SetSearchResult
(CONST msgType : DWSpec.DisplayMessageType;
CONST msgData : SYSTEM.ADDRESS;
CONST index : CARDINAL;
CONST Status : INTEGER);
(**
SetSearchResult - Instructs SageList to reposition as the result of a search.
The SageList sends a SearchChange message when the search string
has changed. The programmer uses the GetSearchValue routines
to get the current search string. The programmer uses the
search string to determine if the list needs to be repositioned.
If so, the programmer can use this routines to reposition the
list to a new index.
CALLING SEQUENCE -
SetSearchResult (msgType, msgData, index, status)
ENTRY -
msgType : DWSpec.DisplayMessageType
The msgType parameter which was passed into the ActionProc.
msgData : SYSTEM.ADDRESS
The msgData parameter which was passed into the ActionProc.
index : CARDINAL
The index number (1 .. n) of the item which matched the search
conditions.
status : INTEGER
Return one of the following
SLB_OK To reposition the list to the new index.
SLB_ERR If there was a problem with the search.
EXIT -
None
*)
PROCEDURE SetTabs
(CONST dialogID : CARDINAL;
CONST controlID : CARDINAL;
CONST numTabs : CARDINAL;
CONST tabs : ARRAY OF CARDINAL);
(**
SetTabs - Sets the tabs for a SageList.
This procecure allows the application programmer to set the
tab stops in a SageList for formatting the data.
CALLING SEQUENCE -
SetTabs (dialogID, controlID, numTabs, tabs)
ENTRY -
dialogID : CARDINAL
The number of the dialog box or window containing the
control.
controlID : CARDINAL
The control resource identifier.
numTabs : CARDINAL
The number of tabs being set (maximum is 20).
tabs : ARRAY OF CARDINAL
Array containing up to 20 tab stop positions. Tab stop
positions are in units of pixels.
EXIT -
None
*)
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance