place.h File Reference

Header for client placement functions. More...

Go to the source code of this file.

Data Structures
struct	BoundingBox
	Bounding box. More...
Typedefs
typedef struct BoundingBox	BoundingBox
	Bounding box.
Functions
void	RemoveClientStrut (struct ClientNode *np)
	Remove struts associated with a client.
void	ReadClientStrut (struct ClientNode *np)
	Read struts associated with a client.
void	PlaceClient (struct ClientNode *np, int alreadyMapped)
	Place a client on the screen.
void	PlaceMaximizedClient (struct ClientNode *np, int horiz, int vert)
	Place a maximized client on the screen.
void	GravitateClient (struct ClientNode *np, int negate)
	Move a client window for a border.
void	GetGravityDelta (const struct ClientNode *np, int *x, int *y)
	Get the x and y deltas for gravitating a client.
void	ConstrainSize (struct ClientNode *np)
	Constrain the size of a client to available screen space.
void	GetScreenBounds (const struct ScreenType *sp, BoundingBox *box)
	Get the bounding box for the screen.
void	SubtractTrayBounds (const struct TrayType *tp, BoundingBox *box, unsigned int layer)
	Subtract bounds for the configured trays.
void	InitializePlacement ()
void	StartupPlacement ()
void	ShutdownPlacement ()
void	DestroyPlacement ()

---

Detailed Description

Header for client placement functions.

Author:

Joe Wingbermuehle

Date:

2004-2006

Definition in file place.h.

---

Typedef Documentation

typedef struct BoundingBox BoundingBox

Bounding box.

---

Function Documentation

void ConstrainSize

(

struct ClientNode *

np

)

Constrain the size of a client to available screen space.

Parameters:

np	The client.

void DestroyPlacement

(

)

void GetGravityDelta	(	const struct ClientNode *	np,
		int *	x,
		int *	y
	)

Get the x and y deltas for gravitating a client.

Parameters:

np	The client.
x	Location to store the x delta.
y	Location to store the y delta.

void GetScreenBounds	(	const struct ScreenType *	sp,
		BoundingBox *	box
	)

Get the bounding box for the screen.

Parameters:

sp	A pointer to the screen whose bounds to get.
box	The bounding box for the screen.

void GravitateClient	(	struct ClientNode *	np,
		int	negate
	)

Move a client window for a border.

Parameters:

np	The client.
negate	0 to gravitate for a border, 1 to gravitate for no border.

void InitializePlacement

(

)

void PlaceClient	(	struct ClientNode *	np,
		int	alreadyMapped
	)

Place a client on the screen.

Parameters:

np	The client to place.
alreadyMapped	1 if already mapped, 0 if unmapped.

void PlaceMaximizedClient	(	struct ClientNode *	np,
		int	horiz,
		int	vert
	)

Place a maximized client on the screen.

Parameters:

np	The client to place.
horiz	Set if maximizing horizontally.
vert	Set if maximizing vertically.

void ReadClientStrut

(

struct ClientNode *

np

)

Read struts associated with a client.

Parameters:

np	The client.

void RemoveClientStrut

(

struct ClientNode *

np

)

Remove struts associated with a client.

Parameters:

np	The client.

void ShutdownPlacement

(

)

void StartupPlacement

(

)

void SubtractTrayBounds	(	const struct TrayType *	tp,
		BoundingBox *	box,
		unsigned int	layer
	)

Subtract bounds for the configured trays.

Parameters:

tp	The first tray to consider.
box	The bounding box.
layer	The maximum layer of the tray bounds.