gpm: Utility Functions
4.2.4 Utility Functions
-----------------------
-- Function: int Gpm_Repeat (int MILLISECS);
It returns 1 if no mouse events arrive in the next MILLICECS
milliseconds, 0 otherwise. It is meant to be used by those
handlers which need to repeat an action as long as the mouse button
is pressed ('while(Gpm_Repeat(200))...').
-- Function: int Gpm_DrawPointer (int X, int Y, int FD);
-- Function: int GPM_DRAWPOINTER (Gpm_Event *EPTR;)
These are actually macros. They should be used to draw the mouse
pointer after mangling the screen (while dragging on a menu, say),
because letting it to the server won't work nicely, due to lack of
synchronism between client and server. The file descriptor should
refer to the console. The return value is 0 on success and -1 on
failure. 'Gpm_DrawPointer' is obsolete, and is retained only for
compatibility.
-- Function: int Gpm_FitValuesM (int *X, int *Y, int MARGIN);
-- Function: int Gpm_FitValues (X,Y);
-- Function: void Gpm_FitEvent (EPTR);
The first is a function, while the other are macros. Note that
'Gpm_FitEvent' does not return values. These three procedures
should be used to fit the pointer inside the visible screen. They
are needed for drag and release event. A connection bit will be
available in the future to force the pointer in the visible region.
Note that fitting uses 'gpm_mx' and 'gpm_my'. Variables.