summaryrefslogtreecommitdiff
path: root/libcaja-private/caja-icon-container.h
blob: d78310d56f8fc760736f0cb6ecb3af1f4c1b41bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */

/* mate-icon-container.h - Icon container widget.

   Copyright (C) 1999, 2000 Free Software Foundation
   Copyright (C) 2000 Eazel, Inc.

   The Mate Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The Mate Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the Mate Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
   Boston, MA 02110-1301, USA.

   Authors: Ettore Perazzoli <ettore@gnu.org>, Darin Adler <darin@bentspoon.com>
*/

#ifndef CAJA_ICON_CONTAINER_H
#define CAJA_ICON_CONTAINER_H

#include <eel/eel-canvas.h>

#include "caja-icon-info.h"

#define CAJA_TYPE_ICON_CONTAINER caja_icon_container_get_type()
#define CAJA_ICON_CONTAINER(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAJA_TYPE_ICON_CONTAINER, CajaIconContainer))
#define CAJA_ICON_CONTAINER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), CAJA_TYPE_ICON_CONTAINER, CajaIconContainerClass))
#define CAJA_IS_ICON_CONTAINER(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAJA_TYPE_ICON_CONTAINER))
#define CAJA_IS_ICON_CONTAINER_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), CAJA_TYPE_ICON_CONTAINER))
#define CAJA_ICON_CONTAINER_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), CAJA_TYPE_ICON_CONTAINER, CajaIconContainerClass))

#define CAJA_ICON_CONTAINER_ICON_DATA(pointer) \
	((CajaIconData *) (pointer))

typedef struct CajaIconData CajaIconData;

typedef void (* CajaIconCallback) (CajaIconData *icon_data,
                                   gpointer callback_data);

typedef struct
{
    int x;
    int y;
    double scale;
} CajaIconPosition;

typedef enum
{
    CAJA_ICON_LAYOUT_L_R_T_B,
    CAJA_ICON_LAYOUT_R_L_T_B,
    CAJA_ICON_LAYOUT_T_B_L_R,
    CAJA_ICON_LAYOUT_T_B_R_L
} CajaIconLayoutMode;

typedef enum
{
    CAJA_ICON_LABEL_POSITION_UNDER,
    CAJA_ICON_LABEL_POSITION_BESIDE
} CajaIconLabelPosition;

#define	CAJA_ICON_CONTAINER_TYPESELECT_FLUSH_DELAY 1000000

typedef struct CajaIconContainerDetails CajaIconContainerDetails;

typedef struct
{
    EelCanvas canvas;
    CajaIconContainerDetails *details;
} CajaIconContainer;

