Class (GI Class)

Gtk-3.0GtkTreeViewColumn

The GtkTreeViewColumn object represents a visible column in a Gtk.TreeView widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed.

Please refer to the tree widget conceptual overview for an overview of all the objects and data types related to the tree widget and how they work together.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

_init add_attribute add_child bind_property bind_property_full block_signal_handler cell_get_position cell_get_size cell_is_visible cell_set_cell_data clear clear_attributes clicked connect connect_after construct_child custom_finished custom_tag_end custom_tag_start disconnect emit focus_cell force_floating freeze_notify get_alignment get_area get_button get_cells get_clickable get_data get_expand get_fixed_width get_internal_child get_max_width get_min_width get_name get_property get_qdata get_reorderable get_resizable get_sizing get_sort_column_id get_sort_indicator get_sort_order get_spacing get_title get_tree_view get_visible get_widget get_width get_x_offset getv is_floating notify notify_by_pspec pack_end pack_start parser_finished queue_resize ref ref_sink reorder run_dispose set set_alignment set_buildable_property set_cell_data_func set_clickable set_data set_expand set_fixed_width set_max_width set_min_width set_name set_property set_reorderable set_resizable set_sizing set_sort_column_id set_sort_indicator set_sort_order set_spacing set_title set_visible set_widget steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_add_attribute vfunc_add_child vfunc_clear vfunc_clear_attributes vfunc_clicked vfunc_construct_child vfunc_constructed vfunc_custom_finished vfunc_custom_tag_end vfunc_custom_tag_start vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_area vfunc_get_cells vfunc_get_internal_child vfunc_get_name vfunc_get_property vfunc_notify vfunc_pack_end vfunc_pack_start vfunc_parser_finished vfunc_reorder vfunc_set_buildable_property vfunc_set_cell_data_func vfunc_set_name vfunc_set_property watch_closure new new_with_area

Methods - Inherited from GObject

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

  • get sort_column_id(): number

    Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header clickable. Set to -1 to make the column unsortable.

    Returns number

    2.18

  • set sort_column_id(val: number): void

    Parameters

    • val: number

    Returns void

  • get sortColumnId(): number

    Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header clickable. Set to -1 to make the column unsortable.

    Returns number

    2.18

  • set sortColumnId(val: number): void

    Parameters

    • val: number

    Returns void

