Widget

The base class for all widgets.

gtk.widget.Widget is the base class all widgets in GTK derive from. It manages the widget lifecycle, layout, states and style.

Height-for-width Geometry Management

GTK uses a height-for-width (and width-for-height) geometry management system. Height-for-width means that a widget can change how much vertical space it needs, depending on the amount of horizontal space that it is given (and similar for width-for-height). The most common example is a label that reflows to fill up the available width, wraps to fewer lines, and therefore needs less height.

Height-for-width geometry management is implemented in GTK by way of two virtual methods:

vfunc@Gtk.Widget.get_request_mode
vfunc@Gtk.Widget.measure

There are some important things to keep in mind when implementing height-for-width and when using it in widget implementations.

If you implement a direct gtk.widget.Widget subclass that supports height-for-width or width-for-height geometry management for itself or its child widgets, the vfunc@Gtk.Widget.get_request_mode virtual function must be implemented as well and return the widget's preferred request mode. The default implementation of this virtual function returns gtk.types.SizeRequestMode.ConstantSize, which means that the widget will only ever get -1 passed as the for_size value to its vfunc@Gtk.Widget.measure implementation.

The geometry management system will query a widget hierarchy in only one orientation at a time. When widgets are initially queried for their minimum sizes it is generally done in two initial passes in the gtk.types.SizeRequestMode chosen by the toplevel.

For example, when queried in the normal gtk.types.SizeRequestMode.HeightForWidth mode:

First, the default minimum and natural width for each widget in the interface will be computed using gtk.widget.Widget.measure with an orientation of gtk.types.Orientation.Horizontal and a for_size of -1. Because the preferred widths for each widget depend on the preferred widths of their children, this information propagates up the hierarchy, and finally a minimum and natural width is determined for the entire toplevel. Next, the toplevel will use the minimum width to query for the minimum height contextual to that width using gtk.widget.Widget.measure with an orientation of gtk.types.Orientation.Vertical and a for_size of the just computed width. This will also be a highly recursive operation. The minimum height for the minimum width is normally used to set the minimum size constraint on the toplevel.

After the toplevel window has initially requested its size in both dimensions it can go on to allocate itself a reasonable size (or a size previously specified with gtk.window.Window.setDefaultSize). During the recursive allocation process it’s important to note that request cycles will be recursively executed while widgets allocate their children. Each widget, once allocated a size, will go on to first share the space in one orientation among its children and then request each child's height for its target allocated width or its width for allocated height, depending. In this way a gtk.widget.Widget will typically be requested its size a number of times before actually being allocated a size. The size a widget is finally allocated can of course differ from the size it has requested. For this reason, gtk.widget.Widget caches a small number of results to avoid re-querying for the same sizes in one allocation cycle.

If a widget does move content around to intelligently use up the allocated size then it must support the request in both gtk.types.SizeRequestModes even if the widget in question only trades sizes in a single orientation.

For instance, a gtk.label.Label that does height-for-width word wrapping will not expect to have vfunc@Gtk.Widget.measure with an orientation of gtk.types.Orientation.Vertical called because that call is specific to a width-for-height request. In this case the label must return the height required for its own minimum possible width. By following this rule any widget that handles height-for-width or width-for-height requests will always be allocated at least enough space to fit its own content.

Here are some examples of how a gtk.types.SizeRequestMode.HeightForWidth widget generally deals with width-for-height requests:

static void
foo_widget_measure (GtkWidget      *widget,
                    GtkOrientation  orientation,
                    int             for_size,
                    int            *minimum_size,
                    int            *natural_size,
                    int            *minimum_baseline,
                    int            *natural_baseline)
{
  if (orientation == GTK_ORIENTATION_HORIZONTAL)
    {
      // Calculate minimum and natural width
    }
  else // VERTICAL
    {
      if (i_am_in_height_for_width_mode)
        {
          int min_width, dummy;

          // First, get the minimum width of our widget
          GTK_WIDGET_GET_CLASS (widget)->measure (widget, GTK_ORIENTATION_HORIZONTAL, -1,
                                                  &min_width, &dummy, &dummy, &dummy);

          // Now use the minimum width to retrieve the minimum and natural height to display
          // that width.
          GTK_WIDGET_GET_CLASS (widget)->measure (widget, GTK_ORIENTATION_VERTICAL, min_width,
                                                  minimum_size, natural_size, &dummy, &dummy);
        }
      else
        {
          // ... some widgets do both.
        }
    }
}

Often a widget needs to get its own request during size request or allocation. For example, when computing height it may need to also compute width. Or when deciding how to use an allocation, the widget may need to know its natural size. In these cases, the widget should be careful to call its virtual methods directly, like in the code example above.

It will not work to use the wrapper function gtk.widget.Widget.measure inside your own vfunc@Gtk.Widget.size_allocate implementation. These return a request adjusted by gtk.size_group.SizeGroup, the widget's align and expand flags, as well as its CSS style.

If a widget used the wrappers inside its virtual method implementations, then the adjustments (such as widget margins) would be applied twice. GTK therefore does not allow this and will warn if you try to do it.