typedef struct
{
    EelCanvasClass parent_slot;

    /* Operations on the container. */
    int          (* button_press) 	          (CajaIconContainer *container,
            GdkEventButton *event);
    void         (* context_click_background) (CajaIconContainer *container,
            GdkEventButton *event);
    void         (* middle_click) 		  (CajaIconContainer *container,
                                           GdkEventButton *event);

    /* Operations on icons. */
    void         (* activate)	  	  (CajaIconContainer *container,
                                       CajaIconData *data);
    void         (* activate_alternate)       (CajaIconContainer *container,
            CajaIconData *data);
    void         (* context_click_selection)  (CajaIconContainer *container,
            GdkEventButton *event);
    void	     (* move_copy_items)	  (CajaIconContainer *container,
                                           const GList *item_uris,
                                           GdkPoint *relative_item_points,
                                           const char *target_uri,
                                           GdkDragAction action,
                                           int x,
                                           int y);
    void	     (* handle_netscape_url)	  (CajaIconContainer *container,
            const char *url,
            const char *target_uri,
            GdkDragAction action,
            int x,
            int y);
    void	     (* handle_uri_list)    	  (CajaIconContainer *container,
            const char *uri_list,
            const char *target_uri,
            GdkDragAction action,
            int x,
            int y);
    void	     (* handle_text)		  (CajaIconContainer *container,
                                           const char *text,
                                           const char *target_uri,
                                           GdkDragAction action,
                                           int x,
                                           int y);
    void	     (* handle_raw)		  (CajaIconContainer *container,
                                       char *raw_data,
                                       int length,
                                       const char *target_uri,
                                       const char *direct_save_uri,
                                       GdkDragAction action,
                                       int x,
                                       int y);

    /* Queries on the container for subclass/client.
     * These must be implemented. The default "do nothing" is not good enough.
     */
    char *	     (* get_container_uri)	  (CajaIconContainer *container);

    /* Queries on icons for subclass/client.
     * These must be implemented. The default "do nothing" is not
     * good enough, these are _not_ signals.
     */
    CajaIconInfo *(* get_icon_images)     (CajaIconContainer *container,
                                           CajaIconData *data,
                                           int icon_size,
                                           GList **emblem_pixbufs,
                                           char **embedded_text,
                                           gboolean for_drag_accept,
                                           gboolean need_large_embeddded_text,
                                           gboolean *embedded_text_needs_loading,
                                           gboolean *has_window_open);
    void         (* get_icon_text)            (CajaIconContainer *container,
            CajaIconData *data,
            char **editable_text,
            char **additional_text,
            gboolean include_invisible);
    char *       (* get_icon_description)     (CajaIconContainer *container,
            CajaIconData *data);
    int          (* compare_icons)            (CajaIconContainer *container,
            CajaIconData *icon_a,
            CajaIconData *icon_b);
    int          (* compare_icons_by_name)    (CajaIconContainer *container,
            CajaIconData *icon_a,
            CajaIconData *icon_b);
    void         (* freeze_updates)           (CajaIconContainer *container);
    void         (* unfreeze_updates)         (CajaIconContainer *container);
    void         (* start_monitor_top_left)   (CajaIconContainer *container,
            CajaIconData *data,
            gconstpointer client,
            gboolean large_text);
    void         (* stop_monitor_top_left)    (CajaIconContainer *container,
            CajaIconData *data,
            gconstpointer client);
    void         (* prioritize_thumbnailing)  (CajaIconContainer *container,
            CajaIconData *data);

    /* Queries on icons for subclass/client.
     * These must be implemented => These are signals !
     * The default "do nothing" is not good enough.
     */
    gboolean     (* can_accept_item)	  (CajaIconContainer *container,
                                           CajaIconData *target,
                                           const char *item_uri);
    gboolean     (* get_stored_icon_position) (CajaIconContainer *container,
            CajaIconData *data,
            CajaIconPosition *position);
    char *       (* get_icon_uri)             (CajaIconContainer *container,
            CajaIconData *data);
    char *       (* get_icon_drop_target_uri) (CajaIconContainer *container,
            CajaIconData *data);

    /* If icon data is NULL, the layout timestamp of the container should be retrieved.
     * That is the time when the container displayed a fully loaded directory with
     * all icon positions assigned.
     *
     * If icon data is not NULL, the position timestamp of the icon should be retrieved.
     * That is the time when the file (i.e. icon data payload) was last displayed in a
     * fully loaded directory with all icon positions assigned.
     */
    gboolean     (* get_stored_layout_timestamp) (CajaIconContainer *container,
            CajaIconData *data,
            time_t *time);
    /* If icon data is NULL, the layout timestamp of the container should be stored.
     * If icon data is not NULL, the position timestamp of the container should be stored.
     */
    gboolean     (* store_layout_timestamp) (CajaIconContainer *container,
            CajaIconData *data,
            const time_t *time);

    /* Notifications for the whole container. */
    void	     (* band_select_started)	  (CajaIconContainer *container);
    void	     (* band_select_ended)	  (CajaIconContainer *container);
    void         (* selection_changed) 	  (CajaIconContainer *container);
    void         (* layout_changed)           (CajaIconContainer *container);

    /* Notifications for icons. */
    void         (* icon_position_changed)    (CajaIconContainer *container,
            CajaIconData *data,
            const CajaIconPosition *position);
    void         (* icon_text_changed)        (CajaIconContainer *container,
            CajaIconData *data,
            const char *text);
    void         (* renaming_icon)            (CajaIconContainer *container,
            GtkWidget *renaming_widget);
    void	     (* icon_stretch_started)     (CajaIconContainer *container,
            CajaIconData *data);
    void	     (* icon_stretch_ended)       (CajaIconContainer *container,
            CajaIconData *data);
    int	     (* preview)		  (CajaIconContainer *container,
                                   CajaIconData *data,
                                   gboolean start_flag);
    void         (* icon_added)               (CajaIconContainer *container,
            CajaIconData *data);
    void         (* icon_removed)             (CajaIconContainer *container,
            CajaIconData *data);
    void         (* cleared)                  (CajaIconContainer *container);
    gboolean     (* start_interactive_search) (CajaIconContainer *container);
} CajaIconContainerClass;

