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
/* CTK - The GIMP Toolkit
 * Copyright (C) 1998, 2001 Tim Janik
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Modified by the CTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the CTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * CTK+ at ftp://ftp.ctk.org/pub/ctk/.
 */

#ifndef __CTK_ACCEL_GROUP_H__
#define __CTK_ACCEL_GROUP_H__


#if !defined (__CTK_H_INSIDE__) && !defined (CTK_COMPILATION)
#error "Only <ctk/ctk.h> can be included directly."
#endif

#include <cdk/cdk.h>
#include <ctk/ctkenums.h>

G_BEGIN_DECLS


/* --- type macros --- */
#define CTK_TYPE_ACCEL_GROUP              (ctk_accel_group_get_type ())
#define CTK_ACCEL_GROUP(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), CTK_TYPE_ACCEL_GROUP, CtkAccelGroup))
#define CTK_ACCEL_GROUP_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), CTK_TYPE_ACCEL_GROUP, CtkAccelGroupClass))
#define CTK_IS_ACCEL_GROUP(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), CTK_TYPE_ACCEL_GROUP))
#define CTK_IS_ACCEL_GROUP_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), CTK_TYPE_ACCEL_GROUP))
#define CTK_ACCEL_GROUP_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), CTK_TYPE_ACCEL_GROUP, CtkAccelGroupClass))


/* --- accel flags --- */
/**
 * CtkAccelFlags:
 * @CTK_ACCEL_VISIBLE: Accelerator is visible
 * @CTK_ACCEL_LOCKED: Accelerator not removable
 * @CTK_ACCEL_MASK: Mask
 *
 * Accelerator flags used with ctk_accel_group_connect().
 */
typedef enum
{
  CTK_ACCEL_VISIBLE        = 1 << 0,
  CTK_ACCEL_LOCKED         = 1 << 1,
  CTK_ACCEL_MASK           = 0x07
} CtkAccelFlags;


/* --- typedefs & structures --- */
typedef struct _CtkAccelGroup	          CtkAccelGroup;
typedef struct _CtkAccelGroupClass        CtkAccelGroupClass;
typedef struct _CtkAccelGroupPrivate      CtkAccelGroupPrivate;
typedef struct _CtkAccelKey               CtkAccelKey;
typedef struct _CtkAccelGroupEntry        CtkAccelGroupEntry;
typedef gboolean (*CtkAccelGroupActivate) (CtkAccelGroup  *accel_group,
					   GObject        *acceleratable,
					   guint           keyval,
					   CdkModifierType modifier);

/**
 * CtkAccelGroupFindFunc:
 * @key: 
 * @closure: 
 * @data: (closure):
 * 
 * Since: 2.2
 */
typedef gboolean (*CtkAccelGroupFindFunc) (CtkAccelKey    *key,
					   GClosure       *closure,
					   gpointer        data);

/**
 * CtkAccelGroup:
 * 
 * An object representing and maintaining a group of accelerators.
 */
struct _CtkAccelGroup
{
  GObject               parent;
  CtkAccelGroupPrivate *priv;
};

/**
 * CtkAccelGroupClass:
 * @parent_class: The parent class.
 * @accel_changed: Signal emitted when an entry is added to or removed
 *    from the accel group.
 */
struct _CtkAccelGroupClass
{
  GObjectClass parent_class;

  /*< public >*/

  void	(*accel_changed)	(CtkAccelGroup	*accel_group,
				 guint           keyval,
				 CdkModifierType modifier,
				 GClosure       *accel_closure);

  /*< private >*/

  /* Padding for future expansion */
  void (*_ctk_reserved1) (void);
  void (*_ctk_reserved2) (void);
  void (*_ctk_reserved3) (void);
  void (*_ctk_reserved4) (void);
};

/**
 * CtkAccelKey:
 * @accel_key: The accelerator keyval
 * @accel_mods:The accelerator modifiers
 * @accel_flags: The accelerator flags
 */
struct _CtkAccelKey
{
  guint           accel_key;
  CdkModifierType accel_mods;
  guint           accel_flags : 16;
};


/* -- Accelerator Groups --- */
CDK_AVAILABLE_IN_ALL
GType          ctk_accel_group_get_type           (void) G_GNUC_CONST;
CDK_AVAILABLE_IN_ALL
CtkAccelGroup* ctk_accel_group_new	      	  (void);
CDK_AVAILABLE_IN_ALL
gboolean       ctk_accel_group_get_is_locked      (CtkAccelGroup  *accel_group);
CDK_AVAILABLE_IN_ALL
CdkModifierType 
               ctk_accel_group_get_modifier_mask  (CtkAccelGroup  *accel_group);
