Maeomm Reference Documentation: hildon-libsmm

    Book  

---

Hildon::SortDialog Class Reference
[Dialogs]

Inheritance diagram for Hildon::SortDialog:

[legend]List of all members.

---

Detailed Description

Hildon::SortDialog is used to define an order (ascending/descending) and a field by which items are sorted in a list.

The combo boxes display the current value when the dialog is opened.

Public Member Functions
int	add_sort_key (const Glib::ustring& sort_key)
	Adds a new sort key and returns the respective index in sort key combobox.
int	get_sort_key () const
	Gets index to currently active sort key.
Gtk::SortType	get_sort_order () const
	Gets current sorting order from "Sort order" field.
const HildonSortDialog*	gobj () const
	Provides access to the underlying C GtkObject.
HildonSortDialog*	gobj ()
	Provides access to the underlying C GtkObject.
void	set_sort_key (int key)
	Sets the index value of the Hildon::SortDialog widget.
void	set_sort_order (Gtk::SortType order)
	Sets the index value of the Hildon::SortDialog widget.
	SortDialog ()
virtual	~SortDialog ()
Related Functions
(Note that these are not member functions.)
Hildon::SortDialog*	wrap (HildonSortDialog* object, bool take_copy=false)

---

Constructor & Destructor Documentation

virtual Hildon::SortDialog::~SortDialog (  )  [virtual]

Hildon::SortDialog::SortDialog (  )

---

Member Function Documentation

int Hildon::SortDialog::add_sort_key ( const Glib::ustring&  sort_key  )

Adds a new sort key and returns the respective index in sort key combobox. Parameters: sort_key  Combo box's index value. Returns: An integer which is the index of the added combo box's item.

int Hildon::SortDialog::get_sort_key (  )  const

Gets index to currently active sort key. Returns: An integer which is the index value of the "Sort by" field.

Gtk::SortType Hildon::SortDialog::get_sort_order (  )  const

Gets current sorting order from "Sort order" field. Returns: Current sorting order as Gtk::SortType.

const HildonSortDialog* Hildon::SortDialog::gobj (  )  const [inline]

Provides access to the underlying C GtkObject. Reimplemented from Gtk::Dialog.

HildonSortDialog* Hildon::SortDialog::gobj (  )  [inline]

Provides access to the underlying C GtkObject. Reimplemented from Gtk::Dialog.

void Hildon::SortDialog::set_sort_key ( int  key  )

Sets the index value of the Hildon::SortDialog widget. Parameters: key  Combo box's index value.

void Hildon::SortDialog::set_sort_order ( Gtk::SortType  order  )

Sets the index value of the Hildon::SortDialog widget. Parameters: order  Combo box's index value.

---

Friends And Related Function Documentation

Hildon::SortDialog* wrap ( HildonSortDialog*  object, bool  take_copy = false )  [related]

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:

• sort-dialog.h

---