Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::FindToolbar Class Reference
[Widgets]

Inheritance diagram for Hildon::FindToolbar:

Inheritance graph
[legend]
List of all members.

Detailed Description

A Hildon::FindToolbar is a special toolbar for the Find feature.

Maemo applications can have several toolbars, which are then attached on top of each other. The Find toolbar is generally placed on the top of the main toolbar, as in the example covered in this section.

This is a predefined toolbar for text searching purposes. It contains a Gtk::ListStore which has the text items that the user has searched. The programmer may get the Gtk::ListStore via the "list" property, in order to use the information.

Note that once the search button is pressed, the string in the ComboBoxEntry will be automatically added to the existing model, unless it is empty.

The Find toolbar should be opened and hidden when appropriate.


Public Member Functions

 FindToolbar (const Glib::ustring& label, const Glib::RefPtr<Gtk::ListStore>& list, int column)
 FindToolbar (const Glib::ustring& label)
 FindToolbar ()
int get_active () const
 Gets the index of the currently active item, or -1 if there's no active item.
Gtk::TreeModel::iterator get_active_iter ()
 Get an iterator that points to the current active item.
const HildonFindToolbar* gobj () const
 Provides access to the underlying C GtkObject.
HildonFindToolbar* gobj ()
 Provides access to the underlying C GtkObject.
void highlight_entry (bool get_focus=true)
 Highlights the current entry in the find toolbar.
void set_active (int index)
 Sets the active item on the toolbar's combo-box.
void set_active_iter (const Gtk::TreeModel::iterator& iter)
 Sets the current active item to be the one referenced by iter.
Glib::SignalProxy0<void> signal_close ()
 
Prototype:
void close()

Glib::SignalProxy0<bool> signal_history_append ()
 
Prototype:
bool history_append()

Glib::SignalProxy0<void> signal_invalid_input ()
 
Prototype:
void invalid_input()

Glib::SignalProxy0<void> signal_search ()
 
Prototype:
void search()

virtual ~FindToolbar ()

Related Functions

(Note that these are not member functions.)

Hildon::FindToolbarwrap (HildonFindToolbar* object, bool take_copy=false)
 
Parameters:
object The C instance


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]


Member Function Documentation

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 HildonFindToolbar's combo.

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

Gtk::TreeModel::iterator Hildon::FindToolbar::get_active_iter (  ) 

Get an iterator that points to the current active item.

: A find toolbar to query

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

const HildonFindToolbar* Hildon::FindToolbar::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Toolbar.

HildonFindToolbar* Hildon::FindToolbar::gobj (  )  [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 find toolbar.

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 toolbar's combo-box.

Simply calls gtk_combo_box_set_active on the HildonFindToolbar's combo.

Parameters:
index An index in the model passed during construction, or -1 to have 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 HildonFindToolbar's combo.

Parameters:
iter An iter to make active.

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

Prototype:
void close()

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

Prototype:
bool history_append()

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

Prototype:
void invalid_input()

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

Prototype:
void search()


Friends And Related Function Documentation

Hildon::FindToolbar* wrap ( HildonFindToolbar *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
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:
Generated for hildonmm by Doxygen 1.5.1 © 1997-2001