Gtk::TreeSortable Class Reference
TreeView Classes

`#include <gtkmm/treesortable.h>`

Inheritance diagram for Gtk::TreeSortable:
[legend]

## Public Types

enum | { DEFAULT_SORT_COLUMN_ID = -1, DEFAULT_UNSORTED_COLUMN_ID = -2 }
typedef sigc::slot< int, const Gtk::TreeModel::iterator&, const Gtk::TreeModel::iterator& > | SlotCompare
| This callback should return -1 if a compares before b, 0 if they compare equal, 1 if a compares after b. More...

## Public Member Functions

| TreeSortable (TreeSortable&& src) noexcept
TreeSortable& | operator= (TreeSortable&& src) noexcept
| ~TreeSortable () noexcept override
GtkTreeSortable* | gobj ()
| Provides access to the underlying C GObject. More...
const GtkTreeSortable* | gobj () const
| Provides access to the underlying C GObject. More...
bool | get_sort_column_id (int& sort_column_id, SortType& order) const
| Fills in sort_column_id and order with the current sort column and the order. More...
void | set_sort_column (const TreeModelColumnBase& sort_column_id, SortType order)
| Sets the current sort column to be sort_column_id. More...
void | set_sort_column (int sort_column_id, SortType order)
| Sets the current sort column to be sort_column_id. More...
void | set_sort_func (const TreeModelColumnBase& sort_column, const SlotCompare& slot)
| Sets the comparison function used when sorting a certain column. More...
void | set_sort_func (int sort_column_id, const SlotCompare& slot)
| Sets the comparison function used when sorting a certain column. More...
void | set_default_sort_func (const SlotCompare& slot)
| Sets the default comparison function used when sorting. More...
void | unset_default_sort_func ()
| Sets the default comparison function used when sorting. More...
bool | has_default_sort_func () const
| Returns `true` if the model has a default sort function. More...
void | sort_column_changed ()
| Emits a Gtk::TreeSortable::signal_sort_column_changed() signal on sortable. More...
Glib::SignalProxy< void > | signal_sort_column_changed ()

## Static Public Member Functions

static void | add_interface (GType gtype_implementer)
static GType | get_type ()
| Get the GType for this class, for use with the underlying GObject type system. More...

## Protected Member Functions

| TreeSortable ()
| You should derive from this class to use it. More...
virtual bool | get_sort_column_id_vfunc (int* sort_column_id, SortType* order) const
virtual void | set_sort_column_id_vfunc (int sort_column_id, SortType order)
virtual void | set_sort_func_vfunc (int sort_column_id, GtkTreeIterCompareFunc func, void* data, GDestroyNotify destroy)
virtual void | set_default_sort_func_vfunc (GtkTreeIterCompareFunc func, void* data, GDestroyNotify destroy)
virtual bool | has_default_sort_func_vfunc () const
virtual void | sort_column_changed_vfunc () const
virtual void | on_sort_column_changed ()
| This is a default handler for the signal signal_sort_column_changed(). More...

## Related Functions

