desktop.h File Reference

Header for the desktop management functions. More...

Go to the source code of this file.

Functions
int	RightDesktop ()
	Switch to the desktop to the right.
int	LeftDesktop ()
	Switch to the desktop to the left.
int	AboveDesktop ()
	Switch to the desktop above.
int	BelowDesktop ()
	Switch to the desktop below.
void	ChangeDesktop (unsigned int desktop)
	Switch to a specific desktop.
void	ShowDesktop ()
	Toggle the "show desktop" state.
struct Menu *	CreateDesktopMenu (unsigned int mask)
	Create a menu containing a list of desktops.
void	SetDesktopCount (const char *width, const char *height)
	Set the number of desktops.
void	SetDesktopName (unsigned int desktop, const char *str)
	Set the name of a desktop.
const char *	GetDesktopName (unsigned int desktop)
	Get the name of a desktop.
void	InitializeDesktops ()
void	StartupDesktops ()
void	ShutdownDesktops ()
void	DestroyDesktops ()
Variables
int	showingDesktop

---

Detailed Description

Header for the desktop management functions.

Author:

Joe Wingbermuehle

Date:

2004-2006

Definition in file desktop.h.

---

Function Documentation

int AboveDesktop

(

)

Switch to the desktop above.

int BelowDesktop

(

)

Switch to the desktop below.

void ChangeDesktop

(

unsigned int

desktop

)

Switch to a specific desktop.

Parameters:

desktop

The desktop to show (0 based).

struct Menu* CreateDesktopMenu

(

unsigned int

mask

)

[read]

Create a menu containing a list of desktops.

Parameters:

mask	A bit mask of desktops to highlight.

Returns:

A menu containing all the desktops.

void DestroyDesktops

(

)

const char* GetDesktopName

(

unsigned int

desktop

)

Get the name of a desktop.

Parameters:

desktop

The desktop (0 based).

Returns:

The name of the desktop.

void InitializeDesktops

(

)

int LeftDesktop

(

)

Switch to the desktop to the left.

int RightDesktop

(

)

Switch to the desktop to the right.

void SetDesktopCount	(	const char *	width,
		const char *	height
	)

Set the number of desktops.

This is called before startup.

Parameters:

width	ASCII representation of number of horizontal desktops.
height	ASCII representation of the number of vertical desktops.

void SetDesktopName	(	unsigned int	desktop,
		const char *	str
	)

Set the name of a desktop.

This is called before startup.

Parameters:

desktop	The desktop to name (0 based).
str	The name to assign.

void ShowDesktop

(

)

Toggle the "show desktop" state.

This will either minimize or restore all items on the current desktop.

void ShutdownDesktops

(

)

void StartupDesktops

(

)

---

Variable Documentation

int showingDesktop