Methods

  • Adds an attribute mapping to the list in tree_column. The column is the column of the model to get a value from, and the attribute is the parameter on cell_renderer to be set from the value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a Gtk.CellRendererText get its values from column 2.

    Parameters

    • cell_renderer: Gtk.CellRenderer

      the Gtk.CellRenderer to set attributes on

    • attribute: string

      An attribute on the renderer

    • column: number

      The column position on the model to get the attribute from.

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Obtains the horizontal position and size of a cell in a column. If the cell is not found in the column, start_pos and width are not changed and false is returned.

    Parameters

    Returns [boolean, number, number]

    true if cell belongs to tree_column.

  • Obtains the width and height needed to render the column. This is used primarily by the Gtk.TreeView.

    Parameters

    • cell_area: Gdk.Rectangle

      The area a cell in the column will be allocated, or null

    Returns [number, number, number, number]

  • Returns true if any of the cells packed into the tree_column are visible. For this to be meaningful, you must first initialize the cells with gtk_tree_view_column_cell_set_cell_data()

    Returns boolean

    true, if any of the cells packed into the tree_column are currently visible

  • Sets the cell renderer based on the tree_model and iter. That is, for every attribute mapping in tree_column, it will get a value from the set column on the iter, and use that value to set the attribute on the cell renderer. This is used primarily by the Gtk.TreeView.

    Parameters

    • tree_model: Gtk.TreeModel

      The Gtk.TreeModel to to get the cell renderers attributes from.

    • iter: Gtk.TreeIter

      The Gtk.TreeIter to to get the cell renderer’s attributes from.

    • is_expander: boolean

      true, if the row has children

    • is_expanded: boolean

      true, if the row has visible children

    Returns void

  • Emits the “clicked” signal on the column. This function will only work if tree_column is clickable.

    Returns void

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Returns the current x alignment of tree_column. This value can range between 0.0 and 1.0.

    Returns number

    The current alignent of tree_column.

  • Returns true if the user can click on the header for the column.

    Returns boolean

    true if user can click the column header.

  • Returns true if the column expands to fill available space.

    Returns boolean

    true if the column expands to fill available space.

  • Gets the fixed width of the column. This may not be the actual displayed width of the column; for that, use gtk_tree_view_column_get_width().

    Returns number

    The fixed width of the column.

  • Returns the maximum width in pixels of the tree_column, or -1 if no maximum width is set.

    Returns number

    The maximum width of the tree_column.

  • Returns the minimum width in pixels of the tree_column, or -1 if no minimum width is set.

    Returns number

    The minimum width of the tree_column.

  • Gets the name of the buildable object.

    Gtk.Builder sets the name based on the [GtkBuilder UI definition][BUILDER-UI] used to construct the buildable.

    Returns string

    the name set with gtk_buildable_set_name()

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • Returns true if the tree_column can be reordered by the user.

    Returns boolean

    true if the tree_column can be reordered by the user.

  • Returns true if the tree_column can be resized by the end user.

    Returns boolean

    true, if the tree_column can be resized.

  • Gets the logical sort_column_id that the model sorts on when this column is selected for sorting. See gtk_tree_view_column_set_sort_column_id().

    Returns number

    the current sort_column_id for this column, or -1 if this column can’t be used for sorting.

  • Gets the value set by gtk_tree_view_column_set_sort_indicator().

    Returns boolean

    whether the sort indicator arrow is displayed

  • Returns the spacing of tree_column.

    Returns number

    the spacing of tree_column.

  • Returns the title of the widget.

    Returns string

    the title of the column. This string should not be modified or freed.

  • Returns the Gtk.TreeView wherein tree_column has been inserted. If column is currently not inserted in any tree view, null is returned.

    Returns Gtk.Widget

    The tree view wherein column has been inserted if any, null otherwise.

  • Returns true if tree_column is visible.

    Returns boolean

    whether the column is visible or not. If it is visible, then the tree will show the column.

  • Returns the current size of tree_column in pixels.

    Returns number

    The current width of tree_column.

  • Returns the current X offset of tree_column in pixels.

    Returns number

    The current X offset of tree_column.

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    Returns void

  • Adds the cell to end of the column. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

    Parameters

    Returns void

  • Packs the cell into the beginning of the column. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

    Parameters

    Returns void

  • Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right.

    Parameters

    • xalign: number

      The alignment, which is between [0.0 and 1.0] inclusive.

    Returns void

  • Sets the header to be active if clickable is true. When the header is active, then it can take keyboard focus, and can be clicked.

    Parameters

    • clickable: boolean

      true if the header is active.

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets the column to take available extra space. This space is shared equally amongst all columns that have the expand set to true. If no column has this option set, then the last column gets all extra space. By default, every column is created with this false.

    Along with “fixed-width”, the “expand” property changes when the column is resized by the user.

    Parameters

    • expand: boolean

      true if the column should expand to fill available space.

    Returns void

  • If fixed_width is not -1, sets the fixed width of tree_column; otherwise unsets it. The effective value of fixed_width is clamped between the minimum and maximum width of the column; however, the value stored in the “fixed-width” property is not clamped. If the column sizing is #GTK_TREE_VIEW_COLUMN_GROW_ONLY or #GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting a fixed width overrides the automatically calculated width. Note that fixed_width is only a hint to GTK+; the width actually allocated to the column may be greater or less than requested.

    Along with “expand”, the “fixed-width” property changes when the column is resized by the user.

    Parameters

    • fixed_width: number

      The new fixed width, in pixels, or -1.

    Returns void

  • Sets the maximum width of the tree_column. If max_width is -1, then the maximum width is unset. Note, the column can actually be wider than max width if it’s the last column in a view. In this case, the column expands to fill any extra space.

    Parameters

    • max_width: number

      The maximum width of the column in pixels, or -1.

    Returns void

  • Sets the minimum width of the tree_column. If min_width is -1, then the minimum width is unset.

    Parameters

    • min_width: number

      The minimum width of the column in pixels, or -1.

    Returns void

  • If reorderable is true, then the column can be reordered by the end user dragging the header.

    Parameters

    • reorderable: boolean

      true, if the column can be reordered.

    Returns void

  • If resizable is true, then the user can explicitly resize the column by grabbing the outer edge of the column button. If resizable is true and sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.

    Parameters

    • resizable: boolean

      true, if the column can be resized

    Returns void

  • Sets the logical sort_column_id that this column sorts on when this column is selected for sorting. Doing so makes the column header clickable.

    Parameters

    • sort_column_id: number

      The sort_column_id of the model to sort on.

    Returns void

  • Call this function with a setting of true to display an arrow in the header button indicating the column is sorted. Call gtk_tree_view_column_set_sort_order() to change the direction of the arrow.

    Parameters

    • setting: boolean

      true to display an indicator that the column is sorted

    Returns void

  • Changes the appearance of the sort indicator.

    This does not actually sort the model. Use gtk_tree_view_column_set_sort_column_id() if you want automatic sorting support. This function is primarily for custom sorting behavior, and should be used in conjunction with gtk_tree_sortable_set_sort_column_id() to do that. For custom models, the mechanism will vary.

    The sort indicator changes direction to indicate normal sort or reverse sort. Note that you must have the sort indicator enabled to see anything when calling this function; see gtk_tree_view_column_set_sort_indicator().

    Parameters

    • order: Gtk.SortType

      sort order that the sort indicator should indicate

    Returns void

  • Sets the spacing field of tree_column, which is the number of pixels to place between cell renderers packed into it.

    Parameters

    • spacing: number

      distance between cell renderers in pixels.

    Returns void

  • Sets the title of the tree_column. If a custom widget has been set, then this value is ignored.

    Parameters

    • title: string

      The title of the tree_column.

    Returns void

  • Sets the visibility of tree_column.

    Parameters

    • visible: boolean

      true if the tree_column is visible.

    Returns void

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • Adds an attribute mapping to the list in cell_layout.

    The column is the column of the model to get a value from, and the attribute is the parameter on cell to be set from the value. So for example if column 2 of the model contains strings, you could have the “text” attribute of a Gtk.CellRendererText get its values from column 2.

    Parameters

    • cell: Gtk.CellRenderer
    • attribute: string

      an attribute on the renderer

    • column: number

      the column position on the model to get the attribute from

    Returns void

  • Emits the “clicked” signal on the column. This function will only work if tree_column is clickable.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • Adds the cell to the end of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

    Note that reusing the same cell renderer is not supported.

    Parameters

    Returns void

  • Packs the cell into the beginning of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

    Note that reusing the same cell renderer is not supported.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Methods - Inherited from GObject

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

Interfaces

ConstructorProps
SignalSignatures