gtk4/org.gtkkn.bindings.gtk/CellAreaBox

CellAreaBox

open class CellAreaBox(val gtkCellAreaBoxPointer: <Error class: unknown class><<Error class: unknown class>>) : CellArea, Orientable(source)

⚠️ Deprecated ⚠️

This is deprecated since version 4.10.

List views use widgets for displaying their contents

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

CellAreaBox

constructor()

This is deprecated since version 4.10.

---

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

Types

Companion

object Companion

Properties

editedCell

open val editedCell: CellRenderer?

The cell in the area that is currently edited

editWidget

open val editWidget: CellEditable?

The widget currently editing the edited cell

focusCell

open var focusCell: CellRenderer?

The cell in the area that currently has focus

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkCellAreaBoxPointer

val gtkCellAreaBoxPointer: <Error class: unknown class><<Error class: unknown class>>

gtkCellAreaPointer

val gtkCellAreaPointer: <Error class: unknown class><<Error class: unknown class>>

gtkCellLayoutPointer

open override val gtkCellLayoutPointer: <Error class: unknown class><<Error class: unknown class>>

gtkOrientablePointer

open override val gtkOrientablePointer: <Error class: unknown class><<Error class: unknown class>>

orientation

open var orientation: Orientation

The orientation of the orientable.

spacing

open var spacing: <Error class: unknown class>

The amount of space to reserve between cells.

Functions

activate

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

This is deprecated since version 4.10.

---

activateCell

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

This is deprecated since version 4.10.

---

add

open fun add(renderer: CellRenderer)

This is deprecated since version 4.10.

---

addAttribute

open fun addAttribute(cell: CellRenderer, attribute: String, column: <Error class: unknown class>)

This is deprecated since version 4.10.

---

addFocusSibling

open fun addFocusSibling(renderer: CellRenderer, sibling: CellRenderer)

This is deprecated since version 4.10.

---

applyAttributes

open fun applyAttributes(treeModel: TreeModel, iter: TreeIter, isExpander: Boolean, isExpanded: Boolean)

This is deprecated since version 4.10.

---

attributeConnect

open fun attributeConnect(renderer: CellRenderer, attribute: String, column: <Error class: unknown class>)

This is deprecated since version 4.10.

---

attributeDisconnect

open fun attributeDisconnect(renderer: CellRenderer, attribute: String)

This is deprecated since version 4.10.

---

attributeGetColumn

open fun attributeGetColumn(renderer: CellRenderer, attribute: String): <Error class: unknown class>

This is deprecated since version 4.10.

---

cellGetProperty

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

This is deprecated since version 4.10.

---

cellSetProperty

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

This is deprecated since version 4.10.

---

clear

open fun clear()

This is deprecated since version 4.10.

---

clearAttributes

open fun clearAttributes(cell: CellRenderer)

This is deprecated since version 4.10.

---

copyContext

open fun copyContext(context: CellAreaContext): CellAreaContext

This is deprecated since version 4.10.

---

createContext

open fun createContext(): CellAreaContext

This is deprecated since version 4.10.

---

emitAddEditable

fun emitAddEditable(renderer: CellRenderer, editable: CellEditable, cellArea: <Error class: unknown class>, path: String)

Emits the "add-editable" signal. See onAddEditable.

emitApplyAttributes

fun emitApplyAttributes(model: TreeModel, iter: TreeIter, isExpander: Boolean, isExpanded: Boolean)

Emits the "apply-attributes" signal. See onApplyAttributes.

emitFocusChanged

fun emitFocusChanged(renderer: CellRenderer, path: String)

Emits the "focus-changed" signal. See onFocusChanged.

emitRemoveEditable

fun emitRemoveEditable(renderer: CellRenderer, editable: CellEditable)

Emits the "remove-editable" signal. See onRemoveEditable.

event

open fun event( context: CellAreaContext, widget: Widget, event: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): <Error class: unknown class>

This is deprecated since version 4.10.

---

focus

open fun focus(direction: DirectionType): Boolean

This is deprecated since version 4.10.

---

foreach

open fun foreach(callback: CellCallback)

This is deprecated since version 4.10.

---

foreachAlloc

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.

getArea

open fun getArea(): CellArea?

This is deprecated since version 4.10.

---

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getCellAllocation

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

This is deprecated since version 4.10.

---

getCellAtPosition

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

This is deprecated since version 4.10.

---

getCells

open fun getCells(): <Error class: unknown class>

This is deprecated since version 4.10.

---

getCurrentPathString

open fun getCurrentPathString(): String

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.

getFocusFromSibling

open fun getFocusFromSibling(renderer: CellRenderer): CellRenderer?

This is deprecated since version 4.10.

---

getFocusSiblings

open fun getFocusSiblings(renderer: CellRenderer): <Error class: unknown class>

This is deprecated since version 4.10.

---

getOrientation

open fun getOrientation(): Orientation

Retrieves the orientation of the @orientable.

getRequestMode

open fun getRequestMode(): SizeRequestMode

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

hasRenderer

open fun hasRenderer(renderer: CellRenderer): Boolean

This is deprecated since version 4.10.

---

innerCellArea

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

This is deprecated since version 4.10.

---

isActivatable

open fun isActivatable(): Boolean

This is deprecated since version 4.10.

---

isFocusSibling

open fun isFocusSibling(renderer: CellRenderer, sibling: CellRenderer): Boolean

This is deprecated since version 4.10.

---

onAddEditable

fun onAddEditable( 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.

onApplyAttributes

fun onApplyAttributes( 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

onFocusChanged

fun onFocusChanged( 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.

onRemoveEditable

fun onRemoveEditable( 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.

packEnd

open fun packEnd(renderer: CellRenderer, expand: Boolean, align: Boolean, fixed: Boolean)

open fun packEnd(cell: CellRenderer, expand: Boolean)

This is deprecated since version 4.10.

---

packStart

open fun packStart(renderer: CellRenderer, expand: Boolean, align: Boolean, fixed: Boolean)

open fun packStart(cell: CellRenderer, expand: Boolean)

This is deprecated since version 4.10.

---

remove

open fun remove(renderer: CellRenderer)

This is deprecated since version 4.10.

---

removeFocusSibling

open fun removeFocusSibling(renderer: CellRenderer, sibling: CellRenderer)

This is deprecated since version 4.10.

---

reorder

open fun reorder(cell: CellRenderer, position: <Error class: unknown class>)

This is deprecated since version 4.10.

---

setCellDataFunc

open fun setCellDataFunc(cell: CellRenderer, func: CellLayoutDataFunc?)

This is deprecated since version 4.10.

---

setOrientation

open fun setOrientation(orientation: Orientation)

Sets the orientation of the @orientable.

snapshot

open fun snapshot( context: CellAreaContext, widget: Widget, snapshot: Snapshot, backgroundArea: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState, paintFocus: Boolean)

This is deprecated since version 4.10.

---

stopEditing

open fun stopEditing(canceled: Boolean)

This is deprecated since version 4.10.

---