Of course if you are getting the size request for another widget, such as a child widget, you must use gtk.widget.Widget.measure; otherwise, you would not properly consider widget margins, gtk.size_group.SizeGroup, and so forth.

GTK also supports baseline vertical alignment of widgets. This means that widgets are positioned such that the typographical baseline of widgets in the same row are aligned. This happens if a widget supports baselines, has a vertical alignment using baselines, and is inside a widget that supports baselines and has a natural “row” that it aligns to the baseline, or a baseline assigned to it by the grandparent.

Baseline alignment support for a widget is also done by the vfunc@Gtk.Widget.measure virtual function. It allows you to report both a minimum and natural size.

If a widget ends up baseline aligned it will be allocated all the space in the parent as if it was gtk.types.Align.Fill, but the selected baseline can be found via gtk.widget.Widget.getBaseline. If the baseline has a value other than -1 you need to align the widget such that the baseline appears at the position.

GtkWidget as GtkBuildable

The gtk.widget.Widget implementation of the gtk.buildable.Buildable interface supports various custom elements to specify additional aspects of widgets that are not directly expressed as properties.

If the widget uses a gtk.layout_manager.LayoutManager, gtk.widget.Widget supports a custom <layout> element, used to define layout properties:

<object class="GtkGrid" id="my_grid">
  <child>
    <object class="GtkLabel" id="label1">
      <property name="label">Description</property>
      <layout>
        <property name="column">0</property>
        <property name="row">0</property>
        <property name="row-span">1</property>
        <property name="column-span">1</property>
      </layout>
    </object>
  </child>
  <child>
    <object class="GtkEntry" id="description_entry">
      <layout>
        <property name="column">1</property>
        <property name="row">0</property>
        <property name="row-span">1</property>
        <property name="column-span">1</property>
      </layout>
    </object>
  </child>
</object>

gtk.widget.Widget allows style information such as style classes to be associated with widgets, using the custom <style> element:

<object class="GtkButton" id="button1">
  <style>
    <class name="my-special-button-class"/>
    <class name="dark-button"/>
  </style>
</object>

gtk.widget.Widget allows defining accessibility information, such as properties, relations, and states, using the custom <accessibility> element:

<object class="GtkButton" id="button1">
  <accessibility>
    <property name="label">Download</property>
    <relation name="labelled-by">label1</relation>
  </accessibility>
</object>

Building composite widgets from template XML

GtkWidget exposes some facilities to automate the procedure of creating composite widgets using "templates".

To create composite widgets with gtk.builder.Builder XML, one must associate the interface description with the widget class at class initialization time using gtk.widget_class.WidgetClass.setTemplate.

The interface description semantics expected in composite template descriptions is slightly different from regular gtk.builder.Builder XML.

Unlike regular interface descriptions, gtk.widget_class.WidgetClass.setTemplate will expect a <template> tag as a direct child of the toplevel <interface> tag. The <template> tag must specify the “class” attribute which must be the type name of the widget. Optionally, the “parent” attribute may be specified to specify the direct parent type of the widget type; this is ignored by gtk.builder.Builder but can be used by UI design tools to introspect what kind of properties and internal children exist for a given type when the actual type does not exist.

The XML which is contained inside the <template> tag behaves as if it were added to the <object> tag defining the widget itself. You may set properties on a widget by inserting <property> tags into the <template> tag, and also add <child> tags to add children and extend a widget in the normal way you would with <object> tags.

Additionally, <object> tags can also be added before and after the initial <template> tag in the normal way, allowing one to define auxiliary objects which might be referenced by other widgets declared as children of the <template> tag.

Since, unlike the <object> tag, the <template> tag does not contain an “id” attribute, if you need to refer to the instance of the object itself that the template will create, simply refer to the template class name in an applicable element content.

Here is an example of a template definition, which includes an example of this in the <signal> tag:

<interface>
  <template class="FooWidget" parent="GtkBox">
    <property name="orientation">horizontal</property>
    <property name="spacing">4</property>
    <child>
      <object class="GtkButton" id="hello_button">
        <property name="label">Hello World</property>
        <signal name="clicked" handler="hello_button_clicked" object="FooWidget" swapped="yes"/>
      </object>
    </child>
    <child>
      <object class="GtkButton" id="goodbye_button">
        <property name="label">Goodbye World</property>
      </object>
    </child>
  </template>
</interface>

Typically, you'll place the template fragment into a file that is bundled with your project, using gio.resource.Resource. In order to load the template, you need to call gtk.widget_class.WidgetClass.setTemplateFromResource from the class initialization of your gtk.widget.Widget type:

static void
foo_widget_class_init (FooWidgetClass *klass)
{
  // ...

  gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass),
                                               "/com/example/ui/foowidget.ui");
}

You will also need to call gtk.widget.Widget.initTemplate from the instance initialization function:

static void
foo_widget_init (FooWidget *self)
{
  gtk_widget_init_template (GTK_WIDGET (self));

  // Initialize the rest of the widget...
}

as well as calling gtk.widget.Widget.disposeTemplate from the dispose function:

