Wiki
Задать вопрос на форуме...

gtkoptionmenu

gtkoptionmenu — a widget used to choose from a list of valid choices

synopsis


#include <gtk/gtk.h>


            gtkoptionmenu;
gtkwidget*  gtk_option_menu_new             (void);
gtkwidget*  gtk_option_menu_get_menu        (gtkoptionmenu *option_menu);
void        gtk_option_menu_set_menu        (gtkoptionmenu *option_menu,
                                             gtkwidget *menu);
void        gtk_option_menu_remove_menu     (gtkoptionmenu *option_menu);
void        gtk_option_menu_set_history     (gtkoptionmenu *option_menu,
                                             guint index_);
gint        gtk_option_menu_get_history     (gtkoptionmenu *option_menu);

object hierarchy


  gobject
   +----ginitiallyunowned
         +----gtkobject
               +----gtkwidget
                     +----gtkcontainer
                           +----gtkbin
                                 +----gtkbutton
                                       +----gtkoptionmenu

implemented interfaces

gtkoptionmenu implements atkimplementoriface.

properties


  "menu"                 gtkmenu               : read / write

style properties


  "indicator-size"       gtkrequisition        : read
  "indicator-spacing"    gtkborder             : read

signals


"changed"   void        user_function      (gtkoptionmenu *optionmenu,
                                            gpointer       user_data)       : run last

description

a gtkoptionmenu is a widget that allows the user to choose from a list of valid choices. the gtkoptionmenu displays the selected choice. when activated the gtkoptionmenu displays a popup gtkmenu which allows the user to make a new choice.

using a gtkoptionmenu is simple; build a gtkmenu, by calling gtk_menu_new(), then appending menu items to it with gtk_menu_shell_append(). set that menu on the option menu with gtk_option_menu_set_menu(). set the selected menu item with gtk_option_menu_set_history(); connect to the "changed" signal on the option menu; in the "changed" signal, check the new selected menu item with gtk_option_menu_get_history().

as of gtk+ 2.4, gtkoptionmenu has been deprecated in favor of gtkcombobox.

details

gtkoptionmenu

typedef struct _gtkoptionmenu gtkoptionmenu;

warning

gtkoptionmenu is deprecated and should not be used in newly-written code. use gtkcombobox instead.

the gtkoptionmenu-struct struct contains private data only, and should be accessed using the functions below.

gtk_option_menu_new ()

gtkwidget*  gtk_option_menu_new             (void);

warning

gtk_option_menu_new is deprecated and should not be used in newly-written code. use gtkcombobox instead.

creates a new gtkoptionmenu.

returns : a new gtkoptionmenu.

gtk_option_menu_get_menu ()

gtkwidget*  gtk_option_menu_get_menu        (gtkoptionmenu *option_menu);

warning

gtk_option_menu_get_menu is deprecated and should not be used in newly-written code. use gtkcombobox instead.

returns the gtkmenu associated with the gtkoptionmenu.

option_menu : a gtkoptionmenu.
returns : the gtkmenu associated with the gtkoptionmenu.

gtk_option_menu_set_menu ()

void        gtk_option_menu_set_menu        (gtkoptionmenu *option_menu,
                                             gtkwidget *menu);

warning

gtk_option_menu_set_menu is deprecated and should not be used in newly-written code. use gtkcombobox instead.

provides the gtkmenu that is popped up to allow the user to choose a new value. you should provide a simple menu avoiding the use of tearoff menu items, submenus, and accelerators.

option_menu : a gtkoptionmenu.
menu : the gtkmenu to associate with the gtkoptionmenu.

gtk_option_menu_remove_menu ()

void        gtk_option_menu_remove_menu     (gtkoptionmenu *option_menu);

warning

gtk_option_menu_remove_menu is deprecated and should not be used in newly-written code. use gtkcombobox instead.

removes the menu from the option menu.

option_menu : a gtkoptionmenu.

gtk_option_menu_set_history ()

void        gtk_option_menu_set_history     (gtkoptionmenu *option_menu,
                                             guint index_);

warning

gtk_option_menu_set_history is deprecated and should not be used in newly-written code. use gtkcombobox instead.

selects the menu item specified by index_ making it the newly selected value for the option menu.

option_menu : a gtkoptionmenu.
index_ : the index of the menu item to select. index values are from 0 to n-1.

gtk_option_menu_get_history ()

gint        gtk_option_menu_get_history     (gtkoptionmenu *option_menu);

warning

gtk_option_menu_get_history is deprecated and should not be used in newly-written code. use gtkcombobox instead.

retrieves the index of the currently selected menu item. the menu items are numbered from top to bottom, starting with 0.

option_menu : a gtkoptionmenu
returns : index of the selected menu item, or -1 if there are no menu items

property details

the "menu" property

  "menu"                 gtkmenu               : read / write

the menu of options.

style property details

the "indicator-size" style property

  "indicator-size"       gtkrequisition        : read

size of dropdown indicator.

the "indicator-spacing" style property

  "indicator-spacing"    gtkborder             : read

spacing around indicator.

signal details

the "changed" signal

void        user_function                  (gtkoptionmenu *optionmenu,
                                            gpointer       user_data)       : run last

optionmenu : the object which received the signal.
user_data : user data set when the signal handler was connected.