Struct gtk4::CellArea

source ·
pub struct CellArea { /* private fields */ }
👎Deprecated: Since 4.10
Expand description

List views use widgets for displaying their contents An abstract class for laying out CellRenderers

The CellArea is an abstract class for CellLayout widgets (also referred to as “layouting widgets”) to interface with an arbitrary number of CellRenderers and interact with the user for a given TreeModel row.

The cell area handles events, focus navigation, drawing and size requests and allocations for a given row of data.

Usually users dont have to interact with the CellArea directly unless they are implementing a cell-layouting widget themselves.

§Requesting area sizes

As outlined in GtkWidget’s geometry management section, GTK uses a height-for-width geometry management system to compute the sizes of widgets and user interfaces. CellArea uses the same semantics to calculate the size of an area for an arbitrary number of TreeModel rows.

When requesting the size of a cell area one needs to calculate the size for a handful of rows, and this will be done differently by different layouting widgets. For instance a TreeViewColumn always lines up the areas from top to bottom while a IconView on the other hand might enforce that all areas received the same width and wrap the areas around, requesting height for more cell areas when allocated less width.

It’s also important for areas to maintain some cell alignments with areas rendered for adjacent rows (cells can appear “columnized” inside an area even when the size of cells are different in each row). For this reason the CellArea uses a CellAreaContext object to store the alignments and sizes along the way (as well as the overall largest minimum and natural size for all the rows which have been calculated with the said context).

The CellAreaContext is an opaque object specific to the CellArea which created it (see CellAreaExt::create_context()).

The owning cell-layouting widget can create as many contexts as it wishes to calculate sizes of rows which should receive the same size in at least one orientation (horizontally or vertically), However, it’s important that the same CellAreaContext which was used to request the sizes for a given TreeModel row be used when rendering or processing events for that row.

In order to request the width of all the rows at the root level of a TreeModel one would do the following:

⚠️ The following code is in c ⚠️

GtkTreeIter iter;
int minimum_width;
int natural_width;

valid = gtk_tree_model_get_iter_first (model, &iter);
while (valid)
  {
    gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
    gtk_cell_area_get_preferred_width (area, context, widget, NULL, NULL);

    valid = gtk_tree_model_iter_next (model, &iter);
  }

gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width);

Note that in this example it’s not important to observe the returned minimum and natural width of the area for each row unless the cell-layouting object is actually interested in the widths of individual rows. The overall width is however stored in the accompanying CellAreaContext object and can be consulted at any time.

This can be useful since CellLayout widgets usually have to support requesting and rendering rows in treemodels with an exceedingly large amount of rows. The CellLayout widget in that case would calculate the required width of the rows in an idle or timeout source (see timeout_add()) and when the widget is requested its actual width in WidgetImpl::measure() it can simply consult the width accumulated so far in the CellAreaContext object.

A simple example where rows are rendered from top to bottom and take up the full width of the layouting widget would look like:

⚠️ The following code is in c ⚠️

static void
foo_get_preferred_width (GtkWidget *widget,
                         int       *minimum_size,
                         int       *natural_size)
{
  Foo *self = FOO (widget);
  FooPrivate *priv = foo_get_instance_private (self);

  foo_ensure_at_least_one_handfull_of_rows_have_been_requested (self);

  gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size);
}

In the above example the Foo widget has to make sure that some row sizes have been calculated (the amount of rows that Foo judged was appropriate to request space for in a single timeout iteration) before simply returning the amount of space required by the area via the CellAreaContext.

Requesting the height for width (or width for height) of an area is a similar task except in this case the CellAreaContext does not store the data (actually, it does not know how much space the layouting widget plans to allocate it for every row. It’s up to the layouting widget to render each row of data with the appropriate height and width which was requested by the CellArea).

In order to request the height for width of all the rows at the root level of a TreeModel one would do the following:

⚠️ The following code is in c ⚠️

GtkTreeIter iter;
int minimum_height;
int natural_height;
int full_minimum_height = 0;
int full_natural_height = 0;

valid = gtk_tree_model_get_iter_first (model, &iter);
while (valid)
  {
    gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
    gtk_cell_area_get_preferred_height_for_width (area, context, widget,
                                                  width, &minimum_height, &natural_height);

    if (width_is_for_allocation)
       cache_row_height (&iter, minimum_height, natural_height);

    full_minimum_height += minimum_height;
    full_natural_height += natural_height;

    valid = gtk_tree_model_iter_next (model, &iter);
  }

