Fix bug #4877 (Some harmless code quirks involving booleans)
[dana/openbox.git] / openbox / popup.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    popup.h for the Openbox window manager
4    Copyright (c) 2003-2007   Dana Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef __popup_h
20 #define __popup_h
21
22 #include "window.h"
23 #include "obrender/render.h"
24 #include <glib.h>
25
26 struct _ObClientIcon;
27
28 #define POPUP_WIDTH 320
29 #define POPUP_HEIGHT 48
30
31 typedef struct _ObPopup      ObPopup;
32 typedef struct _ObIconPopup  ObIconPopup;
33 typedef struct _ObPagerPopup ObPagerPopup;
34
35 struct _ObPopup
36 {
37     ObWindow obwin;
38     Window bg;
39
40     Window text;
41
42     gboolean hasicon;
43     RrAppearance *a_bg;
44     RrAppearance *a_text;
45     gint gravity;
46     gint x;
47     gint y;
48     gint textw;
49     gint h;
50     gint minw;
51     gint maxw;
52     guint iconwm; /* icon width multiplier. multiplied by the normal width */
53     guint iconhm; /* icon height multiplier. multipled by the normal height */
54     gboolean mapped;
55     gboolean delay_mapped;
56     guint delay_timer;
57
58     void (*draw_icon)(gint x, gint y, gint w, gint h, gpointer data);
59     gpointer draw_icon_data;
60 };
61
62 struct _ObIconPopup
63 {
64     ObPopup *popup;
65
66     Window icon;
67     RrAppearance *a_icon;
68 };
69
70 struct _ObPagerPopup
71 {
72     ObPopup *popup;
73
74     guint desks;
75     guint curdesk;
76     Window *wins;
77     RrAppearance *hilight;
78     RrAppearance *unhilight;
79 };
80
81 ObPopup *popup_new(void);
82 void popup_free(ObPopup *self);
83
84 /*! Position the popup. The gravity rules are not the same X uses for windows,
85   instead of the position being the top-left of the window, the gravity
86   specifies which corner of the popup will be placed at the given coords.
87   Static and Forget gravity are equivilent to NorthWest.
88 */
89 void popup_position(ObPopup *self, gint gravity, gint x, gint y);
90 /*! Set the sizes for the popup. When set to 0, the size will be based on
91   the text size. */
92 void popup_height(ObPopup *self, gint w);
93 void popup_min_width(ObPopup *self, gint minw);
94 void popup_max_width(ObPopup *self, gint maxw);
95 void popup_text_width(ObPopup *self, gint w);
96 void popup_text_width_to_string(ObPopup *self, gchar *text);
97 void popup_height_to_string(ObPopup *self, gchar *text);
98 void popup_text_width_to_strings(ObPopup *self, gchar **strings, gint num);
99
100 void popup_set_text_align(ObPopup *self, RrJustify align);
101
102 #define popup_show(s, t) popup_delay_show((s),0,(t))
103 void popup_delay_show(ObPopup *self, gulong msec, gchar *text);
104 void popup_hide(ObPopup *self);
105
106 RrAppearance *popup_icon_appearance(ObPopup *self);
107
108
109 ObIconPopup *icon_popup_new(void);
110 void icon_popup_free(ObIconPopup *self);
111
112 #define icon_popup_show(s, t, i) icon_popup_delay_show((s),0,(t),(i))
113 void icon_popup_delay_show(ObIconPopup *self, gulong msec,
114                            gchar *text, RrImage *icon);
115 #define icon_popup_hide(p) popup_hide((p)->popup)
116 #define icon_popup_position(p, g, x, y) popup_position((p)->popup,(g),(x),(y))
117 #define icon_popup_text_width(p, w) popup_text_width((p)->popup,(w))
118 #define icon_popup_height(p, h) popup_height((p)->popup,(h))
119 #define icon_popup_min_width(p, m) popup_min_width((p)->popup,(m))
120 #define icon_popup_max_width(p, m) popup_max_width((p)->popup,(m))
121 #define icon_popup_text_width_to_string(p, s) \
122     popup_text_width_to_string((p)->popup,(s))
123 #define icon_popup_text_width_to_strings(p, s, n) \
124     popup_text_width_to_strings((p)->popup,(s),(n))
125 #define icon_popup_set_text_align(p, j) popup_set_text_align((p)->popup,(j))
126 void icon_popup_icon_size_multiplier(ObIconPopup *self, guint wm, guint hm);
127
128 ObPagerPopup *pager_popup_new(void);
129 void pager_popup_free(ObPagerPopup *self);
130
131 #define pager_popup_show(s, t, d) pager_popup_delay_show((s),0,(t),(d))
132 void pager_popup_delay_show(ObPagerPopup *self, gulong msec,
133                             gchar *text, guint desk);
134 #define pager_popup_hide(p) popup_hide((p)->popup)
135 #define pager_popup_position(p, g, x, y) popup_position((p)->popup,(g),(x),(y))
136 #define pager_popup_text_width(p, w) popup_text_width((p)->popup,(w))
137 #define pager_popup_height(p, h) popup_height((p)->popup,(h))
138 #define pager_popup_min_width(p, m) popup_min_width((p)->popup,(m))
139 #define pager_popup_max_width(p, m) popup_max_width((p)->popup,(m))
140 #define pager_popup_text_width_to_string(p, s) \
141     popup_text_width_to_string((p)->popup,(s))
142 #define pager_popup_text_width_to_strings(p, s, n) \
143     popup_text_width_to_strings((p)->popup,(s),(n))
144 #define pager_popup_set_text_align(p, j) popup_set_text_align((p)->popup,(j))
145 void pager_popup_icon_size_multiplier(ObPagerPopup *self, guint wm, guint hm);
146
147 #endif