aboutsummaryrefslogtreecommitdiff
path: root/src/traybutton.h
blob: bd22494976b35800ad7b6643ae39fca00fd41605 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/**
 * @file traybutton.h
 * @author Joe Wingbermuehle
 * @date 2004-2006
 *
 * @brief Tray button tray component.
 *
 */

#ifndef TRAY_BUTTON_H
#define TRAY_BUTTON_H

struct TrayComponentType;
struct TimeType;

/*@{*/
void InitializeTrayButtons();
void StartupTrayButtons();
void ShutdownTrayButtons();
void DestroyTrayButtons();
/*@}*/

/** Create a tray button component.
 * @param iconName The name of the icon to use for the button.
 * @param label The label to use for the button.
 * @param action The action to take when the button is clicked.
 * @param popup Text to display in a popup window.
 * @param width The width to use for the button (0 for default).
 * @param height The height to use for the button (0 for default).
 * @return A new tray button component.
 */
struct TrayComponentType *CreateTrayButton(
	const char *iconName, const char *label, const char *action,
	const char *popup, int width, int height);

/** Signal a tray button.
 * @param now The current time.
 * @param x The x-coordinate of the mouse (root relative).
 * @param y The y-coordinate of the mouse (root relative).
 */
void SignalTrayButton(const struct TimeType *now, int x, int y);

/** Validate the tray buttons and print a warning if something is wrong.
 * This is called after parsing the configuration file(s) to determine
 * if a root menu is defined for each each tray button that specifies
 * a root menu.
 */
void ValidateTrayButtons();

#endif