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()
GType _gType() @property
OmniBar self()Returns `this`, for use in `with` statements.
OmniBarGidBuilder builder()Get builder for [panel.omni_bar.OmniBar] Returns: New builder object
string actionTooltip() @propertyGet `actionTooltip` property. Returns: The tooltip for the action.
void actionTooltip(string propval) @propertySet `actionTooltip` property. Params: propval = The tooltip for the action.
string iconName() @propertyGet `iconName` property. Returns: The name of the icon to use.
void iconName(string propval) @propertySet `iconName` property. Params: propval = The name of the icon to use.
gio.menu_model.MenuModel menuModel() @propertyGet `menuModel` property. Returns: The menu model of the omni bar menu.
void menuModel(gio.menu_model.MenuModel propval) @propertySet `menuModel` property. Params: propval = The menu model of the omni bar menu.
gtk.popover.Popover popover() @propertyGet `popover` property. Returns: The popover to show.
void popover(gtk.popover.Popover propval) @propertySet `popover` property. Params: propval = The popover to show.
double progress() @propertyGet `progress` property. Returns: The current progress value.
void progress(double propval) @propertySet `progress` property. Params: propval = The current progress value.
void addPrefix(int priority, gtk.widget.Widget widget)Add 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)Add a widget towards the end of the container, ordered by priority. The highest the priority, the closest to the start.
gtk.popover.Popover getPopover()Gets the current popover or null if none is setup. Returns: a #GtkPopover or null
double getProgress()Gets the progress value displayed in the omni bar. Returns: the progress value.
void remove(gtk.widget.Widget widget)Removes a widget from the omni bar. Currently only prefix or suffix widgets are supported.
void setPopover(gtk.popover.Popover popover = null)Sets the omnibar popover, that will appear when clicking on the omni bar.
void setProgress(double progress)Sets the progress value displayed in the omni bar.
void startPulsing()Starts pulsing the omni bar. Use panelomnibarstoppulsing to stop.
void stopPulsing()Stops pulsing the omni bar, that was started with panelomnibarstartpulsing.
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
Methods
T actionTooltip(string propval)Set `actionTooltip` property. Params: propval = The tooltip for the action. Returns: Builder instance for fluent chaining
T iconName(string propval)Set `iconName` property. Params: propval = The name of the icon to use. Returns: Builder instance for fluent chaining
T menuModel(gio.menu_model.MenuModel propval)Set `menuModel` property. Params: propval = The menu model of the omni bar menu. Returns: Builder instance for fluent chaining
T popover(gtk.popover.Popover propval)Set `popover` property. Params: propval = The popover to show. Returns: Builder instance for fluent chaining
T progress(double propval)Set `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()