Wt::WComboBox Class Reference

A widget that provides a drop-down combo-box control. More...

#include <WComboBox>

Inheritance diagram for Wt::WComboBox:

Inheritance graph
[legend]

List of all members.

Public Slots

void clear ()
 Clear all items.

Public Member Functions

 WComboBox (WContainerWidget *parent=0)
 Create an empty combo-box with optional parent.
void addItem (const WString &text)
 Add an option item.
int count () const
 Get the number of items.
int currentIndex () const
 Get the currently selected item.
void insertItem (int index, const WString &text)
 Insert an option item at the specified position.
void removeItem (int index)
 Remove the option item at the specified position.
void setCurrentIndex (int index)
 Change the current selection.
void setItemText (int index, const WString &text)
 Change the text for a specified option.
const WString currentText () const
 Get the text of the currently selected item.
const WString itemText (int index) const
 Get the text of a particular item.
void setModel (WAbstractItemModel *model)
 Set the model to be used for the items.
void setModelColumn (int index)
 Set the column in the model to be used for the items.
WValidator::State validate ()
 Validate the field.
virtual void refresh ()
 Refresh the widget.

Public Attributes

Signal< int > activated
 Signal emitted when the selection changed.
Signal< WStringsactivated
 Signal emitted when the selection changed.


Detailed Description

A widget that provides a drop-down combo-box control.

WComboBox is an inline widget.

A combo-box provides the user with a choice of options to chose from. Use addItem(const WString&) or insertItem(int, const WString&) to populate the combo-box. All the content can be cleared through clear().

To act on a new selection, either connect a slot to the changed() signal, or to the activated(int) or activated(const std::string) signals.

At all times, the current selection index is available through currentIndex() or the text using currentText().

By default the WComboBox uses a WStandardItemModel to store the items. This may be changed by specifying a custom model with setModel().


Member Function Documentation

void Wt::WComboBox::addItem ( const WString text  ) 

Add an option item.

Equivalent to insertItem (count(), text).

int Wt::WComboBox::currentIndex (  )  const

Get the currently selected item.

If no item is currently selected, the method returns -1.

void Wt::WComboBox::insertItem ( int  index,
const WString text 
)

Insert an option item at the specified position.

The option item is inserted at position index.

void Wt::WComboBox::removeItem ( int  index  ) 

Remove the option item at the specified position.

The option item at position index will be removed.

void Wt::WComboBox::setCurrentIndex ( int  index  ) 

Change the current selection.

Specify a value of -1 for index to clear the selection.

void Wt::WComboBox::setItemText ( int  index,
const WString text 
)

Change the text for a specified option.

Use this method to change the text for the item at position index.

const WString Wt::WComboBox::itemText ( int  index  )  const

Get the text of a particular item.

Use this method to get the text for the item at position index.

void Wt::WComboBox::setModel ( WAbstractItemModel model  ) 

Set the model to be used for the items.

The model may not be 0, and ownership of the model is not transferred.

See also:
setModelColumn(int)

void Wt::WComboBox::setModelColumn ( int  index  ) 

Set the column in the model to be used for the items.

The column index in the model will be used to retrieve data.

See also:
setModel()

void Wt::WComboBox::refresh (  )  [virtual]

Refresh the widget.

The refresh method is invoked when the locale is changed using WApplication::setLocale() or when the user hit the refresh button.

The widget must actualize its contents in response.

Reimplemented from Wt::WWebWidget.


The documentation for this class was generated from the following files:
Generated on Mon Apr 14 15:15:01 2008 for Wt by doxygen 1.5.3