Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ColumnViewSorterMeta

[156:14] static extends: object

Generated metadata helpers for ColumnViewSorter class surfaces.

Methods

  • properties ()

    Returns property metadata for ColumnViewSorter.

    • @r A list.

class: ColumnViewSorter

[30:7] extends: object

Sorts [class@Gtk.ColumnView] columns. The sorter returned by [method@Gtk.ColumnView.get_sorter] is a GtkColumnViewSorter. In column views, sorting can be configured by associating sorters with columns, and users can invert sort order by clicking on column headers. The API of GtkColumnViewSorter is designed to allow saving and restoring this configuration. If you are only interested in the primary sort column (i.e. the column where a sort indicator is shown in the header), then you can just look at [property@Gtk.ColumnViewSorter:primary-sort-column] and [property@Gtk.ColumnViewSorter:primary-sort-order]. If you want to store the full sort configuration, including secondary sort columns that are used for tie breaking, then you can use [method@Gtk.ColumnViewSorter.get_nth_sort_column]. To get notified about changes, use [signal@Gtk.Sorter::changed]. To restore a saved sort configuration on a GtkColumnView, use code like: sorter = gtk_column_view_get_sorter (view); for (i = gtk_column_view_sorter_get_n_sort_columns (sorter) - 1; i >= 0; i--) { column = gtk_column_view_sorter_get_nth_sort_column (sorter, i, &order); gtk_column_view_sort_by_column (view, column, order); }

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • ColumnViewSorter (Handle = null)

    Creates a new ColumnViewSorter by wrapping a native handle or another wrapper.

    • @p Handle is the native handle or another wrapper whose handle to adopt.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asSorter ()

    Wraps this handle as Sorter.

    • @r A Sorter object.
  • get_n_sort_columns ()

    Returns the number of columns by which the sorter sorts. If the sorter of the primary sort column does not determine a total order, then the secondary sorters are consulted to break the ties. Use the [signal@Gtk.Sorter::changed] signal to get notified when the number of sort columns changes.

  • get_primary_sort_column ()

    Returns the primary sort column. The primary sort column is the one that displays the triangle in a column view header.

  • get_primary_sort_order ()

    Returns the primary sort order. The primary sort order determines whether the triangle displayed in the column view header of the primary sort column points upwards or downwards. If there is no primary sort column, then this function returns GTK_SORT_ASCENDING.