Note that in the above example we would need to cache the heights returned for each row so that we would know what sizes to render the areas for each row. However we would only want to really cache the heights if the request is intended for the layouting widgets real allocation.

In some cases the layouting widget is requested the height for an arbitrary for_width, this is a special case for layouting widgets who need to request size for tens of thousands of rows. For this case it’s only important that the layouting widget calculate one reasonably sized chunk of rows and return that height synchronously. The reasoning here is that any layouting widget is at least capable of synchronously calculating enough height to fill the screen height (or scrolled window height) in response to a single call to WidgetImpl::measure(). Returning a perfect height for width that is larger than the screen area is inconsequential since after the layouting receives an allocation from a scrolled window it simply continues to drive the scrollbar values while more and more height is required for the row heights that are calculated in the background.

§Rendering Areas

Once area sizes have been acquired at least for the rows in the visible area of the layouting widget they can be rendered at WidgetImpl::snapshot() time.

A crude example of how to render all the rows at the root level runs as follows:

⚠️ The following code is in c ⚠️

GtkAllocation allocation;
GdkRectangle cell_area = { 0, };
GtkTreeIter iter;
int minimum_width;
int natural_width;

gtk_widget_get_allocation (widget, &allocation);
cell_area.width = allocation.width;

valid = gtk_tree_model_get_iter_first (model, &iter);
while (valid)
  {
    cell_area.height = get_cached_height_for_row (&iter);

    gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE);
    gtk_cell_area_render (area, context, widget, cr,
                          &cell_area, &cell_area, state_flags, FALSE);

    cell_area.y += cell_area.height;

    valid = gtk_tree_model_iter_next (model, &iter);
  }

Note that the cached height in this example really depends on how the layouting widget works. The layouting widget might decide to give every row its minimum or natural height or, if the model content is expected to fit inside the layouting widget without scrolling, it would make sense to calculate the allocation for each row at the time the widget is allocated using distribute_natural_allocation().

§Handling Events and Driving Keyboard Focus

Passing events to the area is as simple as handling events on any normal widget and then passing them to the CellAreaExt::event() API as they come in. Usually CellArea is only interested in button events, however some customized derived areas can be implemented who are interested in handling other events. Handling an event can trigger the focus-changed signal to fire; as well as add-editable in the case that an editable cell was clicked and needs to start editing. You can call CellAreaExt::stop_editing() at any time to cancel any cell editing that is currently in progress.

The CellArea drives keyboard focus from cell to cell in a way similar to Widget. For layouting widgets that support giving focus to cells it’s important to remember to pass GTK_CELL_RENDERER_FOCUSED to the area functions for the row that has focus and to tell the area to paint the focus at render time.

Layouting widgets that accept focus on cells should implement the WidgetImpl::focus() virtual method. The layouting widget is always responsible for knowing where TreeModel rows are rendered inside the widget, so at WidgetImpl::focus() time the layouting widget should use the CellArea methods to navigate focus inside the area and then observe the DirectionType to pass the focus to adjacent rows and areas.

A basic example of how the WidgetImpl::focus() virtual method should be implemented:

static gboolean
foo_focus (GtkWidget       *widget,
           GtkDirectionType direction)
{
  Foo *self = FOO (widget);
  FooPrivate *priv = foo_get_instance_private (self);
  int focus_row = priv->focus_row;
  gboolean have_focus = FALSE;

  if (!gtk_widget_has_focus (widget))
    gtk_widget_grab_focus (widget);

  valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, priv->focus_row);
  while (valid)
    {
      gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE);

      if (gtk_cell_area_focus (priv->area, direction))
        {
           priv->focus_row = focus_row;
           have_focus = TRUE;
           break;
        }
      else
        {
          if (direction == GTK_DIR_RIGHT ||
              direction == GTK_DIR_LEFT)
            break;
          else if (direction == GTK_DIR_UP ||
                   direction == GTK_DIR_TAB_BACKWARD)
           {
              if (focus_row == 0)
                break;
              else
               {
                  focus_row--;
                  valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, focus_row);
               }
            }
          else
            {
              if (focus_row == last_row)
                break;
              else
                {
                  focus_row++;
                  valid = gtk_tree_model_iter_next (priv->model, &iter);
                }
            }
        }
    }
    return have_focus;
}

