• mouseWait
  • mouseSave
  • mouseDefine
  • mouseList
  • mouseVerbose
  • mouseQuiet
  • tclSaoMouse.c

    	DERVISH TCL mouse commands allow FSAOimage mouse button clicks to be
    	translated into user defined DERVISH TCL commands.  This translation is
    	done when FSAOimage is in cursor mode only.
    

    See the mouseDefine command for a description of the parameters that are passed to the user defined DERVISH TCL commands.

    
    

    mouseWait

    DESCRIPTION:
    
    Wait for the arrival of a mouse command from fSAO. The mouse command output is generated whenever a supported mouse button is pressed when the window focus is on an fSAO process. No input will be accepted from the command line or from a sourced file while the wait is in effect. If no arguments are entered on the command line, Dervish will wait for any mouse button output from any existing fSAO process forever. When used in conjunction with the mouseSave command, a specified mouse button can be assigned a particular TCL command (with mouseDefine which is only in effect for the time that Dervish is waiting for mouse button output. For example, consider the following procedure:
     	proc mouseButton {} {
    	  set oldMouse [mouseSave POINT_CL_L]
    	  mouseDefine POINT_CL_L echo
    	  mouseWait POINT_CL_L
    	  mouseDefine POINT_CL_L $oldMouse
    
    SYNTAX:
    	mouseWait [button] [-t milliseconds] [-e] [-s fsao]
    
    	  [button]     Mouse button to wait for.  The available buttons are:
    		POINT_L       - Point Mode, Left mouse button
    		POINT_M       - Point Mode, Middle mouse button
    		POINT_R       - Point Mode, Right mouse button
    		POINT_CL_L    - Point Mode, Ctrl Left mouse button
    		POINT_CL_M    - Point Mode, Ctrl Middle mouse button
    		POINT_CL_R    - Point Mode, Ctrl Right mouse button
    		POINT_SH_L    - Point Mode, Shift Left mouse button
    		POINT_SH_M    - Point Mode, Shift Middle mouse button
    		POINT_SH_R    - Point Mode, Shift Right mouse button
    		POINT_CL_SH_L - Point Mode, Ctrl Shift Left mouse button
    		POINT_CL_SH_M - Point Mode, Ctrl Shift Middle mouse button
    		POINT_CL_SH_R - Point Mode, Ctrl Shift Right mouse butto
    		CIRCLE_CL     - Circle Mode, Ctrl (any) mouse button
    		ELLIPSE_CL    - Ellipse Mode, Ctrl (any) mouse button
    		RECTANGLE_CL  - Rectangle Mode, Ctrl (any) mouse button
    

    mouseSave

    DESCRIPTION:
    	Return the TCL command that was associated with a particular mouse
    	button in a previous mouseDefine command.
    
    SYNTAX:
       mouseSave <button>
    
    	<button>	Mouse button to return.  The available buttons are:
    		POINT_L       - Point Mode, Left mouse button
    		POINT_M       - Point Mode, Middle mouse button
    		POINT_R       - Point Mode, Right mouse button
    		POINT_CL_L    - Point Mode, Ctrl Left mouse button
    		POINT_CL_M    - Point Mode, Ctrl Middle mouse button
    		POINT_CL_R    - Point Mode, Ctrl Right mouse button
    		POINT_SH_L    - Point Mode, Shift Left mouse button
    		POINT_SH_M    - Point Mode, Shift Middle mouse button
    		POINT_SH_R    - Point Mode, Shift Right mouse button
    		POINT_CL_SH_L - Point Mode, Ctrl Shift Left mouse button
    		POINT_CL_SH_M - Point Mode, Ctrl Shift Middle mouse button
    		POINT_CL_SH_R - Point Mode, Ctrl Shift Right mouse button
    		CIRCLE_CL     - Circle Mode, Ctrl (any) mouse button
    		ELLIPSE_CL    - Ellipse Mode, Ctrl (any) mouse button
    		RECTANGLE_CL  - Rectangle Mode, Ctrl (any) mouse button
    

    mouseDefine

    DESCRIPTION:
     	Assign a TCL command to be executed upon selection of the designated
    	mouse button from a Fermi enhanced SAOimage (FSAOimage) program. The
    	user supplied TCL command will be invoked with parameters based
    	on the type of cursor used.  These are listed below:
    
    PARAMETERS PASSED TO USER SUPPLIED TCL COMMAND:
    	Cursor Type  |  Parameters
    	-------------+----------------------------------------------x
    	point	     |	regName  X  Y  fsao#      
    	circle	     |	regName  X  Y  radius  fsao#      
    	ellipse	     |	regName  X  Y  rotAngle  width  height  fsao#      
    	rectangle    |	regName  X  Y  rotAngle  width  height  fsao#      
    
    	Where,
    		regName  - Handle to region displayed by FSAOimage
    		X        - Center X coordinate
    		Y        - Center Y coordinate
    		fsao#    - FSAOimage number
    		radius   - Radius of circle (in pixels)
    		rotAngle - Rotation angle
    		width    - Width (in pixels)
    		height   - Height (in pixels)
    
    TCL SYNTAX:
       mouseDefine <button> <command>
    	<button> Mouse button to assign.  The available buttons are:
    		POINT_L       - Point Mode, Left mouse button
    		POINT_M       - Point Mode, Middle mouse button
    		POINT_R       - Point Mode, Right mouse button
    		POINT_CL_L    - Point Mode, Ctrl Left mouse button
    		POINT_CL_M    - Point Mode, Ctrl Middle mouse button
    		POINT_CL_R    - Point Mode, Ctrl Right mouse button
    		POINT_SH_L    - Point Mode, Shift Left mouse button
    		POINT_SH_M    - Point Mode, Shift Middle mouse button
    		POINT_SH_R    - Point Mode, Shift Right mouse button
    		POINT_CL_SH_L - Point Mode, Ctrl Shift Left mouse button
    		POINT_CL_SH_M - Point Mode, Ctrl Shift Middle mouse button
    		POINT_CL_SH_R - Point Mode, Ctrl Shift Right mouse button
    		CIRCLE_CL     - Circle Mode, Ctrl (any) mouse button
    		ELLIPSE_CL    - Ellipse Mode, Ctrl (any) mouse button
    		RECTANGLE_CL  - Rectangle Mode, Ctrl (any) mouse button
    

    mouseList

    DESCRIPTION:
    	List the TCL commands assigned to FSAOimage mouse buttons.  The
    	assignments are made using the mouseDefine command.
    
    TCL SYNTAX:
       mouseList
    

    mouseVerbose

    DESCRIPTION:
    	Print a message to stdout each time one of the assignable FSAOimage
    	mouse buttons is selected.  The message will be printed regardless of
    	whether or not a TCL function is assigned to that button.  This
    	feature is generally used for debug purposes and can be disabled with
    	the mouseQuiet command.
    
    TCL SYNTAX:
       mouseVerbose
    

    mouseQuiet

    DESCRIPTION:
    	Disable the mouseVerbose command.  Messages will no longer be sent to
     	stdout whenever one of the assignable FSAOimage mouse buttons is
    	selected.  This command has no effect on TCL commands assigned to
    	mouse buttons - they will still be invoked when selected.
    
    TCL SYNTAX:
       mouseQuiet