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
/* CTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * 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_MENU_H__
#define __CTK_MENU_H__

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

#include <ctk/ctkaccelgroup.h>
#include <ctk/ctkmenushell.h>

G_BEGIN_DECLS

#define CTK_TYPE_MENU			(ctk_menu_get_type ())
#define CTK_MENU(obj)			(G_TYPE_CHECK_INSTANCE_CAST ((obj), CTK_TYPE_MENU, CtkMenu))
#define CTK_MENU_CLASS(klass)		(G_TYPE_CHECK_CLASS_CAST ((klass), CTK_TYPE_MENU, CtkMenuClass))
#define CTK_IS_MENU(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), CTK_TYPE_MENU))
#define CTK_IS_MENU_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), CTK_TYPE_MENU))
#define CTK_MENU_GET_CLASS(obj)         (G_TYPE_INSTANCE_GET_CLASS ((obj), CTK_TYPE_MENU, CtkMenuClass))


typedef struct _CtkMenu        CtkMenu;
typedef struct _CtkMenuClass   CtkMenuClass;
typedef struct _CtkMenuPrivate CtkMenuPrivate;

/**
 * CtkArrowPlacement:
 * @CTK_ARROWS_BOTH: Place one arrow on each end of the menu.
 * @CTK_ARROWS_START: Place both arrows at the top of the menu.
 * @CTK_ARROWS_END: Place both arrows at the bottom of the menu.
 *
 * Used to specify the placement of scroll arrows in scrolling menus.
 */
typedef enum
{
  CTK_ARROWS_BOTH,
  CTK_ARROWS_START,
  CTK_ARROWS_END
} CtkArrowPlacement;

/**
 * CtkMenuPositionFunc:
 * @menu: a #CtkMenu.
 * @x: (inout): address of the #gint representing the horizontal
 *     position where the menu shall be drawn.
 * @y: (inout): address of the #gint representing the vertical position
 *     where the menu shall be drawn.  This is an output parameter.
 * @push_in: (out): This parameter controls how menus placed outside
 *     the monitor are handled.  If this is set to %TRUE and part of
 *     the menu is outside the monitor then CTK+ pushes the window
 *     into the visible area, effectively modifying the popup
 *     position.  Note that moving and possibly resizing the menu
 *     around will alter the scroll position to keep the menu items
 *     “in place”, i.e. at the same monitor position they would have
 *     been without resizing.  In practice, this behavior is only
 *     useful for combobox popups or option menus and cannot be used
 *     to simply confine a menu to monitor boundaries.  In that case,
 *     changing the scroll offset is not desirable.
 * @user_data: the data supplied by the user in the ctk_menu_popup()
 *     @data parameter.
 *
 * A user function supplied when calling ctk_menu_popup() which
 * controls the positioning of the menu when it is displayed.  The
 * function sets the @x and @y parameters to the coordinates where the
 * menu is to be drawn.  To make the menu appear on a different
 * monitor than the mouse pointer, ctk_menu_set_monitor() must be
 * called.
 */
typedef void (*CtkMenuPositionFunc) (CtkMenu   *menu,
				     gint      *x,
				     gint      *y,
				     gboolean  *push_in,
				     gpointer	user_data);

/**
 * CtkMenuDetachFunc:
 * @attach_widget: the #CtkWidget that the menu is being detached from.
 * @menu: the #CtkMenu being detached.
 *
 * A user function supplied when calling ctk_menu_attach_to_widget() which 
 * will be called when the menu is later detached from the widget.
 */
typedef void (*CtkMenuDetachFunc)   (CtkWidget *attach_widget,
				     CtkMenu   *menu);

struct _CtkMenu
{
  CtkMenuShell menu_shell;

  /*< private >*/
  CtkMenuPrivate *priv;
};

