Sage-ST ä

Ctrlstat

Documentation

Global Declarations (Constants, Types, Variables)
DisableControl EnableControl GetText
HideControl IsEnabled RedrawControl Reset
SetColors SetFocus SetText ShowControl





  subtype StatColorType is ModSys.S_Natural;
  DarkBlue : constant StatColorType := 8_388_608;   -- RGB(0,0,128)     Low Intensity Blue

  DarkGreen : constant StatColorType := 32_768;   -- RGB(0,128,0)     Low Intensity Green

  DarkRed : constant StatColorType := 128;   -- RGB(128,0,0)     Low Intensity Red

  DarkCyan : constant StatColorType := 8_421_376;   -- RGB(0,128,128)   Low Intensity Cyan

  DarkMagenta : constant StatColorType := 8_388_736;   -- RGB(128,0,128)   Low Intensity Magenta

  DarkYellow : constant StatColorType := 32_896;   -- RGB(128,128,0)   Low Intensity Yellow

  DarkGray : constant StatColorType := 8_421_504;   -- RGB(128,128,128) High Intensity Black

  Black : constant StatColorType := 0;   -- RGB(0,0,0)       Low Intensity Black

  Gray : constant StatColorType := 12_632_256;   -- RGB(192,192,192) Low Intensity White

  Blue : constant StatColorType := 16_711_680;   -- RGB(0,0,255)     High Intensity Blue

  Green : constant StatColorType := 65_280;   -- RGB(0,255,0)     High Intensity Green

  Red : constant StatColorType := 255;   -- RGB(255,0,0)     High Intensity Red

  Cyan : constant StatColorType := 16_776_960;   -- RGB(0,255,255)   High Intensity Cyan

  Magenta : constant StatColorType := 16_711_935;   -- RGB(255,0,255)   High Intensity Magenta

  Yellow : constant StatColorType := 65_535;   -- RGB(255,255,0)   High Intensity Yellow

  White : constant StatColorType := 16_777_215;   -- RGB(255,255,255) High Intensity White

  Default : constant StatColorType := ModSys.S_Natural'last;




  function IsEnabled
            (dialogID  : in     ModSys.S_Natural;
             controlID : in     ModSys.S_Natural) return 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 : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --          control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    status : boolean
  --      TRUE if the control is enabled.
  --




  procedure EnableControl
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  EnableControl - Enables a control.
  --
  --
  --  This routine will enable the specified control.
  --
  --  CALLING SEQUENCE -
  --
  --    EnableControl (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure DisableControl
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  DisableControl - Disables a control.
  --
  --
  --  This routine will disable (gray) the specified control.
  --
  --  CALLING SEQUENCE -
  --
  --    DisableControl (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --          control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure HideControl
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  HideControl - Hides a control.
  --
  --
  --  This routine will hide the specified control.
  --
  --  CALLING SEQUENCE -
  --
  --    HideControl (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure ShowControl
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  ShowControl - Shows a control.
  --
  --
  --  This routine will show the specified control.
  --
  --  CALLING SEQUENCE -
  --
  --    ShowControl (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure SetFocus
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  SetFocus - Sets to focus to a control.
  --
  --
  --  This routine will give the specified control focus.
  --
  --  CALLING SEQUENCE -
  --
  --    SetFocus (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure RedrawControl
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  RedrawControl - Redraws a control.
  --
  --
  --  This routine will redraw the specified control.
  --
  --  CALLING SEQUENCE -
  --
  --    RedrawControl (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure GetText
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural;
              Text      : in out string);

  --*
  --  GetText - Retrieves the text and text length from the control.
  --
  --
  --  This routine will return the text and text length from the
  --  specified SageStat control.
  --
  --  CALLING SEQUENCE -
  --
  --    GetText (DialogId, ControlId, text)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    text : string
  --      The text from the control.
  --




  procedure Reset
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural);

  --*
  --  Reset - Resets the control.
  --
  --
  --  This routine will cause the control to be reset.  This will cause
  --  the controlto reload its contents from the current memory record.
  --
  --  CALLING SEQUENCE -
  --
  --    Reset (DialogId, ControlId)
  --
  --  ENTRY -
  --
  --    DialogId : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




  procedure SetColors
             (dialogID   : in     ModSys.S_Natural;
              controlID  : in     ModSys.S_Natural;
              textColor  : in     StatColorType;
              bkGndColor : in     StatColorType);




  procedure SetText
             (dialogID  : in     ModSys.S_Natural;
              controlID : in     ModSys.S_Natural;
              Text      : in     string);

  --*
  --  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 : Modsys.S_Natural
  --      The number of the dialog box or window containing the
  --      control.
  --
  --    ControlId : Modsys.S_Natural
  --      The control resource identifier.
  --
  --    text : string
  --      The text to set in the control.
  --
  --  EXIT -
  --
  --    None
  --      N/A
  --




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