Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::ComboBox Class Reference

A GtkComboBox C++ wrapper class. More...

#include <xfc/gtk/combobox.hh>

Inheritance diagram for Xfc::Gtk::ComboBox:

Xfc::Gtk::Bin Xfc::Gtk::CellLayout Xfc::Gtk::Container Xfc::G::TypeInterface Xfc::Gtk::Widget Xfc::G::TypeInstance Xfc::Gtk::Object Xfc::Atk::Implementor Xfc::Trackable Xfc::G::Object Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::G::TypeInstance Xfc::Trackable Xfc::Trackable Xfc::Gtk::ComboBoxEntry Xfc::Gtk::ComboBoxText Xfc::Gtk::ComboBoxEntryText List of all members.

Signal Prototypes

Public Member Functions

Constructors
Accessors
Methods
Signal Proxies

Protected Member Functions

Constructors

Detailed Description

A GtkComboBox C++ wrapper class.

The ComboBox widget is used to choose an item from a list of items.

See also: the ComboBox HOWTOs and examples.


Constructor & Destructor Documentation

Xfc::Gtk::ComboBox::ComboBox GtkComboBox *  combo_box,
bool  owns_reference = false
[explicit, protected]
 

Construct a new ComboBox from an existing GtkComboBox.

Parameters:
combo_box A pointer to a GtkComboBox.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The combo_box can be a newly created GtkComboBox or an existing GtkComboBox (see G::Object::Object).

Xfc::Gtk::ComboBox::ComboBox TreeModel model  ) 
 

Constructs a new combo box with the model initialized to model.

Parameters:
model A Gtk::TreeModel.


Member Function Documentation

int Xfc::Gtk::ComboBox::get_active  )  const
 

Gets the index of the currently active item, or -1 if there's no active item.

Returns:
An integer which is the index of the currently active item, or -1 if there's no active item.

bool Xfc::Gtk::ComboBox::get_active_iter TreeIter iter  )  const
 

Sets iter to point to the current active item, if it exists.

Parameters:
iter A Gtk::TreeIter.
Returns:
true if iter was set to point to the active item.

TreeModel* Xfc::Gtk::ComboBox::get_model  )  const
 

Gets the Gtk::TreeModel which is acting as data source for the combo box.

Returns:
A Gtk::TreeModel.

void Xfc::Gtk::ComboBox::popdown  ) 
 

Hides the menu or dropdown list of the combo box.

This method is mostly intended for use by accessibility technologies; applications should have little use for it.

void Xfc::Gtk::ComboBox::popup  ) 
 

Pops up the menu or dropdown list of the combo box.

This method is mostly intended for use by accessibility technologies; applications should have little use for it.

void Xfc::Gtk::ComboBox::set_active int  index  ) 
 

Sets the active item of the combo box to be the item at index.

Parameters:
index An index in the model passed during construction, or -1 to have no active item.

void Xfc::Gtk::ComboBox::set_active_iter const TreeIter iter  ) 
 

Sets the current active item to be the one referenced by iter.

Parameters:
iter The Gtk::TreeIter.
iter must correspond to a path of depth one.

void Xfc::Gtk::ComboBox::set_column_span_column int  column_span  ) 
 

Sets the column with column span information for the combo box to be column_span.

Parameters:
column_span A column in the model passed during construction.
The column span column contains integers which indicate how many columns an item should span.

void Xfc::Gtk::ComboBox::set_model TreeModel model  ) 
 

Sets the model used by the combo box to be model.

Parameters:
model A Gtk::TreeModel.
Will unset a previously set model (if applicable).

void Xfc::Gtk::ComboBox::set_row_span_column int  row_span  ) 
 

Sets the column with row span information for the combo box to be row_span.

Parameters:
row_span A column in the model passed during construction.
The row span column contains integers which indicate how many rows an item should span.

void Xfc::Gtk::ComboBox::set_wrap_width int  width  ) 
 

Sets the wrap width of the combo box to be width.

Parameters:
width The preferred number of columns.
The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table.


Member Data Documentation

const ChangedSignalType Xfc::Gtk::ComboBox::changed_signal [static, protected]
 

Changed signal (see signal_changed()).

Calls a slot with the signature:

             void function();


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3