Sage-ST

Sage-ST ä
Ctrlsbar
Documentation

ControlCommand	Create	CurrentControlID	CurrentDialogID
SetDefault	SetText


  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 SetDefault
             (CONST FormID    : CARDINAL;
              CONST controlID : CARDINAL;
              CONST index     : CARDINAL) : BOOLEAN;

  (**
      SetDefault - Sets one of the SageSBars to receive all DisplayMessages.


      This routine allows the user to specify which SageSBar will
      display the DisplayMessage messages.  Sage.SageError messages will also
      be linked to this status bar.  Calling this routine with a
      formID value of 0 will disable this function.

      CALLING SEQUENCE -

        status := SetDefault (formID, controlID, index)

      ENTRY -

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

        controlID : CARDINAL
          The ID of the SageSBar.  Set to 0 if the status bar is on
          a window.

        index : CARDINAL
          The index (1 .. n) of the cell in the status bar to display the
          message.

      EXIT -

        status : BOOLEAN
          TRUE if the operation was successful.
  *)


  PROCEDURE Create
             (CONST windowID  : CARDINAL;
              CONST parts     : CARDINAL;
              CONST partArray : ARRAY OF SageSBarCellType) : BOOLEAN;

  (**
      Create - Creates a SageSBar control on a window.


      This routine allows the user to create a SageSBar control on a
      window.  SageSBar controls for dialogs should be created in the
      resource editor.

      CALLING SEQUENCE -

        status := Create (windowID, parts, partArray)

      ENTRY -

        windowID : CARDINAL
          The ID of the window.

        parts : CARDINAL
          The number of cells which the SageSBar is to have.  The maximum
          is 10.

        partArray : ARRAY OF SageSBarCellType
          An array containing the following information about each cell -

              percent - CARDINAL -- percent of the total SageSBar that this cell
                                    takes up
              raised - BOOLEAN   -- TRUE = Raised, FALSE = Lowered
              pType - CHAR       -- Not Used, set to N

      EXIT -

        status : BOOLEAN
          TRUE if the operation was successful.
  *)


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

  (**
      SetText - Sets the text for a cell of the SageSBar control.


      This routine will place the given text string in the specified
      SageSBar cell.

      CALLING SEQUENCE -

        SetText (formID, controlID, text, cellIndex)

      ENTRY -

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

        controlID : CARDINAL
          The status bar control resource identifier.  This value should
          be zero for the status bar of a window.

        text : ARRAY OF CHAR
          The text to set in the status bar.

        cellIndex : CARDINAL
          The index (1 .. n) of the cell to put the text in.

      EXIT -

        None
  *)