Note that the layouting widget is responsible for matching the DirectionType values to the way it lays out its cells.

§Cell Properties

The CellArea introduces cell properties for CellRenderers. This provides some general interfaces for defining the relationship cell areas have with their cells. For instance in a CellAreaBox a cell might “expand” and receive extra space when the area is allocated more than its full natural request, or a cell might be configured to “align” with adjacent rows which were requested and rendered with the same CellAreaContext.

Use [CellAreaClassExt::install_cell_property()][crate::subclass::prelude::CellAreaClassExt::install_cell_property()] to install cell properties for a cell area class and CellAreaClassExt::find_cell_property() or CellAreaClassExt::list_cell_properties() to get information about existing cell properties.

To set the value of a cell property, use [CellAreaExtManual::cell_set_property()][crate::prelude::CellAreaExtManual::cell_set_property()], Gtk::CellArea::cell_set() or Gtk::CellArea::cell_set_valist(). To obtain the value of a cell property, use [CellAreaExtManual::cell_get_property()][crate::prelude::CellAreaExtManual::cell_get_property()] Gtk::CellArea::cell_get() or Gtk::CellArea::cell_get_valist().

This is an Abstract Base Class, you cannot instantiate it.

§Properties

§edit-widget

The widget currently editing the edited cell

This property is read-only and only changes as a result of a call gtk_cell_area_activate_cell().

Readable

§edited-cell

The cell in the area that is currently edited

This property is read-only and only changes as a result of a call gtk_cell_area_activate_cell().

Readable

§focus-cell

The cell in the area that currently has focus

Readable | Writeable

§Signals

§add-editable

Indicates that editing has started on @renderer and that @editable should be added to the owning cell-layouting widget at @cell_area.

§apply-attributes

This signal is emitted whenever applying attributes to @area from @model

§focus-changed

Indicates that focus changed on this @area. This signal is emitted either as a result of focus handling or event handling.

It’s possible that the signal is emitted even if the currently focused renderer did not change, this is because focus may change to the same renderer in the same cell area for a different row of data.

§remove-editable

Indicates that editing finished on @renderer and that @editable should be removed from the owning cell-layouting widget.

§Implements

CellAreaExt, [trait@glib::ObjectExt], BuildableExt, CellLayoutExt, CellAreaExtManual, CellLayoutExtManual

Implementations§

source§

impl CellArea

source

pub const NONE: Option<&'static CellArea> = None

👎Deprecated: Since 4.10

Trait Implementations§

source§

impl Clone for CellArea

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CellArea

source§

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

Formats the value using the given formatter. Read more
source§

impl HasParamSpec for CellArea

§

type ParamSpec = ParamSpecObject

§

type SetValue = CellArea

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for CellArea

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T: CellAreaImpl> IsSubclassable<T> for CellArea

source§

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization. Read more
source§

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization. Read more
source§

impl Ord for CellArea

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl ParentClassIs for CellArea

source§

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

source§

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

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

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.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl StaticType for CellArea

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for CellArea

source§

impl IsA<Buildable> for CellArea

source§

impl IsA<CellArea> for CellAreaBox

source§

impl IsA<CellLayout> for CellArea

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<O> BuildableExt for O
where O: IsA<Buildable>,

source§

fn buildable_id(&self) -> Option<GString>

Gets the ID of the @self object. Read more
source§

impl<T> Cast for T
where T: ObjectType,

source§

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
source§

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more
source§

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more
source§

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
source§

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more
source§

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more
source§

impl<O> CellAreaExt for O
where O: IsA<CellArea>,

source§

fn activate( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, cell_area: &Rectangle, flags: CellRendererState, edit_only: bool ) -> bool

👎Deprecated: Since 4.10
Activates @self, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus. Read more
source§

fn activate_cell( &self, widget: &impl IsA<Widget>, renderer: &impl IsA<CellRenderer>, event: impl AsRef<Event>, cell_area: &Rectangle, flags: CellRendererState ) -> bool

👎Deprecated: Since 4.10
This is used by CellArea subclasses when handling events to activate cells, the base CellArea class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation. Read more
source§

fn add(&self, renderer: &impl IsA<CellRenderer>)

👎Deprecated: Since 4.10
Adds @renderer to @self with the default child cell properties. Read more
source§

