Sage-ST ä

Ctrlwin

Documentation

Check ControlCommand CurrentControlID CurrentDialogID
DisableControl EnableControl GetText Gray
HideControl IsChecked IsEnabled MakeDefault
PostCommandToWindow PostMessageToControl ProgressReset ProgressSetRange
ProgressSetStep ProgressStepIt RedrawControl STRGetText
STRSetText ScrollTextPage SendCommandToWindow SendMessageToControl
SetFocus SetText ShowControl TrackClear
TrackClearTics TrackGetPosition TrackSetLineSize TrackSetPageSize
TrackSetPosition TrackSetRange TrackSetSelectionRange TrackSetTicFreq
TrackSetTicPos UnCheck




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

  exports ControlCommand name 'CtrlWin_ControlCommand';

  //*
  //  ControlCommand - Retrieves command which has been sent from 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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 'CtrlWin_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 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 'CtrlWin_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 'CtrlWin_STRGetText';

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




  procedure ScrollTextPage
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const pageDown  : boolean); stdcall;

  exports ScrollTextPage name 'CtrlWin_ScrollTextPage';




  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 'CtrlWin_SetText';

  //*
  //  SetText - Sets the text or label text of a control.
  //
  //
  //  This routine will place the given text string in the specified
  //  controls text area or 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 text or 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 'CtrlWin_STRSetText';

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




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

  exports Check name 'CtrlWin_Check';

  //*
  //  Check - Sets state of checkbox to checked, or a radiobutton to selected.
  //
  //
  //  This routine will place a check in a checkbox control or will change
  //  the state of a radio button to selected.
  //
  //  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 Gray
             (const dialogID  : cardinal;
              const controlID : cardinal); stdcall;

  exports Gray name 'CtrlWin_Gray';

  //*
  //  Gray - Sets the state of a checkbox to grayed.
  //
  //
  //  This routine will fill the specified checkbox 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 'CtrlWin_IsChecked';

  //*
  //  IsChecked - Determines if a checkbox or radio button control is checked.
  //
  //
  //  This routine will determine the checked/unchecked status of
  //  a checkbox control, or the selected status of a radio button.
  //
  //  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 checkbox is checked or grayed, or the radio button
  //      is selected.  False if the checkbox is unchecked, or the radio
  //      button is not selected.
  //




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

  exports UnCheck name 'CtrlWin_UnCheck';

  //*
  //  UnCheck - Sets state of checkbox to unchecked, or radiobutton to unselected.
  //
  //
  //  This routine will remove a check a checkbox control, or will
  //  unselect a radio button.
  //
  //  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.
  //




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

  exports MakeDefault name 'CtrlWin_MakeDefault';

  //*
  //  MakeDefault - Makes a button the default button.
  //
  //
  //  This routine will make a button the default button.  The default
  //  button has a dark outline around it and is automatically pressed
  //  when the user presses the Enter key.
  //
  //  CALLING SEQUENCE -
  //
  //    MakeDefault (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




  procedure ProgressSetRange
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const Range     : cardinal); stdcall;

  exports ProgressSetRange name 'CtrlWin_ProgressSetRange';

  //*
  //  ProgressSetRange - Sets the range of a progress bar.
  //
  //
  //  This routine will set the range (minimum and maximum values)
  //  of the progress bar and redraw the bar.
  //
  //  CALLING SEQUENCE -
  //
  //    ProgressSetRange (dialogID, controlID, Range)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //
  //    Range : cardinal
  //      The total number of part of the progress bar.
  //




  procedure ProgressSetStep
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const Step      : cardinal); stdcall;

  exports ProgressSetStep name 'CtrlWin_ProgressSetStep';

  //*
  //  ProgressSetStep - Sets the increment of a progress bar.
  //
  //
  //  This routine specifies the step increment of the progress bar.
  //
  //  CALLING SEQUENCE -
  //
  //    ProgressSetRange (dialogID, controlID, Step)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //
  //    Step : cardinal
  //      The number of steps the progress bar is to be incremented.
  //




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

  exports ProgressReset name 'CtrlWin_ProgressReset';

  //*
  //  ProgressReset - Reset the progress bar.
  //
  //
  //  This routine will reset the progress bar.
  //
  //  CALLING SEQUENCE -
  //
  //    ProgressReset (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




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

  exports ProgressStepIt name 'CtrlWin_ProgressStepIt';

  //*
  //  ProgressStepIt - Advance the position of the progress bar.
  //
  //
  //  This routine will advance the current position of the progress
  //  bar by the step increment and redraw it.
  //
  //  CALLING SEQUENCE -
  //
  //    ProgressStepIt (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The number of the dialog box or window containing the
  //      control.
  //
  //    controlID : cardinal
  //      The control resource identifier.
  //




  procedure TrackSetRange
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const iMin      : integer;
              const iMax      : integer); stdcall;

  exports TrackSetRange name 'CtrlWin_TrackSetRange';

  //*
  //  TrackSetRange  - Sets the range of the trackbar control.
  //
  //
  //  This routine will set the range of the trackbar control.  The range
  //  is the set of contiguous values that a trackbar can represent.
  //  This is usually used when the trackbar is first created.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetRange (dialogID, controlID, iMin, iMax)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose range will be set.
  //
  //    iMin : cardinal
  //      The minimum value of the trackbar range.
  //
  //    iMax : cardinal
  //      The maximum value of the trackbar range.
  //




  procedure TrackSetPageSize
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const size      : cardinal); stdcall;

  exports TrackSetPageSize name 'CtrlWin_TrackSetPageSize';

  //*
  //  TrackSetPageSize - Sets the size of the page for pageup and down comands.
  //
  //
  //  This routine will set the page size that is to be used for page up and
  //  down commands.  The default is max - min divided by 5.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetPageSize (dialogID, controlID, size)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose position will be set.
  //
  //    size : cardinal
  //      The size of the page for this control.
  //




  procedure TrackSetLineSize
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const size      : cardinal); stdcall;

  exports TrackSetLineSize name 'CtrlWin_TrackSetLineSize';

  //*
  //  TrackSetLineSize - Sets the size of the line for the line left and right comands.
  //
  //
  //  This routine will set the line size that is to be used for line left and right
  //  commands.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetLineSize (dialogID, controlID, size)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose position will be set.
  //
  //    size : cardinal
  //      The size of the line for this control.
  //




  procedure TrackSetSelectionRange
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const iMin      : integer;
              const iMax      : integer); stdcall;

  exports TrackSetSelectionRange name 'CtrlWin_TrackSetSelectionRange';

  //*
  //  TrackSetSelectionRange  - Sets the SelectionRange of the trackbar control.
  //
  //
  //  This routine will set the SelectionRange of the trackbar control.
  //  The SelectionRange is the colored area on the track bar that indicates
  //  the optimum range for the control.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetSelectionRange (dialogID, controlID, iMin, iMax)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose SelectionRange will be set.
  //
  //    iMin : cardinal
  //      The minimum value of the trackbar SelectionRange.
  //
  //    iMax : cardinal
  //      The maximum value of the trackbar SelectionRange.
  //




  procedure TrackSetTicPos
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const Position  : cardinal); stdcall;

  exports TrackSetTicPos name 'CtrlWin_TrackSetTicPos';

  //*
  //  TrackSetTicPos - Sets tic mark position.
  //
  //
  //  This routine will set the position of the tic marks on a
  //  track bar.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetTicPos (dialogID, controlID, position)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose position will be set.
  //
  //    position : cardinal
  //      The position of the first tic mark on the track bar.
  //




  procedure TrackSetTicFreq
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const frequency : cardinal); stdcall;

  exports TrackSetTicFreq name 'CtrlWin_TrackSetTicFreq';

  //*
  //  TrackSetTicFreq - Sets tic mark frequency.
  //
  //
  //  This routine will set the frequency of the tic marks on a
  //  track bar.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetTicFreq (dialogID, controlID, frequency)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose position will be set.
  //
  //    frequency : cardinal
  //      The frequncy of tic marks on the track bar.
  //




  procedure TrackSetPosition
             (const dialogID  : cardinal;
              const controlID : cardinal;
              const Pos       : cardinal); stdcall;

  exports TrackSetPosition name 'CtrlWin_TrackSetPosition';

  //*
  //  TrackSetPosition - Sets the position of the trackbar control.
  //
  //
  //  This routine will set the position of the trackbar control.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackSetPosition (dialogID, controlID, pos)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose position will be set.
  //
  //    pos : cardinal
  //      The position of the trackbar.
  //




  procedure TrackGetPosition
             (const dialogID  : cardinal;
              const controlID : cardinal;
              var   Pos       : cardinal); stdcall;

  exports TrackGetPosition name 'CtrlWin_TrackGetPosition';

  //*
  //  TrackGetPosition - Returns the current position of the trackbar control.
  //
  //
  //  This routine will return the current position (the value the user
  //  has chosen) of the trackbar control.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackGetPosition (dialogID, controlID, pos)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose position will be returned.
  //
  //  EXIT -
  //
  //    pos : cardinal
  //      The position of the trackbar.
  //




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

  exports TrackClear name 'CtrlWin_TrackClear';

  //*
  //  TrackClear - Clears the current track selection.
  //
  //
  //  This routine will clear the selection area on a track bar.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackClear (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose selection will be cleared.
  //




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

  exports TrackClearTics name 'CtrlWin_TrackClearTics';

  //*
  //  TrackClearTics - Clears the current track bar tics.
  //
  //
  //  This routine will clear the tics on the specified track bar.
  //
  //  CALLING SEQUENCE -
  //
  //    TrackClearTics (dialogID, controlID)
  //
  //  ENTRY -
  //
  //    dialogID : cardinal
  //      The ID of the dialog containing the trackbar control.
  //
  //    controlID : cardinal
  //      The ID of the control whose tics will be cleared.
  //




  procedure PostMessageToControl
             (const dId     : cardinal;
              const cId     : cardinal;
              const typeMsg : cardinal;
              const msgId   : cardinal;
              const extra   : cardinal); stdcall;

  exports PostMessageToControl name 'CtrlWin_PostMessageToControl';




  procedure SendMessageToControl
             (const dId     : cardinal;
              const cId     : cardinal;
              const typeMsg : cardinal;
              const msgId   : cardinal;
              const extra   : cardinal); stdcall;

  exports SendMessageToControl name 'CtrlWin_SendMessageToControl';




  procedure PostCommandToWindow
             (const windowID : cardinal;
              const msgId    : cardinal;
              const extra    : cardinal); stdcall;

  exports PostCommandToWindow name 'CtrlWin_PostCommandToWindow';




  procedure SendCommandToWindow
             (const windowID : cardinal;
              const msgId    : cardinal;
              const extra    : cardinal); stdcall;

  exports SendCommandToWindow name 'CtrlWin_SendCommandToWindow';




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