gtk4/org.gtkkn.bindings.gtk/CellRendererProgress

CellRendererProgress

open class CellRendererProgress(pointer: <Error class: unknown class><<Error class: unknown class>>) : CellRenderer, Orientable

Renders numbers as progress bars

GtkCellRendererProgress renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.

Skipped during bindings generation

method inverted: Property has no getter nor setter
method pulse: Property has no getter nor setter
method text: Property has no getter nor setter
method text-xalign: Property has no getter nor setter
method text-yalign: Property has no getter nor setter
method value: Property has no getter nor setter

Constructors

CellRendererProgress

constructor()

Creates a new GtkCellRendererProgress.

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

gtkCellRendererProgressPointer

val gtkCellRendererProgressPointer: <Error class: unknown class><<Error class: unknown class>>

gtkOrientablePointer

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

isExpanded

open var isExpanded: Boolean

isExpander

open var isExpander: Boolean

orientation

open var orientation: Orientation

The orientation of the orientable.

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.

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.

getOrientation

open fun getOrientation(): Orientation

Retrieves the orientation of the @orientable.

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.

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.

setOrientation

open fun setOrientation(orientation: Orientation)

Sets the orientation of the @orientable.

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.