gtkmm 2.24.2
Public Member Functions | Protected Member Functions | Related Functions

Gtk::OptionMenu Class Reference

A widget used to choose from a list of valid choices. More...

Inheritance diagram for Gtk::OptionMenu:
Inheritance graph
[legend]
Collaboration diagram for Gtk::OptionMenu:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~OptionMenu ()
GtkOptionMenu* gobj ()
 Provides access to the underlying C GtkObject.
const GtkOptionMenu* gobj () const
 Provides access to the underlying C GtkObject.
 OptionMenu ()
void set_menu (Menu& menu)
Menuget_menu ()
const Menuget_menu () const
void remove_menu ()
int get_history () const
 Retrieves the index of the currently selected menu item.
void set_history (guint index)
Glib::SignalProxy0< void > signal_changed ()

Protected Member Functions

virtual void on_changed ()

Related Functions

(Note that these are not member functions.)
Gtk::OptionMenuwrap (GtkOptionMenu* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

A widget used to choose from a list of valid choices.

A Gtk::OptionMenu is a widget that allows the user to choose from a list of valid choices. The Gtk::OptionMenu displays the selected choice. When activated the GtkOptionMenu displays a popup Gtk::Menu which allows the user to make a new choice.

Deprecated:
Use the ComboBox widget instead.

Constructor & Destructor Documentation

virtual Gtk::OptionMenu::~OptionMenu ( ) [virtual]
Gtk::OptionMenu::OptionMenu ( )

Member Function Documentation

int Gtk::OptionMenu::get_history ( ) const

Retrieves the index of the currently selected menu item.

The menu items are numbered from top to bottom, starting with 0.

Deprecated: 2.4: Use Gtk::ComboBox instead.

Returns:
Index of the selected menu item, or -1 if there are no menu items.
Menu* Gtk::OptionMenu::get_menu ( )
const Menu* Gtk::OptionMenu::get_menu ( ) const
GtkOptionMenu* Gtk::OptionMenu::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Button.

const GtkOptionMenu* Gtk::OptionMenu::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Button.

virtual void Gtk::OptionMenu::on_changed ( ) [protected, virtual]
void Gtk::OptionMenu::remove_menu ( )
void Gtk::OptionMenu::set_history ( guint  index)
void Gtk::OptionMenu::set_menu ( Menu menu)
Glib::SignalProxy0< void > Gtk::OptionMenu::signal_changed ( )
Prototype:
void on_my_changed()

Friends And Related Function Documentation

Gtk::OptionMenu* wrap ( GtkOptionMenu *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: