Hildon::TouchSelectorEntry Class Reference
[Widgets]

Selector widget with a text entry. More...

Inheritance diagram for Hildon::TouchSelectorEntry:

[legend]

List of all members.

Public Member Functions
virtual	~TouchSelectorEntry ()
HildonTouchSelectorEntry *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonTouchSelectorEntry *	gobj () const
	Provides access to the underlying C GtkObject.
	TouchSelectorEntry ()
void	set_text_column (const Gtk::TreeModelColumnBase &text_column)
	Sets the model column which touch selector box should use to get strings from to be text_column.
void	set_text_column (int text_column)
	Sets the model column which touch selector box should use to get strings from to be text_column.
int	get_text_column () const
	Gets the text column that selector is using as a text column.
Gtk::Hildon::InputMode	get_input_mode () const
	Gets the input mode used in the Gtk::Entry in selector.
void	set_input_mode (Gtk::Hildon::InputMode input_mode)
	Sets the input mode to be used in the Gtk::Entry in selector.
Entry *	get_entry ()
	Provides access to the Hildon::Entry in selector.
const Entry *	get_entry () const
	Provides access to the Hildon::Entry in selector.
Related Functions
(Note that these are not member functions.)
Hildon::TouchSelectorEntry *	wrap (HildonTouchSelectorEntry *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

Selector widget with a text entry.

Hildon::TouchSelectorEntry is a selector widget with a text entry, similar in behaviour to Gtk::ComboBoxEntry, that allows user to select an item from a predefined list or to enter a different one in a Hildon::Entry. Items can also be searched and selected by typing in the entry. For more specific use cases, the Hildon::Entry can be accessed directly with Hildon::TouchSelectorEntry::get_entry().

The main difference between the Gtk::TreeModel used by Hildon::TouchSelector and Hildon::TouchSelectorEntry, is that the latter must always include a text column. You should set it with Hildon::TouchSelectorEntry::set_text_column().

Normally, you would use Hildon::TouchSelectorEntry together with a Hildon::PickerDialog activated from a button. For the most common cases, you should use Hildon::PickerButton.

If you only need a text-only, one column selector, you can use the simpler TouchSelectorEntryText class.

---

Constructor & Destructor Documentation

virtual Hildon::TouchSelectorEntry::~TouchSelectorEntry

(

)

[virtual]

Hildon::TouchSelectorEntry::TouchSelectorEntry

(

)

---

Member Function Documentation

HildonTouchSelectorEntry* Hildon::TouchSelectorEntry::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::TouchSelector.

const HildonTouchSelectorEntry* Hildon::TouchSelectorEntry::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Hildon::TouchSelector.

void Hildon::TouchSelectorEntry::set_text_column

(

const Gtk::TreeModelColumnBase &

text_column

)

Sets the model column which touch selector box should use to get strings from to be text_column.

{2,2}

Parameters:

text_column

A column in model to get the strings from.

void Hildon::TouchSelectorEntry::set_text_column

(

int

text_column

)

Sets the model column which touch selector box should use to get strings from to be text_column.

{2,2}

Parameters:

text_column

A column in model to get the strings from.

int Hildon::TouchSelectorEntry::get_text_column

(

)

const

Gets the text column that selector is using as a text column.

Returns:

The number of the column used as a text column.

{2,2}.

Gtk::Hildon::InputMode Hildon::TouchSelectorEntry::get_input_mode

(

)

const

Gets the input mode used in the Gtk::Entry in selector.

See hildon_gtk_entry_get_input_mode() for details.

Returns:

A mask of Hildon::GtkInputMode

{2,2}.

void Hildon::TouchSelectorEntry::set_input_mode

(

Gtk::Hildon::InputMode

input_mode

)

Sets the input mode to be used in the Gtk::Entry in selector.

See hildon_gtk_entry_set_input_mode() for details.

It must be noted that not all input modes are available for the entry in selector. In particular, Hildon::GTK_INPUT_MODE_MULTILINE, Hildon::GTK_INPUT_MODE_INVISIBLE, Hildon::GTK_INPUT_MODE_DICTIONARY are disabled, since these are irrelevant for Hildon::TouchSelectorEntry.

{2,2}

Parameters:

input_mode

Hildon::GtkInputMode mask.

Entry* Hildon::TouchSelectorEntry::get_entry

(

)

Provides access to the Hildon::Entry in selector.

Use to programmatically change the contents in entry or modify its behavior.

Returns:

A Hildon::Entry.

{2,2}.

const Entry* Hildon::TouchSelectorEntry::get_entry

(

)

const

Provides access to the Hildon::Entry in selector.

Use to programmatically change the contents in entry or modify its behavior.

Returns:

A Hildon::Entry.

{2,2}.

---

Friends And Related Function Documentation

Hildon::TouchSelectorEntry * wrap	(	HildonTouchSelectorEntry *	object,
		bool	take_copy = false
	)			[related]

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

Parameters:

	object	The C instance.
	take_copy	False 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:

• touch-selector-entry.h