fn add_focus_sibling( &self, renderer: &impl IsA<CellRenderer>, sibling: &impl IsA<CellRenderer> )

👎Deprecated: Since 4.10
Adds @sibling to @renderer’s focusable area, focus will be drawn around @renderer and all of its siblings if @renderer can focus for a given row. Read more
source§

fn apply_attributes( &self, tree_model: &impl IsA<TreeModel>, iter: &TreeIter, is_expander: bool, is_expanded: bool )

👎Deprecated: Since 4.10
Applies any connected attributes to the renderers in @self by pulling the values from @tree_model. Read more
source§

fn attribute_connect( &self, renderer: &impl IsA<CellRenderer>, attribute: &str, column: i32 )

👎Deprecated: Since 4.10
Connects an @attribute to apply values from @column for the TreeModel in use. Read more
source§

fn attribute_disconnect( &self, renderer: &impl IsA<CellRenderer>, attribute: &str )

👎Deprecated: Since 4.10
Disconnects @attribute for the @renderer in @self so that attribute will no longer be updated with values from the model. Read more
source§

fn attribute_get_column( &self, renderer: &impl IsA<CellRenderer>, attribute: &str ) -> i32

👎Deprecated: Since 4.10
Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped. Read more
source§

fn copy_context(&self, context: &impl IsA<CellAreaContext>) -> CellAreaContext

👎Deprecated: Since 4.10
This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation. Read more
source§

fn create_context(&self) -> CellAreaContext

👎Deprecated: Since 4.10
Creates a CellAreaContext to be used with @self for all purposes. CellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same CellAreaContext which was used to request the size of those rows of data). Read more
source§

fn event( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, event: impl AsRef<Event>, cell_area: &Rectangle, flags: CellRendererState ) -> i32

👎Deprecated: Since 4.10
Delegates event handling to a CellArea. Read more
source§

fn focus(&self, direction: DirectionType) -> bool

👎Deprecated: Since 4.10
This should be called by the @self’s owning layout widget when focus is to be passed to @self, or moved within @self for a given @direction and row data. Read more
source§

fn foreach<P: FnMut(&CellRenderer) -> bool>(&self, callback: P)

👎Deprecated: Since 4.10
Calls @callback for every CellRenderer in @self. Read more
source§

fn foreach_alloc<P: FnMut(&CellRenderer, &Rectangle, &Rectangle) -> bool>( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, cell_area: &Rectangle, background_area: &Rectangle, callback: P )

👎Deprecated: Since 4.10
Calls @callback for every CellRenderer in @self with the allocated rectangle inside @cell_area. Read more
source§

fn cell_allocation( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, renderer: &impl IsA<CellRenderer>, cell_area: &Rectangle ) -> Rectangle

👎Deprecated: Since 4.10
Derives the allocation of @renderer inside @self if @self were to be rendered in @cell_area. Read more
source§

fn cell_at_position( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, cell_area: &Rectangle, x: i32, y: i32 ) -> (CellRenderer, Rectangle)

👎Deprecated: Since 4.10
Gets the CellRenderer at @x and @y coordinates inside @self and optionally returns the full cell allocation for it inside @cell_area. Read more
source§

fn current_path_string(&self) -> GString

👎Deprecated: Since 4.10
Gets the current TreePath string for the currently applied TreeIter, this is implicitly updated when gtk_cell_area_apply_attributes() is called and can be used to interact with renderers from CellArea subclasses. Read more
source§

fn edit_widget(&self) -> Option<CellEditable>

👎Deprecated: Since 4.10
Gets the CellEditable widget currently used to edit the currently edited cell. Read more
source§

fn edited_cell(&self) -> Option<CellRenderer>

👎Deprecated: Since 4.10
Gets the CellRenderer in @self that is currently being edited. Read more
source§

fn focus_cell(&self) -> Option<CellRenderer>

👎Deprecated: Since 4.10
Retrieves the currently focused cell for @self Read more
source§

fn focus_from_sibling( &self, renderer: &impl IsA<CellRenderer> ) -> Option<CellRenderer>

👎Deprecated: Since 4.10
Gets the CellRenderer which is expected to be focusable for which @renderer is, or may be a sibling. Read more
source§

fn focus_siblings(&self, renderer: &impl IsA<CellRenderer>) -> Vec<CellRenderer>

👎Deprecated: Since 4.10
Gets the focus sibling cell renderers for @renderer. Read more
source§

fn preferred_height( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget> ) -> (i32, i32)

👎Deprecated: Since 4.10
Retrieves a cell area’s initial minimum and natural height. Read more
source§

fn preferred_height_for_width( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, width: i32 ) -> (i32, i32)

👎Deprecated: Since 4.10
Retrieves a cell area’s minimum and natural height if it would be given the specified @width. Read more
source§

fn preferred_width( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget> ) -> (i32, i32)

👎Deprecated: Since 4.10
Retrieves a cell area’s initial minimum and natural width. Read more
source§

fn preferred_width_for_height( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, height: i32 ) -> (i32, i32)

👎Deprecated: Since 4.10
Retrieves a cell area’s minimum and natural width if it would be given the specified @height. Read more
source§

fn request_mode(&self) -> SizeRequestMode

👎Deprecated: Since 4.10
Gets whether the area prefers a height-for-width layout or a width-for-height layout. Read more
source§

fn has_renderer(&self, renderer: &impl IsA<CellRenderer>) -> bool

👎Deprecated: Since 4.10
Checks if @self contains @renderer. Read more
source§

fn inner_cell_area( &self, widget: &impl IsA<Widget>, cell_area: &Rectangle ) -> Rectangle

👎Deprecated: Since 4.10
This is a convenience function for CellArea implementations to get the inner area where a given CellRenderer will be rendered. It removes any padding previously added by gtk_cell_area_request_renderer(). Read more
source§

fn is_activatable(&self) -> bool

👎Deprecated: Since 4.10
Returns whether the area can do anything when activated, after applying new attributes to @self. Read more
source§

fn is_focus_sibling( &self, renderer: &impl IsA<CellRenderer>, sibling: &impl IsA<CellRenderer> ) -> bool

👎Deprecated: Since 4.10
Returns whether @sibling is one of @renderer’s focus siblings (see gtk_cell_area_add_focus_sibling()). Read more
source§

fn remove(&self, renderer: &impl IsA<CellRenderer>)

👎Deprecated: Since 4.10
Removes @renderer from @self. Read more
source§

fn remove_focus_sibling( &self, renderer: &impl IsA<CellRenderer>, sibling: &impl IsA<CellRenderer> )

👎Deprecated: Since 4.10
Removes @sibling from @renderer’s focus sibling list (see gtk_cell_area_add_focus_sibling()). Read more
source§

fn request_renderer( &self, renderer: &impl IsA<CellRenderer>, orientation: Orientation, widget: &impl IsA<Widget>, for_size: i32 ) -> (i32, i32)

👎Deprecated: Since 4.10
This is a convenience function for CellArea implementations to request size for cell renderers. It’s important to use this function to request size and then use gtk_cell_area_inner_cell_area() at render and event time since this function will add padding around the cell for focus painting. Read more
source§

fn set_focus_cell(&self, renderer: Option<&impl IsA<CellRenderer>>)

👎Deprecated: Since 4.10
Explicitly sets the currently focused cell to @renderer. Read more
source§

fn snapshot( &self, context: &impl IsA<CellAreaContext>, widget: &impl IsA<Widget>, snapshot: &impl IsA<Snapshot>, background_area: &Rectangle, cell_area: &Rectangle, flags: CellRendererState, paint_focus: bool )

👎Deprecated: Since 4.10
Snapshots @self’s cells according to @self’s layout onto at the given coordinates. Read more
source§

fn stop_editing(&self, canceled: bool)

👎Deprecated: Since 4.10
Explicitly stops the editing of the currently edited cell. Read more
source§

fn connect_add_editable<F: Fn(&Self, &CellRenderer, &CellEditable, &Rectangle, TreePath) + 'static>( &self, f: F ) -> SignalHandlerId

👎Deprecated: Since 4.10
Indicates that editing has started on @renderer and that @editable should be added to the owning cell-layouting widget at @cell_area. Read more
source§

fn connect_apply_attributes<F: Fn(&Self, &TreeModel, &TreeIter, bool, bool) + 'static>( &self, f: F ) -> SignalHandlerId

👎Deprecated: Since 4.10
This signal is emitted whenever applying attributes to @area from @model Read more
source§

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

👎Deprecated: Since 4.10
Indicates that focus changed on this @area. This signal is emitted either as a result of focus handling or event handling. Read more
source§

fn connect_remove_editable<F: Fn(&Self, &CellRenderer, &CellEditable) + 'static>( &self, f: F ) -> SignalHandlerId

👎Deprecated: Since 4.10
Indicates that editing finished on @renderer and that @editable should be removed from the owning cell-layouting widget. Read more
source§

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

👎Deprecated: Since 4.10
source§

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

👎Deprecated: Since 4.10
source§

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

👎Deprecated: Since 4.10
source§

impl<O> CellAreaExtManual for O
where O: IsA<CellArea>,

source§

fn add_with_properties( &self, renderer: &impl IsA<CellRenderer>, properties: &[(&str, &dyn ToValue)] )

👎Deprecated: Since 4.10
Adds @renderer to @self, setting cell properties at the same time. See gtk_cell_area_add() and gtk_cell_area_cell_set() for more details. Read more
source§

fn cell_get_value( &self, renderer: &impl IsA<CellRenderer>, property_name: impl IntoGStr ) -> Value

👎Deprecated: Since 4.10
source§

fn cell_get<V: for<'b> FromValue<'b> + 'static>( &self, renderer: &impl IsA<CellRenderer>, property_name: impl IntoGStr ) -> V

👎Deprecated: Since 4.10
Similar to Self::cell_get_value but panics if the value is of a different type.
source§

fn cell_set( &self, renderer: &impl IsA<CellRenderer>, property_name: impl IntoGStr, value: impl Into<Value> )

👎Deprecated: Since 4.10
source§

impl<O> CellLayoutExt for O
where O: IsA<CellLayout>,

source§

fn add_attribute( &self, cell: &impl IsA<CellRenderer>, attribute: &str, column: i32 )

👎Deprecated: Since 4.10
Adds an attribute mapping to the list in @self. Read more
source§

fn clear(&self)

👎Deprecated: Since 4.10
Unsets all the mappings on all renderers on @self and removes all renderers from @self. Read more
source§

fn clear_attributes(&self, cell: &impl IsA<CellRenderer>)

👎Deprecated: Since 4.10
Clears all existing attributes previously set with gtk_cell_layout_set_attributes(). Read more
source§

fn area(&self) -> Option<CellArea>

👎Deprecated: Since 4.10
Returns the underlying CellArea which might be @self if called on a CellArea or might be None if no CellArea is used by @self. Read more
source§

fn cells(&self) -> Vec<CellRenderer>

👎Deprecated: Since 4.10
Returns the cell renderers which have been added to @self. Read more
source§

fn pack_end(&self, cell: &impl IsA<CellRenderer>, expand: bool)

👎Deprecated: Since 4.10
Adds the @cell to the end of @self. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true. Read more
source§

fn pack_start(&self, cell: &impl IsA<CellRenderer>, expand: bool)

👎Deprecated: Since 4.10
Packs the @cell into the beginning of @self. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true. Read more
source§

fn reorder(&self, cell: &impl IsA<CellRenderer>, position: i32)

👎Deprecated: Since 4.10
Re-inserts @cell at @position. Read more
source§

fn set_cell_data_func<P: Fn(&CellLayout, &CellRenderer, &TreeModel, &TreeIter) + 'static>( &self, cell: &impl IsA<CellRenderer>, func: P )

👎Deprecated: Since 4.10
Sets the CellLayoutDataFunc to use for @self. Read more
source§

impl<O> CellLayoutExtManual for O
where O: IsA<CellLayout>,

source§

fn set_attributes( &self, cell: &impl IsA<CellRenderer>, attributes: &[(&str, i32)] )

👎Deprecated: Since 4.10
Sets the attributes in the parameter list as the attributes of @self. Read more
source§

fn unset_cell_data_func(&self, cell: &impl IsA<CellRenderer>)

👎Deprecated: Since 4.10
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<U> IsSubclassableExt for U

source§

impl<T> ObjectExt for T
where T: ObjectType,

source§

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more
source§

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
source§

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
source§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
source§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
source§

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
source§

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
source§

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
source§

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
source§

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
source§

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R

Emit signal by signal id. Read more
source§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.
source§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R

Emit signal by its name. Read more
source§

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value] ) -> Option<Value>

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by its name with details. Read more
source§

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by its name with details. Read more
source§

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by signal id with details. Read more
source§

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
source§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
source§

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
source§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
source§

fn bind_property<'f, 't, O, 'a>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

source§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,