Hildon::FindToolbar Class Reference
[Widgets]

A toolbar with a search field. More...

Inheritance diagram for Hildon::FindToolbar:

[legend]

List of all members.

Public Member Functions
virtual	~FindToolbar ()
HildonFindToolbar *	gobj ()
	Provides access to the underlying C GtkObject.
const HildonFindToolbar *	gobj () const
	Provides access to the underlying C GtkObject.
	FindToolbar ()
	FindToolbar (const Glib::ustring &label)
	FindToolbar (const Glib::ustring &label, const Glib::RefPtr< Gtk::ListStore > &list, int column)
	FindToolbar (const Glib::ustring &label, const Glib::RefPtr< Gtk::ListStore > &list, const Gtk::TreeModelColumnBase &column)
void	highlight_entry (bool get_focus=true)
	Highlights the current entry in the Hildon::FindToolbar.
void	set_active (int index)
	Sets the active item on the Hildon::FindToolbar's Gtk::ComboBox.
int	get_active () const
	Gets the index of the currently active item, or -1 if there's no active item.
void	set_active_iter (const Gtk::TreeModel::iterator &iter)
	Sets the current active item to be the one referenced by iter.
Gtk::TreeModel::iterator	get_active_iter ()
	Get an iterator that points to the current active item.
int	get_last_index () const
	Returns: Index of the most recent entry.
Glib::SignalProxy0< void >	signal_search ()
Glib::SignalProxy0< void >	signal_close ()
Glib::SignalProxy0< void >	signal_invalid_input ()
Glib::SignalProxy0< bool >	signal_history_append ()
Related Functions
(Note that these are not member functions.)
Hildon::FindToolbar *	wrap (HildonFindToolbar *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

A toolbar with a search field.

The FindToolbar toolbar contains a search entry and a dropdown list with previously searched strings. The list is represented using a Gtk::ListStore and can be accessed via Hildon::FindToolbar::property_list(). Entries are added automatically to the list when the search button is pressed.

See also:

Hildon::Window

---

Constructor & Destructor Documentation

virtual Hildon::FindToolbar::~FindToolbar

(

)

[virtual]

Hildon::FindToolbar::FindToolbar

(

)

Hildon::FindToolbar::FindToolbar

(

const Glib::ustring &

label

)

[explicit]

Hildon::FindToolbar::FindToolbar	(	const Glib::ustring &	label,
		const Glib::RefPtr< Gtk::ListStore > &	list,
		int	column
	)			[explicit]

Hildon::FindToolbar::FindToolbar	(	const Glib::ustring &	label,
		const Glib::RefPtr< Gtk::ListStore > &	list,
		const Gtk::TreeModelColumnBase &	column
	)			[explicit]

---

Member Function Documentation

HildonFindToolbar* Hildon::FindToolbar::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Toolbar.

const HildonFindToolbar* Hildon::FindToolbar::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Toolbar.

void Hildon::FindToolbar::highlight_entry

(

bool

get_focus = true

)

Highlights the current entry in the Hildon::FindToolbar.

Parameters:

get_focus

If user passes true to this value, then the text in the entry will not only get highlighted, but also get focused.

void Hildon::FindToolbar::set_active

(

int

index

)

Sets the active item on the Hildon::FindToolbar's Gtk::ComboBox.

Simply calls gtk_combo_box_set_active() on the Hildon::FindToolbar's Gtk::ComboBox.

Parameters:

index

An index in the model, or -1 to have no active item.

int Hildon::FindToolbar::get_active

(

)

const

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

Simply calls gtk_combo_box_get_active() on the Hildon::FindToolbar's Gtk::ComboBox.

Returns:

The index of the currently active item, or -1 if there is no active item.

void Hildon::FindToolbar::set_active_iter

(

const Gtk::TreeModel::iterator &

iter

)

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

Simply calls gtk_combo_box_set_active_iter() on the Hildon::FindToolbar's Gtk::ComboBox.

Parameters:

iter

A Gtk::TreeIter to activate.

Gtk::TreeModel::iterator Hildon::FindToolbar::get_active_iter

(

)

Get an iterator that points to the current active item.

Returns:

An iterator that points to the current active item, if it exists. Simply calls get_active_iter() on the FindToolbar's combo.

int Hildon::FindToolbar::get_last_index

(

)

const

Returns: Index of the most recent entry.

Returns:

Index of the most recent entry.

Glib::SignalProxy0< void > Hildon::FindToolbar::signal_search

(

)

Prototype:

void on_my_search()

Glib::SignalProxy0< void > Hildon::FindToolbar::signal_close

(

)

Prototype:

void on_my_close()

Glib::SignalProxy0< void > Hildon::FindToolbar::signal_invalid_input

(

)

Prototype:

void on_my_invalid_input()

Glib::SignalProxy0< bool > Hildon::FindToolbar::signal_history_append

(

)

Prototype:

bool on_my_history_append()

---

Friends And Related Function Documentation

Hildon::FindToolbar * wrap	(	HildonFindToolbar *	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:

• find-toolbar.h