popup.h File Reference

Header for popup functions. More...

Go to the source code of this file.

Defines
#define	POPUP_DELTA   2
	Number of pixels the mouse can move before the popup disappears.
Functions
void	MeasurePopupText (const char *text, int *width, int *height)
	Calculate dimensions of a popup window given the popup text.
void	ShowPopup (int x, int y, const char *text)
	Show a popup window.
void	SetPopupEnabled (int e)
	Set whether or not popups are enabled.
void	SetPopupDelay (const char *str)
	Set the delay before showing popups.
void	SignalPopup (const struct TimeType *now, int x, int y)
	Signal the popup window.
int	ProcessPopupEvent (const XEvent *event)
	Process a popup event.
void	InitializePopup ()
void	StartupPopup ()
void	ShutdownPopup ()
void	DestroyPopup ()
Variables
int	popupDelay
	The popup delay in milliseconds.

---

Detailed Description

Header for popup functions.

Author:

Joe Wingbermuehle

Date:

2004-2006

Definition in file popup.h.

---

Define Documentation

#define POPUP_DELTA   2

Number of pixels the mouse can move before the popup disappears.

Definition at line 14 of file popup.h.

---

Function Documentation

void DestroyPopup

(

)

void InitializePopup

(

)

void MeasurePopupText	(	const char *	text,
		int *	width,
		int *	height
	)

Calculate dimensions of a popup window given the popup text.

Parameters:

text	The text to measure.
width	The width output.
height	The height output.

int ProcessPopupEvent

(

const XEvent *

event

)

Process a popup event.

Parameters:

event

The event to process.

Returns:

1 if handled, 0 otherwise.

void SetPopupDelay

(

const char *

str

)

Set the delay before showing popups.

Parameters:

str	The delay (ASCII, milliseconds).

void SetPopupEnabled

(

int

e

)

Set whether or not popups are enabled.

Parameters:

e	1 to enable popups, 0 to disable popups.

void ShowPopup	(	int	x,
		int	y,
		const char *	text
	)

Show a popup window.

Parameters:

x	The x coordinate of the left edge of the popup window.
y	The y coordinate of the bottom edge of the popup window.
text	The text to display in the popup.

void ShutdownPopup

(

)

void SignalPopup	(	const struct TimeType *	now,
		int	x,
		int	y
	)

Signal the popup window.

Parameters:

now	The effective time of the signal.
x	The x-coordinate of the mouse.
y	The y-coordinate of the mouse.

void StartupPopup

(

)

---

Variable Documentation

int popupDelay

The popup delay in milliseconds.