TreeViewColumn

The GtkTreeViewColumn object represents a visible column in a #GtkTreeView 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.

class TreeViewColumn : InitiallyUnowned , Buildable , CellLayout {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

TreeViewColumn self();

static TreeViewColumnGidBuilder builder();

float alignment [@property getter];

float alignment [@property setter];

gtk.cell_area.CellArea cellArea [@property getter];

bool clickable [@property getter];

bool clickable [@property setter];

bool expand [@property getter];

bool expand [@property setter];

int fixedWidth [@property getter];

int fixedWidth [@property setter];

int maxWidth [@property getter];

int maxWidth [@property setter];

int minWidth [@property getter];

int minWidth [@property setter];

bool reorderable [@property getter];

bool reorderable [@property setter];

bool resizable [@property getter];

bool resizable [@property setter];

gtk.types.TreeViewColumnSizing sizing [@property getter];

gtk.types.TreeViewColumnSizing sizing [@property setter];

int sortColumnId [@property getter];

int sortColumnId [@property setter];

bool sortIndicator [@property getter];

bool sortIndicator [@property setter];

gtk.types.SortType sortOrder [@property getter];

gtk.types.SortType sortOrder [@property setter];

int spacing [@property getter];

int spacing [@property setter];

string title [@property getter];

string title [@property setter];

bool visible [@property getter];

bool visible [@property setter];

gtk.widget.Widget widget [@property getter];

gtk.widget.Widget widget [@property setter];

int width [@property getter];

int xOffset [@property getter];

static gtk.tree_view_column.TreeViewColumn newWithArea(gtk.cell_area.CellArea area);

void addAttribute(gtk.cell_renderer.CellRenderer cellRenderer, string attribute, int column);

bool cellGetPosition(gtk.cell_renderer.CellRenderer cellRenderer, int xOffset, int width);

void cellGetSize(gdk.rectangle.Rectangle cellArea, int xOffset, int yOffset, int width, int height);

bool cellIsVisible();

void cellSetCellData(gtk.tree_model.TreeModel treeModel, gtk.tree_iter.TreeIter iter, bool isExpander, bool isExpanded);

void clear();

void clearAttributes(gtk.cell_renderer.CellRenderer cellRenderer);

void clicked();

void focusCell(gtk.cell_renderer.CellRenderer cell);

float getAlignment();

gtk.widget.Widget getButton();

bool getClickable();

bool getExpand();

int getFixedWidth();

int getMaxWidth();

int getMinWidth();

bool getReorderable();

bool getResizable();

gtk.types.TreeViewColumnSizing getSizing();

int getSortColumnId();

bool getSortIndicator();

gtk.types.SortType getSortOrder();

int getSpacing();

string getTitle();

gtk.widget.Widget getTreeView();

bool getVisible();

gtk.widget.Widget getWidget();

int getWidth();

int getXOffset();

void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand);

void packStart(gtk.cell_renderer.CellRenderer cell, bool expand);

void queueResize();

void setAlignment(float xalign);

void setCellDataFunc(gtk.cell_renderer.CellRenderer cellRenderer, gtk.types.TreeCellDataFunc func);

void setClickable(bool clickable);

void setExpand(bool expand);

void setFixedWidth(int fixedWidth);

void setMaxWidth(int maxWidth);

void setMinWidth(int minWidth);

void setReorderable(bool reorderable);

void setResizable(bool resizable);

void setSizing(gtk.types.TreeViewColumnSizing type);

void setSortColumnId(int sortColumnId);

void setSortIndicator(bool setting);

void setSortOrder(gtk.types.SortType order);

void setSpacing(int spacing);

void setTitle(string title);

void setVisible(bool visible);

void setWidget(gtk.widget.Widget widget);

