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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkMenuItem
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The widget used for item in menus
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkMenuItem widget and the derived widgets are the only valid
  10 childs for menus. Their function is to correctly handle highlighting,
  11 alignment, events and submenus.
  12 </para>
  13 <para>
  14 As it derives from #GtkBin it can hold any valid child widget, altough
  15 only a few are really useful.
  16 </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19 <para>
  20 <variablelist>
  21 <varlistentry>
  22 <term>#GtkBin</term>
  23 <listitem><para>for how to handle the child.</para></listitem>
  24 </varlistentry>
  25 <varlistentry>
  26 <term>#GtkItem</term>
  27 <listitem><para>is the abstract class for all sorts of items.</para></listitem>
  28 </varlistentry>
  29 <varlistentry>
  30 <term>#GtkMenuShell</term>
  31 <listitem><para>is always the parent of #GtkMenuItem.</para></listitem>
  32 </varlistentry>
  33 </variablelist>
  34 </para>
  35
  36 <!-- ##### SECTION Stability_Level ##### -->
  37
  38
  39 <!-- ##### STRUCT GtkMenuItem ##### -->
  40 <para>
  41
  42 </para>
  43
  44
  45 <!-- ##### SIGNAL GtkMenuItem::activate ##### -->
  46 <para>
  47 Emitted when the item is activated.
  48 </para>
  49
  50 @menuitem: the object which received the signal.
  51
  52 <!-- ##### SIGNAL GtkMenuItem::activate-item ##### -->
  53 <para>
  54 Emitted when the item is activated, but also if the menu item has a
  55 submenu. For normal applications, the relevant signal is "activate".
  56 </para>
  57
  58 @menuitem: the object which received the signal.
  59
  60 <!-- ##### SIGNAL GtkMenuItem::toggle-size-allocate ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @menuitem: the object which received the signal.
  66 @arg1:
  67
  68 <!-- ##### SIGNAL GtkMenuItem::toggle-size-request ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @menuitem: the object which received the signal.
  74 @arg1:
  75
  76 <!-- ##### ARG GtkMenuItem:accel-path ##### -->
  77 <para>
  78
  79 </para>
  80
  81 <!-- ##### ARG GtkMenuItem:right-justified ##### -->
  82 <para>
  83
  84 </para>
  85
  86 <!-- ##### ARG GtkMenuItem:submenu ##### -->
  87 <para>
  88
  89 </para>
  90
  91 <!-- ##### ARG GtkMenuItem:arrow-scaling ##### -->
  92 <para>
  93
  94 </para>
  95
  96 <!-- ##### ARG GtkMenuItem:arrow-spacing ##### -->
  97 <para>
  98
  99 </para>
 100
 101 <!-- ##### ARG GtkMenuItem:horizontal-padding ##### -->
 102 <para>
 103
 104 </para>
 105
 106 <!-- ##### ARG GtkMenuItem:selected-shadow-type ##### -->
 107 <para>
 108
 109 </para>
 110
 111 <!-- ##### ARG GtkMenuItem:toggle-spacing ##### -->
 112 <para>
 113
 114 </para>
 115
 116 <!-- ##### ARG GtkMenuItem:width-chars ##### -->
 117 <para>
 118
 119 </para>
 120
 121 <!-- ##### FUNCTION gtk_menu_item_new ##### -->
 122 <para>
 123 Creates a new #GtkMenuItem.
 124 </para>
 125
 126 @Returns: the newly created #GtkMenuItem
 127
 128
 129 <!-- ##### FUNCTION gtk_menu_item_new_with_label ##### -->
 130 <para>
 131 Creates a new #GtkMenuItem whose child is a #GtkLabel.
 132 </para>
 133
 134 @label: the text for the label
 135 @Returns: the newly created #GtkMenuItem
 136
 137
 138 <!-- ##### FUNCTION gtk_menu_item_new_with_mnemonic ##### -->
 139 <para>
 140
 141 </para>
 142
 143 @label:
 144 @Returns:
 145
 146
 147 <!-- ##### FUNCTION gtk_menu_item_set_right_justified ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @menu_item:
 153 @right_justified:
 154
 155
 156 <!-- ##### FUNCTION gtk_menu_item_set_submenu ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @menu_item:
 162 @submenu:
 163
 164
 165 <!-- ##### FUNCTION gtk_menu_item_set_accel_path ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @menu_item:
 171 @accel_path:
 172
 173
 174 <!-- ##### FUNCTION gtk_menu_item_remove_submenu ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @menu_item:
 180
 181
 182 <!-- ##### FUNCTION gtk_menu_item_select ##### -->
 183 <para>
 184 Emits the "select" signal on the given item. Behaves exactly like
 185 #gtk_item_select.
 186 </para>
 187
 188 @menu_item: the menu item
 189
 190
 191 <!-- ##### FUNCTION gtk_menu_item_deselect ##### -->
 192 <para>
 193 Emits the "deselect" signal on the given item. Behaves exactly like
 194 #gtk_item_deselect.
 195 </para>
 196
 197 @menu_item: the menu item
 198
 199
 200 <!-- ##### FUNCTION gtk_menu_item_activate ##### -->
 201 <para>
 202 Emits the "activate" signal on the given item
 203 </para>
 204
 205 @menu_item: the menu item
 206
 207
 208 <!-- ##### FUNCTION gtk_menu_item_toggle_size_request ##### -->
 209 <para>
 210 Emits the "toggle_size_request" signal on the given item.
 211 </para>
 212
 213 @menu_item: the menu item
 214 @requisition: the requisition to use as signal data.
 215
 216
 217 <!-- ##### FUNCTION gtk_menu_item_toggle_size_allocate ##### -->
 218 <para>
 219 Emits the "toggle_size_allocate" signal on the given item.
 220 </para>
 221
 222 @menu_item: the menu item.
 223 @allocation: the allocation to use as signal data.
 224
 225
 226 <!-- ##### MACRO gtk_menu_item_right_justify ##### -->
 227 <para>
 228 Sets the menu item to be right-justified. Only useful for menu bars.
 229 </para>
 230
 231 @menu_item: the menu item
 232
 233
 234 <!-- ##### FUNCTION gtk_menu_item_get_right_justified ##### -->
 235 <para>
 236
 237 </para>
 238
 239 @menu_item:
 240 @Returns:
 241
 242
 243 <!-- ##### FUNCTION gtk_menu_item_get_submenu ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @menu_item:
 249 @Returns:
 250
 251