d0004a85fc4b17d36f2b5a80184c11a94c32e04f
[debian/lxpanel.git] / src / icon-grid.h
1 /*
2 * Copyright (C) 2014 Andriy Grytsenko <andrej@rep.kiev.ua>
3 *
4 * This file is a part of LXPanel project.
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 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 */
20
21 #ifndef __ICON_GRID_H__
22 #define __ICON_GRID_H__ 1
23
24 #include <gtk/gtk.h>
25
26 G_BEGIN_DECLS
27
28 #define PANEL_TYPE_ICON_GRID (panel_icon_grid_get_type())
29 #define PANEL_ICON_GRID(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), \
30 PANEL_TYPE_ICON_GRID, PanelIconGrid))
31 #define PANEL_ICON_GRID_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), \
32 PANEL_TYPE_ICON_GRID, PanelIconGridClass))
33 #define PANEL_IS_ICON_GRID(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
34 PANEL_TYPE_ICON_GRID))
35 #define PANEL_IS_ICON_GRID_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), \
36 PANEL_TYPE_ICON_GRID))
37
38 extern GType panel_icon_grid_get_type (void) G_GNUC_CONST;
39
40 typedef struct _PanelIconGrid PanelIconGrid;
41 typedef struct _PanelIconGridClass PanelIconGridClass;
42
43 extern GtkWidget * panel_icon_grid_new(
44 GtkOrientation orientation, gint child_width, gint child_height, gint spacing, gint border, gint target_dimension);
45 /* Create an icon grid */
46 extern void panel_icon_grid_set_constrain_width(PanelIconGrid * ig, gboolean constrain_width);
47 /* Set the constrain-width property */
48 /**
49 * panel_icon_grid_set_aspect_width
50 * @ig: a widget
51 * @aspect_width: value to set
52 *
53 * Changes #PanelIconGrid::aspect-width property on the @ig. The property
54 * enables or disables taking icons aspect into consideration for @ig.
55 * If disabled then all icons will have the same size (child_width) as
56 * defined for widget. If enabled then child_width will be ignored but
57 * icons aspect will be taken into consideration when children space is
58 * allocated.
59 * Note that if #PanelIconGrid::constrain-width is set to %TRUE then the
60 * #PanelIconGrid::aspect-width is ignored and behavior of widget is that
61 * if #PanelIconGrid::aspect-width is set to %FALSE.
62 *
63 * Since: 0.8.0
64 */
65 extern void panel_icon_grid_set_aspect_width(PanelIconGrid * ig, gboolean aspect_width);
66
67 /* extern void panel_icon_grid_set_fill_width(PanelIconGrid * ig, gboolean fill_width);
68 Set the fill-width property */
69 extern void panel_icon_grid_set_geometry(PanelIconGrid * ig,
70 GtkOrientation orientation, gint child_width, gint child_height, gint spacing, gint border, gint target_dimension);
71 /* Change the geometry of an icon grid */
72 extern gint panel_icon_grid_get_child_position(PanelIconGrid * ig, GtkWidget * child);
73 /* Get the index of an icon grid element. */
74 extern void panel_icon_grid_reorder_child(PanelIconGrid * ig, GtkWidget * child, gint position);
75 /* Reorder the position of a child in the icon grid */
76
77 G_END_DECLS
78
79 #endif