Struct gtk4::LevelBar

source · [−]

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

Expand description

LevelBar is a widget that can be used as a level indicator.

Typical use cases are displaying the strength of a password, or showing the charge level of a battery.

An example GtkLevelBar

Use set_value() to set the current value, and add_offset_value() to set the value offsets at which the bar will be considered in a different state. GTK will add a few offsets by default on the level bar: LEVEL_BAR_OFFSET_LOW, LEVEL_BAR_OFFSET_HIGH and LEVEL_BAR_OFFSET_FULL, with values 0.25, 0.75 and 1.0 respectively.

Note that it is your responsibility to update preexisting offsets when changing the minimum or maximum value. GTK will simply clamp them to the new range.

Adding a custom offset on the bar

⚠️ The following code is in c ⚠️

static GtkWidget *
create_level_bar (void)
{
  GtkWidget *widget;
  GtkLevelBar *bar;

  widget = gtk_level_bar_new ();
  bar = GTK_LEVEL_BAR (widget);

  // This changes the value of the default low offset

  gtk_level_bar_add_offset_value (bar,
                                  GTK_LEVEL_BAR_OFFSET_LOW,
                                  0.10);

  // This adds a new offset to the bar; the application will
  // be able to change its color CSS like this:
  //
  // levelbar block.my-offset {
  //   background-color: magenta;
  //   border-style: solid;
  //   border-color: black;
  //   border-style: 1px;
  // }

  gtk_level_bar_add_offset_value (bar, "my-offset", 0.60);

  return widget;
}

The default interval of values is between zero and one, but it’s possible to modify the interval using set_min_value() and set_max_value(). The value will be always drawn in proportion to the admissible interval, i.e. a value of 15 with a specified interval between 10 and 20 is equivalent to a value of 0.5 with an interval between 0 and 1. When LevelBarMode::Discrete is used, the bar level is rendered as a finite number of separated blocks instead of a single one. The number of blocks that will be rendered is equal to the number of units specified by the admissible interval.

For instance, to build a bar rendered with five blocks, it’s sufficient to set the minimum value to 0 and the maximum value to 5 after changing the indicator mode to discrete.

GtkLevelBar as GtkBuildable

The LevelBar implementation of the Buildable interface supports a custom element, which can contain any number of elements, each of which must have name and value attributes.

CSS nodes

levelbar[.discrete]
╰── trough
    ├── block.filled.level-name
    ┊
    ├── block.empty
    ┊

LevelBar has a main CSS node with name levelbar and one of the style classes .discrete or .continuous and a subnode with name trough. Below the trough node are a number of nodes with name block and style class .filled or .empty. In continuous mode, there is exactly one node of each, in discrete mode, the number of filled and unfilled nodes corresponds to blocks that are drawn. The block.filled nodes also get a style class .level-name corresponding to the level for the current value.

In horizontal orientation, the nodes are always arranged from left to right, regardless of text direction.

Accessibility

LevelBar uses the AccessibleRole::Meter role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, WidgetExtManual, AccessibleExtManual

Struct gtk4::LevelBar

Implementations

impl LevelBar

pub fn new() -> LevelBar

pub fn for_interval(min_value: f64, max_value: f64) -> LevelBar

pub fn builder() -> LevelBarBuilder

pub fn add_offset_value(&self, name: &str, value: f64)

pub fn is_inverted(&self) -> bool

pub fn max_value(&self) -> f64

pub fn min_value(&self) -> f64

pub fn mode(&self) -> LevelBarMode

pub fn offset_value(&self, name: Option<&str>) -> Option<f64>

pub fn value(&self) -> f64

pub fn remove_offset_value(&self, name: Option<&str>)

pub fn set_inverted(&self, inverted: bool)

pub fn set_max_value(&self, value: f64)

pub fn set_min_value(&self, value: f64)

pub fn set_mode(&self, mode: LevelBarMode)

pub fn set_value(&self, value: f64)

pub fn connect_offset_changed<F: Fn(&Self, &str) + 'static>( &self, detail: Option<&str>, f: F) -> SignalHandlerId

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

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

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

pub fn connect_mode_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 LevelBar

fn clone(&self) -> Self

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

impl Debug for LevelBar

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

impl Default for LevelBar

fn default() -> Self

impl Display for LevelBar

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

impl Hash for LevelBar

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

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

impl Ord for LevelBar

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

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

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

fn clamp(self, min: Self, max: Self) -> Self

impl ParentClassIs for LevelBar

type Parent = Widget

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

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

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

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

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

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

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

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

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

impl StaticType for LevelBar

fn static_type() -> Type

impl Eq for LevelBar

impl IsA<Accessible> for LevelBar

impl IsA<Buildable> for LevelBar

impl IsA<ConstraintTarget> for LevelBar

impl IsA<Orientable> for LevelBar

impl IsA<Widget> for LevelBar

Auto Trait Implementations

impl RefUnwindSafe for LevelBar

impl !Send for LevelBar

impl !Sync for LevelBar

impl Unpin for LevelBar

impl UnwindSafe for LevelBar

Blanket Implementations

impl<O> AccessibleExtManual for O where O: IsA<Accessible>,

fn update_property(&self, properties: &[Property<'_>])

fn update_relation(&self, relations: &[Relation<'_>])

fn update_state(&self, states: &[State])

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

pub fn connect_offset_changed<F: Fn(&Self, &str) + 'static>(
&self,
detail: Option<&str>,
f: F
) -> SignalHandlerId

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

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

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

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

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

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

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

impl<O> AccessibleExtManual for O where
O: IsA<Accessible>,

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<U> IsSubclassableExt for U where
U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

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

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

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

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

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

fn try_set_property<V>(
&self,
property_name: &str,
value: V
) -> Result<(), BoolError> where
V: ToValue,

fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,

fn try_set_property_from_value(
&self,
property_name: &str,
value: &Value
) -> Result<(), BoolError>

fn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>

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

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