Sage-ST ä

Ctrlstat

Documentation

DisableControl EnableControl GetText HideControl
IsEnabled RedrawControl Reset SetColors
SetFocus SetText ShowControl




  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 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 GetText
             (CONST dialogID  : CARDINAL;
              CONST controlID : CARDINAL;
              VAR   Text      : ARRAY OF CHAR);

  (**
      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 Reset
             (CONST dialogID  : CARDINAL;
              CONST controlID : CARDINAL);

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

      EXIT -

        None
  *)




  PROCEDURE SetColors
             (CONST dialogID   : CARDINAL;
              CONST controlID  : CARDINAL;
              CONST textColor  : StatColorType;
              CONST bkGndColor : StatColorType);

  (**
      SetColors - Sets the text and background colors of the control.


      This routine will change the text and background colors of
      the SageStat control.

      CALLING SEQUENCE -

        SetColors (dialogID, controlID, textColor, bkGndColor)

      ENTRY -

        dialogID : CARDINAL
          The number of the dialog box or window containing the
          control.

        controlID : CARDINAL
          The control resource identifier.

        textColor : StatColorType
          The color for the text.  Must be one of the StatColorTypes.
          The Default color is determined by the current Windows
          configuration.

        bkGndColor : StatColorType
          The color for the background.  Must be one of the
          StatColorTypes.  The Default color is determined by the
          current Windows configuration.

      EXIT -

        None
  *)




  PROCEDURE SetText
             (CONST dialogID  : CARDINAL;
              CONST controlID : CARDINAL;
              CONST Text      : ARRAY OF CHAR);

  (**
      SetText - Sets the text of the control.


      This routine will place the given text string in the specified SageStat
      control.

      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 text to set in the control.

      EXIT -

        None
  *)




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