Fix memory leak from expand_tilda() in dirmenu plugin.
[lxde/lxpanel.git] / src / private.h
CommitLineData
b31cb1d2
AG
1/**
2 * Copyright (c) 2006 LxDE Developers, see the file AUTHORS for details.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19#ifndef PRIVATE_H
20#define PRIVATE_H
21
17fab6e5
AG
22#include "plugin.h"
23#include "conf.h"
b31cb1d2
AG
24
25#include <gmodule.h>
26
27#include <gtk/gtk.h>
28#include <gdk/gdk.h>
29#include <stdio.h>
30#include "panel.h"
31
32#include <gdk/gdk.h>
33
34#include "bg.h"
35#include "ev.h"
36
908d9fdc
AG
37/* -----------------------------------------------------------------------------
38 * Definitions used by lxpanel main code internally */
39
b31cb1d2
AG
40/* Extracted from panel.h */
41enum { ALLIGN_NONE, ALLIGN_LEFT, ALLIGN_CENTER, ALLIGN_RIGHT };
42enum { EDGE_NONE=0, EDGE_LEFT, EDGE_RIGHT, EDGE_TOP, EDGE_BOTTOM };
43enum { WIDTH_NONE, WIDTH_REQUEST, WIDTH_PIXEL, WIDTH_PERCENT };
44enum { HEIGHT_NONE, HEIGHT_PIXEL, HEIGHT_REQUEST };
45enum {
46 ORIENT_NONE = -1,
47 ORIENT_VERT = GTK_ORIENTATION_VERTICAL,
48 ORIENT_HORIZ = GTK_ORIENTATION_HORIZONTAL
49};
b31cb1d2
AG
50
51#define PANEL_ICON_SIZE 24 /* Default size of panel icons */
52#define PANEL_HEIGHT_DEFAULT 26 /* Default height of horizontal panel */
53#define PANEL_WIDTH_DEFAULT 150 /* Default "height" of vertical panel */
54#define PANEL_HEIGHT_MAX 200 /* Maximum height of panel */
55#define PANEL_HEIGHT_MIN 16 /* Minimum height of panel */
56#define PANEL_ICON_HIGHLIGHT 0x202020 /* Constant to pass to icon loader */
57
58/* to check if we are in LXDE */
59extern gboolean is_in_lxde;
60
61/* Context of a panel on a given edge. */
62struct _Panel {
63 char* name;
64 GtkWidget * topgwin; /* Main panel window */
65 Window topxwin; /* Main panel's X window */
66 GdkDisplay * display; /* Main panel's GdkDisplay */
67 GtkStyle * defstyle;
68 GtkIconTheme* icon_theme; /*Default icon theme*/
69
70 GtkWidget * box; /* Top level widget */
71
72 GtkRequisition requisition;
73 GtkWidget *(*my_box_new) (gboolean, gint);
74 GtkWidget *(*my_separator_new) ();
75
76 FbBg *bg;
77 int alpha;
78 guint32 tintcolor;
79 guint32 fontcolor;
80 GdkColor gtintcolor;
81 GdkColor gfontcolor;
82
83 int ax, ay, aw, ah; /* prefferd allocation of a panel */
84 int cx, cy, cw, ch; /* current allocation (as reported by configure event) allocation */
85 int allign, edge, margin;
86 int orientation;
87 int widthtype, width;
88 int heighttype, height;
89 gint monitor;
90 gulong strut_size; /* Values for WM_STRUT_PARTIAL */
91 gulong strut_lower;
92 gulong strut_upper;
93 int strut_edge;
94
95 guint config_changed : 1;
96 guint self_destroy : 1;
97 guint setdocktype : 1;
98 guint setstrut : 1;
99 guint round_corners : 1;
100 guint usefontcolor : 1;
101 guint usefontsize : 1;
102 guint fontsize;
103 guint transparent : 1;
104 guint background : 1;
105 guint spacing;
106
107 guint autohide : 1;
108 guint visible : 1;
109 int height_when_hidden;
110 guint hide_timeout;
111 int icon_size; /* Icon size */
112
113 int desknum;
114 int curdesk;
115 guint32 *workarea;
116 int wa_len;
117
118 char* background_file;
119
b31cb1d2 120 GSList * system_menus; /* List of plugins having menus */
17fab6e5 121 PanelConf * config; /* Panel configuration data */
b31cb1d2
AG
122
123 GtkWidget* plugin_pref_dialog; /* Plugin preference dialog */
124 GtkWidget* pref_dialog; /* preference dialog */
125 GtkWidget* margin_control; /* Margin control in preference dialog */
126 GtkWidget* height_label; /* Label of height control */
127 GtkWidget* width_label; /* Label of width control */
128 GtkWidget* alignment_left_label; /* Label of alignment: left control */
129 GtkWidget* alignment_right_label; /* Label of alignment: right control */
130 GtkWidget* height_control; /* Height control in preference dialog */
131 GtkWidget* width_control; /* Width control in preference dialog */
de5a8e6c
AG
132
133 //gint dyn_space; /* Space for expandable plugins */
134 //guint calculate_size_idle; /* The idle handler for dyn_space calc */
b31cb1d2
AG
135};
136
137typedef struct {
138 char *name;
139 char *disp_name;
140 void (*cmd)(void);
141} Command;
142
143extern Command commands[];
144
145extern FbEv *fbev;
146
147#define FBPANEL_WIN(win) gdk_window_lookup(win)
148
b31cb1d2 149/* Extracted from misc.h */
b31cb1d2
AG
150typedef struct {
151 int num;
152 gchar *str;
153} pair;
154
155extern pair allign_pair[];
156extern pair edge_pair[];
157extern pair width_pair[];
158extern pair height_pair[];
159extern pair bool_pair[];
b31cb1d2 160
17fab6e5
AG
161int str2num(pair *p, const gchar *str, int defval);
162const gchar *num2str(pair *p, int num, const gchar *defval);
b31cb1d2 163
908d9fdc
AG
164char* get_config_file( const char* profile, const char* file_name, gboolean is_global );
165
de5a8e6c
AG
166//void _queue_panel_calculate_size(Panel *panel);
167
049061d8
AG
168/* FIXME: optional definitions */
169#define STATIC_SEPARATOR
170#define STATIC_LAUNCHBAR
171#define STATIC_DCLOCK
172#define STATIC_WINCMD
173#define STATIC_DIRMENU
174#define STATIC_TASKBAR
175#define STATIC_PAGER
176#define STATIC_TRAY
177#define STATIC_MENU
178#define STATIC_SPACE
179#define STATIC_ICONS
180
181/* Plugins management - new style */
182void _prepare_modules(void);
183void _unload_modules(void);
184
185GtkWidget *lxpanel_add_plugin(Panel *p, const char *name, config_setting_t *cfg, gint at);
186GHashTable *lxpanel_get_all_types(void); /* transfer none */
187
188GQuark lxpanel_plugin_qinit; /* access to LXPanelPluginInit data */
189#define PLUGIN_CLASS(_i) ((LXPanelPluginInit*)g_object_get_qdata(G_OBJECT(_i),lxpanel_plugin_qinit))
190
191GQuark lxpanel_plugin_qconf; /* access to congig_setting_t data */
192
193GQuark lxpanel_plugin_qpanel; /* access to Panel */
194#define PLUGIN_PANEL(_i) ((Panel*)g_object_get_qdata(G_OBJECT(_i),lxpanel_plugin_qpanel))
908d9fdc
AG
195
196/* -----------------------------------------------------------------------------
197 * Deprecated declarations. Kept for compatibility with old code plugins.
198 * Should be removed and appropriate code cleaned on some of next releases. */
199
8dfa5918 200/* Extracted from panel.h */
f9e8104e
AG
201extern int verbose;
202
203/* if current window manager is EWMH conforming. */
204extern gboolean is_ewmh_supported;
205
206/*
207 This function is used to re-create a new box with different
208 orientation from the old one, add all children of the old one to
209 the new one, and then destroy the old box.
210 It's mainly used when we need to change the orientation of the panel or
211 any plugin with a layout box. Since GtkHBox cannot be changed to GtkVBox,
212 recreating a new box to replace the old one is required.
213*/
214GtkWidget* recreate_box( GtkBox* oldbox, GtkOrientation orientation );
215
8dfa5918
AG
216extern const char* lxpanel_get_file_manager();
217
218
908d9fdc
AG
219/* Extracted from misc.h */
220typedef struct _Plugin Plugin;
221
222enum { LINE_NONE, LINE_BLOCK_START, LINE_BLOCK_END, LINE_VAR };
223
224typedef struct {
225 int num, len, type;
226 gchar str[256];
227 gchar *t[3];
228} line;
229
230
b31cb1d2
AG
231extern int lxpanel_get_line(char **fp, line *s);
232extern int lxpanel_put_line(FILE* fp, const char* format, ...);
233#define lxpanel_put_str(fp, name, val) (G_UNLIKELY( !(val) || !*(val) )) ? 0 : lxpanel_put_line(fp, "%s=%s", name, val)
234#define lxpanel_put_bool(fp, name, val) lxpanel_put_line(fp, "%s=%c", name, (val) ? '1' : '0')
235#define lxpanel_put_int(fp, name, val) lxpanel_put_line(fp, "%s=%d", name, val)
b31cb1d2
AG
236
237GtkWidget *_gtk_image_new_from_file_scaled(const gchar *file, gint width,
238 gint height, gboolean keep_ratio);
239
c8e5ebb2
AG
240GtkWidget * fb_button_new_from_file(
241 const gchar * image_file, int width, int height, gulong highlight_color, gboolean keep_ratio);
242GtkWidget * fb_button_new_from_file_with_label(
243 const gchar * image_file, int width, int height, gulong highlight_color, gboolean keep_ratio, Panel * panel, gchar * label);
244
245void fb_button_set_from_file(GtkWidget* btn, const char* img_file, gint width, gint height, gboolean keep_ratio);
246
b31cb1d2
AG
247char* translate_exec_to_cmd( const char* exec, const char* icon,
248 const char* title, const char* fpath );
249
250void show_error( GtkWindow* parent_win, const char* msg );
251
aaaef690
AG
252gboolean spawn_command_async(GtkWindow *parent_window, gchar const* workdir,
253 gchar const* cmd);
254
b31cb1d2
AG
255/* Parameters: const char* name, gpointer ret_value, GType type, ....NULL */
256GtkWidget* create_generic_config_dlg( const char* title, GtkWidget* parent,
257 GSourceFunc apply_func, Plugin * plugin,
258 const char* name, ... );
259
260extern GtkMenu* lxpanel_get_panel_menu( Panel* panel, Plugin* plugin, gboolean use_sub_menu );
261
262gboolean lxpanel_launch_app(const char* exec, GList* files, gboolean in_terminal, char const* in_workdir);
263
63e2d9e5
AG
264extern GdkPixbuf* lxpanel_load_icon( const char* name, int width, int height, gboolean use_fallback );
265
b31cb1d2
AG
266
267/* Extracted from plugin.h */
268struct _Plugin;
269
270/* Support for external plugin versioning.
271 * Plugins must invoke PLUGINCLASS_VERSIONING when they instantiate PluginClass. */
272#define PLUGINCLASS_VERSION 1
273#define PLUGINCLASS_VERSIONING \
274 .structure_size = sizeof(PluginClass), \
275 .structure_version = PLUGINCLASS_VERSION
276
277/* Representative of an available plugin. */
278typedef struct {
279
280 /* Keep these first. Do not make unnecessary changes in structure layout. */
281 unsigned short structure_size; /* Structure size, for versioning support */
282 unsigned short structure_version; /* Structure version, for versioning support */
283
284 char * fname; /* Plugin file pathname */
285 int count; /* Reference count */
286 GModule * gmodule; /* Associated GModule structure */
287
288 int dynamic : 1; /* True if dynamically loaded */
289 int unused_invisible : 1; /* Unused; reserved bit */
290 int not_unloadable : 1; /* Not unloadable due to GModule restriction */
291 int one_per_system : 1; /* Special: only one possible per system, such as system tray */
292 int one_per_system_instantiated : 1; /* True if one instance exists */
293 int expand_available : 1; /* True if "stretch" option is available */
294 int expand_default : 1; /* True if "stretch" option is default */
295
296 /* These fields point within the plugin image. */
297 char * type; /* Internal name of plugin, to match external filename */
298 char * name; /* Display name of plugin for selection UI */
299 char * version; /* Version of plugin */
300 char * description; /* Brief textual description of plugin for selection UI */
301
302 int (*constructor)(struct _Plugin * plugin, char ** fp); /* Create an instance of the plugin */
303 void (*destructor)(struct _Plugin * plugin); /* Destroy an instance of the plugin */
304 void (*config)(struct _Plugin * plugin, GtkWindow * parent); /* Request the plugin to display its configuration dialog */
305 void (*save)(struct _Plugin * plugin, FILE * fp); /* Request the plugin to save its configuration to a file */
306 void (*panel_configuration_changed)(struct _Plugin * plugin); /* Request the plugin to do a full redraw after a panel configuration change */
307} PluginClass;
308
309/* Representative of a loaded and active plugin attached to a panel. */
310struct _Plugin {
311 PluginClass * class; /* Back pointer to PluginClass */
312 Panel * panel; /* Back pointer to Panel */
313 GtkWidget * pwid; /* Top level widget; plugin allocates, but plugin mechanism, not plugin itself, destroys this */
314 int expand; /* Expand ("stretch") setting for container */
315 int padding; /* Padding setting for container */
316 int border; /* Border setting for container */
317 gpointer priv; /* Private context for plugin; plugin frees this in its destructor */
318};
319
320/* Plugins management - deprecated style, for backward compatibility */
b31cb1d2
AG
321extern gboolean plugin_button_press_event(GtkWidget *widget, GdkEventButton *event, Plugin *plugin);
322 /* Handler for "button_press_event" signal with Plugin as parameter */
323extern void plugin_adjust_popup_position(GtkWidget * popup, Plugin * plugin);
324 /* Helper to move popup windows away from the panel */
325extern void plugin_popup_set_position_helper(Plugin * p, GtkWidget * near, GtkWidget * popup, GtkRequisition * popup_req, gint * px, gint * py);
326 /* Helper for position-calculation callback for popup menus */
327
b31cb1d2 328#endif