Merging upstream version 0.8.1.
[debian/lxpanel.git] / src / panel.h
1 /**
2 * Copyright (c) 2006-2014 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 __PANEL_H__
20 #define __PANEL_H__ 1
21
22 #include <X11/Xlib.h>
23 #include <gtk/gtk.h>
24
25 G_BEGIN_DECLS
26
27 /**
28 * LXPANEL_CHECK_VERSION
29 *
30 * A simple macro for plugins to check features.
31 *
32 * Since: 0.8.0
33 */
34 #define LXPANEL_CHECK_VERSION(_a,_b,_c) \
35 (0 > _a || \
36 (0 == _a && 8 > _b) || \
37 (0 == _a && 8 == _b && 1 >= _c))
38
39
40 #define LX_TYPE_PANEL (lxpanel_get_type())
41 #define LXPANEL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
42 LX_TYPE_PANEL, LXPanel))
43 #define LXPANEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), \
44 LX_TYPE_PANEL, LXPanelClass))
45 #define LX_IS_PANEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
46 LX_TYPE_PANEL))
47
48 extern GType lxpanel_get_type (void) G_GNUC_CONST;
49
50 /* A little trick to be compatible with some themes which rely on the
51 PanelToplevel class, so we use LXPanel as alias for PanelToplevel */
52 typedef struct _LXPanel LXPanel;
53 typedef struct _LXPanel PanelToplevel;
54 typedef struct _LXPanelClass PanelToplevelClass;
55
56 typedef struct _Panel Panel;
57
58 struct _LXPanel
59 {
60 GtkWindow window;
61 Panel *priv;
62 };
63
64 /**
65 * LXPanelClass:
66 * @parent_class: The parent class.
67 * @icon_size_changed: callback for "icon-size-changed" signal, emitted when
68 * icons size for panel is changed in the configuration dialog.
69 * @panel_font_changed: callback for "panel-font-changed" signal, emitted when
70 * custom font enabled, disabled or its metrics or color changed
71 * in the panel configuration dialog.
72 */
73 struct _LXPanelClass
74 {
75 GtkWindowClass parent_class;
76 void (*icon_size_changed)(LXPanel *panel);
77 void (*panel_font_changed)(LXPanel *panel);
78 };
79
80 /**
81 * panel_apply_icon
82 * @w: a window to apply
83 *
84 * Sets appropriate icon as the window icon for @w.
85 */
86 extern void panel_apply_icon(GtkWindow *w);
87
88 /**
89 * lxpanel_draw_label_text
90 * @p: a panel instance
91 * @label: a label widget
92 * @text: (allow-none): text for the label
93 * @bold: %TRUE if text should be bold
94 * @custom_size_factor: scale factor for font size
95 * @custom_color: %TRUE to use font color from panel settings
96 *
97 * Changes @label to contain @text with appropriate attributes using the
98 * panel @p settings.
99 */
100 extern void lxpanel_draw_label_text(LXPanel * p, GtkWidget * label, const char * text,
101 gboolean bold, float custom_size_factor,
102 gboolean custom_color);
103
104 /**
105 * lxpanel_config_save
106 * @p: a panel instance
107 *
108 * Immediately saves current configuration for panel @p.
109 */
110 void lxpanel_config_save(LXPanel *p); /* defined in configurator.c */
111
112 /* Accessors APIs for Panel* */
113 extern GtkOrientation panel_get_orientation(LXPanel *panel);
114 extern gint panel_get_icon_size(LXPanel *panel);
115 extern gint panel_get_height(LXPanel *panel);
116 extern Window panel_get_xwindow(LXPanel *panel);
117 extern gint panel_get_monitor(LXPanel *panel);
118 extern GtkStyle *panel_get_defstyle(LXPanel *panel);
119 extern GtkIconTheme *panel_get_icon_theme(LXPanel *panel);
120 extern gboolean panel_is_at_bottom(LXPanel *panel);
121 extern gboolean panel_is_dynamic(LXPanel *panel);
122 extern GtkWidget *panel_box_new(LXPanel *panel, gboolean homogeneous, gint spacing);
123 extern GtkWidget *panel_separator_new(LXPanel *panel);
124
125 G_END_DECLS
126
127 #endif