Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkmenu.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkMenu
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 a drop down menu widget.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkMenu is a #GtkMenuShell that implements a drop down menu consisting of
  10 a list of #GtkMenuItem objects which can be navigated and activated by the
  11 user to perform application functions.
  12 </para>
  13
  14 <para>
  15 A #GtkMenu is most commonly dropped down by activating a #GtkMenuItem in a
  16 #GtkMenuBar or popped up by activating a #GtkMenuItem in another #GtkMenu.
  17 </para>
  18
  19 <para>
  20 A #GtkMenu can also be popped up by activating a #GtkOptionMenu.
  21 Other composite widgets such as the #GtkNotebook can pop up a #GtkMenu
  22 as well.
  23 </para>
  24
  25 <para>
  26 Applications can display a #GtkMenu as a popup menu by calling the
  27 gtk_menu_popup() function.  The example below shows how an application
  28 can pop up a menu when the 3rd mouse button is pressed.
  29 </para>
  30
  31 <example>
  32 <title>Connecting the popup signal handler.</title>
  33 <programlisting>
  34     /* connect our handler which will popup the menu */
  35     gtk_signal_connect_object(GTK_OBJECT(window), "button_press_event",
  36         GTK_SIGNAL_FUNC (my_popup_handler), GTK_OBJECT(menu));
  37 </programlisting>
  38 </example>
  39
  40 <example>
  41 <title>Signal handler which displays a popup menu.</title>
  42 <programlisting>
  43 static gint
  44 my_popup_handler(GtkWidget *widget, GdkEvent *event)
  45 {
  46   GtkMenu *menu;
  47   GdkEventButton *event_button;
  48
  49   g_return_val_if_fail (widget != NULL, FALSE);
  50   g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
  51   g_return_val_if_fail (event != NULL, FALSE);
  52
  53   /* The "widget" is the menu that was supplied when
  54    * gtk_signal_connect_object was called.
  55    */
  56   menu = GTK_MENU (widget);
  57
  58   if (event->type == GDK_BUTTON_PRESS)
  59     {
  60       event_button = (GdkEventButton *) event;
  61       if (event_button->button == 3)
  62         {
  63           gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
  64                           event_button->button, event_button->time);
  65           return TRUE;
  66         }
  67     }
  68
  69   return FALSE;
  70 }
  71 </programlisting>
  72 </example>
  73
  74 <!-- ##### SECTION See_Also ##### -->
  75 <para>
  76
  77 </para>
  78
  79 <!-- ##### STRUCT GtkMenu ##### -->
  80 <para>
  81 The #GtkMenu-struct struct contains private data only, and
  82 should be accessed using the functions below.
  83 </para>
  84
  85
  86 <!-- ##### FUNCTION gtk_menu_new ##### -->
  87 <para>
  88 Creates a new #GtkMenu.
  89 </para>
  90
  91 @Returns: a new #GtkMenu.
  92
  93
  94 <!-- ##### MACRO gtk_menu_append ##### -->
  95 <para>
  96 Adds a new #GtkMenuItem to the end of the menu's item list.
  97 </para>
  98
  99 <!-- # Unused Parameters # -->
 100 @menu: a #GtkMenu.
 101 @child: The #GtkMenuItem to add.
 102
 103
 104 <!-- ##### MACRO gtk_menu_prepend ##### -->
 105 <para>
 106 Adds a new #GtkMenuItem to the beginning of the menu's item list.
 107 </para>
 108
 109 <!-- # Unused Parameters # -->
 110 @menu: a #GtkMenu.
 111 @child: The #GtkMenuItem to add.
 112
 113
 114 <!-- ##### MACRO gtk_menu_insert ##### -->
 115 <para>
 116 Adds a new #GtkMenuItem to the menu's item list at the position
 117 indicated by @position.
 118 </para>
 119
 120 <!-- # Unused Parameters # -->
 121 @menu: a #GtkMenu.
 122 @child: The #GtkMenuItem to add.
 123 @position: The position in the item list where @child is added.
 124 Positions are numbered from 0 to n-1.
 125
 126
 127 <!-- ##### FUNCTION gtk_menu_reorder_child ##### -->
 128 <para>
 129 Moves a #GtkMenuItem to a new position within the #GtkMenu.
 130 </para>
 131
 132 @menu: a #GtkMenu.
 133 @child: the #GtkMenuItem to move.
 134 @position: the new position to place @child.  Positions are numbered from
 135 0 to n-1.
 136
 137
 138 <!-- ##### FUNCTION gtk_menu_popup ##### -->
 139 <para>
 140 Displays a menu and makes it available for selection.  Applications can use
 141 this function to display context-sensitive menus, and will typically supply
 142 NULL for the @parent_menu_shell, @parent_menu_item, @func and @data
 143 parameters.  The default menu positioning function will position the menu
 144 at the current pointer position.
 145 </para>
 146
 147 @menu: a #GtkMenu.
 148 @parent_menu_shell: the menu shell containing the triggering menu item.
 149 @parent_menu_item: the menu item whose activation triggered the popup.
 150 @func: a user supplied function used to position the menu.
 151 @data: user supplied data to be passed to @func.
 152 @button: the button which was pressed to initiate the event.
 153 @activate_time: the time at which the activation event occurred.
 154
 155
 156 <!-- ##### FUNCTION gtk_menu_set_accel_group ##### -->
 157 <para>
 158 Set the #GtkAccelGroup which holds global accelerators for the menu.
 159 </para>
 160
 161 @menu: a #GtkMenu.
 162 @accel_group: the #GtkAccelGroup to be associated with the menu.
 163
 164
 165 <!-- ##### FUNCTION gtk_menu_get_accel_group ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @menu:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gtk_menu_set_title ##### -->
 175 <para>
 176 Sets the title string for the menu.  The title is displayed when the menu
 177 is shown as a tearoff menu.
 178 </para>
 179
 180 @menu: a #GtkMenu.
 181 @title: a string containing the title for the menu.
 182
 183
 184 <!-- ##### FUNCTION gtk_menu_popdown ##### -->
 185 <para>
 186 Removes the menu from the screen.
 187 </para>
 188
 189 @menu: a #GtkMenu.
 190
 191
 192 <!-- ##### FUNCTION gtk_menu_reposition ##### -->
 193 <para>
 194 Repositions the menu according to its position function.
 195 </para>
 196
 197 @menu: a #GtkMenu.
 198
 199
 200 <!-- ##### FUNCTION gtk_menu_get_active ##### -->
 201 <para>
 202 Returns the selected menu item from the menu.  This is used by the
 203 #GtkOptionMenu.
 204 </para>
 205
 206 @menu: a #GtkMenu.
 207 @Returns: the #GtkMenuItem that was last selected in the menu.  If a
 208 selection has not yet been made, the first menu item is selected.
 209
 210
 211 <!-- ##### FUNCTION gtk_menu_set_active ##### -->
 212 <para>
 213 Selects the specified menu item within the menu.  This is used by the
 214 #GtkOptionMenu.
 215 </para>
 216
 217 @menu: a #GtkMenu.
 218 @index: the index of the menu item to select.  Index values are from
 219 0 to n-1.
 220
 221
 222 <!-- ##### FUNCTION gtk_menu_set_tearoff_state ##### -->
 223 <para>
 224 Changes the tearoff state of the menu.  A menu is normally displayed
 225 as drop down menu which persists as long as the menu is active.  It can
 226 also be displayed as a tearoff menu which persists until it is closed
 227 or reattached.
 228 </para>
 229
 230 @menu: a #GtkMenu.
 231 @torn_off: If TRUE, menu is displayed as a tearoff menu.
 232
 233
 234 <!-- ##### FUNCTION gtk_menu_attach_to_widget ##### -->
 235 <para>
 236 Attaches the menu to the widget and provides a callback function that will
 237 be invoked when the menu calls gtk_menu_detach() during its destruction.
 238 </para>
 239
 240 @menu: a #GtkMenu.
 241 @attach_widget: the #GtkWidget that the menu will be attached to.
 242 @detacher: the user supplied callback function that will be called when
 243 the menu calls gtk_menu_detach().
 244
 245
 246 <!-- ##### FUNCTION gtk_menu_detach ##### -->
 247 <para>
 248 Detaches the menu from the widget to which it had been attached.
 249 This function will call the callback function, @detacher, provided
 250 when the gtk_menu_attach_to_widget() function was called.
 251 </para>
 252
 253 @menu: a #GtkMenu.
 254
 255
 256 <!-- ##### FUNCTION gtk_menu_get_attach_widget ##### -->
 257 <para>
 258 Returns the #GtkWidget that the menu is attached to.
 259 </para>
 260
 261 @menu: a #GtkMenu.
 262 @Returns: the #GtkWidget that the menu is attached to.
 263
 264
 265 <!-- ##### USER_FUNCTION GtkMenuPositionFunc ##### -->
 266 <para>
 267 A user function supplied when calling gtk_menu_popup() which controls the
 268 positioning of the menu when it is displayed.  The function sets the @x
 269 and @y parameters to the coordinates where the menu is to be drawn.
 270 </para>
 271
 272 @menu: a #GtkMenu.
 273 @x: address of the #gint representing the horizontal position where the
 274 menu shall be drawn.  This is an output parameter.
 275 @y: address of the #gint representing the vertical position where the
 276 menu shall be drawn.  This is an output parameter.
 277 @push_in:
 278 @user_data: the data supplied by the user in the gtk_menu_popup() @data
 279 parameter.
 280
 281
 282 <!-- ##### USER_FUNCTION GtkMenuDetachFunc ##### -->
 283 <para>
 284 A user function supplied when calling gtk_menu_attach_to_widget() which
 285 will be called when the menu is later detached from the widget.
 286 </para>
 287
 288 @attach_widget: the #GtkWidget that the menu is being detached from.
 289 @menu: the #GtkMenu being detached.
 290
 291