static void
foo_widget_dispose (GObject *gobject)
{
  FooWidget *self = FOO_WIDGET (gobject);

  // Dispose objects for which you have a reference...

  // Clear the template children for this widget type
  gtk_widget_dispose_template (GTK_WIDGET (self), FOO_TYPE_WIDGET);

  G_OBJECT_CLASS (foo_widget_parent_class)->dispose (gobject);
}

You can access widgets defined in the template using the gtk.widget.Widget.getTemplateChild function, but you will typically declare a pointer in the instance private data structure of your type using the same name as the widget in the template definition, and call gtk.widget_class.WidgetClass.bindTemplateChildFull (or one of its wrapper macros func@Gtk.widget_class_bind_template_child and func@Gtk.widget_class_bind_template_child_private) with that name, e.g.

typedef struct {
  GtkWidget *hello_button;
  GtkWidget *goodbye_button;
} FooWidgetPrivate;

G_DEFINE_TYPE_WITH_PRIVATE (FooWidget, foo_widget, GTK_TYPE_BOX)

static void
foo_widget_dispose (GObject *gobject)
{
  gtk_widget_dispose_template (GTK_WIDGET (gobject), FOO_TYPE_WIDGET);

  G_OBJECT_CLASS (foo_widget_parent_class)->dispose (gobject);
}

static void
foo_widget_class_init (FooWidgetClass *klass)
{
  // ...
  G_OBJECT_CLASS (klass)->dispose = foo_widget_dispose;

  gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass),
                                               "/com/example/ui/foowidget.ui");
  gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass),
                                                FooWidget, hello_button);
  gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass),
                                                FooWidget, goodbye_button);
}

static void
foo_widget_init (FooWidget *widget)
{
  gtk_widget_init_template (GTK_WIDGET (widget));
}

You can also use gtk.widget_class.WidgetClass.bindTemplateCallbackFull (or is wrapper macro func@Gtk.widget_class_bind_template_callback) to connect a signal callback defined in the template with a function visible in the scope of the class, e.g.

// the signal handler has the instance and user data swapped
// because of the swapped="yes" attribute in the template XML
static void
hello_button_clicked (FooWidget *self,
                      GtkButton *button)
{
  g_print ("Hello, world!\n");
}

static void
foo_widget_class_init (FooWidgetClass *klass)
{
  // ...
  gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass),
                                               "/com/example/ui/foowidget.ui");
  gtk_widget_class_bind_template_callback (GTK_WIDGET_CLASS (klass), hello_button_clicked);
}

