1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 popup.h for the Openbox window manager
4 Copyright (c) 2003-2007 Dana Jansens
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.
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.
16 See the COPYING file for a copy of the GNU General Public License.
23 #include "render/render.h"
28 #define POPUP_WIDTH 320
29 #define POPUP_HEIGHT 48
31 typedef struct _ObPopup ObPopup;
32 typedef struct _ObIconPopup ObIconPopup;
33 typedef struct _ObPagerPopup ObPagerPopup;
52 guint iconwm; /* icon width multiplier. multiplied by the normal width */
53 guint iconhm; /* icon height multiplier. multipled by the normal height */
55 gboolean delay_mapped;
57 void (*draw_icon)(gint x, gint y, gint w, gint h, gpointer data);
58 gpointer draw_icon_data;
76 RrAppearance *hilight;
77 RrAppearance *unhilight;
80 ObPopup *popup_new(void);
81 void popup_free(ObPopup *self);
83 /*! Position the popup. The gravity rules are not the same X uses for windows,
84 instead of the position being the top-left of the window, the gravity
85 specifies which corner of the popup will be placed at the given coords.
86 Static and Forget gravity are equivilent to NorthWest.
88 void popup_position(ObPopup *self, gint gravity, gint x, gint y);
89 /*! Set the sizes for the popup. When set to 0, the size will be based on
91 void popup_height(ObPopup *self, gint w);
92 void popup_min_width(ObPopup *self, gint minw);
93 void popup_max_width(ObPopup *self, gint maxw);
94 void popup_text_width(ObPopup *self, gint w);
95 void popup_text_width_to_string(ObPopup *self, gchar *text);
96 void popup_height_to_string(ObPopup *self, gchar *text);
97 void popup_text_width_to_strings(ObPopup *self, gchar **strings, gint num);
99 void popup_set_text_align(ObPopup *self, RrJustify align);
101 #define popup_show(s, t) popup_delay_show((s),0,(t))
102 void popup_delay_show(ObPopup *self, gulong usec, gchar *text);
103 void popup_hide(ObPopup *self);
105 RrAppearance *popup_icon_appearance(ObPopup *self);
108 ObIconPopup *icon_popup_new(void);
109 void icon_popup_free(ObIconPopup *self);
111 #define icon_popup_show(s, t, i) icon_popup_delay_show((s),0,(t),(i))
112 void icon_popup_delay_show(ObIconPopup *self, gulong usec,
113 gchar *text, RrImage *icon);
114 #define icon_popup_hide(p) popup_hide((p)->popup)
115 #define icon_popup_position(p, g, x, y) popup_position((p)->popup,(g),(x),(y))
116 #define icon_popup_text_width(p, w) popup_text_width((p)->popup,(w))
117 #define icon_popup_height(p, h) popup_height((p)->popup,(h))
118 #define icon_popup_min_width(p, m) popup_min_width((p)->popup,(m))
119 #define icon_popup_max_width(p, m) popup_max_width((p)->popup,(m))
120 #define icon_popup_text_width_to_string(p, s) \
121 popup_text_width_to_string((p)->popup,(s))
122 #define icon_popup_text_width_to_strings(p, s, n) \
123 popup_text_width_to_strings((p)->popup,(s),(n))
124 #define icon_popup_set_text_align(p, j) popup_set_text_align((p)->popup,(j))
125 void icon_popup_icon_size_multiplier(ObIconPopup *self, guint wm, guint hm);
127 ObPagerPopup *pager_popup_new(void);
128 void pager_popup_free(ObPagerPopup *self);
130 #define pager_popup_show(s, t, d) pager_popup_delay_show((s),0,(t),(d))
131 void pager_popup_delay_show(ObPagerPopup *self, gulong usec,
132 gchar *text, guint desk);
133 #define pager_popup_hide(p) popup_hide((p)->popup)
134 #define pager_popup_position(p, g, x, y) popup_position((p)->popup,(g),(x),(y))
135 #define pager_popup_text_width(p, w) popup_text_width((p)->popup,(w))
136 #define pager_popup_height(p, h) popup_height((p)->popup,(h))
137 #define pager_popup_min_width(p, m) popup_min_width((p)->popup,(m))
138 #define pager_popup_max_width(p, m) popup_max_width((p)->popup,(m))
139 #define pager_popup_text_width_to_string(p, s) \
140 popup_text_width_to_string((p)->popup,(s))
141 #define pager_popup_text_width_to_strings(p, s, n) \
142 popup_text_width_to_strings((p)->popup,(s),(n))
143 #define pager_popup_set_text_align(p, j) popup_set_text_align((p)->popup,(j))
144 void pager_popup_icon_size_multiplier(ObPagerPopup *self, guint wm, guint hm);