CellRendererToggle

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

Renders a toggle button in a cell

GtkCellRendererToggle renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the GtkCellRendererToggle:radio property. When activated, it emits the GtkCellRendererToggle::toggled signal.

Skipped during bindings generation

  • method inconsistent: Property has no getter nor setter

Constructors

Link copied to clipboard
constructor()

Creates a new GtkCellRendererToggle. Adjust rendering parameters 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 “active” property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model.

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
open var active: Boolean
Link copied to clipboard
val gtkCellRendererPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkCellRendererTogglePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var radio: Boolean
Link copied to clipboard
open var sensitive: Boolean
Link copied to clipboard
open var visible: Boolean

Functions

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

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

The ::toggled signal is emitted when the cell is toggled.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard

Checks whether the cell renderer can do something when activated.

Link copied to clipboard
open fun setAlignment(xalign: <Error class: unknown class>, yalign: <Error class: unknown class>)

Sets the renderer’s alignment within its available space.

Link copied to clipboard
open fun setFixedSize(width: <Error class: unknown class>, height: <Error class: unknown class>)

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

Link copied to clipboard
open fun setPadding(xpad: <Error class: unknown class>, ypad: <Error class: unknown class>)

Sets the renderer’s padding.

Link copied to clipboard
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.

Link copied to clipboard
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.