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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1998, 2001 Tim Janik
   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 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
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_ACCEL_GROUP_H__
  32 #define __GTK_ACCEL_GROUP_H__
  33
  34
  35 #include <gdk/gdk.h>
  36 #include <gtk/gtkenums.h>
  37
  38 G_BEGIN_DECLS
  39
  40
  41 /* --- type macros --- */
  42 #define GTK_TYPE_ACCEL_GROUP              (gtk_accel_group_get_type ())
  43 #define GTK_ACCEL_GROUP(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ACCEL_GROUP, GtkAccelGroup))
  44 #define GTK_ACCEL_GROUP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ACCEL_GROUP, GtkAccelGroupClass))
  45 #define GTK_IS_ACCEL_GROUP(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ACCEL_GROUP))
  46 #define GTK_IS_ACCEL_GROUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ACCEL_GROUP))
  47 #define GTK_ACCEL_GROUP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ACCEL_GROUP, GtkAccelGroupClass))
  48
  49
  50 /* --- accel flags --- */
  51 typedef enum
  52 {
  53   GTK_ACCEL_VISIBLE        = 1 << 0,    /* display in GtkAccelLabel? */
  54   GTK_ACCEL_LOCKED         = 1 << 1,    /* is it removable? */
  55   GTK_ACCEL_MASK           = 0x07
  56 } GtkAccelFlags;
  57
  58
  59 /* --- typedefs & structures --- */
  60 typedef struct _GtkAccelGroup      GtkAccelGroup;
  61 typedef struct _GtkAccelGroupClass GtkAccelGroupClass;
  62 typedef struct _GtkAccelKey        GtkAccelKey;
  63 typedef struct _GtkAccelGroupEntry GtkAccelGroupEntry;
  64 typedef gboolean (*GtkAccelGroupActivate) (GtkAccelGroup  *accel_group,
  65                                            GObject        *acceleratable,
  66                                            guint           keyval,
  67                                            GdkModifierType modifier);
  68
  69 /**
  70  * GtkAccelGroupFindFunc:
  71  * @key:
  72  * @closure:
  73  * @data:
  74  *
  75  * Since: 2.2
  76  */
  77 typedef gboolean (*GtkAccelGroupFindFunc) (GtkAccelKey    *key,
  78                                            GClosure       *closure,
  79                                            gpointer        data);
  80
  81 /**
  82  * GtkAccelGroup:
  83  *
  84  * An object representing and maintaining a group of accelerators.
  85  */
  86 struct _GtkAccelGroup
  87 {
  88   GObject             parent;
  89
  90   guint               GSEAL (lock_count);
  91   GdkModifierType     GSEAL (modifier_mask);
  92   GSList             *GSEAL (acceleratables);
  93   guint               GSEAL (n_accels);
  94   GtkAccelGroupEntry *GSEAL (priv_accels);
  95 };
  96
  97 struct _GtkAccelGroupClass
  98 {
  99   GObjectClass parent_class;
 100
 101   void  (*accel_changed)        (GtkAccelGroup  *accel_group,
 102                                  guint           keyval,
 103                                  GdkModifierType modifier,
 104                                  GClosure       *accel_closure);
 105
 106   /* Padding for future expansion */
 107   void (*_gtk_reserved1) (void);
 108   void (*_gtk_reserved2) (void);
 109   void (*_gtk_reserved3) (void);
 110   void (*_gtk_reserved4) (void);
 111 };
 112
 113 struct _GtkAccelKey
 114 {
 115   guint           accel_key;
 116   GdkModifierType accel_mods;
 117   guint           accel_flags : 16;
 118 };
 119
 120
 121 /* -- Accelerator Groups --- */
 122 GType          gtk_accel_group_get_type           (void) G_GNUC_CONST;
 123 GtkAccelGroup* gtk_accel_group_new                (void);
 124 gboolean       gtk_accel_group_get_is_locked      (GtkAccelGroup  *accel_group);
 125 GdkModifierType
 126                gtk_accel_group_get_modifier_mask  (GtkAccelGroup  *accel_group);
 127 void           gtk_accel_group_lock               (GtkAccelGroup  *accel_group);
 128 void           gtk_accel_group_unlock             (GtkAccelGroup  *accel_group);
 129 void           gtk_accel_group_connect            (GtkAccelGroup  *accel_group,
 130                                                    guint           accel_key,
 131                                                    GdkModifierType accel_mods,
 132                                                    GtkAccelFlags   accel_flags,
 133                                                    GClosure       *closure);
 134 void           gtk_accel_group_connect_by_path    (GtkAccelGroup  *accel_group,
 135                                                    const gchar    *accel_path,
 136                                                    GClosure       *closure);
 137 gboolean       gtk_accel_group_disconnect         (GtkAccelGroup  *accel_group,
 138                                                    GClosure       *closure);
 139 gboolean       gtk_accel_group_disconnect_key     (GtkAccelGroup  *accel_group,
 140                                                    guint           accel_key,
 141                                                    GdkModifierType accel_mods);
 142 gboolean       gtk_accel_group_activate           (GtkAccelGroup   *accel_group,
 143                                                    GQuark          accel_quark,
 144                                                    GObject        *acceleratable,
 145                                                    guint           accel_key,
 146                                                    GdkModifierType accel_mods);
 147
 148
 149 /* --- GtkActivatable glue --- */
 150 void            _gtk_accel_group_attach         (GtkAccelGroup  *accel_group,
 151                                                  GObject        *object);
 152 void            _gtk_accel_group_detach         (GtkAccelGroup  *accel_group,
 153                                                  GObject        *object);
 154 gboolean        gtk_accel_groups_activate       (GObject        *object,
 155                                                  guint           accel_key,
 156                                                  GdkModifierType accel_mods);
 157 GSList*         gtk_accel_groups_from_object    (GObject        *object);
 158 GtkAccelKey*    gtk_accel_group_find            (GtkAccelGroup        *accel_group,
 159                                                  GtkAccelGroupFindFunc find_func,
 160                                                  gpointer              data);
 161 GtkAccelGroup*  gtk_accel_group_from_accel_closure (GClosure    *closure);
 162
 163
 164 /* --- Accelerators--- */
 165 gboolean gtk_accelerator_valid                (guint            keyval,
 166                                                GdkModifierType  modifiers) G_GNUC_CONST;
 167 void     gtk_accelerator_parse                (const gchar     *accelerator,
 168                                                guint           *accelerator_key,
 169                                                GdkModifierType *accelerator_mods);
 170 gchar*   gtk_accelerator_name                 (guint            accelerator_key,
 171                                                GdkModifierType  accelerator_mods);
 172 gchar*   gtk_accelerator_get_label            (guint           accelerator_key,
 173                                                GdkModifierType accelerator_mods);
 174 void     gtk_accelerator_set_default_mod_mask (GdkModifierType  default_mod_mask);
 175 guint    gtk_accelerator_get_default_mod_mask (void);
 176
 177
 178 /* --- internal --- */
 179 GtkAccelGroupEntry*     gtk_accel_group_query   (GtkAccelGroup  *accel_group,
 180                                                  guint           accel_key,
 181                                                  GdkModifierType accel_mods,
 182                                                  guint          *n_entries);
 183
 184 void                 _gtk_accel_group_reconnect (GtkAccelGroup *accel_group,
 185                                                  GQuark         accel_path_quark);
 186
 187 struct _GtkAccelGroupEntry
 188 {
 189   GtkAccelKey  key;
 190   GClosure    *closure;
 191   GQuark       accel_path_quark;
 192 };
 193
 194
 195 #ifndef GTK_DISABLE_DEPRECATED
 196 /**
 197  * gtk_accel_group_ref:
 198  *
 199  * Deprecated equivalent of g_object_ref().
 200  *
 201  * Returns: the accel group that was passed in
 202  */
 203 #define gtk_accel_group_ref     g_object_ref
 204
 205 /**
 206  * gtk_accel_group_unref:
 207  *
 208  * Deprecated equivalent of g_object_unref().
 209  */
 210 #define gtk_accel_group_unref   g_object_unref
 211 #endif /* GTK_DISABLE_DEPRECATED */
 212
 213 G_END_DECLS
 214
 215
 216 #endif /* __GTK_ACCEL_GROUP_H__ */