class Widget : InitiallyUnowned , Accessible , Buildable , ConstraintTarget {

static gtk.types.TextDirection getDefaultDirection();

static void setDefaultDirection(gtk.types.TextDirection dir);

void actionSetEnabled(string actionName, bool enabled);

bool activate();

bool activateAction(string name, glib.variant.VariantG args);

void activateDefault();

void addController(gtk.event_controller.EventController controller);

void addCssClass(string cssClass);

void addMnemonicLabel(gtk.widget.Widget label);

uint addTickCallback(gtk.types.TickCallback callback);

void allocate(int width, int height, int baseline, gsk.transform.Transform transform);

bool childFocus(gtk.types.DirectionType direction);

bool computeBounds(gtk.widget.Widget target, graphene.rect.Rect outBounds);

bool computeExpand(gtk.types.Orientation orientation);

bool computePoint(gtk.widget.Widget target, graphene.point.Point point, graphene.point.Point outPoint);

bool computeTransform(gtk.widget.Widget target, graphene.matrix.Matrix outTransform);

bool contains(double x, double y);

pango.context.Context createPangoContext();

pango.layout.Layout createPangoLayout(string text);

void disposeTemplate(gobject.types.GType widgetType);

bool dragCheckThreshold(int startX, int startY, int currentX, int currentY);

void errorBell();

int getAllocatedBaseline();

int getAllocatedHeight();

int getAllocatedWidth();

gtk.widget.Widget getAncestor(gobject.types.GType widgetType);

int getBaseline();

bool getCanFocus();

bool getCanTarget();

bool getChildVisible();

gdk.clipboard.Clipboard getClipboard();

void getColor(gdk.rgba.RGBA color);

string[] getCssClasses();

string getCssName();

gdk.cursor.Cursor getCursor();

gtk.types.TextDirection getDirection();

gdk.display.Display getDisplay();

gtk.widget.Widget getFirstChild();

gtk.widget.Widget getFocusChild();

bool getFocusOnClick();

bool getFocusable();

pango.font_map.FontMap getFontMap();

cairo.font_options.FontOptions getFontOptions();

gdk.frame_clock.FrameClock getFrameClock();

gtk.types.Align getHalign();

bool getHasTooltip();

int getHeight();

bool getHexpand();

bool getHexpandSet();

gtk.widget.Widget getLastChild();

gtk.layout_manager.LayoutManager getLayoutManager();

bool getMapped();

int getMarginBottom();

int getMarginEnd();

int getMarginStart();

int getMarginTop();

string getName();

gtk.native.Native getNative();

gtk.widget.Widget getNextSibling();

double getOpacity();

gtk.types.Overflow getOverflow();

pango.context.Context getPangoContext();

gtk.widget.Widget getParent();

void getPreferredSize(gtk.requisition.Requisition minimumSize, gtk.requisition.Requisition naturalSize);

gtk.widget.Widget getPrevSibling();

gdk.clipboard.Clipboard getPrimaryClipboard();

bool getRealized();

bool getReceivesDefault();

gtk.types.SizeRequestMode getRequestMode();

gtk.root.Root getRoot();

int getScaleFactor();

bool getSensitive();

gtk.settings.Settings getSettings();

int getSize(gtk.types.Orientation orientation);

void getSizeRequest(int width, int height);

gtk.types.StateFlags getStateFlags();

gtk.style_context.StyleContext getStyleContext();

gobject.object.ObjectG getTemplateChild(gobject.types.GType widgetType, string name);

string getTooltipMarkup();

string getTooltipText();

gtk.types.Align getValign();

bool getVexpand();

bool getVexpandSet();

bool getVisible();

int getWidth();

bool grabFocus();

bool hasCssClass(string cssClass);

bool hasDefault();

bool hasFocus();

bool hasVisibleFocus();

void hide();

bool inDestruction();

void initTemplate();

void insertActionGroup(string name, gio.action_group.ActionGroup group);

void insertAfter(gtk.widget.Widget parent, gtk.widget.Widget previousSibling);

void insertBefore(gtk.widget.Widget parent, gtk.widget.Widget nextSibling);

bool isAncestor(gtk.widget.Widget ancestor);

bool isDrawable();

bool isFocus();

bool isSensitive();

bool isVisible();

bool keynavFailed(gtk.types.DirectionType direction);

gtk.widget.Widget[] listMnemonicLabels();

void map();

void measure(gtk.types.Orientation orientation, int forSize, int minimum, int natural, int minimumBaseline, int naturalBaseline);

bool mnemonicActivate(bool groupCycling);

gio.list_model.ListModel observeChildren();

gio.list_model.ListModel observeControllers();

gtk.widget.Widget pick(double x, double y, gtk.types.PickFlags flags);

void queueAllocate();

void queueDraw();

void queueResize();

void realize();

void removeController(gtk.event_controller.EventController controller);

void removeCssClass(string cssClass);

void removeMnemonicLabel(gtk.widget.Widget label);

void removeTickCallback(uint id);

void setCanFocus(bool canFocus);

void setCanTarget(bool canTarget);

void setChildVisible(bool childVisible);

void setCssClasses(string[] classes);

void setCursor(gdk.cursor.Cursor cursor);

void setCursorFromName(string name);

void setDirection(gtk.types.TextDirection dir);

void setFocusChild(gtk.widget.Widget child);

void setFocusOnClick(bool focusOnClick);

void setFocusable(bool focusable);

void setFontMap(pango.font_map.FontMap fontMap);

void setFontOptions(cairo.font_options.FontOptions options);

void setHalign(gtk.types.Align align_);

void setHasTooltip(bool hasTooltip);

void setHexpand(bool expand);

void setHexpandSet(bool set);

void setLayoutManager(gtk.layout_manager.LayoutManager layoutManager);

void setMarginBottom(int margin);

void setMarginEnd(int margin);

void setMarginStart(int margin);

void setMarginTop(int margin);

void setName(string name);

void setOpacity(double opacity);

void setOverflow(gtk.types.Overflow overflow);

void setParent(gtk.widget.Widget parent);

void setReceivesDefault(bool receivesDefault);

void setSensitive(bool sensitive);

void setSizeRequest(int width, int height);

void setStateFlags(gtk.types.StateFlags flags, bool clear);

void setTooltipMarkup(string markup);

void setTooltipText(string text);

void setValign(gtk.types.Align align_);

void setVexpand(bool expand);

void setVexpandSet(bool set);

void setVisible(bool visible);

bool shouldLayout();

void show();

void snapshotChild(gtk.widget.Widget child, gtk.snapshot.Snapshot snapshot);

bool translateCoordinates(gtk.widget.Widget destWidget, double srcX, double srcY, double destX, double destY);

void triggerTooltipQuery();

void unmap();

void unparent();

void unrealize();

void unsetStateFlags(gtk.types.StateFlags flags);

ulong connectDestroy(T callback, Flag!"After" after);

ulong connectDirectionChanged(T callback, Flag!"After" after);

ulong connectHide(T callback, Flag!"After" after);

ulong connectKeynavFailed(T callback, Flag!"After" after);

ulong connectMap(T callback, Flag!"After" after);

ulong connectMnemonicActivate(T callback, Flag!"After" after);

ulong connectMoveFocus(T callback, Flag!"After" after);

ulong connectQueryTooltip(T callback, Flag!"After" after);

ulong connectRealize(T callback, Flag!"After" after);

ulong connectShow(T callback, Flag!"After" after);

ulong connectStateFlagsChanged(T callback, Flag!"After" after);

ulong connectUnmap(T callback, Flag!"After" after);

ulong connectUnrealize(T callback, Flag!"After" after);

}

Members

Functions

