Sage-ST

Sage-ST ä
Objpropsheet
Documentation

CancelLink	ChangeCancelToClose	Close	DefineIOProc
DoFinalize	DoInitialize	Edit	Execute
GetActionInfo	GetEventInfo	GetExtraData	GetLastError
GetLibraryName	GlobalCloseRequested	HistoricalLink	IsDone
IsOpen	LargeBitmapId	LinkOccurred	ObjectClassDes
ObjectClassName	ObjectComponentName	Open	PressButton
RegisterClass	ReturnOriginalID	ReturnTopPageOriginalID	ReturnTopPageUniqueID
ReturnUniqueID	Run	RunExtra	SetActionResponse
SetActivePage	SetApplyOFF	SetApplyON	SetEventResponse
SetExtraData	SetLinkInfo	SetModeless	SetPageTitle
SetPropSheetTitle	SmallBitmapId	StoreDefault	TerminateObject
ValidObject


  PROCEDURE Close
             (VAR   dataH : SYSTEM.ADDRESS);

  (**
      Close - Close and down and release object.

      This procedure closes the object and its associated handle.
      Once this procedure has been called, the object handle is aware
      of the request and will not attempt to futher process a
      close operation is called again during the process by some
      other source.
  *)


  PROCEDURE DefineIOProc
             (CONST IPROC : ObjDef.IOProc);


  PROCEDURE DoInitialize
             (CONST dataH : SYSTEM.ADDRESS) : BOOLEAN;


  PROCEDURE DoFinalize
             (CONST dataH : SYSTEM.ADDRESS) : BOOLEAN;


  PROCEDURE Edit
             (CONST dataH : SYSTEM.ADDRESS);


  PROCEDURE Execute
             (VAR   dataH : SYSTEM.ADDRESS;
              CONST gProc : ObjDef.GeneralProc);


  PROCEDURE GetExtraData
             (CONST dataH : SYSTEM.ADDRESS;
              VAR   extra : SYSTEM.ADDRESS);


  PROCEDURE GetLastError
             (CONST dataH : SYSTEM.ADDRESS;
              VAR   Error : INTEGER;
              VAR   Des   : ARRAY OF CHAR);


  PROCEDURE GetLibraryName
             (VAR   libraryName : ARRAY OF CHAR);


  PROCEDURE GlobalCloseRequested
             (CONST dataH : SYSTEM.ADDRESS) : BOOLEAN;


  PROCEDURE HistoricalLink
             (CONST dataH       : SYSTEM.ADDRESS;
              VAR   Link        : INTEGER;
              VAR   exitType    : INTEGER;
              VAR   interface   : INTEGER;
              VAR   ObjectLabel : ARRAY OF CHAR;
              VAR   done        : BOOLEAN);


  PROCEDURE IsDone
             (CONST dataH : SYSTEM.ADDRESS) : BOOLEAN;


  PROCEDURE IsOpen
             (CONST dataH : SYSTEM.ADDRESS) : BOOLEAN;


  PROCEDURE LargeBitmapId
             (CONST dataH : SYSTEM.ADDRESS) : CARDINAL;


  PROCEDURE LinkOccurred
             (CONST dataH       : SYSTEM.ADDRESS;
              VAR   Link        : INTEGER;
              VAR   exitType    : INTEGER;
              VAR   interface   : INTEGER;
              VAR   ObjectLabel : ARRAY OF CHAR;
              VAR   done        : BOOLEAN);


  PROCEDURE ObjectClassDes
             (VAR   Des : ARRAY OF CHAR);


  PROCEDURE ObjectClassName
             (VAR   ClassName : ARRAY OF CHAR);


  PROCEDURE ObjectComponentName
             (CONST dataH         : SYSTEM.ADDRESS;
              VAR   componentName : ARRAY OF CHAR);


  PROCEDURE Open
             (CONST PropSheetName  : ARRAY OF CHAR;
              CONST instanceNumber : CARDINAL;
              CONST extra          : SYSTEM.ADDRESS;
              VAR   dataH          : SYSTEM.ADDRESS);


  PROCEDURE RegisterClass;


  PROCEDURE Run
             (CONST PropSheetName : ARRAY OF CHAR;
              CONST UProc         : ObjDef.GeneralProc;
              VAR   Link          : INTEGER);


  PROCEDURE RunExtra
             (CONST PropSheetName : ARRAY OF CHAR;
              CONST UProc         : ObjDef.GeneralProc;
              VAR   Link          : INTEGER;
              CONST extraData     : SYSTEM.ADDRESS);


  PROCEDURE SetExtraData
             (CONST dataH     : SYSTEM.ADDRESS;
              CONST extraData : SYSTEM.ADDRESS);


  PROCEDURE SetLinkInfo
             (CONST dataH       : SYSTEM.ADDRESS;
              CONST Link        : INTEGER;
              CONST exitType    : INTEGER;
              CONST interface   : INTEGER;
              CONST ObjectLabel : ARRAY OF CHAR;
              CONST isLink      : BOOLEAN);


  PROCEDURE SmallBitmapId
             (CONST dataH : SYSTEM.ADDRESS) : CARDINAL;


  PROCEDURE StoreDefault
             (CONST editFlag   : BOOLEAN;
              VAR   objectName : ARRAY OF CHAR;
              CONST objectDes  : ARRAY OF CHAR;
              VAR   ObjID      : CARDINAL);


  PROCEDURE TerminateObject
             (CONST dataH : SYSTEM.ADDRESS);


  PROCEDURE ValidObject
             (CONST dataH : SYSTEM.ADDRESS) : BOOLEAN;


  PROCEDURE CancelLink
             (CONST dataH : SYSTEM.ADDRESS);


  PROCEDURE GetActionInfo
             (CONST dataH   : SYSTEM.ADDRESS;
              VAR   msgType : DisplayW.DisplayMessageType;
              VAR   msgData : SYSTEM.ADDRESS);


  PROCEDURE GetEventInfo
             (CONST dataH   : SYSTEM.ADDRESS;
              VAR   hwnd    : WIN32.HWND;
              VAR   message : WIN32.UINT;
              VAR   wParam  : WIN32.WPARAM;
              VAR   lParam  : WIN32.LPARAM);


  PROCEDURE ReturnUniqueID
             (CONST dataH : SYSTEM.ADDRESS) : CARDINAL;


  PROCEDURE ReturnOriginalID
             (CONST dataH : SYSTEM.ADDRESS) : CARDINAL;


  PROCEDURE ReturnTopPageUniqueID
             (CONST dataH : SYSTEM.ADDRESS) : CARDINAL;

  (*
     returns the sage generated run time id of the current top page
     of the property sheet
  *)


  PROCEDURE ReturnTopPageOriginalID
             (CONST dataH : SYSTEM.ADDRESS) : CARDINAL;

  (*
     returns the resource id of the current top page
     of the property sheet
  *)


  PROCEDURE SetActionResponse
             (CONST dataH    : SYSTEM.ADDRESS;
              CONST response : BOOLEAN);


  PROCEDURE SetEventResponse
             (CONST dataH    : SYSTEM.ADDRESS;
              CONST response : BOOLEAN);


  PROCEDURE SetApplyON
             (CONST dataH : SYSTEM.ADDRESS);

  (* enables the Apply button *)


  PROCEDURE SetApplyOFF
             (CONST dataH : SYSTEM.ADDRESS);

  (* disables the Apply button *)


  PROCEDURE SetPropSheetTitle
             (CONST dataH : SYSTEM.ADDRESS;
              CONST Title : ARRAY OF CHAR);

  (* changes the prop sheet title *)


  PROCEDURE SetActivePage
             (CONST dataH : SYSTEM.ADDRESS;
              CONST dId   : CARDINAL);

  (* bring a page to the front *)


  PROCEDURE SetPageTitle
             (CONST dataH : SYSTEM.ADDRESS;
              CONST dId   : CARDINAL;
              CONST Title : ARRAY OF CHAR);

  (* set the title of the indicated page *)


  PROCEDURE SetModeless
             (CONST dataH    : SYSTEM.ADDRESS;
              CONST modeless : BOOLEAN);

  (*
     set property sheet as modal or modeless (modal by default)
    - MUST be done in response to DoInitialize to work
  *)


  PROCEDURE PressButton
             (CONST dataH       : SYSTEM.ADDRESS;
              CONST ObjectLabel : ARRAY OF CHAR);

  (* simulates pressing a prop sheet button *)


  PROCEDURE ChangeCancelToClose
             (CONST dataH : SYSTEM.ADDRESS);

  (* disables Cancel button and changes OK label to Close *)