class: LevelBarMeta

[544:14] static extends: object

Generated metadata helpers for LevelBar class surfaces.

Methods

• properties ()

  Returns property metadata for LevelBar.

  • @r A list.

• signals ()

  Returns signal metadata for LevelBar.

  • @r A list.

class: LevelBar

[57:7] extends: object

Shows a level indicator. Typical use cases are displaying the strength of a password, or showing the charge level of a battery. Use [method@Gtk.LevelBar.set_value] to set the current value, and [method@Gtk.LevelBar.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: %GTK_LEVEL_BAR_OFFSET_LOW, %GTK_LEVEL_BAR_OFFSET_HIGH and %GTK_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 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-width: 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 [method@Gtk.LevelBar.set_min_value] and [method@Gtk.LevelBar.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 %GTK_LEVEL_BAR_MODE_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 GtkLevelBar implementation of the GtkBuildable interface supports a custom <offsets> element, which can contain any number of <offset> elements, each of which must have "name" and "value" attributes. # CSS nodes levelbar[.discrete] ╰── trough ├── block.filled.level-name ┊ ├── block.empty ┊ GtkLevelBar 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 GtkLevelBar uses the [enum@Gtk.AccessibleRole.meter] role.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• LevelBar ()

  Creates a new GtkLevelBar.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asWidget ()

  Wraps this handle as Widget.

  • @r A Widget object.

• asAccessible ()

  Wraps this handle as Accessible.

  • @r A Accessible object.

• asAccessibleRange ()

  Wraps this handle as AccessibleRange.

  • @r A AccessibleRange object.

• asBuildable ()

  Wraps this handle as Buildable.

  • @r A Buildable object.

• asConstraintTarget ()

  Wraps this handle as ConstraintTarget.

  • @r A ConstraintTarget object.

• asOrientable ()

  Wraps this handle as Orientable.

  • @r A Orientable object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnOffsetchanged (callback Fn, UserData = null)

  Emitted when an offset specified on the bar changes value. This typically is the result of a [method@Gtk.LevelBar.add_offset_value] call. The signal supports detailed connections; you can connect to the detailed signal "changed::x" in order to only receive callbacks when the value of offset "x" changes.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (LevelBar Self, string Name).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setInverted (bool Value)

  Whether the GtkLeveBar is inverted. Level bars normally grow from top to bottom or left to right. Inverted level bars grow in the opposite direction.

  • @p Value is the new property value.
  • @r None.

• setMaxvalue (double Value)

  Determines the maximum value of the interval that can be displayed by the bar.

  • @p Value is the new property value.
  • @r None.

• setMinvalue (double Value)

  Determines the minimum value of the interval that can be displayed by the bar.

  • @p Value is the new property value.
  • @r None.

• setMode (string Value)

  Determines the way GtkLevelBar interprets the value properties to draw the level fill area. Specifically, when the value is %GTK_LEVEL_BAR_MODE_CONTINUOUS, GtkLevelBar will draw a single block representing the current value in that area; when the value is %GTK_LEVEL_BAR_MODE_DISCRETE, the widget will draw a succession of separate blocks filling the draw area, with the number of blocks being equal to the units separating the integral roundings of [property@Gtk.LevelBar:min-value] and [property@Gtk.LevelBar:max-value].

  • @p Value is the new property value.
  • @r None.

• setValue (double Value)

  Determines the currently filled value of the level bar.

  • @p Value is the new property value.
  • @r None.

• add_offset_value (string name, double value)

  Adds a new offset marker on @self at the position specified by @value. When the bar value is in the interval topped by @value (or between @value and [property@Gtk.LevelBar:max-value] in case the offset is the last one on the bar) a style class named level-@name will be applied when rendering the level bar fill. If another offset marker named @name exists, its value will be replaced by @value.

  • @p name is the name of the new offset.
  • @p value is the value for the new offset.
  • @r None.

• get_inverted ()

  Returns whether the levelbar is inverted.

• get_max_value ()

  Returns the max-value of the GtkLevelBar.

• get_min_value ()

  Returns the min-value of the GtkLevelBar.

• get_mode ()

  Returns the mode of the GtkLevelBar.

• get_value ()

  Returns the value of the GtkLevelBar.

• remove_offset_value (string name)

  Removes an offset marker from a GtkLevelBar. The marker must have been previously added with [method@Gtk.LevelBar.add_offset_value].

  • @p name is the name of an offset in the bar.
  • @r None.

• set_inverted (bool inverted)

  Sets whether the GtkLevelBar is inverted.

  • @p inverted is %TRUE to invert the level bar.
  • @r None.

• set_max_value (double value)

  Sets the max-value of the GtkLevelBar. You probably want to update preexisting level offsets after calling this function.

  • @p value is a positive value.
  • @r None.

• set_min_value (double value)

  Sets the min-value of the GtkLevelBar. You probably want to update preexisting level offsets after calling this function.

  • @p value is a positive value.
  • @r None.

• set_mode (string mode)

  Sets the mode of the GtkLevelBar.

  • @p mode is a GtkLevelBarMode.
  • @r None.

• set_value (double value)

  Sets the value of the GtkLevelBar.

  • @p value is a value in the interval between [property@Gtk.LevelBar:min-value] and [property@Gtk.LevelBar:max-value].
  • @r None.

class: LevelBarCtors

[456:14] static extends: object

Alternate constructors for LevelBar. Usage: LevelBarCtors.<name>(...). The primary constructor lives directly on LevelBar.

Methods

• newForInterval (double min_value, double max_value)

  Creates a new GtkLevelBar for the specified interval.

  • @p min_value is a positive value.
  • @p max_value is a positive value.
  • @r A new LevelBar.

class: LevelBarOffsetchangedCallback

[474:7] extends: object

Generated low-level callback wrapper for GIR callback offset-changed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• LevelBarOffsetchangedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, name, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.