gtk4/org.gtkkn.bindings.gtk/CellRendererText

CellRendererText

open class CellRendererText(pointer: <Error class: unknown class><<Error class: unknown class>>) : CellRenderer

Renders text in a cell

A GtkCellRendererText renders a given text in its cell, using the font, color and style information provided by its properties. The text will be ellipsized if it is too long and the GtkCellRendererText:ellipsize property allows it.

If the GtkCellRenderer:mode is %GTK_CELL_RENDERER_MODE_EDITABLE, the GtkCellRendererText allows to edit its text using an entry.

Skipped during bindings generation

method align-set: Property has no getter nor setter
method alignment: Property has no getter nor setter
method attributes: Property has no getter nor setter
method background: Property has no getter nor setter
method background-rgba: Property has no getter nor setter
method background-set: Property has no getter nor setter
method editable: Property has no getter nor setter
method editable-set: Property has no getter nor setter
method ellipsize: Property has no getter nor setter
method ellipsize-set: Property has no getter nor setter
method family: Property has no getter nor setter
method family-set: Property has no getter nor setter
method font: Property has no getter nor setter
method font-desc: Property has no getter nor setter
method foreground: Property has no getter nor setter
method foreground-rgba: Property has no getter nor setter
method foreground-set: Property has no getter nor setter
method language: Property has no getter nor setter
method language-set: Property has no getter nor setter
method markup: Property has no getter nor setter
method max-width-chars: Property has no getter nor setter
method placeholder-text: Property has no getter nor setter
method rise: Property has no getter nor setter
method rise-set: Property has no getter nor setter
method scale: Property has no getter nor setter
method scale-set: Property has no getter nor setter
method single-paragraph-mode: Property has no getter nor setter
method size: Property has no getter nor setter
method size-points: Property has no getter nor setter
method size-set: Property has no getter nor setter
method stretch: Property has no getter nor setter
method stretch-set: Property has no getter nor setter
method strikethrough: Property has no getter nor setter
method strikethrough-set: Property has no getter nor setter
method style: Property has no getter nor setter
method style-set: Property has no getter nor setter
method text: Property has no getter nor setter
method underline: Property has no getter nor setter
method underline-set: Property has no getter nor setter
method variant: Property has no getter nor setter
method variant-set: Property has no getter nor setter
method weight: Property has no getter nor setter
method weight-set: Property has no getter nor setter
method width-chars: Property has no getter nor setter
method wrap-mode: Property has no getter nor setter
method wrap-width: Property has no getter nor setter

Inheritors

CellRendererAccel

CellRendererCombo

CellRendererSpin

Constructors

CellRendererText

constructor()

Creates a new GtkCellRendererText. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with GtkTreeViewColumn, you can bind a property to a value in a GtkTreeModel. For example, you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the GtkTreeView.

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

Types

Companion

object Companion

Properties

gtkCellRendererPointer

val gtkCellRendererPointer: <Error class: unknown class><<Error class: unknown class>>

gtkCellRendererTextPointer

val gtkCellRendererTextPointer: <Error class: unknown class><<Error class: unknown class>>

isExpanded

open var isExpanded: Boolean

isExpander

open var isExpander: Boolean

sensitive

open var sensitive: Boolean

visible

open var visible: Boolean

Functions

activate

open fun activate(event: <Error class: unknown class>, widget: Widget, path: String, backgroundArea: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): Boolean

Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, GtkCellRendererToggle toggles when it gets a mouse click.

connectEdited

fun connectEdited(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: String, newText: String) -> Unit): <Error class: unknown class>

This signal is emitted after @renderer has been edited.

connectEditingCanceled

fun connectEditingCanceled(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape.

connectEditingStarted

fun connectEditingStarted(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (editable: CellEditable, path: String) -> Unit): <Error class: unknown class>

This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on @editable, e.g. adding a GtkEntryCompletion or setting up additional columns in a GtkComboBox.

getAlignedArea

open fun getAlignedArea(widget: Widget, flags: CellRendererState, cellArea: <Error class: unknown class>, alignedArea: <Error class: unknown class>)

Gets the aligned area used by @cell inside @cell_area. Used for finding the appropriate edit and focus rectangle.

getIsExpanded

open fun getIsExpanded(): Boolean

Checks whether the given GtkCellRenderer is expanded.

getIsExpander

open fun getIsExpander(): Boolean

Checks whether the given GtkCellRenderer is an expander.

getPreferredSize

open fun getPreferredSize(widget: Widget, minimumSize: Requisition?, naturalSize: Requisition?)

Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.

getRequestMode

open fun getRequestMode(): SizeRequestMode

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

getSensitive

open fun getSensitive(): Boolean

Returns the cell renderer’s sensitivity.

getState

open fun getState(widget: Widget? = null, cellState: CellRendererState): StateFlags

Translates the cell renderer state to GtkStateFlags, based on the cell renderer and widget sensitivity, and the given GtkCellRendererState.

getVisible

open fun getVisible(): Boolean

Returns the cell renderer’s visibility.

isActivatable

open fun isActivatable(): Boolean

Checks whether the cell renderer can do something when activated.

setAlignment

open fun setAlignment(xalign: Float, yalign: Float)

Sets the renderer’s alignment within its available space.

setFixedHeightFromFont

open fun setFixedHeightFromFont(numberOfRows: Int)

Sets the height of a renderer to explicitly be determined by the “font” and “y_pad” property set on it. Further changes in these properties do not affect the height, so they must be accompanied by a subsequent call to this function. Using this function is inflexible, and should really only be used if calculating the size of a cell is too slow (ie, a massive number of cells displayed). If @number_of_rows is -1, then the fixed height is unset, and the height is determined by the properties again.

setFixedSize

open fun setFixedSize(width: Int, height: Int)

Sets the renderer size to be explicit, independent of the properties set.

setIsExpanded

open fun setIsExpanded(isExpanded: Boolean)

Sets whether the given GtkCellRenderer is expanded.

setIsExpander

open fun setIsExpander(isExpander: Boolean)

Sets whether the given GtkCellRenderer is an expander.

setPadding

open fun setPadding(xpad: Int, ypad: Int)

Sets the renderer’s padding.

setSensitive

open fun setSensitive(sensitive: Boolean)

Sets the cell renderer’s sensitivity.

setVisible

open fun setVisible(visible: Boolean)

Sets the cell renderer’s visibility.

startEditing

open fun startEditing(event: <Error class: unknown class>? = null, widget: Widget, path: String, backgroundArea: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): CellEditable?

Starts editing the contents of this @cell, through a new GtkCellEditable widget created by the GtkCellRendererClass.start_editing virtual function.

stopEditing

open fun stopEditing(canceled: Boolean)

Informs the cell renderer that the editing is stopped. If @canceled is true, the cell renderer will emit the GtkCellRenderer::editing-canceled signal.