1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * gdl-dock-object.h - Abstract base class for all dock related objects
4 *
5 * This file is part of the GNOME Devtools Libraries.
6 *
7 * Copyright (C) 2002 Gustavo Giráldez <gustavo.giraldez@gmx.net>
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 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 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
24 #ifndef __GDL_DOCK_OBJECT_H__
25 #define __GDL_DOCK_OBJECT_H__
27 #include <gtk/gtkcontainer.h>
29 G_BEGIN_DECLS
31 /* standard macros */
32 #define GDL_TYPE_DOCK_OBJECT (gdl_dock_object_get_type ())
33 #define GDL_DOCK_OBJECT(obj) (GTK_CHECK_CAST ((obj), GDL_TYPE_DOCK_OBJECT, GdlDockObject))
34 #define GDL_DOCK_OBJECT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GDL_TYPE_DOCK_OBJECT, GdlDockObjectClass))
35 #define GDL_IS_DOCK_OBJECT(obj) (GTK_CHECK_TYPE ((obj), GDL_TYPE_DOCK_OBJECT))
36 #define GDL_IS_DOCK_OBJECT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GDL_TYPE_DOCK_OBJECT))
37 #define GDL_DOCK_OBJECT_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_DOCK_OBJECT, GdlDockObjectClass))
39 /* data types & structures */
40 typedef enum {
41 /* the parameter is to be exported for later layout rebuilding */
42 GDL_DOCK_PARAM_EXPORT = 1 << G_PARAM_USER_SHIFT,
43 /* the parameter must be set after adding the children objects */
44 GDL_DOCK_PARAM_AFTER = 1 << (G_PARAM_USER_SHIFT + 1)
45 } GdlDockParamFlags;
47 #define GDL_DOCK_NAME_PROPERTY "name"
48 #define GDL_DOCK_MASTER_PROPERTY "master"
50 typedef enum {
51 GDL_DOCK_AUTOMATIC = 1 << 0,
52 GDL_DOCK_ATTACHED = 1 << 1,
53 GDL_DOCK_IN_REFLOW = 1 << 2,
54 GDL_DOCK_IN_DETACH = 1 << 3
55 } GdlDockObjectFlags;
57 #define GDL_DOCK_OBJECT_FLAGS_SHIFT 8
59 typedef enum {
60 GDL_DOCK_NONE = 0,
61 GDL_DOCK_TOP,
62 GDL_DOCK_BOTTOM,
63 GDL_DOCK_RIGHT,
64 GDL_DOCK_LEFT,
65 GDL_DOCK_CENTER,
66 GDL_DOCK_FLOATING
67 } GdlDockPlacement;
69 typedef struct _GdlDockObject GdlDockObject;
70 typedef struct _GdlDockObjectClass GdlDockObjectClass;
71 typedef struct _GdlDockRequest GdlDockRequest;
73 struct _GdlDockRequest {
74 GdlDockObject *applicant;
75 GdlDockObject *target;
76 GdlDockPlacement position;
77 GdkRectangle rect;
78 GValue extra;
79 };
81 struct _GdlDockObject {
82 GtkContainer container;
84 GdlDockObjectFlags flags;
85 gint freeze_count;
87 GObject *master;
88 gchar *name;
89 gchar *long_name;
90 gchar *stock_id;
91 GdkPixbuf *pixbuf_icon;
93 gboolean reduce_pending;
94 };
96 struct _GdlDockObjectClass {
97 GtkContainerClass parent_class;
99 gboolean is_compound;
101 void (* detach) (GdlDockObject *object,
102 gboolean recursive);
103 void (* reduce) (GdlDockObject *object);
105 gboolean (* dock_request) (GdlDockObject *object,
106 gint x,
107 gint y,
108 GdlDockRequest *request);
110 void (* dock) (GdlDockObject *object,
111 GdlDockObject *requestor,
112 GdlDockPlacement position,
113 GValue *other_data);
115 gboolean (* reorder) (GdlDockObject *object,
116 GdlDockObject *child,
117 GdlDockPlacement new_position,
118 GValue *other_data);
120 void (* present) (GdlDockObject *object,
121 GdlDockObject *child);
123 gboolean (* child_placement) (GdlDockObject *object,
124 GdlDockObject *child,
125 GdlDockPlacement *placement);
126 };
128 /* additional macros */
129 #define GDL_DOCK_OBJECT_FLAGS(obj) (GDL_DOCK_OBJECT (obj)->flags)
130 #define GDL_DOCK_OBJECT_AUTOMATIC(obj) \
131 ((GDL_DOCK_OBJECT_FLAGS (obj) & GDL_DOCK_AUTOMATIC) != 0)
132 #define GDL_DOCK_OBJECT_ATTACHED(obj) \
133 ((GDL_DOCK_OBJECT_FLAGS (obj) & GDL_DOCK_ATTACHED) != 0)
134 #define GDL_DOCK_OBJECT_IN_REFLOW(obj) \
135 ((GDL_DOCK_OBJECT_FLAGS (obj) & GDL_DOCK_IN_REFLOW) != 0)
136 #define GDL_DOCK_OBJECT_IN_DETACH(obj) \
137 ((GDL_DOCK_OBJECT_FLAGS (obj) & GDL_DOCK_IN_DETACH) != 0)
139 #define GDL_DOCK_OBJECT_SET_FLAGS(obj,flag) \
140 G_STMT_START { (GDL_DOCK_OBJECT_FLAGS (obj) |= (flag)); } G_STMT_END
141 #define GDL_DOCK_OBJECT_UNSET_FLAGS(obj,flag) \
142 G_STMT_START { (GDL_DOCK_OBJECT_FLAGS (obj) &= ~(flag)); } G_STMT_END
144 #define GDL_DOCK_OBJECT_FROZEN(obj) (GDL_DOCK_OBJECT (obj)->freeze_count > 0)
147 /* public interface */
149 GType gdl_dock_object_get_type (void);
151 gboolean gdl_dock_object_is_compound (GdlDockObject *object);
153 void gdl_dock_object_detach (GdlDockObject *object,
154 gboolean recursive);
156 GdlDockObject *gdl_dock_object_get_parent_object (GdlDockObject *object);
158 void gdl_dock_object_freeze (GdlDockObject *object);
159 void gdl_dock_object_thaw (GdlDockObject *object);
161 void gdl_dock_object_reduce (GdlDockObject *object);
163 gboolean gdl_dock_object_dock_request (GdlDockObject *object,
164 gint x,
165 gint y,
166 GdlDockRequest *request);
167 void gdl_dock_object_dock (GdlDockObject *object,
168 GdlDockObject *requestor,
169 GdlDockPlacement position,
170 GValue *other_data);
172 void gdl_dock_object_bind (GdlDockObject *object,
173 GObject *master);
174 void gdl_dock_object_unbind (GdlDockObject *object);
175 gboolean gdl_dock_object_is_bound (GdlDockObject *object);
177 gboolean gdl_dock_object_reorder (GdlDockObject *object,
178 GdlDockObject *child,
179 GdlDockPlacement new_position,
180 GValue *other_data);
182 void gdl_dock_object_present (GdlDockObject *object,
183 GdlDockObject *child);
185 gboolean gdl_dock_object_child_placement (GdlDockObject *object,
186 GdlDockObject *child,
187 GdlDockPlacement *placement);
189 /* other types */
191 /* this type derives from G_TYPE_STRING and is meant to be the basic
192 type for serializing object parameters which are exported
193 (i.e. those that are needed for layout rebuilding) */
194 #define GDL_TYPE_DOCK_PARAM (gdl_dock_param_get_type ())
196 GType gdl_dock_param_get_type (void);
198 /* functions for setting/retrieving nick names for serializing GdlDockObject types */
199 G_CONST_RETURN gchar *gdl_dock_object_nick_from_type (GType type);
200 GType gdl_dock_object_type_from_nick (const gchar *nick);
201 GType gdl_dock_object_set_type_for_nick (const gchar *nick,
202 GType type);
205 /* helper macros */
206 #define GDL_TRACE_OBJECT(object, format, args...) \
207 G_STMT_START { \
208 g_log (G_LOG_DOMAIN, \
209 G_LOG_LEVEL_DEBUG, \
210 "%s:%d (%s) %s [%p %d%s:%d]: "format, \
211 __FILE__, \
212 __LINE__, \
213 __PRETTY_FUNCTION__, \
214 G_OBJECT_TYPE_NAME (object), object, \
215 G_OBJECT (object)->ref_count, \
216 (GTK_IS_OBJECT (object) && GTK_OBJECT_FLOATING (object)) ? "(float)" : "", \
217 GDL_IS_DOCK_OBJECT (object) ? GDL_DOCK_OBJECT (object)->freeze_count : -1, \
218 ##args); } G_STMT_END
222 G_END_DECLS
224 #endif /* __GDL_DOCK_OBJECT_H__ */