LevelBar

The #GtkLevelBar is a bar 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.

Use gtk.level_bar.LevelBar.setValue to set the current value, and gtk.level_bar.LevelBar.addOffsetValue 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

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 gtk.level_bar.LevelBar.setMinValue and gtk.level_bar.LevelBar.setMaxValue. 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 was introduced in GTK+ 3.6.

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.

class LevelBar : Widget , Orientable {

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

static GType _getGType();

GType _gType [@property getter];

LevelBar self();

static LevelBarGidBuilder builder();

bool inverted [@property getter];

bool inverted [@property setter];

double maxValue [@property getter];

double maxValue [@property setter];

double minValue [@property getter];

double minValue [@property setter];

gtk.types.LevelBarMode mode [@property getter];

gtk.types.LevelBarMode mode [@property setter];

double value [@property getter];

double value [@property setter];

this();

static gtk.level_bar.LevelBar newForInterval(double minValue, double maxValue);

void addOffsetValue(string name, double value);

bool getInverted();

double getMaxValue();

double getMinValue();

gtk.types.LevelBarMode getMode();

bool getOffsetValue(string name, double value);

double getValue();

void removeOffsetValue(string name);

void setInverted(bool inverted);

void setMaxValue(double value);

void setMinValue(double value);

void setMode(gtk.types.LevelBarMode mode);

void setValue(double value);

gulong connectOffsetChanged(string detail, T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkLevelBar.

Members

Functions

addOffsetValue void addOffsetValue(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 #GtkLevelBar: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.
connectOffsetChanged gulong connectOffsetChanged(string detail, T callback, Flag!"After" after): Connect to OffsetChanged signal.
getInverted bool getInverted(): Return the value of the #GtkLevelBar:inverted property.
getMaxValue double getMaxValue(): Returns the value of the #GtkLevelBar:max-value property.
getMinValue double getMinValue(): Returns the value of the #GtkLevelBar:min-value property.
getMode gtk.types.LevelBarMode getMode(): Returns the value of the #GtkLevelBar:mode property.
getOffsetValue bool getOffsetValue(string name, double value): Fetches the value specified for the offset marker name in self, returning true in case an offset named name was found.
getValue double getValue(): Returns the value of the #GtkLevelBar:value property.
removeOffsetValue void removeOffsetValue(string name): Removes an offset marker previously added with gtk.level_bar.LevelBar.addOffsetValue.
self LevelBar self(): Returns this, for use in with statements.
setInverted void setInverted(bool inverted): Sets the value of the #GtkLevelBar:inverted property.
setMaxValue void setMaxValue(double value): Sets the value of the #GtkLevelBar:max-value property.
setMinValue void setMinValue(double value): Sets the value of the #GtkLevelBar:min-value property.
setMode void setMode(gtk.types.LevelBarMode mode): Sets the value of the #GtkLevelBar:mode property.
setValue void setValue(double value): Sets the value of the #GtkLevelBar:value property.

Properties

_gType GType _gType [@property getter]
inverted bool inverted [@property getter]: Get inverted property.
inverted bool inverted [@property setter]: Set inverted property.
maxValue double maxValue [@property getter]: Get maxValue property.
maxValue double maxValue [@property setter]: Set maxValue property.
minValue double minValue [@property getter]: Get minValue property.
minValue double minValue [@property setter]: Set minValue property.
mode gtk.types.LevelBarMode mode [@property getter]: Get mode property.
mode gtk.types.LevelBarMode mode [@property setter]: Set mode property.
value double value [@property getter]: Get value property.
value double value [@property setter]: Set value property.

Static functions

_getGType GType _getGType()
builder LevelBarGidBuilder builder(): Get builder for gtk.level_bar.LevelBar
newForInterval gtk.level_bar.LevelBar newForInterval(double minValue, double maxValue): Utility constructor that creates a new #GtkLevelBar for the specified interval.

Mixed In Members

From `mixin OrientableT!()`

orientation gtk.types.Orientation orientation [@property getter]: Get orientation property.
orientation gtk.types.Orientation orientation [@property setter]: Set orientation property.
getOrientation gtk.types.Orientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(gtk.types.Orientation orientation): Sets the orientation of the orientable.

Inherited Members

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Widget self(): Returns this, for use in with statements.
builder WidgetGidBuilder builder(): Get builder for gtk.widget.Widget
appPaintable bool appPaintable [@property getter]
appPaintable bool appPaintable [@property setter]
canDefault bool canDefault [@property getter]
canDefault bool canDefault [@property setter]
canFocus bool canFocus [@property getter]
canFocus bool canFocus [@property setter]
compositeChild bool compositeChild [@property getter]
doubleBuffered bool doubleBuffered [@property getter]: Get doubleBuffered property.
doubleBuffered bool doubleBuffered [@property setter]: Set doubleBuffered property.
events gdk.types.EventMask events [@property getter]
events gdk.types.EventMask events [@property setter]
expand bool expand [@property getter]: Get expand property.
expand bool expand [@property setter]: Set expand property.
focusOnClick bool focusOnClick [@property getter]: Get focusOnClick property.
focusOnClick bool focusOnClick [@property setter]: Set focusOnClick property.
halign gtk.types.Align halign [@property getter]: Get halign property.
halign gtk.types.Align halign [@property setter]: Set halign property.
hasTooltip bool hasTooltip [@property getter]: Get hasTooltip property.
hasTooltip bool hasTooltip [@property setter]: Set hasTooltip property.
heightRequest int heightRequest [@property getter]
heightRequest int heightRequest [@property setter]
hexpand bool hexpand [@property getter]: Get hexpand property.
hexpand bool hexpand [@property setter]: Set hexpand property.
hexpandSet bool hexpandSet [@property getter]: Get hexpandSet property.
hexpandSet bool hexpandSet [@property setter]: Set hexpandSet property.
margin int margin [@property getter]: Get margin property.
margin int margin [@property setter]: Set margin property.
marginBottom int marginBottom [@property getter]: Get marginBottom property.
marginBottom int marginBottom [@property setter]: Set marginBottom property.
marginEnd int marginEnd [@property getter]: Get marginEnd property.
marginEnd int marginEnd [@property setter]: Set marginEnd property.
marginLeft int marginLeft [@property getter]: Get marginLeft property.
marginLeft int marginLeft [@property setter]: Set marginLeft property.
marginRight int marginRight [@property getter]: Get marginRight property.
marginRight int marginRight [@property setter]: Set marginRight property.
marginStart int marginStart [@property getter]: Get marginStart property.
marginStart int marginStart [@property setter]: Set marginStart property.
marginTop int marginTop [@property getter]: Get marginTop property.
marginTop int marginTop [@property setter]: Set marginTop property.
name string name [@property getter]
name string name [@property setter]
noShowAll bool noShowAll [@property getter]
noShowAll bool noShowAll [@property setter]
opacity double opacity [@property getter]: Get opacity property.
opacity double opacity [@property setter]: Set opacity property.
parent gtk.container.Container parent [@property getter]
parent gtk.container.Container parent [@property setter]
receivesDefault bool receivesDefault [@property getter]
receivesDefault bool receivesDefault [@property setter]
scaleFactor int scaleFactor [@property getter]: Get scaleFactor property.
sensitive bool sensitive [@property getter]
sensitive bool sensitive [@property setter]
style gtk.style.Style style [@property getter]: Get style property.
style gtk.style.Style style [@property setter]: Set style property.
tooltipMarkup string tooltipMarkup [@property getter]: Get tooltipMarkup property.
tooltipMarkup string tooltipMarkup [@property setter]: Set tooltipMarkup property.
tooltipText string tooltipText [@property getter]: Get tooltipText property.
tooltipText string tooltipText [@property setter]: Set tooltipText property.
valign gtk.types.Align valign [@property getter]: Get valign property.
valign gtk.types.Align valign [@property setter]: Set valign property.
vexpand bool vexpand [@property getter]: Get vexpand property.
vexpand bool vexpand [@property setter]: Set vexpand property.
vexpandSet bool vexpandSet [@property getter]: Get vexpandSet property.
vexpandSet bool vexpandSet [@property setter]: Set vexpandSet property.
visible bool visible [@property getter]
visible bool visible [@property setter]
widthRequest int widthRequest [@property getter]
widthRequest int widthRequest [@property setter]
window gdk.window.Window window [@property getter]: Get window property.
getDefaultDirection gtk.types.TextDirection getDefaultDirection(): Obtains the current default reading direction. See gtk.widget.Widget.setDefaultDirection.
getDefaultStyle gtk.style.Style getDefaultStyle(): Returns the default style used by all widgets initially.
popCompositeChild void popCompositeChild(): Cancels the effect of a previous call to gtk.widget.Widget.pushCompositeChild.
pushCompositeChild void pushCompositeChild(): Makes all newly-created widgets as composite children until the corresponding gtk.widget.Widget.popCompositeChild call.
setDefaultDirection void setDefaultDirection(gtk.types.TextDirection dir): Sets the default reading direction for widgets where the direction has not been explicitly set by gtk.widget.Widget.setDirection.
activate bool activate(): For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If widget isn't activatable, the function returns false.
addAccelerator void addAccelerator(string accelSignal, gtk.accel_group.AccelGroup accelGroup, uint accelKey, gdk.types.ModifierType accelMods, gtk.types.AccelFlags accelFlags): Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. The accel_group needs to be added to the widget’s toplevel via gtk.window.Window.addAccelGroup, and the signal must be of type G_SIGNAL_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use gtk.accel_map.AccelMap.addEntry and gtk.widget.Widget.setAccelPath or gtk.menu_item.MenuItem.setAccelPath instead.
addDeviceEvents void addDeviceEvents(gdk.device.Device device, gdk.types.EventMask events): Adds the device events in the bitfield events to the event mask for widget. See gtk.widget.Widget.setDeviceEvents for details.
addEvents void addEvents(int events): Adds the events in the bitfield events to the event mask for widget. See gtk.widget.Widget.setEvents and the [input handling overview][event-masks] for details.
addMnemonicLabel void addMnemonicLabel(gtk.widget.Widget label): Adds a widget to the list of mnemonic labels for this widget. (See gtk.widget.Widget.listMnemonicLabels). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well, by using a connection to the #GtkWidget::destroy signal or a weak notifier.
addTickCallback uint addTickCallback(gtk.types.TickCallback callback): Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a #GtkLabel), then you will have to call gtk.widget.Widget.queueResize or gtk.widget.Widget.queueDrawArea yourself.
canActivateAccel bool canActivateAccel(uint signalId): Determines whether an accelerator that activates the signal identified by signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel signal on widget; if the signal isn’t overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped.
childFocus bool childFocus(gtk.types.DirectionType direction): This function is used by custom widget implementations; if you're writing an app, you’d use gtk.widget.Widget.grabFocus to move the focus to a particular widget, and gtk.container.Container.setFocusChain to change the focus tab order. So you may want to investigate those functions instead.
childNotify void childNotify(string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on widget.
classPath void classPath(uint pathLength, string path, string pathReversed): Same as gtk.widget.Widget.path, but always uses the name of a widget’s type, never uses a custom name set with gtk.widget.Widget.setName.
computeExpand bool computeExpand(gtk.types.Orientation orientation): Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at gtk.widget.Widget.getHexpand or gtk.widget.Widget.getVexpand.
createPangoContext pango.context.Context createPangoContext(): Creates a new #PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget. See also gtk.widget.Widget.getPangoContext.
createPangoLayout pango.layout.Layout createPangoLayout(string text): Creates a new #PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
destroy void destroy(): Destroys a widget.
destroyed void destroyed(gtk.widget.Widget widgetPointer): This function sets *widget_pointer to null if widget_pointer != null. It’s intended to be used as a callback connected to the “destroy” signal of a widget. You connect gtk.widget.Widget.destroyed as a signal handler, and pass the address of your widget variable as user data. Then when the widget is destroyed, the variable will be set to null. Useful for example to avoid multiple copies of the same dialog.
deviceIsShadowed bool deviceIsShadowed(gdk.device.Device device): Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. This may be used in the #GtkWidget::grab-notify signal to check for specific devices. See gtk.global.deviceGrabAdd.
dragBegin gdk.drag_context.DragContext dragBegin(gtk.target_list.TargetList targets, gdk.types.DragAction actions, int button, gdk.event.Event event): This function is equivalent to gtk.widget.Widget.dragBeginWithCoordinates, passing -1, -1 as coordinates.
dragBeginWithCoordinates gdk.drag_context.DragContext dragBeginWithCoordinates(gtk.target_list.TargetList targets, gdk.types.DragAction actions, int button, gdk.event.Event event, int x, int y): Initiates a drag on the source side. The function only needs to be used when the application is starting drags itself, and is not needed when gtk.widget.Widget.dragSourceSet is used.
dragCheckThreshold bool dragCheckThreshold(int startX, int startY, int currentX, int currentY): Checks to see if a mouse drag starting at (start_x, start_y) and ending at (current_x, current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation.
dragDestAddImageTargets void dragDestAddImageTargets(): Add the image targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addImageTargets and gtk.widget.Widget.dragDestSetTargetList.
dragDestAddTextTargets void dragDestAddTextTargets(): Add the text targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addTextTargets and gtk.widget.Widget.dragDestSetTargetList.
dragDestAddUriTargets void dragDestAddUriTargets(): Add the URI targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addUriTargets and gtk.widget.Widget.dragDestSetTargetList.
dragDestFindTarget gdk.atom.Atom dragDestFindTarget(gdk.drag_context.DragContext context, gtk.target_list.TargetList targetList): Looks for a match between the supported targets of context and the dest_target_list, returning the first matching target, otherwise returning GDK_NONE. dest_target_list should usually be the return value from gtk.widget.Widget.dragDestGetTargetList, but some widgets may have different valid targets for different parts of the widget; in that case, they will have to implement a drag_motion handler that passes the correct target list to this function.
dragDestGetTargetList gtk.target_list.TargetList dragDestGetTargetList(): Returns the list of targets this widget can accept from drag-and-drop.
dragDestGetTrackMotion bool dragDestGetTrackMotion(): Returns whether the widget has been configured to always emit #GtkWidget::drag-motion signals.
dragDestSet void dragDestSet(gtk.types.DestDefaults flags, gtk.target_entry.TargetEntry[] targets, gdk.types.DragAction actions): Sets a widget as a potential drop destination, and adds default behaviors.
dragDestSetProxy void dragDestSetProxy(gdk.window.Window proxyWindow, gdk.types.DragProtocol protocol, bool useCoordinates): Sets this widget as a proxy for drops to another window.
dragDestSetTargetList void dragDestSetTargetList(gtk.target_list.TargetList targetList): Sets the target types that this widget can accept from drag-and-drop. The widget must first be made into a drag destination with gtk.widget.Widget.dragDestSet.
dragDestSetTrackMotion void dragDestSetTrackMotion(bool trackMotion): Tells the widget to emit #GtkWidget::drag-motion and #GtkWidget::drag-leave events regardless of the targets and the gtk.types.DestDefaults.Motion flag.
dragDestUnset void dragDestUnset(): Clears information about a drop destination set with gtk.widget.Widget.dragDestSet. The widget will no longer receive notification of drags.
dragGetData void dragGetData(gdk.drag_context.DragContext context, gdk.atom.Atom target, uint time): Gets the data associated with a drag. When the data is received or the retrieval fails, GTK+ will emit a #GtkWidget::drag-data-received signal. Failure of the retrieval is indicated by the length field of the selection_data signal parameter being negative. However, when gtk.widget.Widget.dragGetData is called implicitely because the gtk.types.DestDefaults.Drop was set, then the widget will not receive notification of failed drops.
dragHighlight void dragHighlight(): Highlights a widget as a currently hovered drop target. To end the highlight, call gtk.widget.Widget.dragUnhighlight. GTK+ calls this automatically if gtk.types.DestDefaults.Highlight is set.
dragSourceAddImageTargets void dragSourceAddImageTargets(): Add the writable image targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addImageTargets and gtk.widget.Widget.dragSourceSetTargetList.
dragSourceAddTextTargets void dragSourceAddTextTargets(): Add the text targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addTextTargets and gtk.widget.Widget.dragSourceSetTargetList.
dragSourceAddUriTargets void dragSourceAddUriTargets(): Add the URI targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addUriTargets and gtk.widget.Widget.dragSourceSetTargetList.
dragSourceGetTargetList gtk.target_list.TargetList dragSourceGetTargetList(): Gets the list of targets this widget can provide for drag-and-drop.
dragSourceSet void dragSourceSet(gdk.types.ModifierType startButtonMask, gtk.target_entry.TargetEntry[] targets, gdk.types.DragAction actions): Sets up a widget so that GTK+ will start a drag operation when the user clicks and drags on the widget. The widget must have a window.
dragSourceSetIconGicon void dragSourceSetIconGicon(gio.icon.Icon icon): Sets the icon that will be used for drags from a particular source to icon. See the docs for #GtkIconTheme for more details.
dragSourceSetIconName void dragSourceSetIconName(string iconName): Sets the icon that will be used for drags from a particular source to a themed icon. See the docs for #GtkIconTheme for more details.
dragSourceSetIconPixbuf void dragSourceSetIconPixbuf(gdkpixbuf.pixbuf.Pixbuf pixbuf): Sets the icon that will be used for drags from a particular widget from a #GdkPixbuf. GTK+ retains a reference for pixbuf and will release it when it is no longer needed.
dragSourceSetIconStock void dragSourceSetIconStock(string stockId): Sets the icon that will be used for drags from a particular source to a stock icon.
dragSourceSetTargetList void dragSourceSetTargetList(gtk.target_list.TargetList targetList): Changes the target types that this widget offers for drag-and-drop. The widget must first be made into a drag source with gtk.widget.Widget.dragSourceSet.
dragSourceUnset void dragSourceUnset(): Undoes the effects of gtk.widget.Widget.dragSourceSet.
dragUnhighlight void dragUnhighlight(): Removes a highlight set by gtk.widget.Widget.dragHighlight from a widget.
draw void draw(cairo.context.Context cr): Draws widget to cr. The top left corner of the widget will be drawn to the currently set origin point of cr.
ensureStyle void ensureStyle(): Ensures that widget has a style (widget->style).
errorBell void errorBell(): Notifies the user about an input-related error on this widget. If the #GtkSettings:gtk-error-bell setting is true, it calls gdk.window.Window.beep, otherwise it does nothing.
event bool event(gdk.event.Event event): Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don’t use this function; instead, use gtk.global.mainDoEvent so the event will behave as if it were in the event queue. Don’t synthesize expose events; instead, use gdk.window.Window.invalidateRect to invalidate a region of the window.
freezeChildNotify void freezeChildNotify(): Stops emission of #GtkWidget::child-notify signals on widget. The signals are queued until gtk.widget.Widget.thawChildNotify is called on widget.
getAccessible atk.object.ObjectWrap getAccessible(): Returns the accessible object that describes the widget to an assistive technology.
getActionGroup gio.action_group.ActionGroup getActionGroup(string prefix): Retrieves the #GActionGroup that was registered using prefix. The resulting #GActionGroup may have been registered to widget or any #GtkWidget in its ancestry.
getAllocatedBaseline int getAllocatedBaseline(): Returns the baseline that has currently been allocated to widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function, and when allocating child widgets in #GtkWidget::size_allocate.
getAllocatedHeight int getAllocatedHeight(): Returns the height that has currently been allocated to widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function.
getAllocatedSize void getAllocatedSize(gtk.types.Allocation allocation, int baseline): Retrieves the widget’s allocated size.
getAllocatedWidth int getAllocatedWidth(): Returns the width that has currently been allocated to widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function.
getAllocation void getAllocation(gtk.types.Allocation allocation): Retrieves the widget’s allocation.
getAncestor gtk.widget.Widget getAncestor(gobject.types.GType widgetType): Gets the first ancestor of widget with type widget_type. For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that’s an ancestor of widget. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel #GtkWindow in the docs for gtk.widget.Widget.getToplevel.
getAppPaintable bool getAppPaintable(): Determines whether the application intends to draw on the widget in an #GtkWidget::draw handler.
getCanDefault bool getCanDefault(): Determines whether widget can be a default widget. See gtk.widget.Widget.setCanDefault.
getCanFocus bool getCanFocus(): Determines whether widget can own the input focus. See gtk.widget.Widget.setCanFocus.
getChildRequisition void getChildRequisition(gtk.requisition.Requisition requisition): This function is only for use in widget implementations. Obtains widget->requisition, unless someone has forced a particular geometry on the widget (e.g. with gtk.widget.Widget.setSizeRequest), in which case it returns that geometry instead of the widget's requisition.
getChildVisible bool getChildVisible(): Gets the value set with gtk.widget.Widget.setChildVisible. If you feel a need to use this function, your code probably needs reorganization.
getClip void getClip(gtk.types.Allocation clip): Retrieves the widget’s clip area.
getClipboard gtk.clipboard.Clipboard getClipboard(gdk.atom.Atom selection): Returns the clipboard object for the given selection to be used with widget. widget must have a #GdkDisplay associated with it, so must be attached to a toplevel window.
getCompositeName string getCompositeName(): Obtains the composite name of a widget.
getDeviceEnabled bool getDeviceEnabled(gdk.device.Device device): Returns whether device can interact with widget and its children. See gtk.widget.Widget.setDeviceEnabled.
getDeviceEvents gdk.types.EventMask getDeviceEvents(gdk.device.Device device): Returns the events mask for the widget corresponding to an specific device. These are the events that the widget will receive when device operates on it.
getDirection gtk.types.TextDirection getDirection(): Gets the reading direction for a particular widget. See gtk.widget.Widget.setDirection.
getDisplay gdk.display.Display getDisplay(): Get the #GdkDisplay for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top.
getDoubleBuffered bool getDoubleBuffered(): Determines whether the widget is double buffered.
getEvents int getEvents(): Returns the event mask (see #GdkEventMask) for the widget. These are the events that the widget will receive.
getFocusOnClick bool getFocusOnClick(): Returns whether the widget should grab focus when it is clicked with the mouse. See gtk.widget.Widget.setFocusOnClick.
getFontMap pango.font_map.FontMap getFontMap(): Gets the font map that has been set with gtk.widget.Widget.setFontMap.
getFontOptions cairo.font_options.FontOptions getFontOptions(): Returns the #cairo_font_options_t used for Pango rendering. When not set, the defaults font options for the #GdkScreen will be used.
getFrameClock gdk.frame_clock.FrameClock getFrameClock(): Obtains the frame clock for a widget. The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call gdk.frame_clock.FrameClock.getFrameTime, in order to get a time to use for animating. For example you might record the start of the animation with an initial value from gdk.frame_clock.FrameClock.getFrameTime, and then update the animation by calling gdk.frame_clock.FrameClock.getFrameTime again during each repaint.
getHalign gtk.types.Align getHalign(): Gets the value of the #GtkWidget:halign property.
getHasTooltip bool getHasTooltip(): Returns the current value of the has-tooltip property. See #GtkWidget:has-tooltip for more information.
getHasWindow bool getHasWindow(): Determines whether widget has a #GdkWindow of its own. See gtk.widget.Widget.setHasWindow.
getHexpand bool getHexpand(): Gets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
getHexpandSet bool getHexpandSet(): Gets whether gtk.widget.Widget.setHexpand has been used to explicitly set the expand flag on this widget.
getMapped bool getMapped(): Whether the widget is mapped.
getMarginBottom int getMarginBottom(): Gets the value of the #GtkWidget:margin-bottom property.
getMarginEnd int getMarginEnd(): Gets the value of the #GtkWidget:margin-end property.
getMarginLeft int getMarginLeft(): Gets the value of the #GtkWidget:margin-left property.
getMarginRight int getMarginRight(): Gets the value of the #GtkWidget:margin-right property.
getMarginStart int getMarginStart(): Gets the value of the #GtkWidget:margin-start property.
getMarginTop int getMarginTop(): Gets the value of the #GtkWidget:margin-top property.
getModifierMask gdk.types.ModifierType getModifierMask(gdk.types.ModifierIntent intent): Returns the modifier mask the widget’s windowing system backend uses for a particular purpose.
getModifierStyle gtk.rc_style.RcStyle getModifierStyle(): Returns the current modifier style for the widget. (As set by gtk.widget.Widget.modifyStyle.) If no style has previously set, a new #GtkRcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call gtk.widget.Widget.modifyStyle, passing in the returned rc style, to make sure that your changes take effect.
getName string getName(): Retrieves the name of a widget. See gtk.widget.Widget.setName for the significance of widget names.
getNoShowAll bool getNoShowAll(): Returns the current value of the #GtkWidget:no-show-all property, which determines whether calls to gtk.widget.Widget.showAll will affect this widget.
getOpacity double getOpacity(): Fetches the requested opacity for this widget. See gtk.widget.Widget.setOpacity.
getPangoContext pango.context.Context getPangoContext(): Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk.widget.Widget.createPangoContext, this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by using the #GtkWidget::screen-changed signal on the widget.
getParent gtk.widget.Widget getParent(): Returns the parent container of widget.
getParentWindow gdk.window.Window getParentWindow(): Gets widget’s parent window, or null if it does not have one.
getPath gtk.widget_path.WidgetPath getPath(): Returns the #GtkWidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created.
getPointer void getPointer(int x, int y): Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as widget->window coordinates for widgets that return true for gtk.widget.Widget.getHasWindow; and are relative to widget->allocation.x, widget->allocation.y otherwise.
getPreferredHeight void getPreferredHeight(int minimumHeight, int naturalHeight): Retrieves a widget’s initial minimum and natural height.
getPreferredHeightAndBaselineForWidth void getPreferredHeightAndBaselineForWidth(int width, int minimumHeight, int naturalHeight, int minimumBaseline, int naturalBaseline): Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified width, or the default height if width is -1. The baselines may be -1 which means that no baseline is requested for this widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(int width, int minimumHeight, int naturalHeight): Retrieves a widget’s minimum and natural height if it would be given the specified width.
getPreferredSize void getPreferredSize(gtk.requisition.Requisition minimumSize, gtk.requisition.Requisition naturalSize): Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
getPreferredWidth void getPreferredWidth(int minimumWidth, int naturalWidth): Retrieves a widget’s initial minimum and natural width.
getPreferredWidthForHeight void getPreferredWidthForHeight(int height, int minimumWidth, int naturalWidth): Retrieves a widget’s minimum and natural width if it would be given the specified height.
getRealized bool getRealized(): Determines whether widget is realized.
getReceivesDefault bool getReceivesDefault(): Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
getRequestMode gtk.types.SizeRequestMode getRequestMode(): Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
getRequisition void getRequisition(gtk.requisition.Requisition requisition): Retrieves the widget’s requisition.
getRootWindow gdk.window.Window getRootWindow(): Get the root window where this widget is located. This function can only be called after the widget has been added to a widget hierarchy with #GtkWindow at the top.
getScaleFactor int getScaleFactor(): Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).
getScreen gdk.screen.Screen getScreen(): Get the #GdkScreen from the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top.
getSensitive bool getSensitive(): Returns the widget’s sensitivity (in the sense of returning the value that has been set using gtk.widget.Widget.setSensitive).
getSettings gtk.settings.Settings getSettings(): Gets the settings object holding the settings used for this widget.
getSizeRequest void getSizeRequest(int width, int height): Gets the size request that was explicitly set for the widget using gtk.widget.Widget.setSizeRequest. A value of -1 stored in width or height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used instead. See gtk.widget.Widget.setSizeRequest. To get the size a widget will actually request, call gtk.widget.Widget.getPreferredSize instead of this function.
getState gtk.types.StateType getState(): Returns the widget’s state. See gtk.widget.Widget.setState.
getStateFlags gtk.types.StateFlags getStateFlags(): Returns the widget state as a flag set. It is worth mentioning that the effective gtk.types.StateFlags.Insensitive state will be returned, that is, also based on parent insensitivity, even if widget itself is sensitive.
getStyle gtk.style.Style getStyle(): Simply an accessor function that returns widget->style.
getStyleContext gtk.style_context.StyleContext getStyleContext(): Returns the style context associated to widget. The returned object is guaranteed to be the same for the lifetime of widget.
getSupportMultidevice bool getSupportMultidevice(): Returns true if widget is multiple pointer aware. See gtk.widget.Widget.setSupportMultidevice for more information.
getTemplateChild gobject.object.ObjectWrap getTemplateChild(gobject.types.GType widgetType, string name): Fetch an object build from the template XML for widget_type in this widget instance.
getTooltipMarkup string getTooltipMarkup(): Gets the contents of the tooltip for widget.
getTooltipText string getTooltipText(): Gets the contents of the tooltip for widget.
getTooltipWindow gtk.window.Window getTooltipWindow(): Returns the #GtkWindow of the current tooltip. This can be the GtkWindow created by default, or the custom tooltip window set using gtk.widget.Widget.setTooltipWindow.
getToplevel gtk.widget.Widget getToplevel(): This function returns the topmost widget in the container hierarchy widget is a part of. If widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced.
getValign gtk.types.Align getValign(): Gets the value of the #GtkWidget:valign property.
getValignWithBaseline gtk.types.Align getValignWithBaseline(): Gets the value of the #GtkWidget:valign property, including gtk.types.Align.Baseline.
getVexpand bool getVexpand(): Gets whether the widget would like any available extra vertical space.
getVexpandSet bool getVexpandSet(): Gets whether gtk.widget.Widget.setVexpand has been used to explicitly set the expand flag on this widget.
getVisible bool getVisible(): Determines whether the widget is visible. If you want to take into account whether the widget’s parent is also marked as visible, use gtk.widget.Widget.isVisible instead.
getVisual gdk.visual.Visual getVisual(): Gets the visual that will be used to render widget.
getWindow gdk.window.Window getWindow(): Returns the widget’s window if it is realized, null otherwise
grabAdd void grabAdd(): Makes widget the current grabbed widget.
grabDefault void grabDefault(): Causes widget to become the default widget. widget must be able to be a default widget; typically you would ensure this yourself by calling gtk.widget.Widget.setCanDefault with a true value. The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, gtk.widget.Widget.activate should affect them. Note that #GtkEntry widgets require the “activates-default” property set to true before they activate the default widget when Enter is pressed and the #GtkEntry is focused.
grabFocus void grabFocus(): Causes widget to have the keyboard focus for the #GtkWindow it's inside. widget must be a focusable widget, such as a #GtkEntry; something like #GtkFrame won’t work.
grabRemove void grabRemove(): Removes the grab from the given widget.
hasDefault bool hasDefault(): Determines whether widget is the current default widget within its toplevel. See gtk.widget.Widget.setCanDefault.
hasFocus bool hasFocus(): Determines if the widget has the global input focus. See gtk.widget.Widget.isFocus for the difference between having the global input focus, and only having the focus within a toplevel.
hasGrab bool hasGrab(): Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).
hasRcStyle bool hasRcStyle(): Determines if the widget style has been looked up through the rc mechanism.
hasScreen bool hasScreen(): Checks whether there is a #GdkScreen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top.
hasVisibleFocus bool hasVisibleFocus(): Determines if the widget should show a visible indication that it has the global input focus. This is a convenience function for use in ::draw handlers that takes into account whether focus indication should currently be shown in the toplevel window of widget. See gtk.window.Window.getFocusVisible for more information about focus indication.
hide void hide(): Reverses the effects of gtk.widget.Widget.show, causing the widget to be hidden (invisible to the user).
hideOnDelete bool hideOnDelete(): Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk.widget.Widget.hide on its argument, then returns true. If connected to ::delete-event, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when ::delete-event is received.
inDestruction bool inDestruction(): Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work.
initTemplate void initTemplate(): Creates and initializes child widgets defined in templates. This function must be called in the instance initializer for any class which assigned itself a template using gtk.widget_class.WidgetClass.setTemplate
inputShapeCombineRegion void inputShapeCombineRegion(cairo.region.Region region): Sets an input shape for this widget’s GDK window. This allows for windows which react to mouse click in a nonrectangular region, see gdk.window.Window.inputShapeCombineRegion for more information.
insertActionGroup void insertActionGroup(string name, gio.action_group.ActionGroup group): Inserts group into widget. Children of widget that implement #GtkActionable can then be associated with actions in group by setting their “action-name” to prefix.action-name.
intersect bool intersect(gdk.rectangle.Rectangle area, gdk.rectangle.Rectangle intersection): Computes the intersection of a widget’s area and area, storing the intersection in intersection, and returns true if there was an intersection. intersection may be null if you’re only interested in whether there was an intersection.
isAncestor bool isAncestor(gtk.widget.Widget ancestor): Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.
isComposited bool isComposited(): Whether widget can rely on having its alpha channel drawn correctly. On X11 this function returns whether a compositing manager is running for widget’s screen.
isDrawable bool isDrawable(): Determines whether widget can be drawn to. A widget can be drawn to if it is mapped and visible.
isFocus bool isFocus(): Determines if the widget is the focus widget within its toplevel. (This does not mean that the #GtkWidget:has-focus property is necessarily set; #GtkWidget:has-focus will only be set if the toplevel widget additionally has the global input focus.)
isSensitive bool isSensitive(): Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive
isToplevel bool isToplevel(): Determines whether widget is a toplevel widget.
isVisible bool isVisible(): Determines whether the widget and all its parents are marked as visible.
keynavFailed bool keynavFailed(gtk.types.DirectionType direction): This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of gtk.widget.Widget.childFocus:
listAccelClosures gobject.closure.Closure[] listAccelClosures(): Lists the closures used by widget for accelerator group connections with gtk.accel_group.AccelGroup.connectByPath or gtk.accel_group.AccelGroup.connect. The closures can be used to monitor accelerator changes on widget, by connecting to the GtkAccelGroup::accel-changed signal of the #GtkAccelGroup of a closure which can be found out with gtk.accel_group.AccelGroup.fromAccelClosure.
listActionPrefixes string[] listActionPrefixes(): Retrieves a null-terminated array of strings containing the prefixes of #GActionGroup's available to widget.
listMnemonicLabels gtk.widget.Widget[] listMnemonicLabels(): Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, gtk.label.Label.setMnemonicWidget).
map void map(): This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.
mnemonicActivate bool mnemonicActivate(bool groupCycling): Emits the #GtkWidget::mnemonic-activate signal.
modifyBase void modifyBase(gtk.types.StateType state, gdk.color.Color color): Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see gtk.widget.Widget.modifyText) for widgets such as #GtkEntry and #GtkTextView. See also gtk.widget.Widget.modifyStyle.
modifyBg void modifyBg(gtk.types.StateType state, gdk.color.Color color): Sets the background color for a widget in a particular state.
modifyCursor void modifyCursor(gdk.color.Color primary, gdk.color.Color secondary): Sets the cursor color to use in a widget, overriding the #GtkWidget cursor-color and secondary-cursor-color style properties.
modifyFg void modifyFg(gtk.types.StateType state, gdk.color.Color color): Sets the foreground color for a widget in a particular state.
modifyFont void modifyFont(pango.font_description.FontDescription fontDesc): Sets the font to use for a widget.
modifyStyle void modifyStyle(gtk.rc_style.RcStyle style): Modifies style values on the widget.
modifyText void modifyText(gtk.types.StateType state, gdk.color.Color color): Sets the text color for a widget in a particular state.
overrideBackgroundColor void overrideBackgroundColor(gtk.types.StateFlags state, gdk.rgba.RGBA color): Sets the background color to use for a widget.
overrideColor void overrideColor(gtk.types.StateFlags state, gdk.rgba.RGBA color): Sets the color to use for a widget.
overrideCursor void overrideCursor(gdk.rgba.RGBA cursor, gdk.rgba.RGBA secondaryCursor): Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. All other style values are left untouched. See also gtk.widget.Widget.modifyStyle.
overrideFont void overrideFont(pango.font_description.FontDescription fontDesc): Sets the font to use for a widget. All other style values are left untouched. See gtk.widget.Widget.overrideColor.
overrideSymbolicColor void overrideSymbolicColor(string name, gdk.rgba.RGBA color): Sets a symbolic color for a widget.
path void path(uint pathLength, string path, string pathReversed): Obtains the full path to widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from gtk.widget.Widget.getName. Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the widget by default (e.g. “GtkButton”) or can be set to an application-specific value with gtk.widget.Widget.setName. By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. path_reversed_p fills in the path in reverse order, i.e. starting with widget’s name instead of starting with the name of widget’s outermost ancestor.
queueAllocate void queueAllocate(): This function is only for use in widget implementations.
queueComputeExpand void queueComputeExpand(): Mark widget as needing to recompute its expand flags. Call this function when setting legacy expand child properties on the child of a container.
queueDraw void queueDraw(): Equivalent to calling gtk.widget.Widget.queueDrawArea for the entire area of a widget.
queueDrawArea void queueDrawArea(int x, int y, int width, int height): Convenience function that calls gtk.widget.Widget.queueDrawRegion on the region created from the given coordinates.
queueDrawRegion void queueDrawRegion(cairo.region.Region region): Invalidates the area of widget defined by region by calling gdk.window.Window.invalidateRegion on the widget’s window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.
queueResize void queueResize(): This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a #GtkLabel, #GtkLabel queues a resize to ensure there’s enough space for the new text.
queueResizeNoRedraw void queueResizeNoRedraw(): This function works like gtk.widget.Widget.queueResize, except that the widget is not invalidated.
realize void realize(): Creates the GDK (windowing system) resources associated with a widget. For example, widget->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.
regionIntersect cairo.region.Region regionIntersect(cairo.region.Region region): Computes the intersection of a widget’s area and region, returning the intersection. The result may be empty, use cairo.region.Region.isEmpty to check.
registerWindow void registerWindow(gdk.window.Window window): Registers a #GdkWindow with the widget and sets it up so that the widget receives events for it. Call gtk.widget.Widget.unregisterWindow when destroying the window.
removeAccelerator bool removeAccelerator(gtk.accel_group.AccelGroup accelGroup, uint accelKey, gdk.types.ModifierType accelMods): Removes an accelerator from widget, previously installed with gtk.widget.Widget.addAccelerator.
removeMnemonicLabel void removeMnemonicLabel(gtk.widget.Widget label): Removes a widget from the list of mnemonic labels for this widget. (See gtk.widget.Widget.listMnemonicLabels). The widget must have previously been added to the list with gtk.widget.Widget.addMnemonicLabel.
removeTickCallback void removeTickCallback(uint id): Removes a tick callback previously registered with gtk.widget.Widget.addTickCallback.
renderIcon gdkpixbuf.pixbuf.Pixbuf renderIcon(string stockId, gtk.types.IconSize size, string detail): A convenience function that uses the theme settings for widget to look up stock_id and render it to a pixbuf. stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. size should be a size such as #GTK_ICON_SIZE_MENU. detail should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.
renderIconPixbuf gdkpixbuf.pixbuf.Pixbuf renderIconPixbuf(string stockId, gtk.types.IconSize size): A convenience function that uses the theme engine and style settings for widget to look up stock_id and render it to a pixbuf. stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. size should be a size such as #GTK_ICON_SIZE_MENU.
reparent void reparent(gtk.widget.Widget newParent): Moves a widget from one #GtkContainer to another, handling reference count issues to avoid destroying the widget.
resetRcStyles void resetRcStyles(): Reset the styles of widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.
resetStyle void resetStyle(): Updates the style context of widget and all descendants by updating its widget path. #GtkContainers may want to use this on a child when reordering it in a way that a different style might apply to it. See also gtk.container.Container.getPathForChild.
sendExpose int sendExpose(gdk.event.Event event): Very rarely-used function. This function is used to emit an expose event on a widget. This function is not normally used directly. The only time it is used is when propagating an expose event to a windowless child widget (gtk.widget.Widget.getHasWindow is false), and that is normally done using gtk.container.Container.propagateDraw.
sendFocusChange bool sendFocusChange(gdk.event.Event event): Sends the focus change event to widget
setAccelPath void setAccelPath(string accelPath, gtk.accel_group.AccelGroup accelGroup): Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. This removes any accelerators (for any accelerator group) installed by previous calls to gtk.widget.Widget.setAccelPath. Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. (See gtk.accel_map.AccelMap.save.)
setAllocation void setAllocation(gtk.types.Allocation allocation): Sets the widget’s allocation. This should not be used directly, but from within a widget’s size_allocate method.
setAppPaintable void setAppPaintable(bool appPaintable): Sets whether the application intends to draw on the widget in an #GtkWidget::draw handler.
setCanDefault void setCanDefault(bool canDefault): Specifies whether widget can be a default widget. See gtk.widget.Widget.grabDefault for details about the meaning of “default”.
setCanFocus void setCanFocus(bool canFocus): Specifies whether widget can own the input focus. See gtk.widget.Widget.grabFocus for actually setting the input focus on a widget.
setChildVisible void setChildVisible(bool isVisible): Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with gtk.widget.Widget.show.
setClip void setClip(gtk.types.Allocation clip): Sets the widget’s clip. This must not be used directly, but from within a widget’s size_allocate method. It must be called after gtk.widget.Widget.setAllocation (or after chaining up to the parent class), because that function resets the clip.
setCompositeName void setCompositeName(string name): Sets a widgets composite name. The widget must be a composite child of its parent; see gtk.widget.Widget.pushCompositeChild.
setDeviceEnabled void setDeviceEnabled(gdk.device.Device device, bool enabled): Enables or disables a #GdkDevice to interact with widget and all its children.
setDeviceEvents void setDeviceEvents(gdk.device.Device device, gdk.types.EventMask events): Sets the device event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive from device. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk.widget.Widget.addDeviceEvents for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with windowless widgets (which return false from gtk.widget.Widget.getHasWindow); to get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.
setDirection void setDirection(gtk.types.TextDirection dir): Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
setDoubleBuffered void setDoubleBuffered(bool doubleBuffered): Widgets are double buffered by default; you can use this function to turn off the buffering. “Double buffered” simply means that gdk.window.Window.beginDrawFrame and gdk.window.Window.endDrawFrame are called automatically around expose events sent to the widget. gdk.window.Window.beginDrawFrame diverts all drawing to a widget's window to an offscreen buffer, and gdk.window.Window.endDrawFrame draws the buffer to the screen. The result is that users see the window update in one smooth step, and don’t see individual graphics primitives being rendered.
setEvents void setEvents(int events): Sets the event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk.widget.Widget.addEvents for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with widgets that have no window. (See gtk.widget.Widget.getHasWindow). To get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.
setFocusOnClick void setFocusOnClick(bool focusOnClick): Sets whether the widget should grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.
setFontMap void setFontMap(pango.font_map.FontMap fontMap): Sets the font map to use for Pango rendering. When not set, the widget will inherit the font map from its parent.
setFontOptions void setFontOptions(cairo.font_options.FontOptions options): Sets the #cairo_font_options_t used for Pango rendering in this widget. When not set, the default font options for the #GdkScreen will be used.
setHalign void setHalign(gtk.types.Align align_): Sets the horizontal alignment of widget. See the #GtkWidget:halign property.
setHasTooltip void setHasTooltip(bool hasTooltip): Sets the has-tooltip property on widget to has_tooltip. See #GtkWidget:has-tooltip for more information.
setHasWindow void setHasWindow(bool hasWindow): Specifies whether widget has a #GdkWindow of its own. Note that all realized widgets have a non-null “window” pointer (gtk.widget.Widget.getWindow never returns a null window when a widget is realized), but for many of them it’s actually the #GdkWindow of one of its parent widgets. Widgets that do not create a window for themselves in #GtkWidget::realize must announce this by calling this function with has_window = false.
setHexpand void setHexpand(bool expand): Sets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
setHexpandSet void setHexpandSet(bool set): Sets whether the hexpand flag (see gtk.widget.Widget.getHexpand) will be used.
setMapped void setMapped(bool mapped): Marks the widget as being mapped.
setMarginBottom void setMarginBottom(int margin): Sets the bottom margin of widget. See the #GtkWidget:margin-bottom property.
setMarginEnd void setMarginEnd(int margin): Sets the end margin of widget. See the #GtkWidget:margin-end property.
setMarginLeft void setMarginLeft(int margin): Sets the left margin of widget. See the #GtkWidget:margin-left property.
setMarginRight void setMarginRight(int margin): Sets the right margin of widget. See the #GtkWidget:margin-right property.
setMarginStart void setMarginStart(int margin): Sets the start margin of widget. See the #GtkWidget:margin-start property.
setMarginTop void setMarginTop(int margin): Sets the top margin of widget. See the #GtkWidget:margin-top property.
setName void setName(string name): Widgets can be named, which allows you to refer to them from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for #GtkStyleContext).
setNoShowAll void setNoShowAll(bool noShowAll): Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk.widget.Widget.showAll will affect this widget.
setOpacity void setOpacity(double opacity): Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Opacity values are clamped to the [0,1] range.). This works on both toplevel widget, and child widgets, although there are some limitations:
setParent void setParent(gtk.widget.Widget parent): This function is useful only when implementing subclasses of #GtkContainer. Sets the container as the parent of widget, and takes care of some details such as updating the state and style of the child to reflect its new location. The opposite function is gtk.widget.Widget.unparent.
setParentWindow void setParentWindow(gdk.window.Window parentWindow): Sets a non default parent window for widget.
setRealized void setRealized(bool realized): Marks the widget as being realized. This function must only be called after all #GdkWindows for the widget have been created and registered.
setReceivesDefault void setReceivesDefault(bool receivesDefault): Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
setRedrawOnAllocate void setRedrawOnAllocate(bool redrawOnAllocate): Sets whether the entire widget is queued for drawing when its size allocation changes. By default, this setting is true and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this setting off will improve performance.
setSensitive void setSensitive(bool sensitive): Sets the sensitivity of a widget. A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits.
setSizeRequest void setSizeRequest(int width, int height): Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. You can use this function to force a widget to be larger than it normally would be.
setState void setState(gtk.types.StateType state): This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as gtk.widget.Widget.setSensitive.
setStateFlags void setStateFlags(gtk.types.StateFlags flags, bool clear): This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.).
setStyle void setStyle(gtk.style.Style style): Used to set the #GtkStyle for a widget (widget->style). Since GTK 3, this function does nothing, the passed in style is ignored.
setSupportMultidevice void setSupportMultidevice(bool supportMultidevice): Enables or disables multiple pointer awareness. If this setting is true, widget will start receiving multiple, per device enter/leave events. Note that if custom #GdkWindows are created in #GtkWidget::realize, gdk.window.Window.setSupportMultidevice will have to be called manually on them.
setTooltipMarkup void setTooltipMarkup(string markup): Sets markup as the contents of the tooltip, which is marked up with the [Pango text markup language]PangoMarkupFormat.
setTooltipText void setTooltipText(string text): Sets text as the contents of the tooltip. This function will take care of setting #GtkWidget:has-tooltip to true and of the default handler for the #GtkWidget::query-tooltip signal.
setTooltipWindow void setTooltipWindow(gtk.window.Window customWindow): Replaces the default window used for displaying tooltips with custom_window. GTK+ will take care of showing and hiding custom_window at the right moment, to behave likewise as the default tooltip window. If custom_window is null, the default tooltip window will be used.
setValign void setValign(gtk.types.Align align_): Sets the vertical alignment of widget. See the #GtkWidget:valign property.
setVexpand void setVexpand(bool expand): Sets whether the widget would like any available extra vertical space.
setVexpandSet void setVexpandSet(bool set): Sets whether the vexpand flag (see gtk.widget.Widget.getVexpand) will be used.
setVisible void setVisible(bool visible): Sets the visibility state of widget. Note that setting this to true doesn’t mean the widget is actually viewable, see gtk.widget.Widget.getVisible.
setVisual void setVisual(gdk.visual.Visual visual): Sets the visual that should be used for by widget and its children for creating #GdkWindows. The visual must be on the same #GdkScreen as returned by gtk.widget.Widget.getScreen, so handling the #GtkWidget::screen-changed signal is necessary.
setWindow void setWindow(gdk.window.Window window): Sets a widget’s window. This function should only be used in a widget’s #GtkWidget::realize implementation. The window passed is usually either new window created with gdk.window.Window.new_, or the window of its parent widget as returned by gtk.widget.Widget.getParentWindow.
shapeCombineRegion void shapeCombineRegion(cairo.region.Region region): Sets a shape for this widget’s GDK window. This allows for transparent windows etc., see gdk.window.Window.shapeCombineRegion for more information.
show void show(): Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. If you want to show all the widgets in a container, it’s easier to call gtk.widget.Widget.showAll on the container, instead of individually showing the widgets.
showAll void showAll(): Recursively shows a widget, and any child widgets (if the widget is a container).
showNow void showNow(): Shows a widget. If the widget is an unmapped toplevel widget (i.e. a #GtkWindow that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.
sizeAllocate void sizeAllocate(gtk.types.Allocation allocation): This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets.
sizeAllocateWithBaseline void sizeAllocateWithBaseline(gtk.types.Allocation allocation, int baseline): This function is only used by #GtkContainer subclasses, to assign a size, position and (optionally) baseline to their child widgets.
sizeRequest void sizeRequest(gtk.requisition.Requisition requisition): This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk.widget.Widget.sizeAllocate.
styleAttach void styleAttach(): This function attaches the widget’s #GtkStyle to the widget's #GdkWindow. It is a replacement for
styleGetProperty void styleGetProperty(string propertyName, gobject.value.Value value): Gets the value of a style property of widget.
thawChildNotify void thawChildNotify(): Reverts the effect of a previous call to gtk.widget.Widget.freezeChildNotify. This causes all queued #GtkWidget::child-notify signals on widget to be emitted.
translateCoordinates bool translateCoordinates(gtk.widget.Widget destWidget, int srcX, int srcY, int destX, int destY): Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. In order to perform this operation, both widgets must be realized, and must share a common toplevel.
triggerTooltipQuery void triggerTooltipQuery(): Triggers a tooltip query on the display where the toplevel of widget is located. See gtk.tooltip.Tooltip.triggerTooltipQuery for more information.
unmap void unmap(): This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.
unparent void unparent(): This function is only for use in widget implementations. Should be called by implementations of the remove method on #GtkContainer, to dissociate a child from the container.
unrealize void unrealize(): This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as widget->window).
unregisterWindow void unregisterWindow(gdk.window.Window window): Unregisters a #GdkWindow from the widget that was previously set up with gtk.widget.Widget.registerWindow. You need to call this when the window is no longer used by the widget, such as when you destroy it.
unsetStateFlags void unsetStateFlags(gtk.types.StateFlags flags): This function is for use in widget implementations. Turns off flag values for the current widget state (insensitive, prelighted, etc.). See gtk.widget.Widget.setStateFlags.
connectAccelClosuresChanged gulong connectAccelClosuresChanged(T callback, Flag!"After" after): Connect to AccelClosuresChanged signal.
connectButtonPressEvent gulong connectButtonPressEvent(T callback, Flag!"After" after): Connect to ButtonPressEvent signal.
connectButtonReleaseEvent gulong connectButtonReleaseEvent(T callback, Flag!"After" after): Connect to ButtonReleaseEvent signal.
connectCanActivateAccel gulong connectCanActivateAccel(T callback, Flag!"After" after): Connect to CanActivateAccel signal.
connectChildNotify gulong connectChildNotify(string detail, T callback, Flag!"After" after): Connect to ChildNotify signal.
connectCompositedChanged gulong connectCompositedChanged(T callback, Flag!"After" after): Connect to CompositedChanged signal.
connectConfigureEvent gulong connectConfigureEvent(T callback, Flag!"After" after): Connect to ConfigureEvent signal.
connectDamageEvent gulong connectDamageEvent(T callback, Flag!"After" after): Connect to DamageEvent signal.
connectDeleteEvent gulong connectDeleteEvent(T callback, Flag!"After" after): Connect to DeleteEvent signal.
connectDestroy gulong connectDestroy(T callback, Flag!"After" after): Connect to Destroy signal.
connectDestroyEvent gulong connectDestroyEvent(T callback, Flag!"After" after): Connect to DestroyEvent signal.
connectDirectionChanged gulong connectDirectionChanged(T callback, Flag!"After" after): Connect to DirectionChanged signal.
connectDragBegin gulong connectDragBegin(T callback, Flag!"After" after): Connect to DragBegin signal.
connectDragDataDelete gulong connectDragDataDelete(T callback, Flag!"After" after): Connect to DragDataDelete signal.
connectDragDataGet gulong connectDragDataGet(T callback, Flag!"After" after): Connect to DragDataGet signal.
connectDragDataReceived gulong connectDragDataReceived(T callback, Flag!"After" after): Connect to DragDataReceived signal.
connectDragDrop gulong connectDragDrop(T callback, Flag!"After" after): Connect to DragDrop signal.
connectDragEnd gulong connectDragEnd(T callback, Flag!"After" after): Connect to DragEnd signal.
connectDragFailed gulong connectDragFailed(T callback, Flag!"After" after): Connect to DragFailed signal.
connectDragLeave gulong connectDragLeave(T callback, Flag!"After" after): Connect to DragLeave signal.
connectDragMotion gulong connectDragMotion(T callback, Flag!"After" after): Connect to DragMotion signal.
connectDraw gulong connectDraw(T callback, Flag!"After" after): Connect to Draw signal.
connectEnterNotifyEvent gulong connectEnterNotifyEvent(T callback, Flag!"After" after): Connect to EnterNotifyEvent signal.
connectEvent gulong connectEvent(T callback, Flag!"After" after): Connect to Event signal.
connectEventAfter gulong connectEventAfter(T callback, Flag!"After" after): Connect to EventAfter signal.
connectFocus gulong connectFocus(T callback, Flag!"After" after): Connect to Focus signal.
connectFocusInEvent gulong connectFocusInEvent(T callback, Flag!"After" after): Connect to FocusInEvent signal.
connectFocusOutEvent gulong connectFocusOutEvent(T callback, Flag!"After" after): Connect to FocusOutEvent signal.
connectGrabBrokenEvent gulong connectGrabBrokenEvent(T callback, Flag!"After" after): Connect to GrabBrokenEvent signal.
connectGrabFocus gulong connectGrabFocus(T callback, Flag!"After" after): Connect to GrabFocus signal.
connectGrabNotify gulong connectGrabNotify(T callback, Flag!"After" after): Connect to GrabNotify signal.
connectHide gulong connectHide(T callback, Flag!"After" after): Connect to Hide signal.
connectHierarchyChanged gulong connectHierarchyChanged(T callback, Flag!"After" after): Connect to HierarchyChanged signal.
connectKeyPressEvent gulong connectKeyPressEvent(T callback, Flag!"After" after): Connect to KeyPressEvent signal.
connectKeyReleaseEvent gulong connectKeyReleaseEvent(T callback, Flag!"After" after): Connect to KeyReleaseEvent signal.
connectKeynavFailed gulong connectKeynavFailed(T callback, Flag!"After" after): Connect to KeynavFailed signal.
connectLeaveNotifyEvent gulong connectLeaveNotifyEvent(T callback, Flag!"After" after): Connect to LeaveNotifyEvent signal.
connectMap gulong connectMap(T callback, Flag!"After" after): Connect to Map signal.
connectMapEvent gulong connectMapEvent(T callback, Flag!"After" after): Connect to MapEvent signal.
connectMnemonicActivate gulong connectMnemonicActivate(T callback, Flag!"After" after): Connect to MnemonicActivate signal.
connectMotionNotifyEvent gulong connectMotionNotifyEvent(T callback, Flag!"After" after): Connect to MotionNotifyEvent signal.
connectMoveFocus gulong connectMoveFocus(T callback, Flag!"After" after): Connect to MoveFocus signal.
connectParentSet gulong connectParentSet(T callback, Flag!"After" after): Connect to ParentSet signal.
connectPopupMenu gulong connectPopupMenu(T callback, Flag!"After" after): Connect to PopupMenu signal.
connectPropertyNotifyEvent gulong connectPropertyNotifyEvent(T callback, Flag!"After" after): Connect to PropertyNotifyEvent signal.
connectProximityInEvent gulong connectProximityInEvent(T callback, Flag!"After" after): Connect to ProximityInEvent signal.
connectProximityOutEvent gulong connectProximityOutEvent(T callback, Flag!"After" after): Connect to ProximityOutEvent signal.
connectQueryTooltip gulong connectQueryTooltip(T callback, Flag!"After" after): Connect to QueryTooltip signal.
connectRealize gulong connectRealize(T callback, Flag!"After" after): Connect to Realize signal.
connectScreenChanged gulong connectScreenChanged(T callback, Flag!"After" after): Connect to ScreenChanged signal.
connectScrollEvent gulong connectScrollEvent(T callback, Flag!"After" after): Connect to ScrollEvent signal.
connectSelectionClearEvent gulong connectSelectionClearEvent(T callback, Flag!"After" after): Connect to SelectionClearEvent signal.
connectSelectionGet gulong connectSelectionGet(T callback, Flag!"After" after): Connect to SelectionGet signal.
connectSelectionNotifyEvent gulong connectSelectionNotifyEvent(T callback, Flag!"After" after): Connect to SelectionNotifyEvent signal.
connectSelectionReceived gulong connectSelectionReceived(T callback, Flag!"After" after): Connect to SelectionReceived signal.
connectSelectionRequestEvent gulong connectSelectionRequestEvent(T callback, Flag!"After" after): Connect to SelectionRequestEvent signal.
connectShow gulong connectShow(T callback, Flag!"After" after): Connect to Show signal.
connectShowHelp gulong connectShowHelp(T callback, Flag!"After" after): Connect to ShowHelp signal.
connectSizeAllocate gulong connectSizeAllocate(T callback, Flag!"After" after): Connect to SizeAllocate signal.
connectStateChanged gulong connectStateChanged(T callback, Flag!"After" after): Connect to StateChanged signal.
connectStateFlagsChanged gulong connectStateFlagsChanged(T callback, Flag!"After" after): Connect to StateFlagsChanged signal.
connectStyleSet gulong connectStyleSet(T callback, Flag!"After" after): Connect to StyleSet signal.
connectStyleUpdated gulong connectStyleUpdated(T callback, Flag!"After" after): Connect to StyleUpdated signal.
connectTouchEvent gulong connectTouchEvent(T callback, Flag!"After" after): Connect to TouchEvent signal.
connectUnmap gulong connectUnmap(T callback, Flag!"After" after): Connect to Unmap signal.
connectUnmapEvent gulong connectUnmapEvent(T callback, Flag!"After" after): Connect to UnmapEvent signal.
connectUnrealize gulong connectUnrealize(T callback, Flag!"After" after): Connect to Unrealize signal.
connectVisibilityNotifyEvent gulong connectVisibilityNotifyEvent(T callback, Flag!"After" after): Connect to VisibilityNotifyEvent signal.
connectWindowStateEvent gulong connectWindowStateEvent(T callback, Flag!"After" after): Connect to WindowStateEvent signal.

From Orientable

_getGType GType _getGType()
orientation gtk.types.Orientation orientation [@property getter]: Get orientation property.
orientation gtk.types.Orientation orientation [@property setter]: Set orientation property.
getOrientation gtk.types.Orientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(gtk.types.Orientation orientation): Sets the orientation of the orientable.

gtk level_bar classes

LevelBar

GtkLevelBar as GtkBuildable

CSS nodes

From mixin OrientableT!()

From `mixin OrientableT!()`