actionSetEnabled void actionSetEnabled(string actionName, bool enabled): Enable or disable an action installed with gtk.widget_class.WidgetClass.installAction.
activate bool activate(): For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
activateAction bool activateAction(string name, glib.variant.VariantG args): Looks up the action in the action groups associated with widget and its ancestors, and activates it.
activateDefault void activateDefault(): Activates the default.activate action from widget.
addController void addController(gtk.event_controller.EventController controller): Adds controller to widget so that it will receive events.
addCssClass void addCssClass(string cssClass): Adds a style class to widget.
addMnemonicLabel void addMnemonicLabel(gtk.widget.Widget label): Adds a widget to the list of mnemonic labels for this widget.
addTickCallback uint addTickCallback(gtk.types.TickCallback callback): Queues an animation frame update and adds a callback to be called before each frame.
allocate void allocate(int width, int height, int baseline, gsk.transform.Transform transform): This function is only used by gtk.widget.Widget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
childFocus bool childFocus(gtk.types.DirectionType direction): Called by widgets as the user moves around the window using keyboard shortcuts.
computeBounds bool computeBounds(gtk.widget.Widget target, graphene.rect.Rect outBounds): Computes the bounds for widget in the coordinate space of target.
computeExpand bool computeExpand(gtk.types.Orientation orientation): Computes whether a container should give this widget extra space when possible.
computePoint bool computePoint(gtk.widget.Widget target, graphene.point.Point point, graphene.point.Point outPoint): Translates the given point in widget's coordinates to coordinates relative to target’s coordinate system.
computeTransform bool computeTransform(gtk.widget.Widget target, graphene.matrix.Matrix outTransform): Computes a matrix suitable to describe a transformation from widget's coordinate system into target's coordinate system.
connectDestroy ulong connectDestroy(T callback, Flag!"After" after): Connect to Destroy signal.
connectDirectionChanged ulong connectDirectionChanged(T callback, Flag!"After" after): Connect to DirectionChanged signal.
connectHide ulong connectHide(T callback, Flag!"After" after): Connect to Hide signal.
connectKeynavFailed ulong connectKeynavFailed(T callback, Flag!"After" after): Connect to KeynavFailed signal.
connectMap ulong connectMap(T callback, Flag!"After" after): Connect to Map signal.
connectMnemonicActivate ulong connectMnemonicActivate(T callback, Flag!"After" after): Connect to MnemonicActivate signal.
connectMoveFocus ulong connectMoveFocus(T callback, Flag!"After" after): Connect to MoveFocus signal.
connectQueryTooltip ulong connectQueryTooltip(T callback, Flag!"After" after): Connect to QueryTooltip signal.
connectRealize ulong connectRealize(T callback, Flag!"After" after): Connect to Realize signal.
connectShow ulong connectShow(T callback, Flag!"After" after): Connect to Show signal.
connectStateFlagsChanged ulong connectStateFlagsChanged(T callback, Flag!"After" after): Connect to StateFlagsChanged signal.
connectUnmap ulong connectUnmap(T callback, Flag!"After" after): Connect to Unmap signal.
connectUnrealize ulong connectUnrealize(T callback, Flag!"After" after): Connect to Unrealize signal.
contains bool contains(double x, double y): Tests if the point at (x, y) is contained in widget.
createPangoContext pango.context.Context createPangoContext(): Creates a new pango.context.Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
createPangoLayout pango.layout.Layout createPangoLayout(string text): Creates a new pango.layout.Layout with the appropriate font map, font description, and base direction for drawing text for this widget.
disposeTemplate void disposeTemplate(gobject.types.GType widgetType): Clears the template children for the given widget.
dragCheckThreshold bool dragCheckThreshold(int startX, int startY, int currentX, int currentY): Checks to see if a drag movement has passed the GTK drag threshold.
errorBell void errorBell(): Notifies the user about an input-related error on this widget.
getAllocatedBaseline int getAllocatedBaseline(): Returns the baseline that has currently been allocated to widget.
getAllocatedHeight int getAllocatedHeight(): Returns the height that has currently been allocated to widget.
getAllocatedWidth int getAllocatedWidth(): Returns the width that has currently been allocated to widget.
getAncestor gtk.widget.Widget getAncestor(gobject.types.GType widgetType): Gets the first ancestor of widget with type widget_type.
getBaseline int getBaseline(): Returns the baseline that has currently been allocated to widget.
getCanFocus bool getCanFocus(): Determines whether the input focus can enter widget or any of its children.
getCanTarget bool getCanTarget(): Queries whether widget can be the target of pointer events.
getChildVisible bool getChildVisible(): Gets the value set with gtk.widget.Widget.setChildVisible.
getClipboard gdk.clipboard.Clipboard getClipboard(): Gets the clipboard object for widget.
getColor void getColor(gdk.rgba.RGBA color): Gets the current foreground color for the widget’s CSS style.
getCssClasses string[] getCssClasses(): Returns the list of style classes applied to widget.
getCssName string getCssName(): Returns the CSS name that is used for self.
getCursor gdk.cursor.Cursor getCursor(): Queries the cursor set on widget.
getDirection gtk.types.TextDirection getDirection(): Gets the reading direction for a particular widget.
getDisplay gdk.display.Display getDisplay(): Get the gdk.display.Display for the toplevel window associated with this widget.
getFirstChild gtk.widget.Widget getFirstChild(): Returns the widget’s first child.
getFocusChild gtk.widget.Widget getFocusChild(): Returns the current focus child of widget.
getFocusOnClick bool getFocusOnClick(): Returns whether the widget should grab focus when it is clicked with the mouse.
getFocusable bool getFocusable(): Determines whether widget can own the input focus.
getFontMap pango.font_map.FontMap getFontMap(): Gets the font map of widget.
getFontOptions cairo.font_options.FontOptions getFontOptions(): Returns the cairo.font_options.FontOptions of widget.
getFrameClock gdk.frame_clock.FrameClock getFrameClock(): Obtains the frame clock for a widget.
getHalign gtk.types.Align getHalign(): Gets the horizontal alignment of widget.
getHasTooltip bool getHasTooltip(): Returns the current value of the has-tooltip property.
getHeight int getHeight(): Returns the content height of the widget.
getHexpand bool getHexpand(): Gets whether the widget would like any available extra horizontal space.
getHexpandSet bool getHexpandSet(): Gets whether gtk.widget.Widget.setHexpand has been used to explicitly set the expand flag on this widget.
getLastChild gtk.widget.Widget getLastChild(): Returns the widget’s last child.
getLayoutManager gtk.layout_manager.LayoutManager getLayoutManager(): Retrieves the layout manager used by widget.
getMapped bool getMapped(): Whether the widget is mapped.
getMarginBottom int getMarginBottom(): Gets the bottom margin of widget.
getMarginEnd int getMarginEnd(): Gets the end margin of widget.
getMarginStart int getMarginStart(): Gets the start margin of widget.
getMarginTop int getMarginTop(): Gets the top margin of widget.
getName string getName(): Retrieves the name of a widget.
getNative gtk.native.Native getNative(): Returns the nearest gtk.native.Native ancestor of widget.
getNextSibling gtk.widget.Widget getNextSibling(): Returns the widget’s next sibling.
getOpacity double getOpacity(): #Fetches the requested opacity for this widget.
getOverflow gtk.types.Overflow getOverflow(): Returns the widget’s overflow value.
getPangoContext pango.context.Context getPangoContext(): Gets a pango.context.Context with the appropriate font map, font description, and base direction for this widget.
getParent gtk.widget.Widget getParent(): Returns the parent widget of widget.
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.
getPrevSibling gtk.widget.Widget getPrevSibling(): Returns the widget’s previous sibling.
getPrimaryClipboard gdk.clipboard.Clipboard getPrimaryClipboard(): Gets the primary clipboard of widget.
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.
getRoot gtk.root.Root getRoot(): Returns the gtk.root.Root widget of widget.
getScaleFactor int getScaleFactor(): Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
getSensitive bool getSensitive(): Returns the widget’s sensitivity.
getSettings gtk.settings.Settings getSettings(): Gets the settings object holding the settings used for this widget.
getSize int getSize(gtk.types.Orientation orientation): Returns the content width or height of the widget.
getSizeRequest void getSizeRequest(int width, int height): Gets the size request that was explicitly set for the widget using gtk.widget.Widget.setSizeRequest.
getStateFlags gtk.types.StateFlags getStateFlags(): Returns the widget state as a flag set.
getStyleContext gtk.style_context.StyleContext getStyleContext(): Returns the style context associated to widget.
getTemplateChild gobject.object.ObjectG 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.
getValign gtk.types.Align getValign(): Gets the vertical alignment of widget.
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.
getWidth int getWidth(): Returns the content width of the widget.
grabFocus bool grabFocus(): Causes widget to have the keyboard focus for the gtk.window.Window it's inside.
hasCssClass bool hasCssClass(string cssClass): Returns whether css_class is currently applied to widget.
hasDefault bool hasDefault(): Determines whether widget is the current default widget within its toplevel.
hasFocus bool hasFocus(): Determines if the widget has the global input focus.
hasVisibleFocus bool hasVisibleFocus(): Determines if the widget should show a visible indication that it has the global input focus.
hide void hide(): Reverses the effects of gtk.widget.Widget.show.
inDestruction bool inDestruction(): Returns whether the widget is currently being destroyed.
initTemplate void initTemplate(): Creates and initializes child widgets defined in templates.
insertActionGroup void insertActionGroup(string name, gio.action_group.ActionGroup group): Inserts group into widget.
insertAfter void insertAfter(gtk.widget.Widget parent, gtk.widget.Widget previousSibling): Inserts widget into the child widget list of parent.
insertBefore void insertBefore(gtk.widget.Widget parent, gtk.widget.Widget nextSibling): Inserts widget into the child widget list of parent.
isAncestor bool isAncestor(gtk.widget.Widget ancestor): Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.
isDrawable bool isDrawable(): Determines whether widget can be drawn to.
isFocus bool isFocus(): Determines if the widget is the focus widget within its toplevel.
isSensitive bool isSensitive(): Returns the widget’s effective sensitivity.
isVisible bool isVisible(): Determines whether the widget and all its parents are marked as visible.
keynavFailed bool keynavFailed(gtk.types.DirectionType direction): Emits the ::keynav-failed signal on the widget.
listMnemonicLabels gtk.widget.Widget[] listMnemonicLabels(): Returns the widgets for which this widget is the target of a mnemonic.
map void map(): Causes a widget to be mapped if it isn’t already.
measure void measure(gtk.types.Orientation orientation, int forSize, int minimum, int natural, int minimumBaseline, int naturalBaseline): Measures widget in the orientation orientation and for the given for_size.
mnemonicActivate bool mnemonicActivate(bool groupCycling): Emits the ::mnemonic-activate signal.
observeChildren gio.list_model.ListModel observeChildren(): Returns a gio.list_model.ListModel to track the children of widget.
observeControllers gio.list_model.ListModel observeControllers(): Returns a gio.list_model.ListModel to track the gtk.event_controller.EventControllers of widget.
pick gtk.widget.Widget pick(double x, double y, gtk.types.PickFlags flags): Finds the descendant of widget closest to the point (x, y).
queueAllocate void queueAllocate(): Flags the widget for a rerun of the vfuncGtk.Widget.size_allocate function.
queueDraw void queueDraw(): Schedules this widget to be redrawn in the paint phase of the current or the next frame.
queueResize void queueResize(): Flags a widget to have its size renegotiated.
realize void realize(): Creates the GDK resources associated with a widget.
removeController void removeController(gtk.event_controller.EventController controller): Removes controller from widget, so that it doesn't process events anymore.
removeCssClass void removeCssClass(string cssClass): Removes a style from widget.
removeMnemonicLabel void removeMnemonicLabel(gtk.widget.Widget label): Removes a widget from the list of mnemonic labels for this widget.
removeTickCallback void removeTickCallback(uint id): Removes a tick callback previously registered with gtk.widget.Widget.addTickCallback.
setCanFocus void setCanFocus(bool canFocus): Specifies whether the input focus can enter the widget or any of its children.
setCanTarget void setCanTarget(bool canTarget): Sets whether widget can be the target of pointer events.
setChildVisible void setChildVisible(bool childVisible): Sets whether widget should be mapped along with its parent.
setCssClasses void setCssClasses(string[] classes): Clear all style classes applied to widget and replace them with classes.
setCursor void setCursor(gdk.cursor.Cursor cursor): Sets the cursor to be shown when pointer devices point towards widget.
setCursorFromName void setCursorFromName(string name): Sets a named cursor to be shown when pointer devices point towards widget.
setDirection void setDirection(gtk.types.TextDirection dir): Sets the reading direction on a particular widget.
setFocusChild void setFocusChild(gtk.widget.Widget child): Set child as the current focus child of widget.
setFocusOnClick void setFocusOnClick(bool focusOnClick): Sets whether the widget should grab focus when it is clicked with the mouse.
setFocusable void setFocusable(bool focusable): Specifies whether widget can own the input focus.
setFontMap void setFontMap(pango.font_map.FontMap fontMap): Sets the font map to use for Pango rendering.
setFontOptions void setFontOptions(cairo.font_options.FontOptions options): Sets the cairo.font_options.FontOptions used for Pango rendering in this widget.
setHalign void setHalign(gtk.types.Align align_): Sets the horizontal alignment of widget.
setHasTooltip void setHasTooltip(bool hasTooltip): Sets the has-tooltip property on widget to has_tooltip.
setHexpand void setHexpand(bool expand): Sets whether the widget would like any available extra horizontal space.
setHexpandSet void setHexpandSet(bool set): Sets whether the hexpand flag will be used.
setLayoutManager void setLayoutManager(gtk.layout_manager.LayoutManager layoutManager): Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget.
setMarginBottom void setMarginBottom(int margin): Sets the bottom margin of widget.
setMarginEnd void setMarginEnd(int margin): Sets the end margin of widget.
setMarginStart void setMarginStart(int margin): Sets the start margin of widget.
setMarginTop void setMarginTop(int margin): Sets the top margin of widget.
setName void setName(string name): Sets a widgets name.
setOpacity void setOpacity(double opacity): Request the widget to be rendered partially transparent.
setOverflow void setOverflow(gtk.types.Overflow overflow): Sets how widget treats content that is drawn outside the widget's content area.
setParent void setParent(gtk.widget.Widget parent): Sets parent as the parent widget of widget.
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.
setSensitive void setSensitive(bool sensitive): Sets the sensitivity of a widget.
setSizeRequest void setSizeRequest(int width, int height): Sets the minimum size of a widget.
setStateFlags void setStateFlags(gtk.types.StateFlags flags, bool clear): Turns on flag values in the current widget state.
setTooltipMarkup void setTooltipMarkup(string markup): Sets markup as the contents of the tooltip, which is marked up with Pango markup.
setTooltipText void setTooltipText(string text): Sets text as the contents of the tooltip.
setValign void setValign(gtk.types.Align align_): Sets the vertical alignment of widget.
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 will be used.
setVisible void setVisible(bool visible): Sets the visibility state of widget.
shouldLayout bool shouldLayout(): Returns whether widget should contribute to the measuring and allocation of its parent.
show void show(): Flags a widget to be displayed.
snapshotChild void snapshotChild(gtk.widget.Widget child, gtk.snapshot.Snapshot snapshot): Snapshot the a child of widget.
translateCoordinates bool translateCoordinates(gtk.widget.Widget destWidget, double srcX, double srcY, double destX, double destY): Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations.
triggerTooltipQuery void triggerTooltipQuery(): Triggers a tooltip query on the display where the toplevel of widget is located.
unmap void unmap(): Causes a widget to be unmapped if it’s currently mapped.
unparent void unparent(): Dissociate widget from its parent.
unrealize void unrealize(): Causes a widget to be unrealized (frees all GDK resources associated with the widget).
unsetStateFlags void unsetStateFlags(gtk.types.StateFlags flags): Turns off flag values for the current widget state.

