Module: Gtk::TreeSortable

Defined in:
lib/gtk4/tree-sortable.rb

Overview

The interface for sortable models used by GtkTreeView

GtkTreeSortable is an interface to be implemented by tree models which support sorting. The GtkTreeView 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) ⇒ Boolean

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

Parameters:

  • sortable (Gtk::TreeSortable) —

    A GtkTreeSortable

  • sort_column_id (Integer) —

    The sort column id to be filled in

  • order (Gtk::SortType) —

    The GtkSortType to be filled in

Returns:

  • (Boolean) —

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

#has_default_sort_func(sortable) ⇒ Boolean

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

Parameters:

Returns:

  • (Boolean) —

    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 GtkTreeSortable

  • sort_func (Gtk::TreeIterCompareFunc) —

    The comparison function

  • user_data (GObject) —

    User data to pass to sort_func

  • destroy (GLib::DestroyNotify) —

    Destroy notifier of user_data

Returns:

  • (nil)

#set_sort_column_id(sortable, sort_column_id, order) ⇒ nil

Parameters:

  • sortable (Gtk::TreeSortable) —

    A GtkTreeSortable

  • sort_column_id (Integer) —

    the sort column id to set

  • order (Gtk::SortType) —

    The sort order of the column

Returns:

  • (nil)

#set_sort_func(sort_column_id) ⇒ nil

Parameters:

  • sortable (Gtk::TreeSortable) —

    A GtkTreeSortable

  • 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

  • destroy (GLib::DestroyNotify) —

    Destroy notifier of user_data

Returns:

  • (nil) 


20
21
22
23
24
25
26
 
# File 'lib/gtk4/tree-sortable.rb', line 20

def set_sort_func(sort_column_id)
  set_sort_func_raw(sort_column_id) do |model, iter1, iter2|
    iter1.model = model
    iter2.model = model
    yield(model, iter1, iter2)
  end
end

#set_sort_func_raw ⇒ nil

Parameters:

  • sortable (Gtk::TreeSortable) —

    A GtkTreeSortable

  • 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

  • destroy (GLib::DestroyNotify) —

    Destroy notifier of user_data

Returns:

  • (nil) 



# File 'lib/gtk4/tree-sortable.rb', line 19

#sort_column_changed(sortable) ⇒ nil

Parameters:

Returns:

  • (nil)