/usr/include/libgdl-3.0/gdl/gdl-dock-item.h is in libgdl-3-dev 3.8.1-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* gdl-dock-item.h
*
* Author: Gustavo Giráldez <gustavo.giraldez@gmx.net>
*
* Based on GnomeDockItem/BonoboDockItem. Original copyright notice follows.
*
* Copyright (C) 1998 Ettore Perazzoli
* Copyright (C) 1998 Elliot Lee
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
* All rights reserved.
*
* This 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.
*
* This 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 this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GDL_DOCK_ITEM_H__
#define __GDL_DOCK_ITEM_H__
#include <gdl/gdl-dock-object.h>
G_BEGIN_DECLS
/* standard macros */
#define GDL_TYPE_DOCK_ITEM (gdl_dock_item_get_type ())
#define GDL_DOCK_ITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDL_TYPE_DOCK_ITEM, GdlDockItem))
#define GDL_DOCK_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDL_TYPE_DOCK_ITEM, GdlDockItemClass))
#define GDL_IS_DOCK_ITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDL_TYPE_DOCK_ITEM))
#define GDL_IS_DOCK_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDL_TYPE_DOCK_ITEM))
#define GDL_DOCK_ITEM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_DOCK_ITEM, GdlDockItemClass))
/**
* GdlDockItemBehavior:
* @GDL_DOCK_ITEM_BEH_NORMAL: Normal dock item
* @GDL_DOCK_ITEM_BEH_NEVER_FLOATING: item cannot be undocked
* @GDL_DOCK_ITEM_BEH_NEVER_VERTICAL: item cannot be docked vertically
* @GDL_DOCK_ITEM_BEH_NEVER_HORIZONTAL: item cannot be docked horizontally
* @GDL_DOCK_ITEM_BEH_LOCKED: item is locked, it cannot be moved around
* @GDL_DOCK_ITEM_BEH_CANT_DOCK_TOP: item cannot be docked at top
* @GDL_DOCK_ITEM_BEH_CANT_DOCK_BOTTOM: item cannot be docked at bottom
* @GDL_DOCK_ITEM_BEH_CANT_DOCK_LEFT: item cannot be docked left
* @GDL_DOCK_ITEM_BEH_CANT_DOCK_RIGHT: item cannot be docked right
* @GDL_DOCK_ITEM_BEH_CANT_DOCK_CENTER: item cannot be docked at center
* @GDL_DOCK_ITEM_BEH_CANT_CLOSE: item cannot be closed
* @GDL_DOCK_ITEM_BEH_CANT_ICONIFY: item cannot be iconified
* @GDL_DOCK_ITEM_BEH_NO_GRIP: item doesn't have a grip
*
* Described the behaviour of a doc item. The item can have multiple flags set.
*
**/
typedef enum {
GDL_DOCK_ITEM_BEH_NORMAL = 0,
GDL_DOCK_ITEM_BEH_NEVER_FLOATING = 1 << 0,
GDL_DOCK_ITEM_BEH_NEVER_VERTICAL = 1 << 1,
GDL_DOCK_ITEM_BEH_NEVER_HORIZONTAL = 1 << 2,
GDL_DOCK_ITEM_BEH_LOCKED = 1 << 3,
GDL_DOCK_ITEM_BEH_CANT_DOCK_TOP = 1 << 4,
GDL_DOCK_ITEM_BEH_CANT_DOCK_BOTTOM = 1 << 5,
GDL_DOCK_ITEM_BEH_CANT_DOCK_LEFT = 1 << 6,
GDL_DOCK_ITEM_BEH_CANT_DOCK_RIGHT = 1 << 7,
GDL_DOCK_ITEM_BEH_CANT_DOCK_CENTER = 1 << 8,
GDL_DOCK_ITEM_BEH_CANT_CLOSE = 1 << 9,
GDL_DOCK_ITEM_BEH_CANT_ICONIFY = 1 << 10,
GDL_DOCK_ITEM_BEH_NO_GRIP = 1 << 11
} GdlDockItemBehavior;
#ifndef GDL_DISABLE_DEPRECATED
/**
* GdlDockItemFlags:
* @GDL_DOCK_IN_DRAG: item is in a drag operation
* @GDL_DOCK_IN_PREDRAG: item is in a predrag operation
* @GDL_DOCK_ICONIFIED: item is iconified
* @GDL_DOCK_USER_ACTION: indicates the user has started an action on the dock item
*
* Status flag of a GdlDockItem. Don't use unless you derive a widget from GdlDockItem
*
* Deprecated: 3.6: Use your own private data instead.
**/
typedef enum {
GDL_DOCK_IN_DRAG = 1 << GDL_DOCK_OBJECT_FLAGS_SHIFT,
GDL_DOCK_IN_PREDRAG = 1 << (GDL_DOCK_OBJECT_FLAGS_SHIFT + 1),
GDL_DOCK_ICONIFIED = 1 << (GDL_DOCK_OBJECT_FLAGS_SHIFT + 2),
GDL_DOCK_USER_ACTION = 1 << (GDL_DOCK_OBJECT_FLAGS_SHIFT + 3)
} GdlDockItemFlags;
#endif
typedef struct _GdlDockItem GdlDockItem;
typedef struct _GdlDockItemPrivate GdlDockItemPrivate;
typedef struct _GdlDockItemClass GdlDockItemClass;
typedef struct _GdlDockItemClassPrivate GdlDockItemClassPrivate;
struct _GdlDockItem {
GdlDockObject object;
/* < private> */
GdlDockItemPrivate *priv;
};
struct _GdlDockItemClass {
GdlDockObjectClass parent_class;
GdlDockItemClassPrivate *priv;
/* virtuals */
void (* set_orientation) (GdlDockItem *item,
GtkOrientation orientation);
/* signals */
void (* dock_drag_begin) (GdlDockItem *item);
void (* dock_drag_motion) (GdlDockItem *item,
GdkDevice *device,
gint x,
gint y);
void (* dock_drag_end) (GdlDockItem *item,
gboolean cancelled);
void (* move_focus_child) (GdlDockItem *item,
GtkDirectionType direction);
};
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_FLAGS:
* @item: A #GdlDockObject
*
* Get all flags of #GdlDockObject.
*
* Deprecated: 3.6: Use GDL_DOCK_OBJECT_FLAGS instead
*/
#define GDL_DOCK_ITEM_FLAGS(item) (GDL_DOCK_OBJECT (item)->flags)
#endif
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_SET_FLAGS:
* @item: A #GdlDockObject
* @flag: One or more #GdlDockObjectFlags
*
* Set one or more flags of a dock object.
*
* Deprecated: 3.6: Use GDL_DOCK_OBJECT_SET_FLAGS instead
*/
#define GDL_DOCK_ITEM_SET_FLAGS(item,flag) \
G_STMT_START { (GDL_DOCK_OBJECT_FLAGS (item) |= (flag)); } G_STMT_END
#endif
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_UNSET_FLAGS:
* @item: A #GdlDockObject
* @flag: One or more #GdlDockObjectFlags
*
* Clear one or more flags of a dock object.
*
* Deprecated: 3.6: Use GDL_DOCK_OBJECT_UNSET_FLAGS instead
*/
#define GDL_DOCK_ITEM_UNSET_FLAGS(item,flag) \
G_STMT_START { (GDL_DOCK_OBJECT_FLAGS (item) &= ~(flag)); } G_STMT_END
#endif
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_IN_DRAG:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE if the user is dragging the item.
*
* Deprecated: 3.6: Use a private flag instead
*/
#define GDL_DOCK_ITEM_IN_DRAG(item) \
((GDL_DOCK_OBJECT_FLAGS (item) & GDL_DOCK_IN_DRAG) != 0)
#endif
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_IN_PREDRAG:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE if the user has clicked on the item but hasn't made a big
* enough move to start the drag operation.
*
* Deprecated: 3.6: Use a private flag instead
*/
#define GDL_DOCK_ITEM_IN_PREDRAG(item) \
((GDL_DOCK_OBJECT_FLAGS (item) & GDL_DOCK_IN_PREDRAG) != 0)
#endif
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_ICONIFIED:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE if the item is iconified, appearing only as a button in
* the dock bar.
*
* Deprecated: 3.6: Use GDL_DOCK_OBJECT_UNSET_FLAGS instead
*/
#define GDL_DOCK_ITEM_ICONIFIED(item) \
((GDL_DOCK_OBJECT_FLAGS (item) & GDL_DOCK_ICONIFIED) != 0)
#endif
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_USER_ACTION:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE if the user currently use the item, by example dragging
* division of a #GdlDockPaned object.
*
* Deprecated: 3.6: Use a private flag instead
*/
#define GDL_DOCK_ITEM_USER_ACTION(item) \
((GDL_DOCK_OBJECT_FLAGS (item) & GDL_DOCK_USER_ACTION) != 0)
#endif
/**
* GDL_DOCK_ITEM_NOT_LOCKED:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE the item can be moved, closed, or iconified.
*/
#define GDL_DOCK_ITEM_NOT_LOCKED(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_LOCKED) == 0)
#ifndef GDL_DISABLE_DEPRECATED
/**
* GDL_DOCK_ITEM_NO_GRIP:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE the item has not handle, so it cannot be moved.
*
* Deprecated: 3.6: Use !GDL_DOCK_ITEM_HAS_GRIP instead
*/
#define GDL_DOCK_ITEM_NO_GRIP(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_NO_GRIP) != 0)
#endif
/**
* GDL_DOCK_ITEM_HAS_GRIP:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE the item has a handle, so it can be moved.
*/
#define GDL_DOCK_ITEM_HAS_GRIP(item) ((gdl_dock_item_get_behavior_flags (item) & GDL_DOCK_ITEM_BEH_NO_GRIP) == 0)
/**
* GDL_DOCK_ITEM_CANT_CLOSE:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE the item cannot be closed.
*/
#define GDL_DOCK_ITEM_CANT_CLOSE(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_CANT_CLOSE) != 0)
/**
* GDL_DOCK_ITEM_CANT_ICONIFY:
* @item: A #GdlDockObject
*
* Evaluates to %TRUE the item cannot be iconifyed.
*/
#define GDL_DOCK_ITEM_CANT_ICONIFY(item) ((gdl_dock_item_get_behavior_flags(item) & GDL_DOCK_ITEM_BEH_CANT_ICONIFY) != 0)
/* public interface */
GtkWidget *gdl_dock_item_new (const gchar *name,
const gchar *long_name,
GdlDockItemBehavior behavior);
GtkWidget *gdl_dock_item_new_with_stock (const gchar *name,
const gchar *long_name,
const gchar *stock_id,
GdlDockItemBehavior behavior);
GtkWidget *gdl_dock_item_new_with_pixbuf_icon (const gchar *name,
const gchar *long_name,
const GdkPixbuf *pixbuf_icon,
GdlDockItemBehavior behavior);
GType gdl_dock_item_get_type (void);
void gdl_dock_item_dock_to (GdlDockItem *item,
GdlDockItem *target,
GdlDockPlacement position,
gint docking_param);
void gdl_dock_item_set_orientation (GdlDockItem *item,
GtkOrientation orientation);
GtkOrientation gdl_dock_item_get_orientation (GdlDockItem *item);
void gdl_dock_item_set_behavior_flags (GdlDockItem *item,
GdlDockItemBehavior behavior,
gboolean clear);
void gdl_dock_item_unset_behavior_flags (GdlDockItem *item,
GdlDockItemBehavior behavior);
GdlDockItemBehavior gdl_dock_item_get_behavior_flags (GdlDockItem *item);
GtkWidget *gdl_dock_item_get_tablabel (GdlDockItem *item);
void gdl_dock_item_set_tablabel (GdlDockItem *item,
GtkWidget *tablabel);
GtkWidget *gdl_dock_item_get_grip (GdlDockItem *item);
void gdl_dock_item_hide_grip (GdlDockItem *item);
void gdl_dock_item_show_grip (GdlDockItem *item);
void gdl_dock_item_notify_selected (GdlDockItem *item);
void gdl_dock_item_notify_deselected (GdlDockItem *item);
/* bind and unbind items to a dock */
void gdl_dock_item_bind (GdlDockItem *item,
GtkWidget *dock);
void gdl_dock_item_unbind (GdlDockItem *item);
void gdl_dock_item_hide_item (GdlDockItem *item);
void gdl_dock_item_iconify_item (GdlDockItem *item);
void gdl_dock_item_show_item (GdlDockItem *item);
void gdl_dock_item_lock (GdlDockItem *item);
void gdl_dock_item_unlock (GdlDockItem *item);
void gdl_dock_item_set_default_position (GdlDockItem *item,
GdlDockObject *reference);
void gdl_dock_item_preferred_size (GdlDockItem *item,
GtkRequisition *req);
void gdl_dock_item_get_drag_area (GdlDockItem *item,
GdkRectangle *rect);
gboolean gdl_dock_item_or_child_has_focus (GdlDockItem *item);
gboolean gdl_dock_item_is_placeholder (GdlDockItem *item);
gboolean gdl_dock_item_is_closed (GdlDockItem *item);
gboolean gdl_dock_item_is_iconified (GdlDockItem *item);
void gdl_dock_item_set_child (GdlDockItem *item,
GtkWidget *child);
GtkWidget* gdl_dock_item_get_child (GdlDockItem *item);
void gdl_dock_item_class_set_has_grip (GdlDockItemClass *item_class,
gboolean has_grip);
G_END_DECLS
#endif
|