Static functions

getDefaultDirection gtk.types.TextDirection getDefaultDirection(): Obtains the current default reading direction.
setDefaultDirection void setDefaultDirection(gtk.types.TextDirection dir): Sets the default reading direction for widgets.

Mixed In Members

From `mixin AccessibleT!()`

announce void announce(string message, gtk.types.AccessibleAnnouncementPriority priority): Requests the user's screen reader to announce the given message.
getAccessibleParent gtk.accessible.Accessible getAccessibleParent(): Retrieves the accessible parent for an accessible object.
getAccessibleRole gtk.types.AccessibleRole getAccessibleRole(): Retrieves the accessible role of an accessible object.
getAtContext gtk.atcontext.ATContext getAtContext(): Retrieves the accessible implementation for the given gtk.accessible.Accessible.
getBounds bool getBounds(int x, int y, int width, int height): Queries the coordinates and dimensions of this accessible
getFirstAccessibleChild gtk.accessible.Accessible getFirstAccessibleChild(): Retrieves the first accessible child of an accessible object.
getNextAccessibleSibling gtk.accessible.Accessible getNextAccessibleSibling(): Retrieves the next accessible sibling of an accessible object
getPlatformState bool getPlatformState(gtk.types.AccessiblePlatformState state): Query a platform state, such as focus.
resetProperty void resetProperty(gtk.types.AccessibleProperty property): Resets the accessible property to its default value.
resetRelation void resetRelation(gtk.types.AccessibleRelation relation): Resets the accessible relation to its default value.
resetState void resetState(gtk.types.AccessibleState state): Resets the accessible state to its default value.
setAccessibleParent void setAccessibleParent(gtk.accessible.Accessible parent, gtk.accessible.Accessible nextSibling): Sets the parent and sibling of an accessible object.
updateNextAccessibleSibling void updateNextAccessibleSibling(gtk.accessible.Accessible newSibling): Updates the next accessible sibling of self.
updateProperty void updateProperty(gtk.types.AccessibleProperty[] properties, gobject.value.Value[] values): Updates an array of accessible properties.
updateRelation void updateRelation(gtk.types.AccessibleRelation[] relations, gobject.value.Value[] values): Updates an array of accessible relations.
updateState void updateState(gtk.types.AccessibleState[] states, gobject.value.Value[] values): Updates an array of accessible states.

