Implemetation of dropping file or folder onto launch bar to create launcher.
[lxde/lxpanel.git] / src / icon-grid.h
CommitLineData
7d17da4d
AG
1/*
2 * Copyright (C) 2014 Andriy Grytsenko <andrej@rep.kiev.ua>
3 *
4 * This file is a part of LXPanel project.
2918994e 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
b840f7cc 21#ifndef __ICON_GRID_H__
de7ff173 22#define __ICON_GRID_H__ 1
2918994e 23
24#include <gtk/gtk.h>
25
de7ff173
AG
26G_BEGIN_DECLS
27
9fac586f
AG
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), \
34ba1c30 36 PANEL_TYPE_ICON_GRID))
9fac586f
AG
37
38extern GType panel_icon_grid_get_type (void) G_GNUC_CONST;
39
40typedef struct _PanelIconGrid PanelIconGrid;
41typedef struct _PanelIconGridClass PanelIconGridClass;
42
43extern GtkWidget * panel_icon_grid_new(
8f9e6256 44 GtkOrientation orientation, gint child_width, gint child_height, gint spacing, gint border, gint target_dimension);
2918994e 45 /* Create an icon grid */
9fac586f 46extern void panel_icon_grid_set_constrain_width(PanelIconGrid * ig, gboolean constrain_width);
b33a8cc6 47 /* Set the constrain-width property */
04544a53
AG
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 */
9633d713 65extern void panel_icon_grid_set_aspect_width(PanelIconGrid * ig, gboolean aspect_width);
04544a53 66
756c623e
AG
67/* extern void panel_icon_grid_set_fill_width(PanelIconGrid * ig, gboolean fill_width);
68 Set the fill-width property */
9fac586f 69extern void panel_icon_grid_set_geometry(PanelIconGrid * ig,
8f9e6256 70 GtkOrientation orientation, gint child_width, gint child_height, gint spacing, gint border, gint target_dimension);
71 /* Change the geometry of an icon grid */
9fac586f 72extern gint panel_icon_grid_get_child_position(PanelIconGrid * ig, GtkWidget * child);
eb713fbc 73 /* Get the index of an icon grid element. */
9fac586f 74extern void panel_icon_grid_reorder_child(PanelIconGrid * ig, GtkWidget * child, gint position);
2918994e 75 /* Reorder the position of a child in the icon grid */
2918994e 76
230200de 77typedef enum {
a4492fd4
AG
78 PANEL_ICON_GRID_DROP_LEFT_AFTER,
79 PANEL_ICON_GRID_DROP_LEFT_BEFORE,
80 PANEL_ICON_GRID_DROP_RIGHT_AFTER,
81 PANEL_ICON_GRID_DROP_RIGHT_BEFORE,
230200de
AG
82 PANEL_ICON_GRID_DROP_BELOW,
83 PANEL_ICON_GRID_DROP_ABOVE,
84 PANEL_ICON_GRID_DROP_INTO
85} PanelIconGridDropPosition;
86
87/**
88 * panel_icon_grid_get_dest_at_pos
89 * @ig: a widget
90 * @x: coordinate to inspect
91 * @y: coordinate to inspect
92 * @child: (allow-none): (out) (transfer none): pointer to return found child
93 * @pos: (allow-none): (out): pointer to return drop position
94 *
95 * Inspects coordinates @x and @y within @ig to contain some child widget.
96 * Returns nearest child widget and position against it.
97 *
98 * Returns: %FALSE if position is not drawable.
99 *
100 * Since: 0.9.0
101 */
102gboolean panel_icon_grid_get_dest_at_pos(PanelIconGrid * ig, gint x, gint y,
103 GtkWidget ** child, PanelIconGridDropPosition * pos);
104
105/**
106 * panel_icon_grid_set_drag_dest
107 * @ig: a widget
108 * @child: (allow-none): pointer to a child
109 * @pos: drop position to draw
110 *
111 * Queues drawing of focus for given @child and @pos. If @child is %NULL
112 * then nothing will be drawn. In any case previous focus will be wiped.
113 *
114 * Since: 0.9.0
115 */
116void panel_icon_grid_set_drag_dest(PanelIconGrid * ig, GtkWidget * child,
117 PanelIconGridDropPosition pos);
118
a4492fd4
AG
119/**
120 * panel_icon_grid_get_drag_dest
121 * @ig: a widget
122 * @child: (allow-none): pointer to pointer to a child
123 *
124 * Retrieves data last set with panel_icon_grid_set_drag_dest()
125 *
126 * Returns: position to drop.
127 *
128 * Since: 0.9.0
129 */
130PanelIconGridDropPosition panel_icon_grid_get_drag_dest(PanelIconGrid * ig,
131 GtkWidget ** child);
132
de7ff173
AG
133G_END_DECLS
134
2918994e 135#endif