gtkaccelgroup.h 5.22 KB
Newer Older
Tim Janik's avatar
Tim Janik committed
1 2 3 4 5 6 7
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GtkAccelGroup: Accelerator manager for GtkObjects.
 * Copyright (C) 1998 Tim Janik
 *
 * This library is free software; you can redistribute it and/or
8
 * modify it under the terms of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
9 10 11 12 13 14
 * 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
15
 * Lesser General Public License for more details.
Tim Janik's avatar
Tim Janik committed
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
18 19 20 21
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
22 23

/*
24
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
25 26 27 28 29
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Tim Janik's avatar
Tim Janik committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#ifndef __GTK_ACCEL_GROUP_H__
#define __GTK_ACCEL_GROUP_H__


#include <gdk/gdk.h>
#include <gtk/gtkobject.h>
#include <gtk/gtkenums.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


typedef struct _GtkAccelGroup	GtkAccelGroup;
typedef struct _GtkAccelEntry	GtkAccelEntry;

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
typedef enum
{
  /* should the accelerator appear in
   * the widget's display?
   */
  GTK_ACCEL_VISIBLE        = 1 << 0,
  /* should the signal associated with
   * this accelerator be also visible?
   */
  GTK_ACCEL_SIGNAL_VISIBLE = 1 << 1,
  /* may the accelerator be removed
   * again?
   */
  GTK_ACCEL_LOCKED         = 1 << 2,
  GTK_ACCEL_MASK           = 0x07
} GtkAccelFlags;
Tim Janik's avatar
Tim Janik committed
63 64 65

struct _GtkAccelGroup
{
66 67 68 69
  guint	          ref_count;
  guint	          lock_count;
  GdkModifierType modifier_mask;
  GSList         *attach_objects;
Tim Janik's avatar
Tim Janik committed
70 71 72 73 74 75 76 77
};

struct _GtkAccelEntry
{
  /* key portion
   */
  GtkAccelGroup		*accel_group;
  guint			 accelerator_key;
78
  GdkModifierType	 accelerator_mods;
Tim Janik's avatar
Tim Janik committed
79 80 81 82 83 84 85
  
  GtkAccelFlags		 accel_flags;
  GtkObject		*object;
  guint			 signal_id;
};


86 87 88
/* Accelerators
 */
gboolean gtk_accelerator_valid		      (guint	        keyval,
Elliot Lee's avatar
Elliot Lee committed
89
					       GdkModifierType  modifiers) G_GNUC_CONST;
90 91 92 93 94 95 96 97 98
void	 gtk_accelerator_parse		      (const gchar     *accelerator,
					       guint	       *accelerator_key,
					       GdkModifierType *accelerator_mods);
gchar*	 gtk_accelerator_name		      (guint	        accelerator_key,
					       GdkModifierType  accelerator_mods);
void	 gtk_accelerator_set_default_mod_mask (GdkModifierType  default_mod_mask);
guint	 gtk_accelerator_get_default_mod_mask (void);


Tim Janik's avatar
Tim Janik committed
99 100 101 102 103 104
/* Accelerator Groups
 */
GtkAccelGroup*  gtk_accel_group_new	      	(void);
GtkAccelGroup*  gtk_accel_group_get_default    	(void);
GtkAccelGroup*  gtk_accel_group_ref	     	(GtkAccelGroup	*accel_group);
void	        gtk_accel_group_unref	      	(GtkAccelGroup	*accel_group);
105 106 107
void		gtk_accel_group_lock		(GtkAccelGroup	*accel_group);
void		gtk_accel_group_unlock		(GtkAccelGroup	*accel_group);
gboolean        gtk_accel_groups_activate      	(GtkObject	*object,
Tim Janik's avatar
Tim Janik committed
108
						 guint		 accel_key,
109
						 GdkModifierType accel_mods);
110 111 112 113

/* internal functions
 */
gboolean        gtk_accel_group_activate	(GtkAccelGroup	*accel_group,
Tim Janik's avatar
Tim Janik committed
114
						 guint		 accel_key,
115
						 GdkModifierType accel_mods);
Tim Janik's avatar
Tim Janik committed
116 117 118 119 120
void		gtk_accel_group_attach		(GtkAccelGroup	*accel_group,
						 GtkObject	*object);
void		gtk_accel_group_detach		(GtkAccelGroup	*accel_group,
						 GtkObject	*object);

121
/* Accelerator Group Entries (internal)
Tim Janik's avatar
Tim Janik committed
122 123 124
 */
GtkAccelEntry* 	gtk_accel_group_get_entry      	(GtkAccelGroup  *accel_group,
						 guint           accel_key,
125
						 GdkModifierType accel_mods);
Tim Janik's avatar
Tim Janik committed
126 127
void		gtk_accel_group_lock_entry	(GtkAccelGroup	*accel_group,
						 guint		 accel_key,
128
						 GdkModifierType accel_mods);
Tim Janik's avatar
Tim Janik committed
129 130
void		gtk_accel_group_unlock_entry	(GtkAccelGroup	*accel_group,
						 guint		 accel_key,
131
						 GdkModifierType accel_mods);
Tim Janik's avatar
Tim Janik committed
132 133
void		gtk_accel_group_add		(GtkAccelGroup	*accel_group,
						 guint		 accel_key,
134
						 GdkModifierType accel_mods,
Tim Janik's avatar
Tim Janik committed
135 136 137 138 139
						 GtkAccelFlags	 accel_flags,
						 GtkObject	*object,
						 const gchar	*accel_signal);
void		gtk_accel_group_remove		(GtkAccelGroup	*accel_group,
						 guint		 accel_key,
140
						 GdkModifierType accel_mods,
Tim Janik's avatar
Tim Janik committed
141 142
						 GtkObject	*object);

143
/* Accelerator Signals (internal)
Tim Janik's avatar
Tim Janik committed
144 145 146 147 148
 */
void		gtk_accel_group_handle_add	(GtkObject	*object,
						 guint		 accel_signal_id,
						 GtkAccelGroup	*accel_group,
						 guint		 accel_key,
149
						 GdkModifierType accel_mods,
Tim Janik's avatar
Tim Janik committed
150 151 152 153
						 GtkAccelFlags   accel_flags);
void		gtk_accel_group_handle_remove	(GtkObject	*object,
						 GtkAccelGroup	*accel_group,
						 guint		 accel_key,
154
						 GdkModifierType accel_mods);
Tim Janik's avatar
Tim Janik committed
155
guint		gtk_accel_group_create_add	(GtkType	 class_type,
156
						 GtkSignalRunType signal_flags,
Tim Janik's avatar
Tim Janik committed
157 158
						 guint		 handler_offset);
guint		gtk_accel_group_create_remove	(GtkType	 class_type,
159
						 GtkSignalRunType signal_flags,
Tim Janik's avatar
Tim Janik committed
160 161
						 guint		 handler_offset);

162
/* Miscellaneous (internal)
Tim Janik's avatar
Tim Janik committed
163 164 165 166 167 168 169 170 171 172 173 174
 */
GSList*	gtk_accel_groups_from_object		(GtkObject	*object);
GSList*	gtk_accel_group_entries_from_object	(GtkObject	*object);



#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_ACCEL_GROUP_H__ */