From `mixin BuildableT!()`

getBuildableId string getBuildableId(): Gets the ID of the buildable object.

Inherited Members

From Accessible

announce void announce(string message, gtk.types.AccessibleAnnouncementPriority priority): Requests the user's screen reader to announce the given message.
getAccessibleParent gtk.accessible.Accessible getAccessibleParent(): Retrieves the accessible parent for an accessible object.
getAccessibleRole gtk.types.AccessibleRole getAccessibleRole(): Retrieves the accessible role of an accessible object.
getAtContext gtk.atcontext.ATContext getAtContext(): Retrieves the accessible implementation for the given gtk.accessible.Accessible.
getBounds bool getBounds(int x, int y, int width, int height): Queries the coordinates and dimensions of this accessible
getFirstAccessibleChild gtk.accessible.Accessible getFirstAccessibleChild(): Retrieves the first accessible child of an accessible object.
getNextAccessibleSibling gtk.accessible.Accessible getNextAccessibleSibling(): Retrieves the next accessible sibling of an accessible object
getPlatformState bool getPlatformState(gtk.types.AccessiblePlatformState state): Query a platform state, such as focus.
resetProperty void resetProperty(gtk.types.AccessibleProperty property): Resets the accessible property to its default value.
resetRelation void resetRelation(gtk.types.AccessibleRelation relation): Resets the accessible relation to its default value.
resetState void resetState(gtk.types.AccessibleState state): Resets the accessible state to its default value.
setAccessibleParent void setAccessibleParent(gtk.accessible.Accessible parent, gtk.accessible.Accessible nextSibling): Sets the parent and sibling of an accessible object.
updateNextAccessibleSibling void updateNextAccessibleSibling(gtk.accessible.Accessible newSibling): Updates the next accessible sibling of self.
updateProperty void updateProperty(gtk.types.AccessibleProperty[] properties, gobject.value.Value[] values): Updates an array of accessible properties.
updateRelation void updateRelation(gtk.types.AccessibleRelation[] relations, gobject.value.Value[] values): Updates an array of accessible relations.
updateState void updateState(gtk.types.AccessibleState[] states, gobject.value.Value[] values): Updates an array of accessible states.

From Buildable

getBuildableId string getBuildableId(): Gets the ID of the buildable object.

gtk widget classes

Widget