Memory-managed wrapper type.

Type class for types which can be safely cast to CellRenderer, for instance with toCellRenderer.

Cast to CellRenderer, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe CellRenderer.

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

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

Since: 3.0

Fills in xalign and yalign with the appropriate values of cell.

Since: 2.18

Fills in width and height with the appropriate size of cell.

Fills in xpad and ypad with the appropriate values of cell.

Since: 2.18

Retreives a renderer’s natural size when rendered to widget.

Since: 3.0

Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.

Since: 3.0

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

Since: 3.0

Retreives a renderer’s natural size when rendered to widget.

Since: 3.0

Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.

Since: 3.0

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

Since: 3.0

Returns the cell renderer’s sensitivity.

Since: 2.18

Obtains the width and height needed to render the cell. Used by view widgets to determine the appropriate size for the cell_area passed to cellRendererRender. If cellArea is not Nothing, fills in the x and y offsets (if set) of the cell relative to this location.

Please note that the values set in width and height, as well as those in xOffset and yOffset are inclusive of the xpad and ypad properties.

Translates the cell renderer state to StateFlags, based on the cell renderer and widget sensitivity, and the given CellRendererState.

Since: 3.0

Returns the cell renderer’s visibility.

Since: 2.18

Checks whether the cell renderer can do something when activated.

Since: 3.0

Invokes the virtual render function of the CellRenderer. The three passed-in rectangles are areas in cr. Most renderers will draw within cellArea; the xalign, yalign, xpad, and ypad fields of the CellRenderer should be honored with respect to cellArea. backgroundArea includes the blank space around the cell, and also the area containing the tree expander; so the backgroundArea rectangles for all cells tile to cover the entire window.

Sets the renderer’s alignment within its available space.

Since: 2.18

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

Sets the renderer’s padding.

Since: 2.18

Sets the cell renderer’s sensitivity.

Since: 2.18

Sets the cell renderer’s visibility.

Since: 2.18

Starts editing the contents of this cell, through a new CellEditable widget created by the CellRendererClass.start_editing virtual function.

Informs the cell renderer that the editing is stopped. If canceled is True, the cell renderer will emit the CellRenderer::editing-canceled signal.

This function should be called by cell renderer implementations in response to the CellEditable::editing-done signal of CellEditable.

Since: 2.6

Set the value of the “cell-background” property to Nothing. When overloading is enabled, this is equivalent to

clear #cellBackground

Construct a GValueConstruct with valid value for the “cell-background” property. This is rarely needed directly, but it is used by new.

Set the value of the “cell-background” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #cellBackground := value ]

Set the value of the “cell-background-gdk” property to Nothing. When overloading is enabled, this is equivalent to

clear #cellBackgroundGdk

Construct a GValueConstruct with valid value for the “cell-background-gdk” property. This is rarely needed directly, but it is used by new.

Get the value of the “cell-background-gdk” property. When overloading is enabled, this is equivalent to

get cellRenderer #cellBackgroundGdk

Set the value of the “cell-background-gdk” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #cellBackgroundGdk := value ]

Set the value of the “cell-background-rgba” property to Nothing. When overloading is enabled, this is equivalent to

clear #cellBackgroundRgba

Construct a GValueConstruct with valid value for the “cell-background-rgba” property. This is rarely needed directly, but it is used by new.

Get the value of the “cell-background-rgba” property. When overloading is enabled, this is equivalent to

get cellRenderer #cellBackgroundRgba

Set the value of the “cell-background-rgba” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #cellBackgroundRgba := value ]

Construct a GValueConstruct with valid value for the “cell-background-set” property. This is rarely needed directly, but it is used by new.

Get the value of the “cell-background-set” property. When overloading is enabled, this is equivalent to

get cellRenderer #cellBackgroundSet

Set the value of the “cell-background-set” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #cellBackgroundSet := value ]

Get the value of the “editing” property. When overloading is enabled, this is equivalent to

get cellRenderer #editing

Construct a GValueConstruct with valid value for the “height” property. This is rarely needed directly, but it is used by new.

Get the value of the “height” property. When overloading is enabled, this is equivalent to

get cellRenderer #height

Set the value of the “height” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #height := value ]

Construct a GValueConstruct with valid value for the “is-expanded” property. This is rarely needed directly, but it is used by new.

