Pileus Git - ~andy/gtk/blob - gtk/gtktoolpalette.h

   1 /* GtkToolPalette -- A tool palette with categories and DnD support
   2  * Copyright (C) 2008  Openismus GmbH
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  *
  18  * Authors:
  19  *      Mathias Hasselmann
  20  */
  21
  22 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  23 #error "Only <gtk/gtk.h> can be included directly."
  24 #endif
  25
  26 #ifndef __GTK_TOOL_PALETTE_H__
  27 #define __GTK_TOOL_PALETTE_H__
  28
  29 #include <gtk/gtkcontainer.h>
  30 #include <gtk/gtkdnd.h>
  31 #include <gtk/gtktoolitem.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define GTK_TYPE_TOOL_PALETTE           (gtk_tool_palette_get_type ())
  36 #define GTK_TOOL_PALETTE(obj)           (G_TYPE_CHECK_INSTANCE_CAST (obj, GTK_TYPE_TOOL_PALETTE, GtkToolPalette))
  37 #define GTK_TOOL_PALETTE_CLASS(cls)     (G_TYPE_CHECK_CLASS_CAST (cls, GTK_TYPE_TOOL_PALETTE, GtkToolPaletteClass))
  38 #define GTK_IS_TOOL_PALETTE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE (obj, GTK_TYPE_TOOL_PALETTE))
  39 #define GTK_IS_TOOL_PALETTE_CLASS(obj)  (G_TYPE_CHECK_CLASS_TYPE (obj, GTK_TYPE_TOOL_PALETTE))
  40 #define GTK_TOOL_PALETTE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOL_PALETTE, GtkToolPaletteClass))
  41
  42 typedef struct _GtkToolPalette           GtkToolPalette;
  43 typedef struct _GtkToolPaletteClass      GtkToolPaletteClass;
  44 typedef struct _GtkToolPalettePrivate    GtkToolPalettePrivate;
  45
  46 /**
  47  * GtkToolPaletteDragTargets:
  48  * @GTK_TOOL_PALETTE_DRAG_ITEMS: Support drag of items.
  49  * @GTK_TOOL_PALETTE_DRAG_GROUPS: Support drag of groups.
  50  *
  51  * Flags used to specify the supported drag targets.
  52  */
  53 typedef enum /*< flags >*/
  54 {
  55   GTK_TOOL_PALETTE_DRAG_ITEMS = (1 << 0),
  56   GTK_TOOL_PALETTE_DRAG_GROUPS = (1 << 1)
  57 }
  58 GtkToolPaletteDragTargets;
  59
  60 /**
  61  * GtkToolPalette:
  62  *
  63  * This should not be accessed directly. Use the accessor functions below.
  64  */
  65 struct _GtkToolPalette
  66 {
  67   GtkContainer parent_instance;
  68   GtkToolPalettePrivate *priv;
  69 };
  70
  71 struct _GtkToolPaletteClass
  72 {
  73   GtkContainerClass parent_class;
  74
  75   void (*set_scroll_adjustments) (GtkWidget     *widget,
  76                                   GtkAdjustment *hadjustment,
  77                                   GtkAdjustment *vadjustment);
  78
  79   /* Padding for future expansion */
  80   void (*_gtk_reserved1) (void);
  81   void (*_gtk_reserved2) (void);
  82   void (*_gtk_reserved3) (void);
  83   void (*_gtk_reserved4) (void);
  84   void (*_gtk_reserved5) (void);
  85   void (*_gtk_reserved6) (void);
  86 };
  87
  88 GType                          gtk_tool_palette_get_type              (void) G_GNUC_CONST;
  89 GtkWidget*                     gtk_tool_palette_new                   (void);
  90
  91 void                           gtk_tool_palette_set_group_position    (GtkToolPalette            *palette,
  92                                                                        GtkToolItemGroup          *group,
  93                                                                        gint                       position);
  94 void                           gtk_tool_palette_set_exclusive         (GtkToolPalette            *palette,
  95                                                                        GtkToolItemGroup          *group,
  96                                                                        gboolean                   exclusive);
  97 void                           gtk_tool_palette_set_expand            (GtkToolPalette            *palette,
  98                                                                        GtkToolItemGroup          *group,
  99                                                                        gboolean                   expand);
 100
 101 gint                           gtk_tool_palette_get_group_position    (GtkToolPalette            *palette,
 102                                                                        GtkToolItemGroup          *group);
 103 gboolean                       gtk_tool_palette_get_exclusive         (GtkToolPalette            *palette,
 104                                                                        GtkToolItemGroup          *group);
 105 gboolean                       gtk_tool_palette_get_expand            (GtkToolPalette            *palette,
 106                                                                        GtkToolItemGroup          *group);
 107
 108 void                           gtk_tool_palette_set_icon_size         (GtkToolPalette            *palette,
 109                                                                        GtkIconSize                icon_size);
 110 void                           gtk_tool_palette_unset_icon_size       (GtkToolPalette            *palette);
 111 void                           gtk_tool_palette_set_style             (GtkToolPalette            *palette,
 112                                                                        GtkToolbarStyle            style);
 113 void                           gtk_tool_palette_unset_style           (GtkToolPalette            *palette);
 114
 115 GtkIconSize                    gtk_tool_palette_get_icon_size         (GtkToolPalette            *palette);
 116 GtkToolbarStyle                gtk_tool_palette_get_style             (GtkToolPalette            *palette);
 117
 118 GtkToolItem*                   gtk_tool_palette_get_drop_item         (GtkToolPalette            *palette,
 119                                                                        gint                       x,
 120                                                                        gint                       y);
 121 GtkToolItemGroup*              gtk_tool_palette_get_drop_group        (GtkToolPalette            *palette,
 122                                                                        gint                       x,
 123                                                                        gint                       y);
 124 GtkWidget*                     gtk_tool_palette_get_drag_item         (GtkToolPalette            *palette,
 125                                                                        const GtkSelectionData    *selection);
 126
 127 void                           gtk_tool_palette_set_drag_source       (GtkToolPalette            *palette,
 128                                                                        GtkToolPaletteDragTargets  targets);
 129 void                           gtk_tool_palette_add_drag_dest         (GtkToolPalette            *palette,
 130                                                                        GtkWidget                 *widget,
 131                                                                        GtkDestDefaults            flags,
 132                                                                        GtkToolPaletteDragTargets  targets,
 133                                                                        GdkDragAction              actions);
 134
 135 GtkAdjustment*                 gtk_tool_palette_get_hadjustment       (GtkToolPalette            *palette);
 136 GtkAdjustment*                 gtk_tool_palette_get_vadjustment       (GtkToolPalette            *palette);
 137
 138 G_CONST_RETURN GtkTargetEntry* gtk_tool_palette_get_drag_target_item  (void) G_GNUC_CONST;
 139 G_CONST_RETURN GtkTargetEntry* gtk_tool_palette_get_drag_target_group (void) G_GNUC_CONST;
 140
 141
 142 G_END_DECLS
 143
 144 #endif /* __GTK_TOOL_PALETTE_H__ */