gulong connectClicked(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkTreeViewColumn.

Members

Functions

addAttribute void addAttribute(gtk.cell_renderer.CellRenderer cellRenderer, string attribute, int column): 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 #GtkCellRendererText get its values from column 2.
cellGetPosition bool cellGetPosition(gtk.cell_renderer.CellRenderer cellRenderer, int xOffset, int width): 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.
cellGetSize void cellGetSize(gdk.rectangle.Rectangle cellArea, int xOffset, int yOffset, int width, int height): Obtains the width and height needed to render the column. This is used primarily by the #GtkTreeView.
cellIsVisible bool cellIsVisible(): 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.TreeViewColumn.cellSetCellData
cellSetCellData void cellSetCellData(gtk.tree_model.TreeModel treeModel, gtk.tree_iter.TreeIter iter, bool isExpander, bool isExpanded): 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 #GtkTreeView.
clear void clear(): Unsets all the mappings on all renderers on the tree_column.
clearAttributes void clearAttributes(gtk.cell_renderer.CellRenderer cellRenderer): Clears all existing attributes previously set with gtk.tree_view_column.TreeViewColumn.setAttributes.
clicked void clicked(): Emits the “clicked” signal on the column. This function will only work if tree_column is clickable.
connectClicked gulong connectClicked(T callback, Flag!"After" after): Connect to Clicked signal.
focusCell void focusCell(gtk.cell_renderer.CellRenderer cell): Sets the current keyboard focus to be at cell, if the column contains 2 or more editable and activatable cells.
getAlignment float getAlignment(): Returns the current x alignment of tree_column. This value can range between 0.0 and 1.0.
getButton gtk.widget.Widget getButton(): Returns the button used in the treeview column header
getClickable bool getClickable(): Returns true if the user can click on the header for the column.
getExpand bool getExpand(): Returns true if the column expands to fill available space.
getFixedWidth int getFixedWidth(): 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.TreeViewColumn.getWidth.
getMaxWidth int getMaxWidth(): Returns the maximum width in pixels of the tree_column, or -1 if no maximum width is set.
getMinWidth int getMinWidth(): Returns the minimum width in pixels of the tree_column, or -1 if no minimum width is set.
getReorderable bool getReorderable(): Returns true if the tree_column can be reordered by the user.
getResizable bool getResizable(): Returns true if the tree_column can be resized by the end user.
getSizing gtk.types.TreeViewColumnSizing getSizing(): Returns the current type of tree_column.
getSortColumnId int getSortColumnId(): Gets the logical sort_column_id that the model sorts on when this column is selected for sorting. See gtk.tree_view_column.TreeViewColumn.setSortColumnId.
getSortIndicator bool getSortIndicator(): Gets the value set by gtk.tree_view_column.TreeViewColumn.setSortIndicator.
getSortOrder gtk.types.SortType getSortOrder(): Gets the value set by gtk.tree_view_column.TreeViewColumn.setSortOrder.
getSpacing int getSpacing(): Returns the spacing of tree_column.
getTitle string getTitle(): Returns the title of the widget.
getTreeView gtk.widget.Widget getTreeView(): Returns the #GtkTreeView wherein tree_column has been inserted. If column is currently not inserted in any tree view, null is returned.
getVisible bool getVisible(): Returns true if tree_column is visible.
getWidget gtk.widget.Widget getWidget(): Returns the #GtkWidget in the button on the column header. If a custom widget has not been set then null is returned.
getWidth int getWidth(): Returns the current size of tree_column in pixels.
getXOffset int getXOffset(): Returns the current X offset of tree_column in pixels.
packEnd void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand): 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.
packStart void packStart(gtk.cell_renderer.CellRenderer cell, bool expand): 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.
queueResize void queueResize(): Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.
self TreeViewColumn self(): Returns this, for use in with statements.
setAlignment void setAlignment(float xalign): 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.
setCellDataFunc void setCellDataFunc(gtk.cell_renderer.CellRenderer cellRenderer, gtk.types.TreeCellDataFunc func): Sets the #GtkTreeCellDataFunc to use for the column. This function is used instead of the standard attributes mapping for setting the column value, and should set the value of tree_column's cell renderer as appropriate. func may be null to remove an older one.
setClickable void setClickable(bool clickable): 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.
setExpand void setExpand(bool expand): 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.
setFixedWidth void setFixedWidth(int fixedWidth): 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.
setMaxWidth void setMaxWidth(int maxWidth): 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.
setMinWidth void setMinWidth(int minWidth): Sets the minimum width of the tree_column. If min_width is -1, then the minimum width is unset.
setReorderable void setReorderable(bool reorderable): If reorderable is true, then the column can be reordered by the end user dragging the header.
setResizable void setResizable(bool resizable): 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.
setSizing void setSizing(gtk.types.TreeViewColumnSizing type): Sets the growth behavior of tree_column to type.
setSortColumnId void setSortColumnId(int sortColumnId): 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.
setSortIndicator void setSortIndicator(bool setting): 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.TreeViewColumn.setSortOrder to change the direction of the arrow.
setSortOrder void setSortOrder(gtk.types.SortType order): Changes the appearance of the sort indicator.
setSpacing void setSpacing(int spacing): Sets the spacing field of tree_column, which is the number of pixels to place between cell renderers packed into it.
setTitle void setTitle(string title): Sets the title of the tree_column. If a custom widget has been set, then this value is ignored.
setVisible void setVisible(bool visible): Sets the visibility of tree_column.
setWidget void setWidget(gtk.widget.Widget widget): Sets the widget in the header to be widget. If widget is null, then the header button is set with a #GtkLabel set to the title of tree_column.

Properties