(Note that these are not member functions.)
Glib::RefPtr< Gtk::TreeSortable > | wrap (GtkTreeSortable* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...

## Member Typedef Documentation

## SlotCompare

typedef sigc::slot<int, const Gtk::TreeModel::iterator&, const Gtk::TreeModel::iterator&> Gtk::TreeSortable::SlotCompare

This callback should return -1 if a compares before b, 0 if they compare equal, 1 if a compares after b.

For instance, int on_sort_compare(const Gtk::TreeModel::iterator& a, const Gtk::TreeModel::iterator& b);

## Member Enumeration Documentation

## anonymous enum

anonymous enum

Enumerator
DEFAULT_SORT_COLUMN_ID | See set_default_sort_func() and set_sort_column().
DEFAULT_UNSORTED_COLUMN_ID |

## Constructor & Destructor Documentation

## TreeSortable() [1/2]

Gtk::TreeSortable::TreeSortable | ( |  | ) |

protected

You should derive from this class to use it.

## TreeSortable() [2/2]

Gtk::TreeSortable::TreeSortable | ( | TreeSortable&& | src | ) |

noexcept

## ~TreeSortable()

Gtk::TreeSortable::~TreeSortable | ( |  | ) |

override noexcept

## Member Function Documentation

## add_interface()

static void Gtk::TreeSortable::add_interface | ( | GType | gtype_implementer | ) |

static

## get_sort_column_id()

bool Gtk::TreeSortable::get_sort_column_id | ( | int & | sort_column_id,
|  | SortType& | order
| ) |  | const

Fills in sort_column_id and order with the current sort column and the order.

It returns `true` unless the sort_column_id is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.

Parameters

  sort_column_id | The sort column id to be filled in.
  order | The Gtk::SortType to be filled in.

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

## get_sort_column_id_vfunc()

virtual bool Gtk::TreeSortable::get_sort_column_id_vfunc | ( | int * | sort_column_id,
|  | SortType* | order
| ) |  | const

protected virtual

## get_type()

static GType Gtk::TreeSortable::get_type | ( |  | ) |

static

Get the GType for this class, for use with the underlying GObject type system.

## gobj() [1/2]

GtkTreeSortable* Gtk::TreeSortable::gobj | ( |  | ) |

inline

Provides access to the underlying C GObject.

## gobj() [2/2]

const GtkTreeSortable* Gtk::TreeSortable::gobj | ( |  | ) | const

inline

Provides access to the underlying C GObject.

## has_default_sort_func()

bool Gtk::TreeSortable::has_default_sort_func | ( |  | ) | const

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

This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not.

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

## has_default_sort_func_vfunc()

virtual bool Gtk::TreeSortable::has_default_sort_func_vfunc | ( |  | ) | const

protected virtual

## on_sort_column_changed()

virtual void Gtk::TreeSortable::on_sort_column_changed | ( |  | ) |

protected virtual

This is a default handler for the signal signal_sort_column_changed().

## operator=()

TreeSortable& Gtk::TreeSortable::operator= | ( | TreeSortable&& | src | ) |

noexcept

## set_default_sort_func()

void Gtk::TreeSortable::set_default_sort_func | ( | const SlotCompare& | slot | ) |

Sets the default comparison function used when sorting.

If the current sort column id of sortable is DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. See also unset_default_sort_func().

Parameters

  slot | The sorting function

## set_default_sort_func_vfunc()

virtual void Gtk::TreeSortable::set_default_sort_func_vfunc | ( | GtkTreeIterCompareFunc | func,
|  | void * | data,
|  | GDestroyNotify | destroy
| ) |  |

protected virtual

## set_sort_column() [1/2]

void Gtk::TreeSortable::set_sort_column | ( | const TreeModelColumnBase& | sort_column_id,
|  | SortType | order
| ) |  |

Sets the current sort column to be sort_column_id.

The sortable will resort itself to reflect this change, after emitting a Gtk::TreeSortable::signal_sort_column_changed() signal. sort_column_id may either be a regular column id, or one of the following special values:

- GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function will be used, if it is set
- GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur

Parameters

  sort_column_id | The sort column id to set.
  order | The sort order of the column.

## set_sort_column() [2/2]

void Gtk::TreeSortable::set_sort_column | ( | int | sort_column_id,
|  | SortType | order
| ) |  |

Sets the current sort column to be sort_column_id.

The sortable will resort itself to reflect this change, after emitting a Gtk::TreeSortable::signal_sort_column_changed() signal. sort_column_id may either be a regular column id, or one of the following special values:

- GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function will be used, if it is set
- GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur

Parameters

  sort_column_id | The sort column id to set.
  order | The sort order of the column.

## set_sort_column_id_vfunc()

virtual void Gtk::TreeSortable::set_sort_column_id_vfunc | ( | int | sort_column_id,
|  | SortType | order
| ) |  |

protected virtual

## set_sort_func() [1/2]

void Gtk::TreeSortable::set_sort_func | ( | const TreeModelColumnBase& | sort_column,
|  | const SlotCompare& | slot
| ) |  |

Sets the comparison function used when sorting a certain column.

If the current sort column is the same as sort_column, then the model will sort using this function.

Parameters

  sort_column | the sort column to set the function for
  slot | The sorting slot callback.

## set_sort_func() [2/2]

void Gtk::TreeSortable::set_sort_func | ( | int | sort_column_id,
|  | const SlotCompare& | slot
| ) |  |

Sets the comparison function used when sorting a certain column.

If the current sort column id is the same as sort_column_id, then the model will sort using this function.

Parameters

  sort_column_id | the sort column id to set the function for
  slot | The sorting slot callback.

## set_sort_func_vfunc()

virtual void Gtk::TreeSortable::set_sort_func_vfunc | ( | int | sort_column_id,
|  | GtkTreeIterCompareFunc | func,
|  | void * | data,
|  | GDestroyNotify | destroy
| ) |  |

protected virtual

## signal_sort_column_changed()

Glib::SignalProxy< void > Gtk::TreeSortable::signal_sort_column_changed | ( |  | ) |

Slot Prototype:
  `void on_my_sort_column_changed()`

Flags: Run Last

The signal_sort_column_changed() signal is emitted when the sort column or sort order of sortable is changed. The signal is emitted before the contents of sortable are resorted.

## sort_column_changed()

void Gtk::TreeSortable::sort_column_changed | ( |  | ) |

Emits a Gtk::TreeSortable::signal_sort_column_changed() signal on sortable.

## sort_column_changed_vfunc()

virtual void Gtk::TreeSortable::sort_column_changed_vfunc | ( |  | ) | const

protected virtual

## unset_default_sort_func()

void Gtk::TreeSortable::unset_default_sort_func | ( |  | ) |

Sets the default comparison function used when sorting.

See set_default_sort_func().

After calling this method there will be no default comparison function. This means that once the model has been sorted, it can't go back to the default state. In this case, when the current sort column id of sortable is DEFAULT_SORT_COLUMN_ID, the model will be unsorted.

## Friends And Related Function Documentation

## wrap()

Glib::RefPtr< Gtk::TreeSortable > wrap | ( | GtkTreeSortable * | 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.