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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkOptionMenu
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget used to choose from a list of valid choices
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkOptionMenu is a widget that allows the user to choose from a
  10 list of valid choices.  The #GtkOptionMenu displays the selected
  11 choice.  When activated the #GtkOptionMenu displays a popup #GtkMenu
  12 which allows the user to make a new choice.
  13 </para>
  14
  15 <para>
  16 Using a #GtkOptionMenu is simple; build a #GtkMenu, by calling
  17 gtk_menu_new(), then appending menu items to it with
  18 gtk_menu_shell_append(). Set that menu on the option menu
  19 with gtk_option_menu_set_menu(). Set the selected menu item with
  20 gtk_option_menu_set_history(); connect to the "changed" signal on
  21 the option menu; in the "changed" signal, check the new selected
  22 menu item with gtk_option_menu_get_history().
  23 </para>
  24
  25 <para>
  26 As of GTK+ 2.4, #GtkOptionMenu has been deprecated in favor of #GtkComboBox.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30
  31
  32 <!-- ##### SECTION Stability_Level ##### -->
  33
  34
  35 <!-- ##### STRUCT GtkOptionMenu ##### -->
  36 <para>
  37 The #GtkOptionMenu-struct struct contains private data only, and
  38 should be accessed using the functions below.
  39 </para>
  40
  41 @Deprecated: Use #GtkComboBox instead.
  42
  43 <!-- ##### SIGNAL GtkOptionMenu::changed ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @optionmenu: the object which received the signal.
  49
  50 <!-- ##### ARG GtkOptionMenu:menu ##### -->
  51 <para>
  52
  53 </para>
  54
  55 <!-- ##### ARG GtkOptionMenu:indicator-size ##### -->
  56 <para>
  57
  58 </para>
  59
  60 <!-- ##### ARG GtkOptionMenu:indicator-spacing ##### -->
  61 <para>
  62
  63 </para>
  64
  65 <!-- ##### FUNCTION gtk_option_menu_new ##### -->
  66 <para>
  67 Creates a new #GtkOptionMenu.
  68 </para>
  69
  70 @Returns: a new #GtkOptionMenu.
  71 @Deprecated: Use #GtkComboBox instead.
  72
  73
  74 <!-- ##### FUNCTION gtk_option_menu_get_menu ##### -->
  75 <para>
  76 Returns the #GtkMenu associated with the #GtkOptionMenu.
  77 </para>
  78
  79 @option_menu: a #GtkOptionMenu.
  80 @Returns: the #GtkMenu associated with the #GtkOptionMenu.
  81 @Deprecated: Use #GtkComboBox instead.
  82
  83
  84 <!-- ##### FUNCTION gtk_option_menu_set_menu ##### -->
  85 <para>
  86 Provides the #GtkMenu that is popped up to allow the user to choose
  87 a new value.  You should provide a simple menu avoiding the
  88 use of tearoff menu items, submenus, and accelerators.
  89 </para>
  90
  91 @option_menu: a #GtkOptionMenu.
  92 @menu: the #GtkMenu to associate with the #GtkOptionMenu.
  93 @Deprecated: Use #GtkComboBox instead.
  94
  95
  96 <!-- ##### FUNCTION gtk_option_menu_remove_menu ##### -->
  97 <para>
  98 Removes the menu from the option menu.
  99 </para>
 100
 101 @option_menu: a #GtkOptionMenu.
 102 @Deprecated: Use #GtkComboBox instead.
 103
 104
 105 <!-- ##### FUNCTION gtk_option_menu_set_history ##### -->
 106 <para>
 107 Selects the menu item specified by @index_ making it the newly
 108 selected value for the option menu.
 109 </para>
 110
 111 @option_menu: a #GtkOptionMenu.
 112 @index_: the index of the menu item to select.  Index values are from 0 to n-1.
 113 @Deprecated: Use #GtkComboBox instead.
 114
 115
 116 <!-- ##### FUNCTION gtk_option_menu_get_history ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @option_menu:
 122 @Returns:
 123
 124