cursor.h File Reference

Header for the cursor functions. More...

#include "border.h"

Go to the source code of this file.

Functions
int	GrabMouseForResize (BorderActionType action)
	Grab the mouse for resizing a window.
int	GrabMouseForMove ()
	Grab the mouse for moving a window.
int	GrabMouse (Window w)
	Grab the mouse.
int	GrabMouseForChoose ()
	Grab the mouse to select a window.
Cursor	GetFrameCursor (BorderActionType action)
	Get the cursor to use given a border action.
void	MoveMouse (Window win, int x, int y)
	Move the mouse cursor.
void	SetMousePosition (int x, int y)
	Set the current mouse position.
void	GetMousePosition (int *x, int *y)
	Get the current mouse position.
unsigned int	GetMouseMask ()
	Get a mask of the current mouse buttons pressed.
void	SetDefaultCursor (Window w)
	Reset to the default cursor on a window.
void	SetDoubleClickSpeed (const char *str)
	Set the double click speed.
void	SetDoubleClickDelta (const char *str)
	Set the double click delta.
void	InitializeCursors ()
void	StartupCursors ()
void	ShutdownCursors ()
void	DestroyCursors ()

---

Detailed Description

Header for the cursor functions.

Author:

Joe Wingbermuehle

Date:

2004-2006

Definition in file cursor.h.

---

Function Documentation

void DestroyCursors

(

)

Cursor GetFrameCursor

(

BorderActionType

action

)

Get the cursor to use given a border action.

Parameters:

action

The border action.

Returns:

The cursor to use.

unsigned int GetMouseMask

(

)

Get a mask of the current mouse buttons pressed.

Returns:

A mask of the current mouse buttons pressed.

void GetMousePosition	(	int *	x,
		int *	y
	)

Get the current mouse position.

Parameters:

x	Location to store the x-coordinate.
y	Location to store the y-coordinate.

int GrabMouse

(

Window

w

)

Grab the mouse.

Returns:

1 on success, 0 on failure.

int GrabMouseForChoose

(

)

Grab the mouse to select a window.

Returns:

1 on success, 0 on failure.

int GrabMouseForMove

(

)

Grab the mouse for moving a window.

Returns:

1 on success, 0 on failure.

int GrabMouseForResize

(

BorderActionType

action

)

Grab the mouse for resizing a window.

Parameters:

action

The resize action.

Returns:

1 on success, 0 on failure.

void InitializeCursors

(

)

void MoveMouse	(	Window	win,
		int	x,
		int	y
	)

Move the mouse cursor.

Parameters:

win	The window to act as an origin for the coordinates.
x	The x-coordinate.
y	The y-coordinate.

void SetDefaultCursor

(

Window

w

)

Reset to the default cursor on a window.

Parameters:

w	The window whose cursor to change.

void SetDoubleClickDelta

(

const char *

str

)

Set the double click delta.

Parameters:

str	The delta (ASCII, pixels).

void SetDoubleClickSpeed

(

const char *

str

)

Set the double click speed.

Parameters:

str	The speed (ASCII, milliseconds).

void SetMousePosition	(	int	x,
		int	y
	)

Set the current mouse position.

Parameters:

x	The x-coordinate (relative to the current desktop).
y	The y-coordinate (relative to the current desktop).

void ShutdownCursors

(

)

void StartupCursors

(

)