/* GtkObject */
GType             caja_icon_container_get_type                      (void);
GtkWidget *       caja_icon_container_new                           (void);

/* adding, removing, and managing icons */
void              caja_icon_container_clear                         (CajaIconContainer  *view);
gboolean          caja_icon_container_add                           (CajaIconContainer  *view,
        CajaIconData       *data);
void              caja_icon_container_layout_now                    (CajaIconContainer *container);
gboolean          caja_icon_container_remove                        (CajaIconContainer  *view,
        CajaIconData       *data);
void              caja_icon_container_for_each                      (CajaIconContainer  *view,
        CajaIconCallback    callback,
        gpointer                callback_data);
void              caja_icon_container_request_update                (CajaIconContainer  *view,
        CajaIconData       *data);
void              caja_icon_container_request_update_all            (CajaIconContainer  *container);
void              caja_icon_container_reveal                        (CajaIconContainer  *container,
        CajaIconData       *data);
gboolean          caja_icon_container_is_empty                      (CajaIconContainer  *container);
CajaIconData *caja_icon_container_get_first_visible_icon        (CajaIconContainer  *container);
void              caja_icon_container_scroll_to_icon                (CajaIconContainer  *container,
        CajaIconData       *data);

void              caja_icon_container_begin_loading                 (CajaIconContainer  *container);
void              caja_icon_container_end_loading                   (CajaIconContainer  *container,
        gboolean                all_icons_added);

/* control the layout */
gboolean          caja_icon_container_is_auto_layout                (CajaIconContainer  *container);
void              caja_icon_container_set_auto_layout               (CajaIconContainer  *container,
        gboolean                auto_layout);
gboolean          caja_icon_container_is_tighter_layout             (CajaIconContainer  *container);
void              caja_icon_container_set_tighter_layout            (CajaIconContainer  *container,
        gboolean                tighter_layout);

gboolean          caja_icon_container_is_keep_aligned               (CajaIconContainer  *container);
void              caja_icon_container_set_keep_aligned              (CajaIconContainer  *container,
        gboolean                keep_aligned);
gboolean          caja_icon_container_is_lock_icons_position        (CajaIconContainer  *container);
void              caja_icon_container_set_lock_icons_position       (CajaIconContainer *container,
        gboolean lock_icons_position);
void              caja_icon_container_set_layout_mode               (CajaIconContainer  *container,
        CajaIconLayoutMode  mode);
void              caja_icon_container_set_label_position            (CajaIconContainer  *container,
        CajaIconLabelPosition pos);
void              caja_icon_container_sort                          (CajaIconContainer  *container);
void              caja_icon_container_freeze_icon_positions         (CajaIconContainer  *container);

int               caja_icon_container_get_max_layout_lines           (CajaIconContainer  *container);
int               caja_icon_container_get_max_layout_lines_for_pango (CajaIconContainer  *container);

void              caja_icon_container_set_highlighted_for_clipboard (CajaIconContainer  *container,
        GList                  *clipboard_icon_data);

/* operations on all icons */
void              caja_icon_container_unselect_all                  (CajaIconContainer  *view);
void              caja_icon_container_select_all                    (CajaIconContainer  *view);

