CellAreaBox

open class CellAreaBox(pointer: <Error class: unknown class><<Error class: unknown class>>) : CellArea, Orientable

A cell area that renders GtkCellRenderers into a row or a column

The GtkCellAreaBox renders cell renderers into a row or a column depending on its GtkOrientation.

GtkCellAreaBox uses a notion of packing. Packing refers to adding cell renderers with reference to a particular position in a GtkCellAreaBox. There are two reference positions: the start and the end of the box. When the GtkCellAreaBox is oriented in the %GTK_ORIENTATION_VERTICAL orientation, the start is defined as the top of the box and the end is defined as the bottom. In the %GTK_ORIENTATION_HORIZONTAL orientation start is defined as the left side and the end is defined as the right side.

Alignments of GtkCellRenderers rendered in adjacent rows can be configured by configuring the GtkCellAreaBox align child cell property with gtk_cell_area_cell_set_property() or by specifying the "align" argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end().

Constructors

Link copied to clipboard
constructor()

Creates a new GtkCellAreaBox.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The cell in the area that is currently edited

Link copied to clipboard

The widget currently editing the edited cell

Link copied to clipboard

The cell in the area that currently has focus

Link copied to clipboard
open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkCellAreaBoxPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkCellAreaPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkCellLayoutPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkOrientablePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard

The orientation of the orientable.

Link copied to clipboard
open var spacing: Int

The amount of space to reserve between cells.

Functions

Link copied to clipboard
open fun activate(context: CellAreaContext, widget: Widget, cellArea: <Error class: unknown class>, flags: CellRendererState, editOnly: Boolean): Boolean

Activates @area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus.

Link copied to clipboard
open fun activateCell(widget: Widget, renderer: CellRenderer, event: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): Boolean

This is used by GtkCellArea subclasses when handling events to activate cells, the base GtkCellArea class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation.

Link copied to clipboard
open fun add(renderer: CellRenderer)

Adds @renderer to @area with the default child cell properties.

Link copied to clipboard
open fun addAttribute(cell: CellRenderer, attribute: String, column: Int)

Adds an attribute mapping to the list in @cell_layout.

Link copied to clipboard
open fun addFocusSibling(renderer: CellRenderer, sibling: CellRenderer)

Adds @sibling to @renderer’s focusable area, focus will be drawn around @renderer and all of its siblings if @renderer can focus for a given row.

Link copied to clipboard
open fun applyAttributes(treeModel: TreeModel, iter: TreeIter, isExpander: Boolean, isExpanded: Boolean)

Applies any connected attributes to the renderers in

Link copied to clipboard
open fun attributeConnect(renderer: CellRenderer, attribute: String, column: Int)

Connects an @attribute to apply values from @column for the GtkTreeModel in use.

Link copied to clipboard
open fun attributeDisconnect(renderer: CellRenderer, attribute: String)

Disconnects @attribute for the @renderer in @area so that attribute will no longer be updated with values from the model.

Link copied to clipboard
open fun attributeGetColumn(renderer: CellRenderer, attribute: String): Int

Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped.

Link copied to clipboard
open fun cellGetProperty(renderer: CellRenderer, propertyName: String, value: <Error class: unknown class>)

Gets the value of a cell property for @renderer in @area.

Link copied to clipboard
open fun cellSetProperty(renderer: CellRenderer, propertyName: String, value: <Error class: unknown class>)

Sets a cell property for @renderer in @area.

Link copied to clipboard
open fun clear()

Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout.

Link copied to clipboard

Clears all existing attributes previously set with gtk_cell_layout_set_attributes().

Link copied to clipboard
fun connectAddEditable(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (renderer: CellRenderer, editable: CellEditable, <Error class: unknown class>, path: String) -> Unit): <Error class: unknown class>

Indicates that editing has started on @renderer and that @editable should be added to the owning cell-layouting widget at @cell_area.

Link copied to clipboard
fun connectApplyAttributes(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (model: TreeModel, iter: TreeIter, isExpander: Boolean, isExpanded: Boolean) -> Unit): <Error class: unknown class>

This signal is emitted whenever applying attributes to @area from @model

Link copied to clipboard
fun connectFocusChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (renderer: CellRenderer, path: String) -> Unit): <Error class: unknown class>

Indicates that focus changed on this @area. This signal is emitted either as a result of focus handling or event handling.

Link copied to clipboard
fun connectRemoveEditable(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (renderer: CellRenderer, editable: CellEditable) -> Unit): <Error class: unknown class>

Indicates that editing finished on @renderer and that @editable should be removed from the owning cell-layouting widget.

Link copied to clipboard

This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.

Link copied to clipboard

Creates a GtkCellAreaContext to be used with @area for all purposes. GtkCellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same GtkCellAreaContext which was used to request the size of those rows of data).

Link copied to clipboard
open fun event(context: CellAreaContext, widget: Widget, event: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): Int

Delegates event handling to a GtkCellArea.

Link copied to clipboard
open fun focus(direction: DirectionType): Boolean

