1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
2 
3 /* Caja - Icon canvas item class for icon container.
4  *
5  * Copyright (C) 2000 Eazel, Inc.
6  *
7  * Author: Andy Hertzfeld <andy@eazel.com>
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public
20  * License along with this library; if not, write to the
21  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24 
25 #ifndef CAJA_ICON_CANVAS_ITEM_H
26 #define CAJA_ICON_CANVAS_ITEM_H
27 
28 #include <eel/eel-canvas.h>
29 #include <eel/eel-art-extensions.h>
30 
31 G_BEGIN_DECLS
32 
33 #define CAJA_TYPE_ICON_CANVAS_ITEM caja_icon_canvas_item_get_type()
34 #define CAJA_ICON_CANVAS_ITEM(obj) \
35   (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAJA_TYPE_ICON_CANVAS_ITEM, CajaIconCanvasItem))
36 #define CAJA_ICON_CANVAS_ITEM_CLASS(klass) \
37   (G_TYPE_CHECK_CLASS_CAST ((klass), CAJA_TYPE_ICON_CANVAS_ITEM, CajaIconCanvasItemClass))
38 #define CAJA_IS_ICON_CANVAS_ITEM(obj) \
39   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAJA_TYPE_ICON_CANVAS_ITEM))
40 #define CAJA_IS_ICON_CANVAS_ITEM_CLASS(klass) \
41   (G_TYPE_CHECK_CLASS_TYPE ((klass), CAJA_TYPE_ICON_CANVAS_ITEM))
42 #define CAJA_ICON_CANVAS_ITEM_GET_CLASS(obj) \
43   (G_TYPE_INSTANCE_GET_CLASS ((obj), CAJA_TYPE_ICON_CANVAS_ITEM, CajaIconCanvasItemClass))
44 
45     typedef struct CajaIconCanvasItem CajaIconCanvasItem;
46     typedef struct CajaIconCanvasItemClass CajaIconCanvasItemClass;
47     typedef struct _CajaIconCanvasItemPrivate CajaIconCanvasItemPrivate;
48 
49     struct CajaIconCanvasItem
50     {
51         EelCanvasItem item;
52         CajaIconCanvasItemPrivate *details;
53         gpointer user_data;
54     };
55 
56     struct CajaIconCanvasItemClass
57     {
58         EelCanvasItemClass parent_class;
59     };
60 
61     /* not namespaced due to their length */
62     typedef enum
63     {
64         BOUNDS_USAGE_FOR_LAYOUT,
65         BOUNDS_USAGE_FOR_ENTIRE_ITEM,
66         BOUNDS_USAGE_FOR_DISPLAY
67     } CajaIconCanvasItemBoundsUsage;
68 
69     /* GObject */
70     GType       caja_icon_canvas_item_get_type                 (void);
71 
72     /* attributes */
73     void        caja_icon_canvas_item_set_image                (CajaIconCanvasItem       *item,
74             GdkPixbuf                    *image);
75 
76     cairo_surface_t* caja_icon_canvas_item_get_drag_surface    (CajaIconCanvasItem       *item);
77 
78     void        caja_icon_canvas_item_set_emblems              (CajaIconCanvasItem       *item,
79             GList                        *emblem_pixbufs);
80     void        caja_icon_canvas_item_set_show_stretch_handles (CajaIconCanvasItem       *item,
81             gboolean                      show_stretch_handles);
82     void        caja_icon_canvas_item_set_attach_points        (CajaIconCanvasItem       *item,
83             GdkPoint                     *attach_points,
84             int                           n_attach_points);
85     void        caja_icon_canvas_item_set_embedded_text_rect   (CajaIconCanvasItem       *item,
86             const GdkRectangle           *text_rect);
87     void        caja_icon_canvas_item_set_embedded_text        (CajaIconCanvasItem       *item,
88             const char                   *text);
89     double      caja_icon_canvas_item_get_max_text_width       (CajaIconCanvasItem       *item);
90     const char *caja_icon_canvas_item_get_editable_text        (CajaIconCanvasItem       *icon_item);
91     void        caja_icon_canvas_item_set_renaming             (CajaIconCanvasItem       *icon_item,
92             gboolean                      state);
93 
94     /* geometry and hit testing */
95     gboolean    caja_icon_canvas_item_hit_test_rectangle       (CajaIconCanvasItem       *item,
96             EelIRect                      canvas_rect);
97     gboolean    caja_icon_canvas_item_hit_test_stretch_handles (CajaIconCanvasItem       *item,
98             EelDPoint                     world_point,
99             GtkCornerType                *corner);
100     void        caja_icon_canvas_item_invalidate_label         (CajaIconCanvasItem       *item);
101     void        caja_icon_canvas_item_invalidate_label_size    (CajaIconCanvasItem       *item);
102     EelDRect    caja_icon_canvas_item_get_icon_rectangle       (const CajaIconCanvasItem *item);
103     EelDRect    caja_icon_canvas_item_get_text_rectangle       (CajaIconCanvasItem       *item,
104             gboolean                      for_layout);
105     void        caja_icon_canvas_item_get_bounds_for_layout    (CajaIconCanvasItem       *item,
106             double *x1, double *y1, double *x2, double *y2);
107     void        caja_icon_canvas_item_get_bounds_for_entire_item (CajaIconCanvasItem       *item,
108             double *x1, double *y1, double *x2, double *y2);
109     void        caja_icon_canvas_item_update_bounds            (CajaIconCanvasItem       *item,
110             double i2w_dx, double i2w_dy);
111     void        caja_icon_canvas_item_set_is_visible           (CajaIconCanvasItem       *item,
112             gboolean                      visible);
113     /* whether the entire label text must be visible at all times */
114     void        caja_icon_canvas_item_set_entire_text          (CajaIconCanvasItem       *icon_item,
115             gboolean                      entire_text);
116 
117 G_END_DECLS
118 
119 #endif /* CAJA_ICON_CANVAS_ITEM_H */
120