Module: Gtk::TreeSortable

Defined in:
(unknown)

Overview

Gtk::TreeSortable is an interface to be implemented by tree models which support sorting. The Gtk::TreeView uses the methods provided by this interface to sort the model.

Instance Method Summary collapse

Instance Method Details

#get_sort_column_id(sortable, sort_column_id, order) ⇒ TrueClass

Returns true if the sort column is not one of the special sort column ids.

Parameters:

  • sortable (Gtk::TreeSortable) —

    A Gtk::TreeSortable

  • sort_column_id (Integer) —

    The sort column id to be filled in

  • order (Gtk::SortType) —

    The Gtk::SortType to be filled in

Returns:

  • (TrueClass) —

    true if the sort column is not one of the special sort column ids.

#has_default_sort_func(sortable) ⇒ TrueClass

Returns true, if the model has a default sort function.

Parameters:

Returns:

  • (TrueClass) —

    true, if the model has a default sort function

#set_default_sort_func(sortable, sort_func, user_data, destroy) ⇒ nil

Parameters:

  • sortable (Gtk::TreeSortable) —

    A Gtk::TreeSortable

  • sort_func (Gtk::TreeIterCompareFunc) —

    The comparison function

  • user_data (GObject) —

    User data to pass to sort_func, or nil

  • destroy (GLib::DestroyNotify) —

    Destroy notifier of user_data, or nil

Returns:

  • (nil)

#set_sort_column_id(sortable, sort_column_id, order) ⇒ nil

Parameters:

  • sortable (Gtk::TreeSortable) —

    A Gtk::TreeSortable

  • sort_column_id (Integer) —

    the sort column id to set

  • order (Gtk::SortType) —

    The sort order of the column

Returns:

  • (nil)

#set_sort_func(sortable, sort_column_id, sort_func, user_data, destroy) ⇒ nil

Parameters:

  • sortable (Gtk::TreeSortable) —

    A Gtk::TreeSortable

  • sort_column_id (Integer) —

    the sort column id to set the function for

  • sort_func (Gtk::TreeIterCompareFunc) —

    The comparison function

  • user_data (GObject) —

    User data to pass to sort_func, or nil

  • destroy (GLib::DestroyNotify) —

    Destroy notifier of user_data, or nil

Returns:

  • (nil)

#sort_column_changed(sortable) ⇒ nil

Parameters:

Returns:

  • (nil)