Mouse


Functions

MouseButtonMode_e TecUtilMouseGetCurrentMode (void)
  Get Tecplot's current mouse mode.
Boolean_t TecUtilMouseIsValidMode (MouseButtonMode_e MouseMode)
  This function will tell you if the specified mouse mode is valid for the current state of Tecplot.
Boolean_t TecUtilMouseSetMode (MouseButtonMode_e MouseMode)
  Sets Tecplot's mouse mode to the one specified.


Function Documentation

MouseButtonMode_e TecUtilMouseGetCurrentMode ( void   ) 

Get Tecplot's current mouse mode.

Returns:
Returns the current mode.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilMouseGetCurrentMode()

Python Syntax:

  Results = TecUtil.MouseGetCurrentMode()

  Output:
    Results[0]    ReturnVal            MouseButtonMode_e  (defined in TecVals.py)

Boolean_t TecUtilMouseIsValidMode ( MouseButtonMode_e  MouseMode  ) 

This function will tell you if the specified mouse mode is valid for the current state of Tecplot.

Parameters:
MouseMode Mouse mode to check.
Returns:
Returns TRUE if the specified mode is appropriate, otherwise FALSE.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilMouseIsValidMode(MouseMode)
    INTEGER*4 MouseMode

Python Syntax:

  Results = TecUtil.MouseIsValidMode(MouseMode)

  Input:
                  MouseMode            MouseButtonMode_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilMouseSetMode ( MouseButtonMode_e  MouseMode  ) 

Sets Tecplot's mouse mode to the one specified.

This service request behaves exactly as if the user had selected the mouse mode via Tecplot's user interface.

Parameters:
MouseMode Desired mouse mode.
Returns:
TRUE if the requested mouse mode was set, otherwise FALSE.
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilMouseSetMode(MouseMode)
    INTEGER*4 MouseMode

Python Syntax:

  Results = TecUtil.MouseSetMode(MouseMode)

  Input:
                  MouseMode            MouseButtonMode_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            boolean


Generated on Tue Mar 12 02:24:42 2013 for Tecplot by  doxygen 1.5.5