SP_RAT_ROWR

RAT_ROWR() Returns mouse row at the last right button press

 Returns
 <nRow> => mouse row at last right button press

 Syntax
 RAT_ROWR()

 Description
 Returns mouse row at the last right button press (as
 recorded by a call to rat_rightb() )

 Examples
  if rat_rightb()

    ?"While you were out:"

    ?"Right button was depressed at"

    ??rat_rowr(),rat_colr()

  endif

 Notes:
 This is different from RAT_ROW() in that RAT_ROW()
 tells the mouse row NOW wherease RAT_ROWR() tells where the
 mouse was at the last recorded right button press (as recorded
 by a call to rat_rightb() )

 Source: S_MOUSE.ASM

SP_RAT_ROWL

RAT_ROWL() Returns mouse row at the last left button press

 Returns
 <nRow> => mouse row at last left button press

 Syntax
 RAT_ROWL()

 Description
 Returns mouse row at the last left button press (as
 recorded by a call to rat_leftb() )

 Examples
  if rat_leftb()

    ?"While you were out:"

    ?"Left button was depressed at"

    ??rat_rowl(),rat_coll()

  endif

 Notes:
 This is different from RAT_ROW() in that RAT_ROW()
 tells the mouse row NOW wherease RAT_ROWL() tells where the
 mouse was at the last recorded left button press (as recorded by
 a call to rat_leftb() )

 Source: S_MOUSE.ASM

 

SP_RAT_ROW

RAT_ROW() Current mouse row

 Returns
 <nRow> => mouse row right now

 Syntax
 RAT_ROW()

 Description
 This gives the CURRENT mouse row

 Examples
  ?"Mouse is at row :",rat_row()

 Notes:
 This is different from RAT_ROWL() or RAT_ROWR() in
 that these two functions return the recorded row when the mouse
 button was last pressed, RAT_ROWL() for left or RAT_ROWR() for
 right.

 This function tells where the mouse is right now.

 Source: S_MOUSE.ASM

 

SP_RAT_RIGHTB

RAT_RIGHTB() Determines if the right mouse button has been
 pressed

 Returns
 <lHasBeenPressed> => right mouse button has been
 pressed

 Syntax
 RAT_RIGHTB()

 Description
 This returns .t. if the right button has been pressed
 since last call to this function. Row and column are recorded
 for reference by rat_rowr() and rat_colr().

 Examples
  if rat_rightb()

    ?"While you were out:"

    ?"Left button was depressed at"

    ??rat_rowr(),rat_colr()

  endif

 Notes:
 This is different from RAT_RBHD() in that RAT_RBHD()
 is a 'right now' function - determining if the button IS
 depressed, whereas this function determines if the button HAS
 been depressed.

 Source: S_MOUSE.ASM

SP_RAT_RBHD

RAT_RBHD() Determines if the mouse right button is currently
 depressed

 Returns
 <lDepressed> => mouse right button is currently
 depressed

 Syntax
 RAT_RBHD()

 Description
 Determines if the mouse right button is currently
 depressed

 Examples
  if RAT_RBHD()

    ?"Mouse right button depressed NOW"

  endif

 Notes:
 This is different from the event function
 RAT_ERBHD(). RAT_ERBHD(<n>) watches the mouse for <n> seconds,
 and if the mouse remains depressed for the full time, then it is
 considered to be HELD DOWN. RAT_RBHD() on the other hand, only
 checks for the mouse button being depressed RIGHT NOW.
 RAT_ERBHD() calls RAT_RBHD() repetitively.

 Source: S_MOUSE.ASM

 

SP_RAT_POSIT

RAT_POSIT() Positions the mouse cursor at row,column
 coordinates

 Returns
 None

 Syntax
 RAT_POSIT(nRow,nColumn)

 Description
 Move the mouse cursor to nRow,nColumn.

 Examples
  RAT_OFF()

  RAT_POSIT(0,0)  // upper left hand corner

  RAT_ON()

 Notes:
 Be sure to RAT_OFF() before doing this.

 Source: S_MOUSE.ASM

SP_RAT_ON

RAT_ON() Sets the mouse cursor on

 Returns
 None

 Syntax
 RAT_ON()

 Description
 Turns the mouse cursor on

 Examples
  if rat_exist()
    rat_on()
    * do something, or wait for something...
    rat_off()

  endif

 Notes:
 There must be a rat_on() call for each rat_off() call
 in succession.

 In other words, if you do:
          rat_off()
          rat_off()

 you must then do:
          rat_on()
          rat_on()

 to turn on the mouse cursor, as it is stacked.

 e.g.

        if rat_exist()
          rat_on()
          * do something, or wait for something...
          rat_off()
        endif

 RAT_EVENT() takes care of the mouse on/off settings,
 so if you use RAT_EVENT(), you need not use RAT_ON()/RAT_OFF()

 Source: S_MOUSE.ASM

 

SP_RAT_OFF

RAT_OFF() Sets the mouse cursor off

 Returns
 None

 Syntax
 RAT_OFF()

 Description
 Turns the mouse cursor off

 Examples
  if rat_exist()
    rat_on()
    * do something, or wait for something...
    rat_off()
  endif

 Notes:
 There must be a rat_on() call for each rat_off() call
 in succession.

 In other words, if you do:
          rat_off()
          rat_off()

 you must then do:
          rat_on()
          rat_on()

 to turn on the mouse cursor, as it is stacked.

 e.g.

        if rat_exist()
          rat_on()
          * do something, or wait for something...
          rat_off()
        endif

 RAT_EVENT() takes care of the mouse on/off settings,
 so if you use RAT_EVENT(), you need not use RAT_ON()/RAT_OFF()

 Source: S_MOUSE.ASM