Struct gtk4::CellRendererToggle

#[repr(transparent)]
pub struct CellRendererToggle { /* private fields */ }

List views use widgets to display their contents. You should use ToggleButton instead Renders a toggle button in a cell

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

Properties

activatable

Readable | Writeable

active

Readable | Writeable

inconsistent

Readable | Writeable

radio

Readable | Writeable

CellRenderer

cell-background

Writeable

cell-background-rgba

Cell background as a gdk::RGBA

Readable | Writeable

cell-background-set

Readable | Writeable

editing

Readable

height

Readable | Writeable

is-expanded

Readable | Writeable

is-expander

Readable | Writeable

mode

Readable | Writeable

sensitive

Readable | Writeable

visible

Readable | Writeable

width

Readable | Writeable

xalign

Readable | Writeable

xpad

Readable | Writeable

yalign

Readable | Writeable

ypad

Readable | Writeable

Signals

toggled

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

It is the responsibility of the application to update the model with the correct value to store at @path. Often this is simply the opposite of the value currently stored at @path.

CellRenderer

editing-canceled

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: gtk_cell_renderer_stop_editing().

editing-started

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 gtk_cell_editable_start_editing() 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:

⚠️ The following code is in C ⚠️

static void
text_editing_started (GtkCellRenderer *cell,
                      GtkCellEditable *editable,
                      const char      *path,
                      gpointer         data)
{
  if (GTK_IS_ENTRY (editable))
    {
      GtkEntry *entry = GTK_ENTRY (editable);

      // ... create a GtkEntryCompletion

      gtk_entry_set_completion (entry, completion);
    }
}

Implements

CellRendererExt, glib::ObjectExt, [CellRendererExtManual][trait@crate::prelude::CellRendererExtManual]

Implementations

impl CellRendererToggle

pub fn new() -> CellRendererToggle

Creates a new CellRendererToggle. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with TreeViewColumn, you can bind a property to a value in a TreeModel. 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.

Deprecated since 4.10

Returns

the new cell renderer

pub fn builder() -> CellRendererToggleBuilder

Creates a new builder-pattern struct instance to construct CellRendererToggle objects.

This method returns an instance of CellRendererToggleBuilder which can be used to create CellRendererToggle objects.

pub fn is_activatable(&self) -> bool

Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable().

Deprecated since 4.10

Returns

true if the cell renderer is activatable.

pub fn is_active(&self) -> bool

Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active().

Deprecated since 4.10

Returns

true if the cell renderer is active.

pub fn is_radio(&self) -> bool

Returns whether we’re rendering radio toggles rather than checkboxes.

Deprecated since 4.10

Returns

true if we’re rendering radio toggles rather than checkboxes

pub fn set_activatable(&self, setting: bool)

Makes the cell renderer activatable.

Deprecated since 4.10

setting

the value to set.

pub fn set_active(&self, setting: bool)

Activates or deactivates a cell renderer.

Deprecated since 4.10

setting

the value to set.

pub fn set_radio(&self, radio: bool)

If @radio is true, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles). If false, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for TreeView, you set up a per-row setting using TreeViewColumn to associate model columns with cell renderer properties).

Deprecated since 4.10

radio

true to make the toggle look like a radio button

pub fn is_inconsistent(&self) -> bool

pub fn set_inconsistent(&self, inconsistent: bool)

pub fn connect_toggled<F: Fn(&Self, TreePath) + 'static>( &self, f: F ) -> SignalHandlerId

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

It is the responsibility of the application to update the model with the correct value to store at @path. Often this is simply the opposite of the value currently stored at @path.

path

string representation of TreePath describing the event location

pub fn connect_activatable_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_active_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_inconsistent_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_radio_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for CellRendererToggle

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CellRendererToggle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CellRendererToggle

fn default() -> Self

Returns the “default value” for a type.

impl Display for CellRendererToggle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for CellRendererToggle

type ParamSpec = ParamSpecObject

type SetValue = CellRendererToggle

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, CellRendererToggle>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CellRendererToggle

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CellRendererToggle

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for CellRendererToggle

type Parent = CellRenderer

impl<OT: ObjectType> PartialEq<OT> for CellRendererToggle

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for CellRendererToggle

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for CellRendererToggle

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CellRendererToggle

impl IsA<CellRenderer> for CellRendererToggle