CDK_AVAILABLE_IN_ALL
void	       ctk_accel_group_lock		  (CtkAccelGroup  *accel_group);
CDK_AVAILABLE_IN_ALL
void	       ctk_accel_group_unlock		  (CtkAccelGroup  *accel_group);
CDK_AVAILABLE_IN_ALL
void	       ctk_accel_group_connect		  (CtkAccelGroup  *accel_group,
						   guint	   accel_key,
						   CdkModifierType accel_mods,
						   CtkAccelFlags   accel_flags,
						   GClosure	  *closure);
CDK_AVAILABLE_IN_ALL
void           ctk_accel_group_connect_by_path    (CtkAccelGroup  *accel_group,
						   const gchar	  *accel_path,
						   GClosure	  *closure);
CDK_AVAILABLE_IN_ALL
gboolean       ctk_accel_group_disconnect	  (CtkAccelGroup  *accel_group,
						   GClosure	  *closure);
CDK_AVAILABLE_IN_ALL
gboolean       ctk_accel_group_disconnect_key	  (CtkAccelGroup  *accel_group,
						   guint	   accel_key,
						   CdkModifierType accel_mods);
CDK_AVAILABLE_IN_ALL
gboolean       ctk_accel_group_activate           (CtkAccelGroup   *accel_group,
                                                   GQuark	   accel_quark,
                                                   GObject	  *acceleratable,
                                                   guint	   accel_key,
                                                   CdkModifierType accel_mods);


/* --- CtkActivatable glue --- */
void		_ctk_accel_group_attach		(CtkAccelGroup	*accel_group,
						 GObject	*object);
void		_ctk_accel_group_detach		(CtkAccelGroup	*accel_group,
						 GObject	*object);
CDK_AVAILABLE_IN_ALL
gboolean        ctk_accel_groups_activate      	(GObject	*object,
						 guint		 accel_key,
						 CdkModifierType accel_mods);
CDK_AVAILABLE_IN_ALL
GSList*	        ctk_accel_groups_from_object    (GObject	*object);
CDK_AVAILABLE_IN_ALL
CtkAccelKey*	ctk_accel_group_find		(CtkAccelGroup	      *accel_group,
						 CtkAccelGroupFindFunc find_func,
						 gpointer              data);
CDK_AVAILABLE_IN_ALL
CtkAccelGroup*	ctk_accel_group_from_accel_closure (GClosure    *closure);


/* --- Accelerators--- */
CDK_AVAILABLE_IN_ALL
gboolean ctk_accelerator_valid		      (guint	        keyval,
					       CdkModifierType  modifiers) G_GNUC_CONST;
CDK_AVAILABLE_IN_ALL
void	 ctk_accelerator_parse		      (const gchar     *accelerator,
					       guint	       *accelerator_key,
					       CdkModifierType *accelerator_mods);
CDK_AVAILABLE_IN_3_4
void ctk_accelerator_parse_with_keycode       (const gchar     *accelerator,
                                               guint           *accelerator_key,
                                               guint          **accelerator_codes,
                                               CdkModifierType *accelerator_mods);
CDK_AVAILABLE_IN_ALL
gchar*	 ctk_accelerator_name		      (guint	        accelerator_key,
					       CdkModifierType  accelerator_mods);
CDK_AVAILABLE_IN_3_4
gchar*	 ctk_accelerator_name_with_keycode    (CdkDisplay      *display,
                                               guint            accelerator_key,
                                               guint            keycode,
                                               CdkModifierType  accelerator_mods);
CDK_AVAILABLE_IN_ALL
gchar*   ctk_accelerator_get_label            (guint           accelerator_key,
                                               CdkModifierType accelerator_mods);
CDK_AVAILABLE_IN_3_4
gchar*   ctk_accelerator_get_label_with_keycode (CdkDisplay      *display,
                                                 guint            accelerator_key,
                                                 guint            keycode,
                                                 CdkModifierType  accelerator_mods);
CDK_AVAILABLE_IN_ALL
void	 ctk_accelerator_set_default_mod_mask (CdkModifierType  default_mod_mask);
CDK_AVAILABLE_IN_ALL
CdkModifierType
	 ctk_accelerator_get_default_mod_mask (void);

CDK_AVAILABLE_IN_ALL
CtkAccelGroupEntry*	ctk_accel_group_query	(CtkAccelGroup	*accel_group,
						 guint		 accel_key,
						 CdkModifierType accel_mods,
						 guint          *n_entries);

struct _CtkAccelGroupEntry
{
  CtkAccelKey  key;
  GClosure    *closure;
  GQuark       accel_path_quark;
};

G_DEFINE_AUTOPTR_CLEANUP_FUNC(CtkAccelGroup, g_object_unref)<--- There is an unknown macro here somewhere. Configuration is required. If G_DEFINE_AUTOPTR_CLEANUP_FUNC is a macro then please configure it.

G_END_DECLS

#endif /* __CTK_ACCEL_GROUP_H__ */