|
|
|
|
type ExecuteProcType is access
procedure (DataHandle : in Obj.Object_Handle);
pragma Convention
(WIN32,
ExecuteProcType);
type RunProcType is access
procedure (DataHandle : in out Obj.Object_Handle);
pragma Convention
(WIN32,
RunProcType);
function DoInitialize
(DataHandle : in Obj.Object_Handle) return boolean;
--*
-- DoInitialize - Determine if initialization of object is to be done.
--
function DoFinalize
(DataHandle : in Obj.Object_Handle) return boolean;
--*
-- DoFinalize - Determine if finalization of object is to be done.
--
procedure Close
(DataHandle : in Obj.Object_Handle);
procedure Edit
(systemHandle : in ModSys.S_Natural);
procedure Execute
(DataHandle : in Obj.Object_Handle;
ExecuteProc : in ExecuteProcType);
procedure GetExtraData
(DataHandle : in Obj.Object_Handle;
extra : out System.Address);
procedure GetLastError
(DataHandle : in Obj.Object_Handle;
Error : out ModSys.S_Natural;
Des : out string);
procedure HistoricalLink
(DataHandle : in Obj.Object_Handle;
Link : out ModSys.S_Natural;
exitType : out ModSys.S_Natural;
interfaceType : out ModSys.S_Natural;
LinkLabel : out string;
done : out boolean);
function IsDone
(DataHandle : in Obj.Object_Handle) return boolean;
function IsOpen
(DataHandle : in Obj.Object_Handle) return boolean;
function LargeBitmapId
(DataHandle : in Obj.Object_Handle) return ModSys.S_Natural;
procedure LinkOccurred
(DataHandle : in Obj.Object_Handle;
Link : out ModSys.S_Natural;
exitType : out ModSys.S_Natural;
interfaceType : out ModSys.S_Natural;
LinkLabel : out string;
done : out boolean);
--*
-- LinkOccurred - Called to see if a link has occurred.
--
-- The calling context calls this procedure to determine whether or not
-- a link has occurred for this object instance. This is a single-shot;
-- that is when a link occurs the first call to LinkOccurred will return
-- TRUE, and FALSE will be returned thereafter until another link occurs.
--
-- ENTRY -
--
-- dataH : Obj.Object_Handle
-- Handle of object instance data.
--
-- EXIT -
--
-- link : ModSys.S_Natural
-- The link ID, unique to this object instance, that occurred. An
-- example would be a button was pressed during this instance's
-- execution, this instance called the gProc passed to it in the
-- Execute call, and in response the calling context called LinkOccurred
-- to determine whether the "happening" was the occurrence of a link.
--
-- exitType : ModSys.S_Natural
-- This parameter tells the calling context that
--
-- interface : ModSys.S_Natural
-- Reserved.
--
-- label : string
-- A string describing the link that occurred. Obtained by querying
-- the DFL for the associated link.
--
-- done : boolean
-- TRUE a link occurred, else FALSE.
--
procedure ObjectClassName
(ClassName : out string);
procedure Open
(dialogName : in string;
instanceNumber : in ModSys.S_Natural;
extra : in System.Address;
DataHandle : out Obj.Object_Handle);
procedure SetLinkInfo
(DataHandle : in Obj.Object_Handle;
Link : in ModSys.S_Natural;
exitType : in ModSys.S_Natural;
interfaceType : in ModSys.S_Natural;
LinkLabel : in string;
isLink : in boolean);
function SmallBitmapId
(DataHandle : in Obj.Object_Handle) return ModSys.S_Natural;
procedure StoreDefault
(editFlag : in boolean;
objectName : out string;
objectDes : in string;
ObjID : out ModSys.S_Natural);
procedure TerminateObject
(DataHandle : in Obj.Object_Handle);
--*
-- TerminateObject - Request termination of object.
--
-- A call to this procedure results in the termination of the
-- OS level representation of this object instance. After this
-- procedure is executed IsOpen will return FALSE.
--
-- This procedure MUST not do what Close does. That is to say this
-- procedure does not destroy the calling context's view of the
-- object instance.
--
-- Applies to run-time.
--
-- CALLING SEQUENCE -
--
-- TerminateObject (dataH);
--
-- ENTRY -
--
-- dataH : Obj.Object_Handle
-- Handle of object instance data.
--
function ValidObject
(DataHandle : in Obj.Object_Handle) return boolean;
procedure GetActionInfo
(DataHandle : in Obj.Object_Handle;
msgType : out DisplayW.DisplayMessageType;
msgData : out System.Address);
--*
-- GetActionInfo - Get action info for use with Ctrl packages.
--
-- This procedures retrieves arguments which are used for the
-- Ctrl (CtrlBttn, CtrlEdit, ..) packages. Not all messages sent
-- to the event handling procedure will have thie action procedure
-- information. Procedures such as CtrlBttn.ControlCommand will
-- return the appropriate command to determine this.
--
-- The 'SetActionResponse' procedure is used to return a response
-- corresponding to an action using these arguments.
--
procedure Run
(dialogName : in string;
RunProc : in RunProcType;
Link : in out ModSys.S_Natural);
--*
-- Run - Run (execute) the object.
--
-- This procedure will execute the specified object. The procedure
-- 'UProc' with which this procedure is instantiated is used as
-- the object's event handling procedure.
--
-- CALLING SEQUENCE -
--
-- Run (name)
--
-- ENTRY -
--
-- DialogName : string
-- The name of the object to run.
--
-- link : ModSys.S_Natural
-- Returning link number.
--
-- EXIT -
--
-- Sage.SageError : ModSys.S_Natural
-- The return error code (0=ok)
--
function ReturnUniqueID
(DataHandle : in Obj.Object_Handle) return ModSys.S_Natural;
--*
-- ReturnUniqueID - Return the unique object ID associated with the handle.
--
-- This procedure returns the ID in the system associated with the
-- handle which may be used in turn to call the various Ctrl...
-- procedures. This may differ than the originally assigned ID
-- if this object has more than one (duplicate) instances simulteneously
-- executed, otherwise the unique will be the same as the original
-- ID (see ReturnOriginalID).
--
function ReturnOriginalID
(DataHandle : in Obj.Object_Handle) return ModSys.S_Natural;
--*
-- ReturnUniqueID - Return the original object ID associated with the handle.
--
procedure GetEventInfo
(DataHandle : in System.Address;
hwndDlg : in out WinSys.Hwnd;
Message : in out WinSys.UINT;
WParam : in out WinSys.WParam;
LParam : in out WinSys.LParam);
procedure SetActionResponse
(DataHandle : in Obj.Object_Handle;
response : in boolean);
--*
-- SetActionResponse - Return a response to Action command.
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance