panel.omni_bar

Module for [OmniBar] class

class OmniBar OmniBarGidBuilder OmniBarGidBuilderImpl

Types 3

classOmniBar : gtk.widget.Widget, gtk.actionable.Actionable

A multi-use widget for user interaction in the window header bar. You can add widgets, a popover to provide action items, an icon, updates on progress and pulse the main widget.

There is also a prefix and suffix area that can contain more widgets.

omni-bar

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

OmniBar self() nothrowReturns `this`, for use in `with` statements.

OmniBarGidBuilder builder() static nothrowGet builder for [panel.omni_bar.OmniBar] Returns: New builder object

string actionTooltip() @property nothrowGet `actionTooltip` property. Returns: The tooltip for the action.

void actionTooltip(string propval) @property nothrowSet `actionTooltip` property. Params: propval = The tooltip for the action.

string iconName() @property nothrowGet `iconName` property. Returns: The name of the icon to use.

void iconName(string propval) @property nothrowSet `iconName` property. Params: propval = The name of the icon to use.

gio.menu_model.MenuModel menuModel() @property nothrowGet `menuModel` property. Returns: The menu model of the omni bar menu.

void menuModel(gio.menu_model.MenuModel propval) @property nothrowSet `menuModel` property. Params: propval = The menu model of the omni bar menu.

gtk.popover.Popover popover() @property nothrowGet `popover` property. Returns: The popover to show.

void popover(gtk.popover.Popover propval) @property nothrowSet `popover` property. Params: propval = The popover to show.

double progress() @property nothrowGet `progress` property. Returns: The current progress value.

void progress(double propval) @property nothrowSet `progress` property. Params: propval = The current progress value.

void addPrefix(int priority, gtk.widget.Widget widget) nothrowAdd a widget at the start of the container, ordered by priority. The highest the priority, the closest to the start.

void addSuffix(int priority, gtk.widget.Widget widget) nothrowAdd a widget towards the end of the container, ordered by priority. The highest the priority, the closest to the start.

gtk.popover.Popover getPopover() nothrowGets the current popover or null if none is setup. Returns: a #GtkPopover or null

double getProgress() nothrowGets the progress value displayed in the omni bar. Returns: the progress value.

void remove(gtk.widget.Widget widget) nothrowRemoves a widget from the omni bar. Currently only prefix or suffix widgets are supported.

void setPopover(gtk.popover.Popover popover = null) nothrowSets the omnibar popover, that will appear when clicking on the omni bar.

void setProgress(double progress) nothrowSets the progress value displayed in the omni bar.

void startPulsing() nothrowStarts pulsing the omni bar. Use panel_omni_bar_stop_pulsing to stop.

void stopPulsing() nothrowStops pulsing the omni bar, that was started with panel_omni_bar_start_pulsing.

Constructors

this(void * ptr, Flag!"Take" take)

this()Create a new #PanelOmniBar. Returns: a newly created #PanelOmniBar

classOmniBarGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T, gtk.actionable.ActionableGidBuilderImpl!T

Fluent builder implementation template for panel.omni_bar.OmniBar

Methods

T actionTooltip(string propval) nothrowSet `actionTooltip` property. Params: propval = The tooltip for the action. Returns: Builder instance for fluent chaining

T iconName(string propval) nothrowSet `iconName` property. Params: propval = The name of the icon to use. Returns: Builder instance for fluent chaining

T menuModel(gio.menu_model.MenuModel propval) nothrowSet `menuModel` property. Params: propval = The menu model of the omni bar menu. Returns: Builder instance for fluent chaining

T popover(gtk.popover.Popover propval) nothrowSet `popover` property. Params: propval = The popover to show. Returns: Builder instance for fluent chaining

T progress(double propval) nothrowSet `progress` property. Params: propval = The current progress value. Returns: Builder instance for fluent chaining

classOmniBarGidBuilder : OmniBarGidBuilderImpl!OmniBarGidBuilder

Fluent builder for panel.omni_bar.OmniBar

Methods

OmniBar build() nothrowCreate object from builder. Returns: New object