Sage-ST ä

Ctrlcbox

Documentation

Check ControlCommand CurrentControlID CurrentDialogID
DisableControl EnableControl Flush GetText
Gray HideControl IsChecked IsEnabled
RedrawControl Reset STRGetText STRSetText
SetFocus SetText ShowControl UnCheck




  function ControlCommand
             (const msgType : DWSpec.DisplayMessageType;
              const msgData : pointer) : ControlMessage; stdcall;

  exports ControlCommand name 'CtrlCBox_ControlCommand';

  //*
  //  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 : pointer
  //      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.
  //




  function CurrentDialogID
             (const msgData : pointer) : cardinal; stdcall;

  exports CurrentDialogID name 'CtrlCBox_CurrentDialogID';

  //*
  //  CurrentDialogID - Retrieves ID of 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 : pointer
  //      The msgData parameter which was passed into the ActionProc.
  //
  //  EXIT -
  //
  //    dialogID : cardinal
  //      The ID of the dialog receiving a message.
  //




  function CurrentControlID
             (const msgData : pointer) : cardinal; stdcall;

  exports CurrentControlID name 'CtrlCBox_CurrentControlID';

  //*
  //  CurrentControlID - Retrieves ID of 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 : pointer
  //      The msgData parameter which was passed into the ActionProc.
  //
  //  EXIT -
  //
  //    controlID : cardinal
  //      The ID of the control.
  //




  function IsEnabled
             (const dialogID  : cardinal;
              const controlID : cardinal) : boolean; stdcall;

  exports IsEnabled name 'CtrlCBox_IsEnabled';

  //*
  //  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); stdcall;

  exports EnableControl name 'CtrlCBox_EnableControl';

  //*
  //  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.
  //




  procedure DisableControl
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports DisableControl name 'CtrlCBox_DisableControl';

  //*
  //  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.
  //




  procedure HideControl
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports HideControl name 'CtrlCBox_HideControl';

  //*
  //  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.
  //




  procedure ShowControl
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports ShowControl name 'CtrlCBox_ShowControl';

  //*
  //  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.
  //




  procedure SetFocus
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports SetFocus name 'CtrlCBox_SetFocus';

  //*
  //  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.
  //




  procedure RedrawControl
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports RedrawControl name 'CtrlCBox_RedrawControl';

  //*
  //  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.
  //




  procedure Check
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports Check name 'CtrlCBox_Check';

  //*
  //  Check - Sets the status of the SageCBox to checked.
  //
  //
  //  This routine will place a check in the specified SageCBox control.
  //
  //  CALLING SEQUENCE -
  //
  //    Check (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




  procedure Flush
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports Flush name 'CtrlCBox_Flush';

  //*
  //  Flush - Writes contents of Sage control to the current memory record.
  //
  //
  //  This routine will cause the Sage control have its contents written to the
  //  current memory record.  Note :  Sage controls are automatically written
  //  out when the form is terminated.
  //
  //  CALLING SEQUENCE -
  //
  //    Flush (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




  procedure GetText
             (const dialogID  : cardinal;
              const controlID : cardinal;
              var   Text      : array of char); overload; stdcall;

  exports GetText (const dialogID  : cardinal;
                   const controlID : cardinal;
                   var   Text      : array of char) name 'CtrlCBox_GetText';

  //*
  //  GetText - Retrieves the label text and text length from the control.
  //
  //
  //  This routine will return the label and label length of the specified
  //  SageBttn control.
  //
  //  CALLING SEQUENCE -
  //
  //    GetText (dialogID, controlID, text)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //
  //  EXIT -
  //
  //    text : array of char
  //      The label text from the control.
  //
  //    textLength : cardinal
  //      The length ot the label text returned.
  //




  procedure GetText
             (const dialogID  : cardinal;
              const controlID : cardinal;
              var   Text      : string); overload; stdcall;

  exports GetText (const dialogID  : cardinal;
                   const controlID : cardinal;
                   var   Text      : string) name 'CtrlCBox_STRGetText';

  //*
  //  STRGetText - See documentation of GetText.
  //




  procedure Gray
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports Gray name 'CtrlCBox_Gray';

  //*
  //  Gray - Sets the status of the SageCBox to grayed.
  //
  //
  //  This routine will fill the specified SageCBox control with gray.
  //
  //  CALLING SEQUENCE -
  //
  //    Gray (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




  function IsChecked
             (const dialogID  : cardinal;
              const controlID : cardinal) : boolean; stdcall;

  exports IsChecked name 'CtrlCBox_IsChecked';

  //*
  //  IsChecked - Determines if a SageCBox control is checked.
  //
  //
  //  This routine will determine the checked/unchecked status of
  //  a SageCBox control.
  //
  //  CALLING SEQUENCE -
  //
  //    checked := IsChecked (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //
  //  EXIT -
  //
  //    checked : boolean
  //      True if the SageCBox is checked or grayed.  False if the
  //      SageCBox is unchecked.
  //




  procedure Reset
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports Reset name 'CtrlCBox_Reset';

  //*
  //  Reset - Resets the control.
  //
  //
  //  This routine will cause the control to be reset.  If the control
  //  is associated with a Sage table and field, the current contents
  //  of the memory record will be reflected.
  //
  //  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.
  //




  procedure SetText
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const Text      : array of char); overload; stdcall;

  exports SetText (const dialogID  : cardinal;
                   const controlID : cardinal;
                   const Text      : array of char) name 'CtrlCBox_SetText';

  //*
  //  SetText - Sets the label text of the control.
  //
  //
  //  This routine will place the given text string in the specified SageCBox
  //  control label.
  //
  //  CALLING SEQUENCE -
  //
  //    SetText (dialogID, controlID, text)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //
  //    text : array of char
  //      The label text to set in the control.
  //




  procedure SetText
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const Text      : string); overload; stdcall;

  exports SetText (const dialogID  : cardinal;
                   const controlID : cardinal;
                   const Text      : string) name 'CtrlCBox_STRSetText';

  //*
  //  STRSetText - See documentation of SetText.
  //




  procedure UnCheck
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports UnCheck name 'CtrlCBox_UnCheck';

  //*
  //  UnCheck - Sets the status of the SageCBox to unchecked.
  //
  //
  //  This routine will remove a check from the specified SageCBox control.
  //
  //  CALLING SEQUENCE -
  //
  //    UnCheck (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




Send mail to   warren.merrill@inl.gov with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance