Struct gtk4::CellRendererProgress

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

List views use widgets to display their contents. You should use ProgressBar instead Renders numbers as progress bars

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

Properties

inverted

Readable | Writeable

pulse

Setting this to a non-negative value causes the cell renderer to enter “activity mode”, where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.

Each increment of the property causes the block to move by a little bit.

To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to G_MAXINT.

Readable | Writeable

text

The “text” property determines the label which will be drawn over the progress bar. Setting this property to None causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.

Readable | Writeable

text-xalign

The “text-xalign” property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.

Readable | Writeable

text-yalign

The “text-yalign” property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).

Readable | Writeable

value

The “value” property determines the percentage to which the progress bar will be “filled in”.

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

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Implements

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

Implementations

impl CellRendererProgress

pub fn new() -> CellRendererProgress

Creates a new CellRendererProgress.

Deprecated since 4.10

Returns

the new cell renderer

pub fn builder() -> CellRendererProgressBuilder

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

This method returns an instance of CellRendererProgressBuilder which can be used to create CellRendererProgress objects.

pub fn is_inverted(&self) -> bool

pub fn set_inverted(&self, inverted: bool)

pub fn pulse(&self) -> i32

Setting this to a non-negative value causes the cell renderer to enter “activity mode”, where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.

Each increment of the property causes the block to move by a little bit.

To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to G_MAXINT.

pub fn set_pulse(&self, pulse: i32)

Setting this to a non-negative value causes the cell renderer to enter “activity mode”, where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.

Each increment of the property causes the block to move by a little bit.

To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to G_MAXINT.

pub fn text(&self) -> Option<GString>

The “text” property determines the label which will be drawn over the progress bar. Setting this property to None causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.

pub fn set_text(&self, text: Option<&str>)

The “text” property determines the label which will be drawn over the progress bar. Setting this property to None causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.

pub fn text_xalign(&self) -> f32

The “text-xalign” property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.

pub fn set_text_xalign(&self, text_xalign: f32)

The “text-xalign” property controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.

pub fn text_yalign(&self) -> f32

The “text-yalign” property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).

pub fn set_text_yalign(&self, text_yalign: f32)

The “text-yalign” property controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).

pub fn value(&self) -> i32

The “value” property determines the percentage to which the progress bar will be “filled in”.

pub fn set_value(&self, value: i32)

The “value” property determines the percentage to which the progress bar will be “filled in”.

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

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

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

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

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

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

Trait Implementations

impl Clone for CellRendererProgress

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 CellRendererProgress

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

Formats the value using the given formatter.

impl Default for CellRendererProgress

fn default() -> Self

Returns the “default value” for a type.

impl Display for CellRendererProgress

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

Formats the value using the given formatter.

impl HasParamSpec for CellRendererProgress

type ParamSpec = ParamSpecObject

type SetValue = CellRendererProgress

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CellRendererProgress

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 CellRendererProgress

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 CellRendererProgress

type Parent = CellRenderer

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

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 CellRendererProgress

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 CellRendererProgress

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CellRendererProgress

impl IsA<CellRenderer> for CellRendererProgress

impl IsA<Orientable> for CellRendererProgress