Get the value of the “is-expanded” property. When overloading is enabled, this is equivalent to

get cellRenderer #isExpanded

Set the value of the “is-expanded” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #isExpanded := value ]

Construct a GValueConstruct with valid value for the “is-expander” property. This is rarely needed directly, but it is used by new.

Get the value of the “is-expander” property. When overloading is enabled, this is equivalent to

get cellRenderer #isExpander

Set the value of the “is-expander” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #isExpander := value ]

Construct a GValueConstruct with valid value for the “mode” property. This is rarely needed directly, but it is used by new.

Get the value of the “mode” property. When overloading is enabled, this is equivalent to

get cellRenderer #mode

Set the value of the “mode” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #mode := value ]

Construct a GValueConstruct with valid value for the “sensitive” property. This is rarely needed directly, but it is used by new.

Get the value of the “sensitive” property. When overloading is enabled, this is equivalent to

get cellRenderer #sensitive

Set the value of the “sensitive” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #sensitive := value ]

Construct a GValueConstruct with valid value for the “visible” property. This is rarely needed directly, but it is used by new.

Get the value of the “visible” property. When overloading is enabled, this is equivalent to

get cellRenderer #visible

Set the value of the “visible” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #visible := value ]

Construct a GValueConstruct with valid value for the “width” property. This is rarely needed directly, but it is used by new.

Get the value of the “width” property. When overloading is enabled, this is equivalent to

get cellRenderer #width

Set the value of the “width” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #width := value ]

Construct a GValueConstruct with valid value for the “xalign” property. This is rarely needed directly, but it is used by new.

Get the value of the “xalign” property. When overloading is enabled, this is equivalent to

get cellRenderer #xalign

Set the value of the “xalign” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #xalign := value ]

Construct a GValueConstruct with valid value for the “xpad” property. This is rarely needed directly, but it is used by new.

Get the value of the “xpad” property. When overloading is enabled, this is equivalent to

get cellRenderer #xpad

Set the value of the “xpad” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #xpad := value ]

Construct a GValueConstruct with valid value for the “yalign” property. This is rarely needed directly, but it is used by new.

Get the value of the “yalign” property. When overloading is enabled, this is equivalent to

get cellRenderer #yalign

Set the value of the “yalign” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #yalign := value ]

Construct a GValueConstruct with valid value for the “ypad” property. This is rarely needed directly, but it is used by new.

Get the value of the “ypad” property. When overloading is enabled, this is equivalent to

get cellRenderer #ypad

Set the value of the “ypad” property. When overloading is enabled, this is equivalent to

set cellRenderer [ #ypad := value ]

Type for the callback on the (unwrapped) C side.

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.

See also: cellRendererStopEditing.

Since: 2.4

Connect a signal handler for the “editing-canceled” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellRenderer #editingCanceled callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_CellRendererEditingCanceledCallback.

A convenience synonym for Nothing :: Maybe CellRendererEditingCanceledCallback.

Connect a signal handler for the “editing-canceled” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellRenderer #editingCanceled callback

Wrap a CellRendererEditingCanceledCallback into a C_CellRendererEditingCanceledCallback.

Type for the callback on the (unwrapped) C side.

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 EntryCompletion or setting up additional columns in a ComboBox.

See cellEditableStartEditing for information on the lifecycle of the editable and a way to do setup that doesn’t depend on the renderer.

Note that GTK+ doesn't guarantee that cell renderers will continue to use the same kind of widget for editing in future releases, therefore you should check the type of editable before doing any specific setup, as in the following example:

C code

static void
text_editing_started (GtkCellRenderer *cell,
                      GtkCellEditable *editable,
                      const gchar     *path,
                      gpointer         data)
{
  if (GTK_IS_ENTRY (editable))
    {
      GtkEntry *entry = GTK_ENTRY (editable);
      
      // ... create a GtkEntryCompletion
      
      gtk_entry_set_completion (entry, completion);
    }
}

Since: 2.6

Connect a signal handler for the “editing-started” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellRenderer #editingStarted callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_CellRendererEditingStartedCallback.

A convenience synonym for Nothing :: Maybe CellRendererEditingStartedCallback.

Connect a signal handler for the “editing-started” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellRenderer #editingStarted callback

Wrap a CellRendererEditingStartedCallback into a C_CellRendererEditingStartedCallback.