This should be called by the @area’s owning layout widget when focus is to be passed to @area, or moved within @area for a given @direction and row data.

Link copied to clipboard
open fun foreach(callback: CellCallback)

Calls @callback for every GtkCellRenderer in @area.

Link copied to clipboard
open fun foreachAlloc(context: CellAreaContext, widget: Widget, cellArea: <Error class: unknown class>, backgroundArea: <Error class: unknown class>, callback: CellAllocCallback)

Calls @callback for every GtkCellRenderer in @area with the allocated rectangle inside @cell_area.

Link copied to clipboard
open fun getArea(): CellArea?

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.

Link copied to clipboard
open fun getBuildableId(): String?

Gets the ID of the @buildable object.

Link copied to clipboard
open fun getCellAllocation(context: CellAreaContext, widget: Widget, renderer: CellRenderer, cellArea: <Error class: unknown class>, allocation: <Error class: unknown class>)

Derives the allocation of @renderer inside @area if @area were to be renderered in @cell_area.

Link copied to clipboard
open fun getCellAtPosition(context: CellAreaContext, widget: Widget, cellArea: <Error class: unknown class>, x: Int, y: Int, allocArea: <Error class: unknown class>?): CellRenderer

Gets the GtkCellRenderer at @x and @y coordinates inside @area and optionally returns the full cell allocation for it inside @cell_area.

Link copied to clipboard
open fun getCells(): <Error class: unknown class>

Returns the cell renderers which have been added to @cell_layout.

Link copied to clipboard

Gets the current GtkTreePath string for the currently applied GtkTreeIter, this is implicitly updated when gtk_cell_area_apply_attributes() is called and can be used to interact with renderers from GtkCellArea subclasses.

Link copied to clipboard

Gets the GtkCellRenderer in @area that is currently being edited.

Link copied to clipboard

Gets the GtkCellEditable widget currently used to edit the currently edited cell.

Link copied to clipboard

Retrieves the currently focused cell for @area

Link copied to clipboard

Gets the GtkCellRenderer which is expected to be focusable for which @renderer is, or may be a sibling.

Link copied to clipboard
open fun getFocusSiblings(renderer: CellRenderer): <Error class: unknown class>

Gets the focus sibling cell renderers for @renderer.

Link copied to clipboard

Retrieves the orientation of the @orientable.

Link copied to clipboard

Gets whether the area prefers a height-for-width layout or a width-for-height layout.

Link copied to clipboard
open fun getSpacing(): Int

Gets the spacing added between cell renderers.

Link copied to clipboard
open fun hasRenderer(renderer: CellRenderer): Boolean

Checks if @area contains @renderer.

Link copied to clipboard
open fun innerCellArea(widget: Widget, cellArea: <Error class: unknown class>, innerArea: <Error class: unknown class>)

This is a convenience function for GtkCellArea implementations to get the inner area where a given GtkCellRenderer will be rendered. It removes any padding previously added by gtk_cell_area_request_renderer().

Link copied to clipboard

Returns whether the area can do anything when activated, after applying new attributes to @area.

Link copied to clipboard
open fun isFocusSibling(renderer: CellRenderer, sibling: CellRenderer): Boolean

Returns whether @sibling is one of @renderer’s focus siblings (see gtk_cell_area_add_focus_sibling()).

Link copied to clipboard
open fun packEnd(cell: CellRenderer, expand: Boolean)

Adds the @cell to the end of @cell_layout. If @expand is false, then the

Link copied to clipboard
open fun packEnd_(renderer: CellRenderer, expand: Boolean, align: Boolean, fixed: Boolean)

Adds @renderer to @box, packed with reference to the end of @box.

Link copied to clipboard
open fun packStart(cell: CellRenderer, expand: Boolean)

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.

Link copied to clipboard
open fun packStart_(renderer: CellRenderer, expand: Boolean, align: Boolean, fixed: Boolean)

Adds @renderer to @box, packed with reference to the start of @box.

Link copied to clipboard
open fun remove(renderer: CellRenderer)

Removes @renderer from @area.

Link copied to clipboard
open fun removeFocusSibling(renderer: CellRenderer, sibling: CellRenderer)

Removes @sibling from @renderer’s focus sibling list (see gtk_cell_area_add_focus_sibling()).

Link copied to clipboard
open fun reorder(cell: CellRenderer, position: Int)

Re-inserts @cell at @position.

Link copied to clipboard

Sets the GtkCellLayoutDataFunc to use for @cell_layout.

Link copied to clipboard
open fun setFocusCell(renderer: CellRenderer? = null)

Explicitly sets the currently focused cell to @renderer.

Link copied to clipboard
open fun setOrientation(orientation: Orientation)

Sets the orientation of the @orientable.

Link copied to clipboard
open fun setSpacing(spacing: Int)

Sets the spacing to add between cell renderers in @box.

Link copied to clipboard
open fun stopEditing(canceled: Boolean)

Explicitly stops the editing of the currently edited cell.