CellRendererCombo

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

Renders a combobox in a cell

GtkCellRendererCombo renders text in a cell like GtkCellRendererText from which it is derived. But while GtkCellRendererText offers a simple entry to edit the text, GtkCellRendererCombo offers a GtkComboBox widget to edit the text. The values to display in the combo box are taken from the tree model specified in the GtkCellRendererCombo:model property.

The combo cell renderer takes care of adding a text cell renderer to the combo box and sets it to display the column specified by its GtkCellRendererCombo:text-column property. Further properties of the combo box can be set in a handler for the GtkCellRenderer::editing-started signal.

Skipped during bindings generation

  • method has-entry: Property has no getter nor setter

  • method model: Property has no getter nor setter

  • method text-column: Property has no getter nor setter

Constructors

Link copied to clipboard
constructor()

Creates a new GtkCellRendererCombo. 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

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gtkCellRendererComboPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkCellRendererPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkCellRendererTextPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
Link copied to clipboard
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 connectChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (pathString: String, newIter: TreeIter) -> Unit): <Error class: unknown class>

This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to GtkComboBox, GtkCellRendererCombo::changed is not emitted for changes made to a selected item in the entry. The argument @new_iter corresponds to the newly selected item in the combo box and it is relative to the GtkTreeModel set via the model property on GtkCellRendererCombo.

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

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
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

Checks whether the given GtkCellRenderer is expanded.

Link copied to clipboard

Checks whether the given GtkCellRenderer is an expander.

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 getSensitive(): Boolean

Returns the cell renderer’s sensitivity.

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
open fun getVisible(): Boolean

Returns the cell renderer’s visibility.

Link copied to clipboard

Checks whether the cell renderer can do something when activated.

Link copied to clipboard
open fun setAlignment(xalign: Float, yalign: Float)

Sets the renderer’s alignment within its available space.

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

Link copied to clipboard
open fun setFixedSize(width: Int, height: Int)

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

Link copied to clipboard
open fun setIsExpanded(isExpanded: Boolean)

Sets whether the given GtkCellRenderer is expanded.

Link copied to clipboard
open fun setIsExpander(isExpander: Boolean)

Sets whether the given GtkCellRenderer is an expander.

Link copied to clipboard
open fun setPadding(xpad: Int, ypad: Int)

Sets the renderer’s padding.

Link copied to clipboard
open fun setSensitive(sensitive: Boolean)

Sets the cell renderer’s sensitivity.

Link copied to clipboard
open fun setVisible(visible: Boolean)

Sets the cell renderer’s visibility.

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.