/* operations on the selection */
GList     *       caja_icon_container_get_selection                 (CajaIconContainer  *view);
void			  caja_icon_container_invert_selection				(CajaIconContainer  *view);
void              caja_icon_container_set_selection                 (CajaIconContainer  *view,
        GList                  *selection);
GArray    *       caja_icon_container_get_selected_icon_locations   (CajaIconContainer  *view);
gboolean          caja_icon_container_has_stretch_handles           (CajaIconContainer  *container);
gboolean          caja_icon_container_is_stretched                  (CajaIconContainer  *container);
void              caja_icon_container_show_stretch_handles          (CajaIconContainer  *container);
void              caja_icon_container_unstretch                     (CajaIconContainer  *container);
void              caja_icon_container_start_renaming_selected_item  (CajaIconContainer  *container,
        gboolean                select_all);

/* options */
CajaZoomLevel caja_icon_container_get_zoom_level                (CajaIconContainer  *view);
void              caja_icon_container_set_zoom_level                (CajaIconContainer  *view,
        int                     new_zoom_level);
void              caja_icon_container_set_single_click_mode         (CajaIconContainer  *container,
        gboolean                single_click_mode);
void              caja_icon_container_enable_linger_selection       (CajaIconContainer  *view,
        gboolean                enable);
gboolean          caja_icon_container_get_is_fixed_size             (CajaIconContainer  *container);
void              caja_icon_container_set_is_fixed_size             (CajaIconContainer  *container,
        gboolean                is_fixed_size);
gboolean          caja_icon_container_get_is_desktop                (CajaIconContainer  *container);
void              caja_icon_container_set_is_desktop                (CajaIconContainer  *container,
        gboolean                is_desktop);
void              caja_icon_container_reset_scroll_region           (CajaIconContainer  *container);
void              caja_icon_container_set_font                      (CajaIconContainer  *container,
        const char             *font);
void              caja_icon_container_set_font_size_table           (CajaIconContainer  *container,
        const int               font_size_table[CAJA_ZOOM_LEVEL_LARGEST + 1]);
void              caja_icon_container_set_margins                   (CajaIconContainer  *container,
        int                     left_margin,
        int                     right_margin,
        int                     top_margin,
        int                     bottom_margin);
void              caja_icon_container_set_use_drop_shadows          (CajaIconContainer  *container,
        gboolean                use_drop_shadows);
char*             caja_icon_container_get_icon_description          (CajaIconContainer  *container,
        CajaIconData       *data);
gboolean          caja_icon_container_get_allow_moves               (CajaIconContainer  *container);
void              caja_icon_container_set_allow_moves               (CajaIconContainer  *container,
        gboolean                allow_moves);
void		  caja_icon_container_set_forced_icon_size		(CajaIconContainer  *container,
        int                     forced_icon_size);
void		  caja_icon_container_set_all_columns_same_width	(CajaIconContainer  *container,
        gboolean                all_columns_same_width);

gboolean	  caja_icon_container_is_layout_rtl			(CajaIconContainer  *container);
gboolean	  caja_icon_container_is_layout_vertical		(CajaIconContainer  *container);

gboolean          caja_icon_container_get_store_layout_timestamps   (CajaIconContainer  *container);
void              caja_icon_container_set_store_layout_timestamps   (CajaIconContainer  *container,
        gboolean                store_layout);

void              caja_icon_container_widget_to_file_operation_position (CajaIconContainer *container,
        GdkPoint              *position);

#define CANVAS_WIDTH(container,allocation) ((allocation.width	  \
				- container->details->left_margin \
				- container->details->right_margin) \
				/  EEL_CANVAS (container)->pixels_per_unit)

#define CANVAS_HEIGHT(container,allocation) ((allocation.height \
			 - container->details->top_margin \
			 - container->details->bottom_margin) \
			 / EEL_CANVAS (container)->pixels_per_unit)

#endif /* CAJA_ICON_CONTAINER_H */