move.h File Reference

Header for client window move functions. More...

Go to the source code of this file.

Enumerations
enum	SnapModeType { SNAP_NONE = 0, SNAP_SCREEN = 1, SNAP_BORDER = 2 }
	Window snap modes. More...
enum	MoveModeType { MOVE_OPAQUE, MOVE_OUTLINE }
	Window move modes. More...
Functions
int	MoveClient (struct ClientNode *np, int startx, int starty, int snap)
	Move a client window.
int	MoveClientKeyboard (struct ClientNode *np)
	Move a client window using the keyboard (mouse optional).
void	SetSnapMode (SnapModeType mode)
	Set the snap mode to use.
void	SetSnapDistance (const char *value)
	Set the snap distance to use.
void	SetDefaultSnapDistance ()
	Set the snap distance to the default.
void	SetMoveMode (MoveModeType mode)
	Set the move mode to use.

---

Detailed Description

Header for client window move functions.

Author:

Joe Wingbermuehle

Date:

2004-2006

Definition in file move.h.

---

Enumeration Type Documentation

enum MoveModeType

Window move modes.

Enumerator:

MOVE_OPAQUE	Show window contents while moving.
MOVE_OUTLINE	Show an outline while moving.

Definition at line 23 of file move.h.

enum SnapModeType

Window snap modes.

Enumerator:

SNAP_NONE	Don't snap.
SNAP_SCREEN	Snap to the edges of the screen.
SNAP_BORDER	Snap to all borders.

Definition at line 16 of file move.h.

---

Function Documentation

int MoveClient	(	struct ClientNode *	np,
		int	startx,
		int	starty,
		int	snap
	)

Move a client window.

Parameters:

np	The client to move.
startx	The starting mouse x-coordinate (window relative).
starty	The starting mouse y-coordinate (window relative).
snap	1 to do edge snapping, 0 otherwise.

Returns:

1 if the client moved, 0 otherwise.

int MoveClientKeyboard

(

struct ClientNode *

np

)

Move a client window using the keyboard (mouse optional).

Parameters:

np	The client to move.

Returns:

1 if the client moved, 0 otherwise.

void SetDefaultSnapDistance

(

)

Set the snap distance to the default.

void SetMoveMode

(

MoveModeType

mode

)

Set the move mode to use.

Parameters:

mode	The move mode to use.

void SetSnapDistance

(

const char *

value

)

Set the snap distance to use.

Parameters:

value

A string representation of the distance to use.

void SetSnapMode

(

SnapModeType

mode

)

Set the snap mode to use.

Parameters:

mode	The snap mode to use.