_gType GType _gType [@property getter]
alignment float alignment [@property getter]
alignment float alignment [@property setter]
cellArea gtk.cell_area.CellArea cellArea [@property getter]: Get cellArea property.
clickable bool clickable [@property getter]
clickable bool clickable [@property setter]
expand bool expand [@property getter]
expand bool expand [@property setter]
fixedWidth int fixedWidth [@property getter]
fixedWidth int fixedWidth [@property setter]
maxWidth int maxWidth [@property getter]
maxWidth int maxWidth [@property setter]
minWidth int minWidth [@property getter]
minWidth int minWidth [@property setter]
reorderable bool reorderable [@property getter]
reorderable bool reorderable [@property setter]
resizable bool resizable [@property getter]
resizable bool resizable [@property setter]
sizing gtk.types.TreeViewColumnSizing sizing [@property getter]
sizing gtk.types.TreeViewColumnSizing sizing [@property setter]
sortColumnId int sortColumnId [@property getter]: Get sortColumnId property.
sortColumnId int sortColumnId [@property setter]: Set sortColumnId property.
sortIndicator bool sortIndicator [@property getter]
sortIndicator bool sortIndicator [@property setter]
sortOrder gtk.types.SortType sortOrder [@property getter]
sortOrder gtk.types.SortType sortOrder [@property setter]
spacing int spacing [@property getter]
spacing int spacing [@property setter]
title string title [@property getter]
title string title [@property setter]
visible bool visible [@property getter]
visible bool visible [@property setter]
widget gtk.widget.Widget widget [@property getter]
widget gtk.widget.Widget widget [@property setter]
width int width [@property getter]
xOffset int xOffset [@property getter]

Static functions

_getGType GType _getGType()
builder TreeViewColumnGidBuilder builder(): Get builder for gtk.tree_view_column.TreeViewColumn
newWithArea gtk.tree_view_column.TreeViewColumn newWithArea(gtk.cell_area.CellArea area): Creates a new #GtkTreeViewColumn using area to render its cells.

Mixed In Members

From `mixin BuildableT!()`

addChild void addChild(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild gobject.object.ObjectWrap constructChild(gtk.builder.Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, void* data): This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
customTagStart bool customTagStart(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, glib.types.MarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild gobject.object.ObjectWrap getInternalChild(gtk.builder.Builder builder, string childname): Get the internal child called childname of the buildable object.
getName string getName(): Gets the name of the buildable object.
parserFinished void parserFinished(gtk.builder.Builder builder): Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(gtk.builder.Builder builder, string name, gobject.value.Value value): Sets the property name name to value on the buildable object.
setName void setName(string name): Sets the name of the buildable object.

From `mixin CellLayoutT!()`

addAttribute void addAttribute(gtk.cell_renderer.CellRenderer cell, string attribute, int column): Adds an attribute mapping to the list in cell_layout.
clear void clear(): Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.
clearAttributes void clearAttributes(gtk.cell_renderer.CellRenderer cell): Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.
getArea gtk.cell_area.CellArea getArea(): Returns the underlying #GtkCellArea which might be cell_layout if called on a #GtkCellArea or might be null if no #GtkCellArea is used by cell_layout.
getCells gtk.cell_renderer.CellRenderer[] getCells(): Returns the cell renderers which have been added to cell_layout.
packEnd void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand): 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.
packStart void packStart(gtk.cell_renderer.CellRenderer cell, bool expand): 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.
reorder void reorder(gtk.cell_renderer.CellRenderer cell, int position): Re-inserts cell at position.
setCellDataFunc void setCellDataFunc(gtk.cell_renderer.CellRenderer cell, gtk.types.CellLayoutDataFunc func): Sets the #GtkCellLayoutDataFunc to use for cell_layout.

Inherited Members

From InitiallyUnowned

_getGType GType _getGType()
_gType GType _gType [@property getter]
self InitiallyUnowned self(): Returns this, for use in with statements.
builder InitiallyUnownedGidBuilder builder(): Get builder for gobject.initially_unowned.InitiallyUnowned

From Buildable

_getGType GType _getGType()
addChild void addChild(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild gobject.object.ObjectWrap constructChild(gtk.builder.Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, void* data): This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
customTagStart bool customTagStart(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, glib.types.MarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild gobject.object.ObjectWrap getInternalChild(gtk.builder.Builder builder, string childname): Get the internal child called childname of the buildable object.
getName string getName(): Gets the name of the buildable object.
parserFinished void parserFinished(gtk.builder.Builder builder): Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(gtk.builder.Builder builder, string name, gobject.value.Value value): Sets the property name name to value on the buildable object.
setName void setName(string name): Sets the name of the buildable object.

From CellLayout

_getGType GType _getGType()
addAttribute void addAttribute(gtk.cell_renderer.CellRenderer cell, string attribute, int column): Adds an attribute mapping to the list in cell_layout.
clear void clear(): Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.
clearAttributes void clearAttributes(gtk.cell_renderer.CellRenderer cell): Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.
getArea gtk.cell_area.CellArea getArea(): Returns the underlying #GtkCellArea which might be cell_layout if called on a #GtkCellArea or might be null if no #GtkCellArea is used by cell_layout.
getCells gtk.cell_renderer.CellRenderer[] getCells(): Returns the cell renderers which have been added to cell_layout.
packEnd void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand): 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.
packStart void packStart(gtk.cell_renderer.CellRenderer cell, bool expand): 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.
reorder void reorder(gtk.cell_renderer.CellRenderer cell, int position): Re-inserts cell at position.
setCellDataFunc void setCellDataFunc(gtk.cell_renderer.CellRenderer cell, gtk.types.CellLayoutDataFunc func): Sets the #GtkCellLayoutDataFunc to use for cell_layout.

gtk tree_view_column classes