SQABasic ScrollBarFunctions Script

SQABasic "ScrollBarFunctions" Script

 MODULE DESCRIPTION:

      Routines and utilities to work on SQA Type=SCROLLBAR objects in
      Data-Driven Automation.

Action Commands Global Variables Routine Details

User Dependencies:

(stuff the developer's library/script $INCLUDES at compile time.)
(Note: The order of items may matter and may be different for your code.)

(none)

Internal Dependencies:

(stuff this library needs at compile time.)

'$INCLUDE: "LogUtilities_X.SBH"
'$INCLUDE: "ApplicationUtilities_X.SBH"
'$INCLUDE: "DDUtilities_X.SBH"
'$INCLUDE: "GenericMasterFunctions_X.SBH"
'$INCLUDE: "StepDriver_X.SBH"
'$INCLUDE: "StringUtilities_X.SBH"
'$INCLUDE: "DDGUIUtilities_X.SBH"
'$INCLUDE: "DDGUIUtilities.SBH"
'$INCLUDE: "GenericMasterFunctions.SBH"
'$INCLUDE: "LogUtilities.SBH"
'$INCLUDE: "StringUtilities.SBH"

DDE Action Commands

 SUPPORTED ACTION COMMANDS:

      PageRight               '(horizontal scrollbars) scroll page right
      PageLeft                '(horizontal scrollbars) scroll page left
      OneRight                '(horizontal scrollbars) scroll right
      OneLeft                 '(horizontal scrollbars) scroll left
      PageUp                  ' (vertical scrollbars)  scroll page up
      PageDown                ' (vertical scrollbars)  scroll page down
      OneUp                   ' (vertical scrollbars)  scroll up
      OneDown                 ' (vertical scrollbars)  scroll down

Globals

    (none)

Routine Details



   Sub ScrollBarPageRight ()


 DESCRIPTION:

      Tries to perform a ScrollPageRight on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarPageLeft ()


 DESCRIPTION:

      Tries to perform a ScrollPageLeft on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarPageUp ()


 DESCRIPTION:

      Tries to perform a ScrollPageUp on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarPageDown ()


 DESCRIPTION:

      Tries to perform a ScrollPageDown on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarOneRight ()


 DESCRIPTION:

      Tries to perform a ScrollRight on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarOneLeft ()


 DESCRIPTION:

      Tries to perform a ScrollLeft on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarOneUp ()


 DESCRIPTION:

      Tries to perform a ScrollLineUp on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub ScrollBarOneDown ()


 DESCRIPTION:

      Tries to perform a ScrollLineDown on a scrollbar.  The input record
      can optionally specify the number of iterations to perform the action.

      The routine expects that the given object already has Context or Focus.
      It also expects that Global StepDriverTestInfo contains all the information
      it needs to perform its function.

 DATA TABLE PARAMETERS:

      (5) Optional integer to specify how many times to perform the action.

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release





   Sub Main ()

 DESCRIPTION:

      Entry point to process a StepDriver ACTION COMMAND on a SCROLLBAR.
      The routine merely reads the Global StepDriverTestInfo.testcommand and
      calls the appropriate subroutine to process it.

      If the testcommand is unrecognized it will log a WARNING_MESSAGE and
      exit with a WARNING status.

 DATA TABLE PARAMETERS:

      none    -   the called subroutine has the requirements

 ERRORS:

      none

 Orig Author: Carl Nagle
 Orig   Date: APR 12, 2000
 History:

      APR 12, 2000    Original Release
      OCT 17, 2002    (CANAGL) Reroute fallback to GenericObjectFunctions.
      OCT 22, 2002    (CANAGL) Warn of unimplemented TF and TW record types.
      DEC 12, 2002    (CANAGL) Added support for XSLComponentActions.MAP
      DEC 08, 2003    (YWANG)  Added HScrollTo and VScrollTo
      DEC 09, 2003    (YWANG)  Moved HScrollTo and VScrollTo to GenericObjectFunctions.

Copyright (C) SAS Institute
GNU General Public License: http://www.opensource.org/licenses/gpl-license.php 
==============================================================================