struct _CtkMenuClass
{
  CtkMenuShellClass parent_class;

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


CDK_AVAILABLE_IN_ALL
GType	   ctk_menu_get_type		  (void) G_GNUC_CONST;
CDK_AVAILABLE_IN_ALL
CtkWidget* ctk_menu_new			  (void);
CDK_AVAILABLE_IN_3_4
CtkWidget* ctk_menu_new_from_model        (GMenuModel *model);

/* Display the menu onscreen */
CDK_AVAILABLE_IN_ALL
void	   ctk_menu_popup		  (CtkMenu	       *menu,
					   CtkWidget	       *parent_menu_shell,
					   CtkWidget	       *parent_menu_item,
					   CtkMenuPositionFunc	func,
					   gpointer		data,
					   guint		button,
					   guint32		activate_time);
CDK_AVAILABLE_IN_ALL
void       ctk_menu_popup_for_device      (CtkMenu             *menu,
                                           CdkDevice           *device,
                                           CtkWidget           *parent_menu_shell,
                                           CtkWidget           *parent_menu_item,
                                           CtkMenuPositionFunc  func,
                                           gpointer             data,
                                           GDestroyNotify       destroy,
                                           guint                button,
                                           guint32              activate_time);
CDK_AVAILABLE_IN_3_22
void       ctk_menu_popup_at_rect         (CtkMenu             *menu,
                                           CdkWindow           *rect_window,
                                           const CdkRectangle  *rect,
                                           CdkGravity           rect_anchor,
                                           CdkGravity           menu_anchor,
                                           const CdkEvent      *trigger_event);
CDK_AVAILABLE_IN_3_22
void       ctk_menu_popup_at_widget       (CtkMenu             *menu,
                                           CtkWidget           *widget,
                                           CdkGravity           widget_anchor,
                                           CdkGravity           menu_anchor,
                                           const CdkEvent      *trigger_event);
CDK_AVAILABLE_IN_3_22
void       ctk_menu_popup_at_pointer      (CtkMenu             *menu,
                                           const CdkEvent      *trigger_event);

/* Position the menu according to its position function. Called
 * from ctkmenuitem.c when a menu-item changes its allocation
 */
CDK_AVAILABLE_IN_ALL
void	   ctk_menu_reposition		  (CtkMenu	       *menu);

CDK_AVAILABLE_IN_ALL
void	   ctk_menu_popdown		  (CtkMenu	       *menu);

/* Keep track of the last menu item selected. (For the purposes
 * of the option menu
 */
CDK_AVAILABLE_IN_ALL
CtkWidget* ctk_menu_get_active		  (CtkMenu	       *menu);
CDK_AVAILABLE_IN_ALL
void	   ctk_menu_set_active		  (CtkMenu	       *menu,
					   guint		index);

/* set/get the accelerator group that holds global accelerators (should
 * be added to the corresponding toplevel with ctk_window_add_accel_group().
 */
CDK_AVAILABLE_IN_ALL
void	       ctk_menu_set_accel_group	  (CtkMenu	       *menu,
					   CtkAccelGroup       *accel_group);
CDK_AVAILABLE_IN_ALL
CtkAccelGroup* ctk_menu_get_accel_group	  (CtkMenu	       *menu);
CDK_AVAILABLE_IN_ALL
void           ctk_menu_set_accel_path    (CtkMenu             *menu,
					   const gchar         *accel_path);
CDK_AVAILABLE_IN_ALL
const gchar*   ctk_menu_get_accel_path    (CtkMenu             *menu);

/* A reference count is kept for a widget when it is attached to
 * a particular widget. This is typically a menu item; it may also
 * be a widget with a popup menu - for instance, the Notebook widget.
 */
CDK_AVAILABLE_IN_ALL
void	   ctk_menu_attach_to_widget	  (CtkMenu	       *menu,
					   CtkWidget	       *attach_widget,
					   CtkMenuDetachFunc	detacher);
CDK_AVAILABLE_IN_ALL
void	   ctk_menu_detach		  (CtkMenu	       *menu);

/* This should be dumped in favor of data set when the menu is popped
 * up - that is currently in the ItemFactory code, but should be
 * in the Menu code.
 */
CDK_AVAILABLE_IN_ALL
CtkWidget* ctk_menu_get_attach_widget	  (CtkMenu	       *menu);

CDK_AVAILABLE_IN_ALL
void       ctk_menu_set_tearoff_state     (CtkMenu             *menu,
                                           gboolean             torn_off);
CDK_AVAILABLE_IN_ALL
gboolean   ctk_menu_get_tearoff_state     (CtkMenu             *menu);

/* This sets the window manager title for the window that
 * appears when a menu is torn off
 */
CDK_AVAILABLE_IN_ALL
void          ctk_menu_set_title          (CtkMenu             *menu,
                                           const gchar         *title);
CDK_AVAILABLE_IN_ALL
const gchar * ctk_menu_get_title          (CtkMenu             *menu);

CDK_AVAILABLE_IN_ALL
void       ctk_menu_reorder_child         (CtkMenu             *menu,
                                           CtkWidget           *child,
                                           gint                position);

CDK_AVAILABLE_IN_ALL
void	   ctk_menu_set_screen		  (CtkMenu	       *menu,
					   CdkScreen	       *screen);

CDK_AVAILABLE_IN_ALL
void       ctk_menu_attach                (CtkMenu             *menu,
                                           CtkWidget           *child,
                                           guint                left_attach,
                                           guint                right_attach,
                                           guint                top_attach,
                                           guint                bottom_attach);

CDK_AVAILABLE_IN_ALL
void       ctk_menu_set_monitor           (CtkMenu             *menu,
                                           gint                 monitor_num);
CDK_AVAILABLE_IN_ALL
gint       ctk_menu_get_monitor           (CtkMenu             *menu);

CDK_AVAILABLE_IN_3_22
void       ctk_menu_place_on_monitor      (CtkMenu             *menu,
                                           CdkMonitor          *monitor);

CDK_AVAILABLE_IN_ALL
GList*     ctk_menu_get_for_attach_widget (CtkWidget           *widget); 

CDK_AVAILABLE_IN_ALL
void     ctk_menu_set_reserve_toggle_size (CtkMenu  *menu,
                                          gboolean   reserve_toggle_size);
CDK_AVAILABLE_IN_ALL
gboolean ctk_menu_get_reserve_toggle_size (CtkMenu  *menu);

G_DEFINE_AUTOPTR_CLEANUP_FUNC(CtkMenu, 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_MENU_H__ */