gtk.Widget



class Widget : gobject.ObjectG.ObjectG, atk.ImplementorIF.ImplementorIF, gtk.BuildableIF.BuildableIF;
GtkWidget is the base class all widgets in GTK+ derive from. It manages the widget lifecycle, states and style.

# Height-for-width Geometry Management # {#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 five virtual methods:

- #GtkWidgetClass.get_request_mode() - #GtkWidgetClass.get_preferred_width() - #GtkWidgetClass.get_preferred_height() - #GtkWidgetClass.get_preferred_height_for_width() - #GtkWidgetClass.get_preferred_width_for_height() - #GtkWidgetClass.get_preferred_height_and_baseline_for_width()

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

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 #GtkSizeRequestMode chosen by the toplevel.

For example, when queried in the normal %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH mode: First, the default minimum and natural width for each widget in the interface will be computed using gtk_widget_get_preferred_width(). Because the preferred widths for each container 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_get_preferred_height_for_width(), which 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 (unless gtk_window_set_geometry_hints() is explicitly used instead).

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_set_default_size()). During the recursive allocation process it’s important to note that request cycles will be recursively executed while container widgets allocate their children. Each container 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 #GtkWidget 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, #GtkWidget caches a small number of results to avoid re-querying for the same sizes in one allocation cycle.

See [GtkContainer’s geometry management section][container-geometry-management] to learn more about how height-for-width allocations are performed by container widgets.

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

For instance, a #GtkLabel that does height-for-width word wrapping will not expect to have #GtkWidgetClass.get_preferred_height() 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_SIZE_REQUEST_HEIGHT_FOR_WIDTH widget generally deals with width-for-height requests, for #GtkWidgetClass.get_preferred_height() it will do:

|[ static void foo_widget_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height) { if (i_am_in_height_for_width_mode) { gint min_width, nat_width;

GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, &nat_width); GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, min_height, nat_height); } else { ... some widgets do both. For instance, if a GtkLabel is rotated to 90 degrees it will return the minimum and natural height for the rotated label here. } } ]|

And in #GtkWidgetClass.get_preferred_width_for_height() it will simply return the minimum and natural width: |[ static void foo_widget_get_preferred_width_for_height (GtkWidget *widget, gint for_height, gint *min_width, gint *nat_width) { if (i_am_in_height_for_width_mode) { GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width); } else { ... again if a widget is sometimes operating in width-for-height mode (like a rotated GtkLabel) it can go ahead and do its real width for height calculation here. } } ]|

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 this:

|[ GTK_WIDGET_GET_CLASS(widget)->get_preferred_width (widget, &min, &natural); ]|

It will not work to use the wrapper functions, such as gtk_widget_get_preferred_width() inside your own size request implementation. These return a request adjusted by #GtkSizeGroup and by the #GtkWidgetClass.adjust_size_request() virtual method. 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 of a container, you must use the wrapper APIs. Otherwise, you would not properly consider widget margins, #GtkSizeGroup, and so forth.

Since 3.10 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 of %GTK_ALIGN_BASELINE, and is inside a container 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 done by the #GtkWidgetClass.get_preferred_height_and_baseline_for_width() virtual function. It allows you to report a baseline in combination with the minimum and natural height. If there is no baseline you can return -1 to indicate this. The default implementation of this virtual function calls into the #GtkWidgetClass.get_preferred_height() and #GtkWidgetClass.get_preferred_height_for_width(), so if baselines are not supported it doesn’t need to be implemented.

If a widget ends up baseline aligned it will be allocated all the space in the parent as if it was %GTK_ALIGN_FILL, but the selected baseline can be found via gtk_widget_get_allocated_baseline(). If this has a value other than -1 you need to align the widget such that the baseline appears at the position.

# Style Properties

#GtkWidget introduces “style properties” - these are basically object properties that are stored not on the object, but in the style object associated to the widget. Style properties are set in [resource files][gtk3-Resource-Files]. This mechanism is used for configuring such things as the location of the scrollbar arrows through the theme, giving theme authors more control over the look of applications without the need to write a theme engine in C.

Use gtk_widget_class_install_style_property() to install style properties for a widget class, gtk_widget_class_find_style_property() or gtk_widget_class_list_style_properties() to get information about existing style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or gtk_widget_style_get_valist() to obtain the value of a style property.

# GtkWidget as GtkBuildable

The GtkWidget implementation of the GtkBuildable interface supports a custom element, which has attributes named ”key”, ”modifiers” and ”signal” and allows to specify accelerators.

An example of a UI definition fragment specifying an accelerator: |[ <object class="GtkButton"> </object> ]|

In addition to accelerators, GtkWidget also support a custom element, which supports actions and relations. Properties on the accessible implementation of an object can be set by accessing the internal child “accessible” of a #GtkWidget.

An example of a UI definition fragment specifying an accessible: |[ <object class="GtkButton" id="label1"/> I am a Label for a Button </object> <object class="GtkButton" id="button1"> Click the button. <object class="AtkObject" id="a11y-button1"> Clickable Button </object> </object> ]|

Finally, GtkWidget allows style information such as style classes to be associated with widgets, using the custom </object> ]|

# Building composite widgets from template XML

GtkWidget exposes some facilities to automate the proceedure of creating composite widgets using #GtkBuilder interface description language.

To create composite widgets with #GtkBuilder XML, one must associate the interface description with the widget class at class initialization time using gtk_widget_class_set_template().

The interface description semantics expected in composite template descriptions is slightly different from regulare #GtkBuilder XML.

Unlike regular interface descriptions, gtk_widget_class_set_template() 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 the GtkBuilder but required for Glade 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 @widget itself. You may set properties on @widget by inserting tags into the <template> tag, and also add tags to add children and extend @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 auxilary objects which might be referenced by other widgets declared as children of the <template> tag.

An example of a GtkBuilder Template Definition: |[ <interface> <template class="FooWidget" parent="GtkBox"> GTK_ORIENTATION_HORIZONTAL 4 <object class="GtkButton" id="hello_button"> Hello World </object> <object class="GtkButton" id="goodbye_button"> Goodbye World </object> </template> </interface> ]|

Typically, you'll place the template fragment into a file that is bundled with your project, using #GResource. In order to load the template, you need to call gtk_widget_class_set_template_from_resource() from the class initialization of your #GtkWidget 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_init_template() from the instance initialization function:

|[ static void foo_widget_init (FooWidget *self) { // ... gtk_widget_init_template (GTK_WIDGET (self)); } ]|

You can access widgets defined in the template using the gtk_widget_get_template_child() 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_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_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_child_private (GTK_WIDGET_CLASS (klass), FooWidget, hello_button); gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass), FooWidget, goodbye_button); } ]|

You can also use 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); } ]|

protected GtkWidget* gtkWidget ;
the main Gtk struct

GtkWidget* getWidgetStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkWidget* gtkWidget, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

int getWidth ();


int getHeight ();


void setCursor (Cursor cursor);
Sets the cursor.

Params:
Cursor cursor the new cursor

BUGS:
the cursor changes to the parent widget also

void resetCursor ();
Resets the cursor. don't know if this is implemented by GTK+. Seems that it's not

BUGS:
does nothing

void modifyFont (string family, int size);
Modifies the font for this widget. This just calls modifyFont (new PgFontDescription(PgFontDescription.fromString(family ~ " " ~ size)));

bool onEvent (GdkEvent* event);


bool onButtonPressEvent (GdkEventButton* event);


bool onButtonReleaseEvent (GdkEventButton* event);


bool onScrollEvent (GdkEventScroll* event);


bool onMotionNotifyEvent (GdkEventMotion* event);


bool onDeleteEvent (GdkEventAny* event);


bool onDestroyEvent (GdkEventAny* event);


bool onKeyPressEvent (GdkEventKey* event);


bool onKeyReleaseEvent (GdkEventKey* event);


bool onEnterNotifyEvent (GdkEventCrossing* event);


bool onLeaveNotifyEvent (GdkEventCrossing* event);


bool onConfigureEvent (GdkEventConfigure* event);


bool onFocusInEvent (GdkEventFocus* event);


bool onFocusOutEvent (GdkEventFocus* event);


bool onMapEvent (GdkEventAny* event);


bool onUnmapEvent (GdkEventAny* event);


bool onPropertyNotifyEvent (GdkEventProperty* event);


bool onSelectionClearEvent (GdkEventSelection* event);


bool onSelectionRequestEvent (GdkEventSelection* event);


bool onSelectionNotifyEvent (GdkEventSelection* event);


bool onProximityInEvent (GdkEventProximity* event);


bool onProximityOutEvent (GdkEventProximity* event);


bool onVisibilityNotifyEvent (GdkEventVisibility* event);


bool onWindowStateEvent (GdkEventWindowState* event);


bool onDamageEvent (GdkEventExpose* event);


bool onGrabBrokenEvent (GdkEventGrabBroken* event);


void addTickCallback (bool delegate(Widget, FrameClock) 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 gtk.Label), then you will have to call queueResize() or queuDrawArea() yourself.

gdk.FrameClock.FrameClock.getFrameTime() should generally be used for timing continuous animations and gdk.FrameTimings.FrameTimings.getPredictedPresentationPime() if you are trying to display isolated frames at particular times.

This is a more convenient alternative to connecting directly to the "update" signal of GdkFrameClock, since you don't have to worry about when a GdkFrameClock is assigned to a widget.

Params:
bool delegate(Widget, FrameClock) callback function to call for updating animations

void addOnDraw (bool delegate(Scoped!Context, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
This signal is emitted when a widget is supposed to render itself. The widget's top left corner must be painted at the origin of the passed in context and be sized to the values returned by getAllocatedWidth() and getAllocatedHeight().

Signal handlers connected to this signal can modify the cairo context passed as cr in any way they like and don't need to restore it. The signal emission takes care of calling Context.save() before and Context.restore() after invoking the handler.

The signal handler will get a cr with a clip region already set to the widget's dirty region, i.e. to the area that needs repainting. Complicated widgets that want to avoid redrawing themselves completely can get the full extents of the clip region with gdk.cairo.getClipRectangle(), or they can get a finer-grained representation of the dirty region with Context.copyClipRectangleList().

Return true to stop other handlers from being invoked for the event, false to propagate the event further.

Since 3.0

deprecated void addOnDraw (bool delegate(Context, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
This signal is emitted when a widget is supposed to render itself. The @widget's top left corner must be painted at the origin of the passed in context and be sized to the values returned by gtk_widget_get_allocated_width() and gtk_widget_get_allocated_height().

Signal handlers connected to this signal can modify the cairo context passed as @cr in any way they like and don't need to restore it. The signal emission takes care of calling cairo_save() before and cairo_restore() after invoking the handler.

The signal handler will get a @cr with a clip region already set to the widget's dirty region, i.e. to the area that needs repainting. Complicated widgets that want to avoid redrawing themselves completely can get the full extents of the clip region with gdk_cairo_get_clip_rectangle(), or they can get a finer-grained representation of the dirty region with cairo_copy_clip_rectangle_list().

Params:
cr the cairo context to draw to

Return:
%TRUE to stop other handlers from being invoked for the event. % %FALSE to propagate the event further.

Since:
3.0

void destroy ();
Destroys a widget.

When a widget is destroyed, it will break any references it holds to other objects. If the widget is inside a container, the widget will be removed from the container. If the widget is a toplevel (derived from #GtkWindow), it will be removed from the list of toplevels, and the reference GTK+ holds to it will be removed. Removing a widget from its container or the list of toplevels results in the widget being finalized, unless you’ve added additional references to the widget with ref().

In most cases, only toplevel widgets (windows) require explicit destruction, because when you destroy a toplevel its children will be destroyed as well.

static GType getType ();


static GtkTextDirection getDefaultDirection ();
Obtains the current default reading direction. See gtk_widget_set_default_direction().

Return:
the current default direction.

static Style getDefaultStyle ();
Returns the default style used by all widgets initially.

Deprecated:
Use #GtkStyleContext instead, and gtk_css_provider_get_default() to obtain a #GtkStyleProvider with the default widget style information.

Return:
the default style. This #GtkStyle object is owned by GTK+ and should not be modified or freed.

static void popCompositeChild ();
Cancels the effect of a previous call to gtk_widget_push_composite_child().

Deprecated:
Use gtk_widget_class_set_template(), or don’t use this API at all.

static void pushCompositeChild ();
Makes all newly-created widgets as composite children until the corresponding gtk_widget_pop_composite_child() call.

A composite child is a child that’s an implementation detail of the container it’s inside and should not be visible to people using the container. Composite children aren’t treated differently by GTK (but see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI builders might want to treat them in a different way.

Deprecated:
This API never really worked well and was mostly unused, now we have a more complete mechanism for composite children, see gtk_widget_class_set_template().

static void setDefaultDirection (GtkTextDirection dir);
Sets the default reading direction for widgets where the direction has not been explicitly set by gtk_widget_set_direction().

Params:
GtkTextDirection dir the new default direction. This cannot be %GTK_TEXT_DIR_NONE.

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.

Return:
%TRUE if the widget was activatable

void addAccelerator (string accelSignal, AccelGroup accelGroup, uint accelKey, GdkModifierType accelMods, GtkAccelFlags 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_add_accel_group(), 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_add_entry() and gtk_widget_set_accel_path() or gtk_menu_item_set_accel_path() instead.

Params:
string accelSignal widget signal to emit on accelerator activation
AccelGroup accelGroup accel group for this widget, added to its toplevel
uint accelKey GDK keyval of the accelerator
GdkModifierType accelMods modifier key combination of the accelerator
GtkAccelFlags accelFlags flag accelerators, e.g. %GTK_ACCEL_VISIBLE

void addDeviceEvents (Device device, GdkEventMask events);
Adds the device events in the bitfield @events to the event mask for @widget. See gtk_widget_set_device_events() for details.

Params:
Device device a #GdkDevice
GdkEventMask events an event mask, see #GdkEventMask

Since:
3.0

void addEvents (int events);
Adds the events in the bitfield @events to the event mask for @widget. See gtk_widget_set_events() for details.

Params:
int events an event mask, see #GdkEventMask

void addMnemonicLabel (Widget label);
Adds a widget to the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). 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.

Params:
Widget label a #GtkWidget that acts as a mnemonic label for @widget

Since:
2.4

uint addTickCallback (GtkTickCallback callback, void* userData, GDestroyNotify notify);
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_queue_resize() or gtk_widget_queue_draw_area() yourself.

gdk_frame_clock_get_frame_time() should generally be used for timing continuous animations and gdk_frame_timings_get_predicted_presentation_time() if you are trying to display isolated frames at particular times.

This is a more convenient alternative to connecting directly to the #GdkFrameClock::update signal of #GdkFrameClock, since you don't have to worry about when a #GdkFrameClock is assigned to a widget.

Params:
GtkTickCallback callback function to call for updating animations
void* userData data to pass to @callback
GDestroyNotify notify function to call to free @user_data when the callback is removed.

Return:
an id for the connection of this callback. Remove the callback by passing it to gtk_widget_remove_tick_callback()

Since:
3.8

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.

Params:
uint signalId the ID of a signal installed on @widget

Return:
%TRUE if the accelerator can be activated.

Since:
2.4

bool childFocus (GtkDirectionType direction);
This function is used by custom widget implementations; if you're writing an app, you’d use gtk_widget_grab_focus() to move the focus to a particular widget, and gtk_container_set_focus_chain() to change the focus tab order. So you may want to investigate those functions instead.

gtk_widget_child_focus() is called by containers as the user moves around the window using keyboard shortcuts. @direction indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). gtk_widget_child_focus() emits the #GtkWidget::focus signal; widgets override the default handler for this signal in order to implement appropriate focus behavior.

The default ::focus handler for a widget should return %TRUE if moving in @direction left the focus on a focusable location inside that widget, and %FALSE if moving in @direction moved the focus outside the widget. If returning %TRUE, widgets normally call gtk_widget_grab_focus() to place the focus accordingly; if returning %FALSE, they don’t modify the current focus location.

Params:
GtkDirectionType direction direction of focus movement

Return:
%TRUE if focus ended up inside @widget

void childNotify (string childProperty);
Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on @widget.

This is the analogue of g_object_notify() for child properties.

Also see gtk_container_child_notify().

Params:
string childProperty the name of a child property installed on the class of @widget’s parent

void classPath (out uint pathLength, out string path, out string pathReversed);
Same as gtk_widget_path(), but always uses the name of a widget’s type, never uses a custom name set with gtk_widget_set_name().

Deprecated:
Use gtk_widget_get_path() instead

Params:
uint pathLength location to store the length of the class path, or %NULL
string path location to store the class path as an allocated string, or %NULL
string pathReversed location to store the reverse class path as an allocated string, or %NULL

bool computeExpand (GtkOrientation orientation);
Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().

This function already checks whether the widget is visible, so visibility does not need to be checked separately. Non-visible widgets are not expanded.

The computed expand value uses either the expand setting explicitly set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do.

Params:
GtkOrientation orientation expand direction

Return:
whether widget tree rooted here should be expanded

PgContext createPangoContext ();
Creates a new #PangoContext with the appropriate font map, font description, and base direction for drawing text for this widget. See also gtk_widget_get_pango_context().

Return:
the new #PangoContext

PgLayout createPangoLayout (string text);
Creates a new #PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

If you keep a #PangoLayout created in this way around, you need to re-create it when the widget #PangoContext is replaced. This can be tracked by using the #GtkWidget::screen-changed signal on the widget.

Params:
string text text to set on the layout (can be %NULL)

Return:
the new #PangoLayout

void destroyed (ref 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_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.

Params:
Widget widgetPointer address of a variable that contains @widget

bool deviceIsShadowed (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_device_grab_add().

Params:
Device device a #GdkDevice

Return:
%TRUE if there is an ongoing grab on @device by another #GtkWidget than @widget.

Since:
3.0

DragContext dragBegin (TargetList targets, GdkDragAction actions, int button, Event event);
This function is equivalent to gtk_drag_begin_with_coordinates(), passing -1, -1 as coordinates.

Deprecated:
Use gtk_drag_begin_with_coordinates() instead

Params:
TargetList targets The targets (data formats) in which the source can provide the data
GdkDragAction actions A bitmask of the allowed drag actions for this drag
int button The button the user clicked to start the drag
Event event The event that triggered the start of the drag

Return:
the context for this drag

DragContext dragBeginWithCoordinates (TargetList targets, GdkDragAction actions, int button, 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_drag_source_set() is used.

The @event is used to retrieve the timestamp that will be used internally to grab the pointer. If @event is %NULL, then %GDK_CURRENT_TIME will be used. However, you should try to pass a real event in all cases, since that can be used to get information about the drag.

Generally there are three cases when you want to start a drag by hand by calling this function:

1. During a #GtkWidget::button-press-event handler, if you want to start a drag immediately when the user presses the mouse button. Pass the @event that you have in your #GtkWidget::button-press-event handler.

2. During a #GtkWidget::motion-notify-event handler, if you want to start a drag when the mouse moves past a certain threshold distance after a button-press. Pass the @event that you have in your #GtkWidget::motion-notify-event handler.

3. During a timeout handler, if you want to start a drag after the mouse button is held down for some time. Try to save the last event that you got from the mouse, using gdk_event_copy(), and pass it to this function (remember to free the event with gdk_event_free() when you are done). If you can really not pass a real event, pass #NULL instead.

Params:
TargetList targets The targets (data formats) in which the source can provide the data
GdkDragAction actions A bitmask of the allowed drag actions for this drag
int button The button the user clicked to start the drag
Event event The event that triggered the start of the drag
int x The initial x coordinate to start dragging from, in the coordinate space of @widget. If -1 is passed, the coordinates are retrieved from @event or the current pointer position
int y The initial y coordinate to start dragging from, in the coordinate space of @widget. If -1 is passed, the coordinates are retrieved from @event or the current pointer position

Return:
the context for this drag

Since:
3.10

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.

Params:
int startX X coordinate of start of drag
int startY Y coordinate of start of drag
int currentX current X coordinate
int currentY current Y coordinate

Return:
%TRUE if the drag threshold has been passed.

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_add_image_targets() and gtk_drag_dest_set_target_list().

Since:
2.6

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_add_text_targets() and gtk_drag_dest_set_target_list().

Since:
2.6

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_add_uri_targets() and gtk_drag_dest_set_target_list().

Since:
2.6

GdkAtom dragDestFindTarget (DragContext context, 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_drag_dest_get_target_list(), 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.

Params:
DragContext context drag context
TargetList targetList list of droppable targets, or %NULL to use gtk_drag_dest_get_target_list (@widget).

Return:
first target that the source offers and the dest can accept, or %GDK_NONE

TargetList dragDestGetTargetList ();
Returns the list of targets this widget can accept from drag-and-drop.

Return:
the #GtkTargetList, or %NULL if none

bool dragDestGetTrackMotion ();
Returns whether the widget has been configured to always emit #GtkWidget::drag-motion signals.

Return:
%TRUE if the widget always emits #GtkWidget::drag-motion events

Since:
2.10

void dragDestSet (GtkDestDefaults flags, TargetEntry[] targets, GdkDragAction actions);
Sets a widget as a potential drop destination, and adds default behaviors.

The default behaviors listed in @flags have an effect similar to installing default handlers for the widget’s drag-and-drop signals (#GtkWidget::drag-motion, #GtkWidget::drag-drop, ...). They all exist for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is sufficient to connect to the widget’s #GtkWidget::drag-data-received signal to get primitive, but consistent drag-and-drop support.

Things become more complicated when you try to preview the dragged data, as described in the documentation for #GtkWidget::drag-motion. The default behaviors described by @flags make some assumptions, that can conflict with your own signal handlers. For instance #GTK_DEST_DEFAULT_DROP causes invokations of gdk_drag_status() in the context of #GtkWidget::drag-motion, and invokations of gtk_drag_finish() in #GtkWidget::drag-data-received. Especially the later is dramatic, when your own #GtkWidget::drag-motion handler calls gtk_drag_get_data() to inspect the dragged data.

There’s no way to set a default action here, you can use the #GtkWidget::drag-motion callback for that. Here’s an example which selects the action to use depending on whether the control key is pressed or not: |[ static void drag_motion (GtkWidget *widget, GdkDragContext *context, gint x, gint y, guint time) { GdkModifierType mask;

gdk_window_get_pointer (gtk_widget_get_window (widget), NULL, NULL, &mask); if (mask & GDK_CONTROL_MASK) gdk_drag_status (context, GDK_ACTION_COPY, time); else gdk_drag_status (context, GDK_ACTION_MOVE, time); } ]|

Params:
GtkDestDefaults flags which types of default drag behavior to use
TargetEntry[] targets a pointer to an array of #GtkTargetEntrys indicating the drop types that this @widget will accept, or %NULL. Later you can access the list with gtk_drag_dest_get_target_list() and gtk_drag_dest_find_target().
nTargets the number of entries in @targets
GdkDragAction actions a bitmask of possible actions for a drop onto this @widget.

void dragDestSetProxy (GdkWin proxyWindow, GdkDragProtocol protocol, bool useCoordinates);
Sets this widget as a proxy for drops to another window.

Params:
GdkWin proxyWindow the window to which to forward drag events
GdkDragProtocol protocol the drag protocol which the @proxy_window accepts (You can use gdk_drag_get_protocol() to determine this)
bool useCoordinates If %TRUE, send the same coordinates to the destination, because it is an embedded subwindow.

void dragDestSetTargetList (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_drag_dest_set().

Params:
TargetList targetList list of droppable targets, or %NULL for none

void dragDestSetTrackMotion (bool trackMotion);
Tells the widget to emit #GtkWidget::drag-motion and #GtkWidget::drag-leave events regardless of the targets and the %GTK_DEST_DEFAULT_MOTION flag.

This may be used when a widget wants to do generic actions regardless of the targets that the source offers.

Params:
bool trackMotion whether to accept all targets

Since:
2.10

void dragDestUnset ();
Clears information about a drop destination set with gtk_drag_dest_set(). The widget will no longer receive notification of drags.

void dragGetData (DragContext context, GdkAtom 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_drag_get_data() is called implicitely because the %GTK_DEST_DEFAULT_DROP was set, then the widget will not receive notification of failed drops.

Params:
DragContext context the drag context
GdkAtom target the target (form of the data) to retrieve
uint time a timestamp for retrieving the data. This will generally be the time received in a #GtkWidget::drag-motion" or #GtkWidget::drag-drop" signal

void dragHighlight ();
Draws a highlight around a widget. This will attach handlers to #GtkWidget::draw, so the highlight will continue to be displayed until gtk_drag_unhighlight() is called.

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_add_image_targets() and gtk_drag_source_set_target_list().

Since:
2.6

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_add_text_targets() and gtk_drag_source_set_target_list().

Since:
2.6

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_add_uri_targets() and gtk_drag_source_set_target_list().

Since:
2.6

TargetList dragSourceGetTargetList ();
Gets the list of targets this widget can provide for drag-and-drop.

Return:
the #GtkTargetList, or %NULL if none

Since:
2.4

void dragSourceSet (GdkModifierType startButtonMask, TargetEntry[] targets, GdkDragAction 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.

Params:
GdkModifierType startButtonMask the bitmask of buttons that can start the drag
TargetEntry[] targets the table of targets that the drag will support, may be %NULL
nTargets the number of items in @targets
GdkDragAction actions the bitmask of possible actions for a drag from this widget

void dragSourceSetIconGicon (IconIF icon);
Sets the icon that will be used for drags from a particular source to @icon. See the docs for #GtkIconTheme for more details.

Params:
IconIF icon A #GIcon

Since:
3.2

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.

Params:
string iconName name of icon to use

Since:
2.8

void dragSourceSetIconPixbuf (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.

Params:
Pixbuf pixbuf the #GdkPixbuf for the drag icon

void dragSourceSetIconStock (string stockId);
Sets the icon that will be used for drags from a particular source to a stock icon.

Deprecated:
Use gtk_drag_source_set_icon_name() instead.

Params:
string stockId the ID of the stock icon to use

void dragSourceSetTargetList (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_drag_source_set().

Params:
TargetList targetList list of draggable targets, or %NULL for none

Since:
2.4

void dragSourceUnset ();
Undoes the effects of gtk_drag_source_set().

void dragUnhighlight ();
Removes a highlight set by gtk_drag_highlight() from a widget.

void draw (Context cr);
Draws @widget to @cr. The top left corner of the widget will be drawn to the currently set origin point of @cr.

You should pass a cairo context as @cr argument that is in an original state. Otherwise the resulting drawing is undefined. For example changing the operator using cairo_set_operator() or the line width using cairo_set_line_width() might have unwanted side effects. You may however change the context’s transform matrix - like with cairo_scale(), cairo_translate() or cairo_set_matrix() and clip region with cairo_clip() prior to calling this function. Also, it is fine to modify the context with cairo_save() and cairo_push_group() prior to calling this function.

Note that special-purpose widgets may contain special code for rendering to the screen and might appear differently on screen and when rendered using gtk_widget_draw().

Params:
Context cr a cairo context to draw to

Since:
3.0

void ensureStyle ();
Ensures that @widget has a style (@widget->style).

Not a very useful function; most of the time, if you want the style, the widget is realized, and realized widgets are guaranteed to have a style already.

Deprecated:
Use #GtkStyleContext instead

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_beep(), otherwise it does nothing.

Note that the effect of gdk_window_beep() can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used.

Since:
2.12

bool 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_main_do_event() so the event will behave as if it were in the event queue. Don’t synthesize expose events; instead, use gdk_window_invalidate_rect() to invalidate a region of the window.

Params:
Event event a #GdkEvent

Return:
return from the event signal emission (%TRUE if the event was handled)

void freezeChildNotify ();
Stops emission of #GtkWidget::child-notify signals on @widget. The signals are queued until gtk_widget_thaw_child_notify() is called on @widget.

This is the analogue of g_object_freeze_notify() for child properties.

ObjectAtk getAccessible ();
Returns the accessible object that describes the widget to an assistive technology.

If accessibility support is not available, this #AtkObject instance may be a no-op. Likewise, if no class-specific #AtkObject implementation is available for the widget instance in question, it will inherit an #AtkObject implementation from the first ancestor class for which such an implementation is defined.

The documentation of the [ATK](http://developer.gnome.org/atk/stable/) library contains more information about accessible objects and their uses.

Return:
the #AtkObject associated with @widget

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.

Return:
the baseline of the @widget, or -1 if none

Since:
3.10

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.

Return:
the height of the @widget

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.

Return:
the width of the @widget

void getAllocation (out GtkAllocation allocation);
Retrieves the widget’s allocation.

Note, when implementing a #GtkContainer: a widget’s allocation will be its “adjusted” allocation, that is, the widget’s parent container typically calls gtk_widget_size_allocate() with an allocation, and that allocation is then adjusted (to handle margin and alignment for example) before assignment to the widget. gtk_widget_get_allocation() returns the adjusted allocation that was actually assigned to the widget. The adjusted allocation is guaranteed to be completely contained within the gtk_widget_size_allocate() allocation, however. So a #GtkContainer is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the container assigned. There is no way to get the original allocation assigned by gtk_widget_size_allocate(), since it isn’t stored; if a container implementation needs that information it will have to track it itself.

Params:
GtkAllocation allocation a pointer to a #GtkAllocation to copy to

Since:
2.18

Widget getAncestor (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_get_toplevel().

Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor() considers @widget to be an ancestor of itself.

Params:
GType widgetType ancestor type

Return:
the ancestor widget, or %NULL if not found

bool getAppPaintable ();
Determines whether the application intends to draw on the widget in an #GtkWidget::draw handler.

See gtk_widget_set_app_paintable()

Return:
%TRUE if the widget is app paintable

Since:
2.18

bool getCanDefault ();
Determines whether @widget can be a default widget. See gtk_widget_set_can_default().

Return:
%TRUE if @widget can be a default widget, %FALSE otherwise

Since:
2.18

bool getCanFocus ();
Determines whether @widget can own the input focus. See gtk_widget_set_can_focus().

Return:
%TRUE if @widget can own the input focus, %FALSE otherwise

Since:
2.18

void getChildRequisition (out 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_set_size_request()), in which case it returns that geometry instead of the widget's requisition.

This function differs from gtk_widget_size_request() in that it retrieves the last size request value from @widget->requisition, while gtk_widget_size_request() actually calls the "size_request" method on @widget to compute the size request and fill in @widget->requisition, and only then returns @widget->requisition.

Because this function does not call the “size_request” method, it can only be used when you know that @widget->requisition is up-to-date, that is, gtk_widget_size_request() has been called since the last time a resize was queued. In general, only container implementations have this information; applications should use gtk_widget_size_request().

Deprecated:
Use gtk_widget_get_preferred_size() instead.

Params:
Requisition requisition a #GtkRequisition to be filled in

bool getChildVisible ();
Gets the value set with gtk_widget_set_child_visible(). If you feel a need to use this function, your code probably needs reorganization.

This function is only useful for container implementations and never should be called by an application.

Return:
%TRUE if the widget is mapped with the parent.

void getClip (out GtkAllocation clip);
Retrieves the widget’s clip area.

The clip area is the area in which all of @widget's drawing will happen. Other toolkits call it the bounding box.

Historically, in GTK+ the clip area has been equal to the allocation retrieved via gtk_widget_get_allocation().

Params:
GtkAllocation clip a pointer to a #GtkAllocation to copy to

Since:
3.14

Clipboard getClipboard (GdkAtom 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.

Params:
GdkAtom selection a #GdkAtom which identifies the clipboard to use. %GDK_SELECTION_CLIPBOARD gives the default clipboard. Another common value is %GDK_SELECTION_PRIMARY, which gives the primary X selection.

Return:
the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time.

Since:
2.2

string getCompositeName ();
Obtains the composite name of a widget.

Deprecated:
Use gtk_widget_class_set_template(), or don’t use this API at all.

Return:
the composite name of @widget, or %NULL if @widget is not a composite child. The string should be freed when it is no longer needed.

bool getDeviceEnabled (Device device);
Returns whether @device can interact with @widget and its children. See gtk_widget_set_device_enabled().

Params:
Device device a #GdkDevice

Return:
%TRUE is @device is enabled for @widget

Since:
3.0

GdkEventMask getDeviceEvents (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.

Params:
Device device a #GdkDevice

Return:
device event mask for @widget

Since:
3.0

GtkTextDirection getDirection ();
Gets the reading direction for a particular widget. See gtk_widget_set_direction().

Return:
the reading direction for the widget.

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.

In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Return:
the #GdkDisplay for the toplevel for this widget.

Since:
2.2

bool getDoubleBuffered ();
Determines whether the widget is double buffered.

See gtk_widget_set_double_buffered()

Return:
%TRUE if the widget is double buffered

Since:
2.18

int getEvents ();
Returns the event mask for the widget (a bitfield containing flags from the #GdkEventMask enumeration). These are the events that the widget will receive.

Note:
Internally, the widget event mask will be the logical OR of the event mask set through gtk_widget_set_events() or gtk_widget_add_events(), and the event mask necessary to cater for every #GtkEventController created for the widget.

Return:
event mask for @widget

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_get_frame_time(), 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_get_frame_time(), and then update the animation by calling gdk_frame_clock_get_frame_time() again during each repaint.

gdk_frame_clock_request_phase() will result in a new frame on the clock, but won’t necessarily repaint any widgets. To repaint a widget, you have to use gtk_widget_queue_draw() which invalidates the widget (thus scheduling it to receive a draw on the next frame). gtk_widget_queue_draw() will also end up requesting a frame on the appropriate frame clock.

A widget’s frame clock will not change while the widget is mapped. Reparenting a widget (which implies a temporary unmap) can change the widget’s frame clock.

Unrealized widgets do not have a frame clock.

Return:
a #GdkFrameClock (or #NULL if widget is unrealized)

Since:
3.8

GtkAlign getHalign ();
Gets the value of the #GtkWidget:halign property.

For backwards compatibility reasons this method will never return %GTK_ALIGN_BASELINE, but instead it will convert it to %GTK_ALIGN_FILL. Baselines are not supported for horizontal alignment.

Return:
the horizontal alignment of @widget

bool getHasTooltip ();
Returns the current value of the has-tooltip property. See #GtkWidget:has-tooltip for more information.

Return:
current value of has-tooltip on @widget.

Since:
2.12

bool getHasWindow ();
Determines whether @widget has a #GdkWindow of its own. See gtk_widget_set_has_window().

Return:
%TRUE if @widget has a window, %FALSE otherwise

Since:
2.18

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.

Containers should use gtk_widget_compute_expand() rather than this function, to see whether a widget, or any of its children, has the expand flag set. If any child of a widget wants to expand, the parent may ask to expand also.

This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand.

Return:
whether hexpand flag is set

bool getHexpandSet ();
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.

There are few reasons to use this function, but it’s here for completeness and consistency.

Return:
whether hexpand has been explicitly set

bool getMapped ();
Whether the widget is mapped.

Return:
%TRUE if the widget is mapped, %FALSE otherwise.

Since:
2.20

int getMarginBottom ();
Gets the value of the #GtkWidget:margin-bottom property.

Return:
The bottom margin of @widget

Since:
3.0

int getMarginEnd ();
Gets the value of the #GtkWidget:margin-end property.

Return:
The end margin of @widget

Since:
3.12

int getMarginLeft ();
Gets the value of the #GtkWidget:margin-left property.

Deprecated:
Use gtk_widget_get_margin_start() instead.

Return:
The left margin of @widget

Since:
3.0

int getMarginRight ();
Gets the value of the #GtkWidget:margin-right property.

Deprecated:
Use gtk_widget_get_margin_end() instead.

Return:
The right margin of @widget

Since:
3.0

int getMarginStart ();
Gets the value of the #GtkWidget:margin-start property.

Return:
The start margin of @widget

Since:
3.12

int getMarginTop ();
Gets the value of the #GtkWidget:margin-top property.

Return:
The top margin of @widget

Since:
3.0

GdkModifierType getModifierMask (GdkModifierIntent intent);
Returns the modifier mask the @widget’s windowing system backend uses for a particular purpose.

See gdk_keymap_get_modifier_mask().

Params:
GdkModifierIntent intent the use case for the modifier mask

Return:
the modifier mask used for @intent.

Since:
3.4

RcStyle getModifierStyle ();
Returns the current modifier style for the widget. (As set by gtk_widget_modify_style().) 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_modify_style(), passing in the returned rc style, to make sure that your changes take effect.

Caution:
passing the style back to gtk_widget_modify_style() will normally end up destroying it, because gtk_widget_modify_style() copies the passed-in style and sets the copy as the new modifier style, thus dropping any reference to the old modifier style. Add a reference to the modifier style if you want to keep it alive.

Deprecated:
Use #GtkStyleContext with a custom #GtkStyleProvider instead

Return:
the modifier style for the widget. This rc style is owned by the widget. If you want to keep a pointer to value this around, you must add a refcount using g_object_ref().

string getName ();
Retrieves the name of a widget. See gtk_widget_set_name() for the significance of widget names.

Return:
name of the widget. This string is owned by GTK+ and should not be modified or freed

bool getNoShowAll ();
Returns the current value of the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() will affect this widget.

Return:
the current value of the “no-show-all” property.

Since:
2.4

double getOpacity ();
Fetches the requested opacity for this widget. See gtk_widget_set_opacity().

Return:
the requested opacity for this widget.

Since:
3.8

PgContext getPangoContext ();
Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk_widget_create_pango_context(), 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.

Return:
the #PangoContext for the widget.

Widget getParent ();
Returns the parent container of @widget.

Return:
the parent container of @widget, or %NULL

GdkWin getParentWindow ();
Gets @widget’s parent window.

Return:
the parent window of @widget.

WidgetPath getPath ();
Returns the #GtkWidgetPath representing @widget, if the widget is not connected to a toplevel widget, a partial path will be created.

Return:
The #GtkWidgetPath representing @widget

void getPointer (out int x, out 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 are not #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x, @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.

Deprecated:
Use gdk_window_get_device_position() instead.

Params:
int x return location for the X coordinate, or %NULL
int y return location for the Y coordinate, or %NULL

void getPreferredHeight (out int minimumHeight, out int naturalHeight);
Retrieves a widget’s initial minimum and natural height.

This call is specific to width-for-height requests.

The returned request will be modified by the

GtkWidgetClass:
:adjust_size_request virtual method and by any #GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.

Params:
int minimumHeight location to store the minimum height, or %NULL
int naturalHeight location to store the natural height, or %NULL

Since:
3.0

void getPreferredHeightAndBaselineForWidth (int width, out int minimumHeight, out int naturalHeight, out int minimumBaseline, out 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.

The returned request will be modified by the

GtkWidgetClass:
:adjust_size_request and GtkWidgetClass::adjust_baseline_request virtual methods and by any #GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.

Params:
int width the width which is available for allocation, or -1 if none
int minimumHeight location for storing the minimum height, or %NULL
int naturalHeight location for storing the natural height, or %NULL
int minimumBaseline location for storing the baseline for the minimum height, or %NULL
int naturalBaseline location for storing the baseline for the natural height, or %NULL

Since:
3.10

void getPreferredHeightForWidth (int width, out int minimumHeight, out int naturalHeight);
Retrieves a widget’s minimum and natural height if it would be given the specified @width.

The returned request will be modified by the

GtkWidgetClass:
:adjust_size_request virtual method and by any #GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.

Params:
int width the width which is available for allocation
int minimumHeight location for storing the minimum height, or %NULL
int naturalHeight location for storing the natural height, or %NULL

Since:
3.0

void getPreferredSize (out Requisition minimumSize, out Requisition naturalSize);
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

This is used to retrieve a suitable size by container widgets which do not impose any restrictions on the child placement. It can be used to deduce toplevel window and menu sizes as well as child widgets in free-form containers such as GtkLayout.

Handle with care. Note that the natural height of a height-for-width widget will generally be a smaller size than the minimum height, since the required height for the natural width is generally smaller than the required height for the minimum width.

Use gtk_widget_get_preferred_height_and_baseline_for_width() if you want to support baseline alignment.

Params:
Requisition minimumSize location for storing the minimum size, or %NULL
Requisition naturalSize location for storing the natural size, or %NULL

Since:
3.0

void getPreferredWidth (out int minimumWidth, out int naturalWidth);
Retrieves a widget’s initial minimum and natural width.

This call is specific to height-for-width requests.

The returned request will be modified by the

GtkWidgetClass:
:adjust_size_request virtual method and by any #GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.

Params:
int minimumWidth location to store the minimum width, or %NULL
int naturalWidth location to store the natural width, or %NULL

Since:
3.0

void getPreferredWidthForHeight (int height, out int minimumWidth, out int naturalWidth);
Retrieves a widget’s minimum and natural width if it would be given the specified @height.

The returned request will be modified by the

GtkWidgetClass:
:adjust_size_request virtual method and by any #GtkSizeGroups that have been applied. That is, the returned request is the one that should be used for layout, not necessarily the one returned by the widget itself.

Params:
int height the height which is available for allocation
int minimumWidth location for storing the minimum width, or %NULL
int naturalWidth location for storing the natural width, or %NULL

Since:
3.0

bool getRealized ();
Determines whether @widget is realized.

Return:
%TRUE if @widget is realized, %FALSE otherwise

Since:
2.20

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.

See gtk_widget_set_receives_default().

Return:
%TRUE if @widget acts as the default widget when focussed, %FALSE otherwise

Since:
2.18

GtkSizeRequestMode getRequestMode ();
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

#GtkBin widgets generally propagate the preference of their child, container widgets need to request something either in context of their children or in context of their allocation capabilities.

Return:
The #GtkSizeRequestMode preferred by @widget.

Since:
3.0

void getRequisition (out Requisition requisition);
Retrieves the widget’s requisition.

This function should only be used by widget implementations in order to figure whether the widget’s requisition has actually changed after some internal state change (so that they can call gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).

Normally, gtk_widget_size_request() should be used.

Deprecated:
The #GtkRequisition cache on the widget was removed, If you need to cache sizes across requests and allocations, add an explicit cache to the widget in question instead.

Params:
Requisition requisition a pointer to a #GtkRequisition to copy to

Since:
2.20

GdkWin 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.

The root window is useful for such purposes as creating a popup #GdkWindow associated with the window. In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Deprecated:
Use gdk_screen_get_root_window() instead

Return:
the #GdkWindow root window for the toplevel for this widget.

Since:
2.2

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).

See gdk_window_get_scale_factor().

Return:
the scale factor for @widget

Since:
3.10

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.

In general, you should only create screen specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

Return:
the #GdkScreen for the toplevel for this widget.

Since:
2.2

bool getSensitive ();
Returns the widget’s sensitivity (in the sense of returning the value that has been set using gtk_widget_set_sensitive()).

The effective sensitivity of a widget is however determined by both its own and its parent widget’s sensitivity. See gtk_widget_is_sensitive().

Return:
%TRUE if the widget is sensitive

Since:
2.18

Settings getSettings ();
Gets the settings object holding the settings used for this widget.

Note that this function can only be called when the #GtkWidget is attached to a toplevel, since the settings object is specific to a particular #GdkScreen.

Return:
the relevant #GtkSettings object

void getSizeRequest (out int width, out int height);
Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). 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 intead. See gtk_widget_set_size_request(). To get the size a widget will actually request, call gtk_widget_get_preferred_size() instead of this function.

Params:
int width return location for width, or %NULL
int height return location for height, or %NULL

GtkStateFlags getStateFlags ();
Returns the widget state as a flag set. It is worth mentioning that the effective %GTK_STATE_FLAG_INSENSITIVE state will be returned, that is, also based on parent insensitivity, even if @widget itself is sensitive.

Return:
The state flags for widget

Since:
3.0

Style getStyle ();
Simply an accessor function that returns @widget->style.

Deprecated:
Use #GtkStyleContext instead

Return:
the widget’s #GtkStyle

StyleContext getStyleContext ();
Returns the style context associated to @widget.

Return:
a #GtkStyleContext. This memory is owned by @widget and must not be freed.

bool getSupportMultidevice ();
Returns %TRUE if @widget is multiple pointer aware. See gtk_widget_set_support_multidevice() for more information.

Return:
%TRUE if @widget is multidevice aware.

ObjectG getTemplateChild (GType widgetType, string name);
Fetch an object build from the template XML for @widget_type in this @widget instance.

This will only report children which were previously declared with gtk_widget_class_bind_template_child_full() or one of its variants.

This function is only meant to be called for code which is private to the @widget_type which declared the child and is meant for language bindings which cannot easily make use of the GObject structure offsets.

Params:
GType widgetType The #GType to get a template child for
string name The “id” of the child defined in the template XML

Return:
The object built in the template XML with the id @name

string getTooltipMarkup ();
Gets the contents of the tooltip for @widget.

Return:
the tooltip text, or %NULL. You should free the returned string with g_free() when done.

Since:
2.12

string getTooltipText ();
Gets the contents of the tooltip for @widget.

Return:
the tooltip text, or %NULL. You should free the returned string with g_free() when done.

Since:
2.12

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_set_tooltip_window().

Return:
The #GtkWindow of the current tooltip.

Since:
2.12

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.

Note the difference in behavior vs. gtk_widget_get_ancestor(); `gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)` would return %NULL if @widget wasn’t inside a toplevel window, and if the window was inside a #GtkWindow-derived widget which was in turn inside the toplevel #GtkWindow. While the second case may seem unlikely, it actually happens when a #GtkPlug is embedded inside a #GtkSocket within the same application.

To reliably find the toplevel #GtkWindow, use gtk_widget_get_toplevel() and call gtk_widget_is_toplevel() on the result. |[ GtkWidget *toplevel = gtk_widget_get_toplevel (widget); if (gtk_widget_is_toplevel (toplevel)) { // Perform action on toplevel. } ]|

Return:
the topmost ancestor of @widget, or @widget itself if there’s no ancestor.

GtkAlign getValign ();
Gets the value of the #GtkWidget:valign property.

For backwards compatibility reasons this method will never return %GTK_ALIGN_BASELINE, but instead it will convert it to %GTK_ALIGN_FILL. If your widget want to support baseline aligned children it must use gtk_widget_get_valign_with_baseline(), or `g_object_get (widget, "valign", &value, NULL)`, which will also report the true value.

Return:
the vertical alignment of @widget, ignoring baseline alignment

GtkAlign getValignWithBaseline ();
Gets the value of the #GtkWidget:valign property, including %GTK_ALIGN_BASELINE.

Return:
the vertical alignment of @widget

Since:
3.10

bool getVexpand ();
Gets whether the widget would like any available extra vertical space.

See gtk_widget_get_hexpand() for more detail.

Return:
whether vexpand flag is set

bool getVexpandSet ();
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

See gtk_widget_get_hexpand_set() for more detail.

Return:
whether vexpand has been explicitly set

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_is_visible() instead.

This function does not check if the widget is obscured in any way.

See gtk_widget_set_visible().

Return:
%TRUE if the widget is visible

Since:
2.18

Visual getVisual ();
Gets the visual that will be used to render @widget.

Return:
the visual for @widget

GdkWin getWindow ();
Returns the widget’s window if it is realized, %NULL otherwise

Return:
@widget’s window.

Since:
2.14

void grabAdd ();
Makes @widget the current grabbed widget.

This means that interaction with other widgets in the same application is blocked and mouse as well as keyboard events are delivered to this widget.

If @widget is not sensitive, it is not set as the current grabbed widget and this function does nothing.

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_set_can_default() 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_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.

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.

More precisely, it must have the %GTK_CAN_FOCUS flag set. Use gtk_widget_set_can_focus() to modify that flag.

The widget also needs to be realized and mapped. This is indicated by the related signals. Grabbing the focus immediately after creating the widget will likely fail and cause critical warnings.

void grabRemove ();
Removes the grab from the given widget.

You have to pair calls to gtk_grab_add() and gtk_grab_remove().

If @widget does not have the grab, this function does nothing.

bool hasDefault ();
Determines whether @widget is the current default widget within its toplevel. See gtk_widget_set_can_default().

Return:
%TRUE if @widget is the current default widget within its toplevel, %FALSE otherwise

Since:
2.18

bool hasFocus ();
Determines if the widget has the global input focus. See gtk_widget_is_focus() for the difference between having the global input focus, and only having the focus within a toplevel.

Return:
%TRUE if the widget has the global input focus.

Since:
2.18

bool hasGrab ();
Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).

See also gtk_grab_add().

Return:
%TRUE if the widget is in the grab_widgets stack

Since:
2.18

bool hasRcStyle ();
Determines if the widget style has been looked up through the rc mechanism.

Deprecated:
Use #GtkStyleContext instead

Return:
%TRUE if the widget has been looked up through the rc mechanism, %FALSE otherwise.

Since:
2.20

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.

Return:
%TRUE if there is a #GdkScreen associcated with the widget.

Since:
2.2

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_get_focus_visible() for more information about focus indication.

To find out if the widget has the global input focus, use gtk_widget_has_focus().

Return:
%TRUE if the widget should display a “focus rectangle”

Since:
3.2

void hide ();
Reverses the effects of gtk_widget_show(), causing the widget to be hidden (invisible to the user).

bool hideOnDelete ();
Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk_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.

Return:
%TRUE

bool inDestruction ();
Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work.

Return:
%TRUE if @widget is being destroyed

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_set_template()

It is important to call this function in the instance initializer of a #GtkWidget subclass and not in #GObject.constructed() or #GObject.constructor() for two reasons.

One reason is that generally derived widgets will assume that parent class composite widgets have been created in their instance initializers.

Another reason is that when calling g_object_new() on a widget with composite templates, it’s important to build the composite widgets before the construct properties are set. Properties passed to g_object_new() should take precedence over properties set in the private template XML.

Since:
3.10

void inputShapeCombineRegion (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_input_shape_combine_region() for more information.

Params:
Region region shape to be added, or %NULL to remove an existing shape

Since:
3.0

void insertActionGroup (string name, ActionGroupIF 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`.

If @group is %NULL, a previously inserted group for @name is removed from @widget.

Params:
string name the prefix for actions in @group
ActionGroupIF group a #GActionGroup, or %NULL

Since:
3.6

bool intersect (GdkRectangle* area, GdkRectangle* 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.

Params:
GdkRectangle* area a rectangle
GdkRectangle* intersection rectangle to store intersection of @widget and @area

Return:
%TRUE if there was an intersection

bool isAncestor (Widget ancestor);
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.

Params:
Widget ancestor another #GtkWidget

Return:
%TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc.

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.

Please note that the semantics of this call will change in the future if used on a widget that has a composited window in its hierarchy (as set by gdk_window_set_composited()).

Return:
%TRUE if the widget can rely on its alpha channel being drawn correctly.

Since:
2.10

bool isDrawable ();
Determines whether @widget can be drawn to. A widget can be drawn to if it is mapped and visible.

Return:
%TRUE if @widget is drawable, %FALSE otherwise

Since:
2.18

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.)

Return:
%TRUE if the widget is the focus widget.

bool isSensitive ();
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive

Return:
%TRUE if the widget is effectively sensitive

Since:
2.18

bool isToplevel ();
Determines whether @widget is a toplevel widget.

Currently only #GtkWindow and #GtkInvisible (and out-of-process #GtkPlugs) are toplevel widgets. Toplevel widgets have no parent widget.

Return:
%TRUE if @widget is a toplevel, %FALSE otherwise

Since:
2.18

bool isVisible ();
Determines whether the widget and all its parents are marked as visible.

This function does not check if the widget is obscured in any way.

See also gtk_widget_get_visible() and gtk_widget_set_visible()

Return:
%TRUE if the widget and all its parents are visible

Since:
3.8

bool keynavFailed (GtkDirectionType 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_child_focus():

When %TRUE is returned, stay in the widget, the failed keyboard navigation is Ok and/or there is nowhere we can/should move the focus to.

When %FALSE is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling gtk_widget_child_focus() on the widget’s toplevel.

The default ::keynav-failed handler returns %TRUE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other values of #GtkDirectionType it returns %FALSE.

Whenever the default handler returns %TRUE, it also calls gtk_widget_error_bell() to notify the user of the failed keyboard navigation.

A use case for providing an own implementation of ::keynav-failed (either by connecting to it or by overriding it) would be a row of #GtkEntry widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys.

Params:
GtkDirectionType direction direction of focus movement

Return:
%TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s).

Since:
2.12

ListG listAccelClosures ();
Lists the closures used by @widget for accelerator group connections with gtk_accel_group_connect_by_path() or gtk_accel_group_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_from_accel_closure().

Return:
a newly allocated #GList of closures

ListG 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_set_mnemonic_widget()).

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and then unref all the widgets afterwards.

Return:
the list of mnemonic labels; free this list with g_list_free() when you are done with it.

Since:
2.4

void map ();
This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.

bool mnemonicActivate (bool groupCycling);
Emits the #GtkWidget::mnemonic-activate signal.

The default handler for this signal activates the @widget if @group_cycling is %FALSE, and just grabs the focus if @group_cycling is %TRUE.

Params:
bool groupCycling %TRUE if there are other widgets with the same mnemonic

Return:
%TRUE if the signal has been handled

void modifyBase (GtkStateType state, 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_modify_text()) for widgets such as #GtkEntry and #GtkTextView. See also gtk_widget_modify_style().

> Note that “no window” widgets (which have the %GTK_NO_WINDOW > flag set) draw on their parent container’s window and thus may > not draw any background themselves. This is the case for e.g. > #GtkLabel. > > To modify the background of such widgets, you have to set the > base color on their parent; if you want to set the background > of a rectangular area around a label, try placing the label in > a #GtkEventBox widget and setting the base color on that.

Deprecated:
Use gtk_widget_override_background_color() instead

Params:
GtkStateType state the state for which to set the base color
Color color the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_base().

void modifyBg (GtkStateType state, Color color);
Sets the background color for a widget in a particular state.

All other style values are left untouched. See also gtk_widget_modify_style().

> Note that “no window” widgets (which have the %GTK_NO_WINDOW > flag set) draw on their parent container’s window and thus may > not draw any background themselves. This is the case for e.g. > #GtkLabel. > > To modify the background of such widgets, you have to set the > background color on their parent; if you want to set the background > of a rectangular area around a label, try placing the label in > a #GtkEventBox widget and setting the background color on that.

Deprecated:
Use gtk_widget_override_background_color() instead

Params:
GtkStateType state the state for which to set the background color
Color color the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_bg().

void modifyCursor (Color primary, Color secondary);
Sets the cursor color to use in a widget, overriding the #GtkWidget cursor-color and secondary-cursor-color style properties.

All other style values are left untouched. See also gtk_widget_modify_style().

Deprecated:
Use gtk_widget_override_cursor() instead.

Params:
Color primary the color to use for primary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor().
Color secondary the color to use for secondary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor().

Since:
2.12

void modifyFg (GtkStateType state, Color color);
Sets the foreground color for a widget in a particular state.

All other style values are left untouched. See also gtk_widget_modify_style().

Deprecated:
Use gtk_widget_override_color() instead

Params:
GtkStateType state the state for which to set the foreground color
Color color the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_fg().

void modifyFont (PgFontDescription fontDesc);
Sets the font to use for a widget.

All other style values are left untouched. See also gtk_widget_modify_style().

Deprecated:
Use gtk_widget_override_font() instead

Params:
PgFontDescription fontDesc the font description to use, or %NULL to undo the effect of previous calls to gtk_widget_modify_font()

void modifyStyle (RcStyle style);
Modifies style values on the widget.

Modifications made using this technique take precedence over style values set via an RC file, however, they will be overridden if a style is explicitly set on the widget using gtk_widget_set_style(). The #GtkRcStyle-struct is designed so each field can either be set or unset, so it is possible, using this function, to modify some style values and leave the others unchanged.

Note that modifications made with this function are not cumulative with previous calls to gtk_widget_modify_style() or with such functions as gtk_widget_modify_fg(). If you wish to retain previous values, you must first call gtk_widget_get_modifier_style(), make your modifications to the returned style, then call gtk_widget_modify_style() with that style. On the other hand, if you first call gtk_widget_modify_style(), subsequent calls to such functions gtk_widget_modify_fg() will have a cumulative effect with the initial modifications.

Deprecated:
Use #GtkStyleContext with a custom #GtkStyleProvider instead

Params:
RcStyle style the #GtkRcStyle-struct holding the style modifications

void modifyText (GtkStateType state, Color color);
Sets the text color for a widget in a particular state.

All other style values are left untouched. The text color is the foreground color used along with the base color (see gtk_widget_modify_base()) for widgets such as #GtkEntry and #GtkTextView. See also gtk_widget_modify_style().

Deprecated:
Use gtk_widget_override_color() instead

Params:
GtkStateType state the state for which to set the text color
Color color the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_text().

void overrideBackgroundColor (GtkStateFlags state, RGBA color);
Sets the background color to use for a widget.

All other style values are left untouched. See gtk_widget_override_color().

Params:
GtkStateFlags state the state for which to set the background color
RGBA color the color to assign, or %NULL to undo the effect of previous calls to gtk_widget_override_background_color()

Since:
3.0

void overrideColor (GtkStateFlags state, RGBA color);
Sets the color to use for a widget.

All other style values are left untouched.

This function does not act recursively. Setting the color of a container does not affect its children. Note that some widgets that you may not think of as containers, for instance #GtkButtons, are actually containers.

This API is mostly meant as a quick way for applications to change a widget appearance. If you are developing a widgets library and intend this change to be themeable, it is better done by setting meaningful CSS classes and regions in your widget/container implementation through gtk_style_context_add_class() and gtk_style_context_add_region().

This way, your widget library can install a #GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order to provide a default styling for those widgets that need so, and this theming may fully overridden by the user’s theme.

Note that for complex widgets this may bring in undesired results (such as uniform background color everywhere), in these cases it is better to fully style such widgets through a #GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION priority.

Params:
GtkStateFlags state the state for which to set the color
RGBA color the color to assign, or %NULL to undo the effect of previous calls to gtk_widget_override_color()

Since:
3.0

void overrideCursor (RGBA cursor, 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_modify_style().

Note that the underlying properties have the #GdkColor type, so the alpha value in @primary and @secondary will be ignored.

Params:
RGBA cursor the color to use for primary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_override_cursor().
RGBA secondaryCursor the color to use for secondary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_override_cursor().

Since:
3.0

void overrideFont (PgFontDescription fontDesc);
Sets the font to use for a widget. All other style values are left untouched. See gtk_widget_override_color().

Params:
PgFontDescription fontDesc the font descriptiong to use, or %NULL to undo the effect of previous calls to gtk_widget_override_font()

Since:
3.0

void overrideSymbolicColor (string name, RGBA color);
Sets a symbolic color for a widget.

All other style values are left untouched. See gtk_widget_override_color() for overriding the foreground or background color.

Params:
string name the name of the symbolic color to modify
RGBA color the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to gtk_widget_override_symbolic_color()

Since:
3.0

void path (out uint pathLength, out string path , out 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_get_name(). 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_set_name(). 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.

Deprecated:
Use gtk_widget_get_path() instead

Params:
uint pathLength location to store length of the path , or %NULL
string path location to store allocated path string, or %NULL
string pathReversed location to store allocated reverse path string, or %NULL

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.

See gtk_widget_compute_expand().

void queueDraw ();
Equivalent to calling gtk_widget_queue_draw_area() for the entire area of a widget.

void queueDrawArea (int x, int y, int width, int height);
Convenience function that calls gtk_widget_queue_draw_region() on the region created from the given coordinates.

The region here is specified in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as @widget->window coordinates for widgets that are not #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x, @widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.

Params:
int x x coordinate of upper-left corner of rectangle to redraw
int y y coordinate of upper-left corner of rectangle to redraw
int width width of region to draw
int height height of region to draw

void queueDrawRegion (Region region);
Invalidates the area of @widget defined by @region by calling gdk_window_invalidate_region() 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.

Normally you would only use this function in widget implementations. You might also use it to schedule a redraw of a #GtkDrawingArea or some portion thereof.

Params:
Region region region to draw

Since:
3.0

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.

Note that you cannot call gtk_widget_queue_resize() on a widget from inside its implementation of the GtkWidgetClass::size_allocate virtual method. Calls to gtk_widget_queue_resize() from inside

GtkWidgetClass:
:size_allocate will be silently ignored.

void queueResizeNoRedraw ();
This function works like gtk_widget_queue_resize(), except that the widget is not invalidated.

Since:
2.4

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.

Realizing a widget requires all the widget’s parent widgets to be realized; calling gtk_widget_realize() realizes the widget’s parents in addition to @widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.

This function is primarily used in widget implementations, and isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as #GtkWidget::draw. Or simply g_signal_connect () to the #GtkWidget:: realize signal.

Region regionIntersect (Region region);
Computes the intersection of a @widget’s area and @region, returning the intersection. The result may be empty, use cairo_region_is_empty() to check.

Deprecated:
Use gtk_widget_get_allocation() and cairo_region_intersect_rectangle() to get the same behavior.

Params:
Region region a #cairo_region_t, in the same coordinate system as @widget->allocation. That is, relative to @widget->window for %NO_WINDOW widgets; relative to the parent window of @widget->window for widgets with their own window.

Return:
A newly allocated region holding the intersection of @widget and @region. The coordinates of the return value are relative to @widget->window for %NO_WINDOW widgets, and relative to the parent window of @widget->window for widgets with their own window.

void registerWindow (GdkWin window);
Registers a #GdkWindow with the widget and sets it up so that the widget receives events for it. Call gtk_widget_unregister_window() when destroying the window.

Before 3.8 you needed to call gdk_window_set_user_data() directly to set this up. This is now deprecated and you should use gtk_widget_register_window() instead. Old code will keep working as is, although some new features like transparency might not work perfectly.

Params:
GdkWin window a #GdkWindow

Since:
3.8

bool removeAccelerator (AccelGroup accelGroup, uint accelKey, GdkModifierType accelMods);
Removes an accelerator from @widget, previously installed with gtk_widget_add_accelerator().

Params:
AccelGroup accelGroup accel group for this widget
uint accelKey GDK keyval of the accelerator
GdkModifierType accelMods modifier key combination of the accelerator

Return:
whether an accelerator was installed and could be removed

void removeMnemonicLabel (Widget label);
Removes a widget from the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). The widget must have previously been added to the list with gtk_widget_add_mnemonic_label().

Params:
Widget label a #GtkWidget that was previously set as a mnemnic label for @widget with gtk_widget_add_mnemonic_label().

Since:
2.4

void removeTickCallback (uint id);
Removes a tick callback previously registered with gtk_widget_add_tick_callback().

Params:
uint id an id returned by gtk_widget_add_tick_callback()

Since:
3.8

Pixbuf renderIcon (string stockId, GtkIconSize 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.

The pixels in the returned #GdkPixbuf are shared with the rest of the application and should not be modified. The pixbuf should be freed after use with g_object_unref().

Deprecated:
Use gtk_widget_render_icon_pixbuf() instead.

Params:
string stockId a stock ID
GtkIconSize size a stock size. A size of (GtkIconSize)-1 means render at the size of the source and don’t scale (if there are multiple source sizes, GTK+ picks one of the available sizes).
string detail render detail to pass to theme engine

Return:
a new pixbuf, or %NULL if the stock ID wasn’t known

Pixbuf renderIconPixbuf (string stockId, GtkIconSize 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.

The pixels in the returned #GdkPixbuf are shared with the rest of the application and should not be modified. The pixbuf should be freed after use with g_object_unref().

Deprecated:
Use gtk_icon_theme_load_icon() instead.

Params:
string stockId a stock ID
GtkIconSize size a stock size. A size of (GtkIconSize)-1 means render at the size of the source and don’t scale (if there are multiple source sizes, GTK+ picks one of the available sizes).

Return:
a new pixbuf, or %NULL if the stock ID wasn’t known

Since:
3.0

void reparent (Widget newParent);
Moves a widget from one #GtkContainer to another, handling reference count issues to avoid destroying the widget.

Deprecated:
Use gtk_container_remove() and gtk_container_add().

Params:
Widget newParent a #GtkContainer to move the widget into

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.

This function is not useful for applications.

Deprecated:
Use #GtkStyleContext instead, and gtk_widget_reset_style()

void resetStyle ();
Updates the style context of @widget and all descendents 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_get_path_for_child().

Since:
3.0

int sendExpose (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 child %NO_WINDOW widget, and that is normally done using gtk_container_propagate_draw().

If you want to force an area of a window to be redrawn, use gdk_window_invalidate_rect() or gdk_window_invalidate_region(). To cause the redraw to be done immediately, follow that call with a call to gdk_window_process_updates().

Params:
Event event a expose #GdkEvent

Return:
return from the event signal emission (%TRUE if the event was handled)

bool sendFocusChange (Event event);
Sends the focus change @event to @widget

This function is not meant to be used by applications. The only time it should be used is when it is necessary for a #GtkWidget to assign focus to a widget that is semantically owned by the first widget even though it’s not a direct child - for instance, a search entry in a floating window similar to the quick search in #GtkTreeView.

An example of its usage is:

|[ GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);

fevent->focus_change.type = GDK_FOCUS_CHANGE; fevent->focus_change.in = TRUE; fevent->focus_change.window = gtk_widget_get_window (widget); if (fevent->focus_change.window != NULL) g_object_ref (fevent->focus_change.window);

gtk_widget_send_focus_change (widget, fevent);

gdk_event_free (event); ]|

Params:
Event event a #GdkEvent of type GDK_FOCUS_CHANGE

Return:
the return value from the event signal emission: %TRUE if the event was handled, and %FALSE otherwise

Since:
2.20

void setAccelPath (string accelPath, 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_set_accel_path(). 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_save().)

This function is a low level function that would most likely be used by a menu creation system like #GtkUIManager. If you use #GtkUIManager, setting up accelerator paths will be done automatically.

Even when you you aren’t using #GtkUIManager, if you only want to set up accelerators on menu items gtk_menu_item_set_accel_path() provides a somewhat more convenient interface.

Note that @accel_path string will be stored in a #GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string().

Params:
string accelPath path used to look up the accelerator
AccelGroup accelGroup a #GtkAccelGroup.

void setAllocation (GtkAllocation* allocation);
Sets the widget’s allocation. This should not be used directly, but from within a widget’s size_allocate method.

The allocation set should be the “adjusted” or actual allocation. If you’re implementing a #GtkContainer, you want to use gtk_widget_size_allocate() instead of gtk_widget_set_allocation(). The GtkWidgetClass::adjust_size_allocation virtual method adjusts the allocation inside gtk_widget_size_allocate() to create an adjusted allocation.

Params:
GtkAllocation* allocation a pointer to a #GtkAllocation to copy from

Since:
2.18

void setAppPaintable (bool appPaintable);
Sets whether the application intends to draw on the widget in an #GtkWidget::draw handler.

This is a hint to the widget and does not affect the behavior of the GTK+ core; many widgets ignore this flag entirely. For widgets that do pay attention to the flag, such as #GtkEventBox and #GtkWindow, the effect is to suppress default themed drawing of the widget's background. (Children of the widget will still be drawn.) The application is then entirely responsible for drawing the widget background.

Note that the background is still drawn when the widget is mapped.

Params:
bool appPaintable %TRUE if the application will paint on the widget

void setCanDefault (bool canDefault);
Specifies whether @widget can be a default widget. See gtk_widget_grab_default() for details about the meaning of “default”.

Params:
bool canDefault whether or not @widget can be a default widget.

Since:
2.18

void setCanFocus (bool canFocus);
Specifies whether @widget can own the input focus. See gtk_widget_grab_focus() for actually setting the input focus on a widget.

Params:
bool canFocus whether or not @widget can own the input focus.

Since:
2.18

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_show().

The child visibility can be set for widget before it is added to a container with gtk_widget_set_parent(), to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of %TRUE when the widget is removed from a container.

Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself.

This function is only useful for container implementations and never should be called by an application.

Params:
bool isVisible if %TRUE, @widget should be mapped along with its parent.

void setClip (GtkAllocation* clip);
Sets the widget’s clip. This must not be used directly, but from within a widget’s size_allocate method.

The clip set should be the area that @widget draws on. If @widget is a #GtkContainer, the area must contain all children's clips.

If this function is not called by @widget during a ::size-allocate handler, it is assumed to be equal to the allocation. However, if the function is not called, certain features that might extend a widget's allocation will not be available:

* The #GtkWidget::draw signal will be clipped to the widget's allocation to avoid overdraw. * Calling gtk_render_background() will not draw outset shadows.

It is therefore suggested that you always call gtk_widget_set_clip() during a ::size-allocate handler.

Params:
GtkAllocation* clip a pointer to a #GtkAllocation to copy from

Since:
3.14

void setCompositeName (string name);
Sets a widgets composite name. The widget must be a composite child of its parent; see gtk_widget_push_composite_child().

Deprecated:
Use gtk_widget_class_set_template(), or don’t use this API at all.

Params:
string name the name to set

void setDeviceEnabled (Device device, bool enabled);
Enables or disables a #GdkDevice to interact with @widget and all its children.

It does so by descending through the #GdkWindow hierarchy and enabling the same mask that is has for core events (i.e. the one that gdk_window_get_events() returns).

Params:
Device device a #GdkDevice
bool enabled whether to enable the device

Since:
3.0

void setDeviceEvents (Device device, GdkEventMask 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_add_device_events() for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with #GTK_NO_WINDOW widgets; to get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.

Params:
Device device a #GdkDevice
GdkEventMask events event mask

Since:
3.0

void setDirection (GtkTextDirection 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).

If the direction is set to %GTK_TEXT_DIR_NONE, then the value set by gtk_widget_set_default_direction() will be used.

Params:
GtkTextDirection dir the new direction

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_begin_paint_region() and gdk_window_end_paint() are called automatically around expose events sent to the widget. gdk_window_begin_paint_region() diverts all drawing to a widget's window to an offscreen buffer, and gdk_window_end_paint() 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.

In very simple terms, double buffered widgets don’t flicker, so you would only use this function to turn off double buffering if you had special needs and really knew what you were doing.

Note:
if you turn off double-buffering, you have to handle expose events, since even the clearing to the background color or pixmap will not happen automatically (as it is done in gdk_window_begin_paint_region()).

Since 3.10 this function only works for widgets with native windows.

Deprecated:
This does not work under non-X11 backends, and it should not be used in newly written code.

Params:
bool doubleBuffered %TRUE to double-buffer a widget

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_add_events() 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_get_has_window()). To get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.

Params:
int events event mask

void setHalign (GtkAlign alig);
Sets the horizontal alignment of @widget. See the #GtkWidget:halign property.

Params:
GtkAlign alig the horizontal alignment

void setHasTooltip (bool hasTooltip);
Sets the has-tooltip property on @widget to @has_tooltip. See #GtkWidget:has-tooltip for more information.

Params:
bool hasTooltip whether or not @widget has a tooltip.

Since:
2.12

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_get_window() 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.

This function should only be called by widget implementations, and they should call it in their init() function.

Params:
bool hasWindow whether or not @widget has a window.

Since:
2.18

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.

Call this function to set the expand flag if you would like your widget to become larger horizontally when the window has extra room.

By default, widgets automatically expand if any of their children want to expand. (To see if a widget will automatically expand given its current children and state, call gtk_widget_compute_expand(). A container can decide how the expandability of children affects the expansion of the container by overriding the compute_expand virtual method on #GtkWidget.).

Setting hexpand explicitly with this function will override the automatic expand behavior.

This function forces the widget to expand or not to expand, regardless of children. The override occurs because gtk_widget_set_hexpand() sets the hexpand-set property (see gtk_widget_set_hexpand_set()) which causes the widget’s hexpand value to be used, rather than looking at children and widget state.

Params:
bool expand whether to expand

void setHexpandSet (bool set);
Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will be used.

The hexpand-set property will be set automatically when you call gtk_widget_set_hexpand() to set hexpand, so the most likely reason to use this function would be to unset an explicit expand flag.

If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.

There are few reasons to use this function, but it’s here for completeness and consistency.

Params:
bool set value for hexpand-set property

void setMapped (bool mapped);
Marks the widget as being realized.

This function should only ever be called in a derived widget's “map” or “unmap” implementation.

Params:
bool mapped %TRUE to mark the widget as mapped

Since:
2.20

void setMarginBottom (int margin);
Sets the bottom margin of @widget. See the #GtkWidget:margin-bottom property.

Params:
int margin the bottom margin

Since:
3.0

void setMarginEnd (int margin);
Sets the end margin of @widget. See the #GtkWidget:margin-end property.

Params:
int margin the end margin

Since:
3.12

void setMarginLeft (int margin);
Sets the left margin of @widget. See the #GtkWidget:margin-left property.

Deprecated:
Use gtk_widget_set_margin_start() instead.

Params:
int margin the left margin

Since:
3.0

void setMarginRight (int margin);
Sets the right margin of @widget. See the #GtkWidget:margin-right property.

Deprecated:
Use gtk_widget_set_margin_end() instead.

Params:
int margin the right margin

Since:
3.0

void setMarginStart (int margin);
Sets the start margin of @widget. See the #GtkWidget:margin-start property.

Params:
int margin the start margin

Since:
3.12

void setMarginTop (int margin);
Sets the top margin of @widget. See the #GtkWidget:margin-top property.

Params:
int margin the top margin

Since:
3.0

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).

Note that the CSS syntax has certain special characters to delimit and represent elements in a selector (period, #, >, *...), so using these will make your widget impossible to match by name. Any combination of alphanumeric symbols, dashes and underscores will suffice.

Params:
string name name for the widget

void setNoShowAll (bool noShowAll);
Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() will affect this widget.

This is mostly for use in constructing widget hierarchies with externally controlled visibility, see #GtkUIManager.

Params:
bool noShowAll the new value for the “no-show-all” property

Since:
2.4

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:

For toplevel widgets this depends on the capabilities of the windowing system. On X11 this has any effect only on X screens with a compositing manager running. See gtk_widget_is_composited(). On Windows it should work always, although setting a window’s opacity after the window has been shown causes it to flicker once on Windows.

For child widgets it doesn’t work if any affected widget has a native window, or disables double buffering.

Params:
double opacity desired opacity, between 0 and 1

Since:
3.8

void setParent (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_unparent().

Params:
Widget parent parent container

void setParentWindow (GdkWin parentWindow);
Sets a non default parent window for @widget.

For #GtkWindow classes, setting a @parent_window effects whether the window is a toplevel window or can be embedded into other widgets.

For #GtkWindow classes, this needs to be called before the window is realized.

Params:
GdkWin parentWindow the new parent window.

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.

This function should only ever be called in a derived widget's “realize” or “unrealize” implementation.

Params:
bool realized %TRUE to mark the widget as realized

Since:
2.20

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.

See gtk_widget_grab_default() for details about the meaning of “default”.

Params:
bool receivesDefault whether or not @widget can be a default widget.

Since:
2.18

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.

Note that for widgets where gtk_widget_get_has_window() is %FALSE setting this flag to %FALSE turns off all allocation on resizing: the widget will not even redraw if its position changes; this is to allow containers that don’t draw anything to avoid excess invalidations. If you set this flag on a widget with no window that does draw on @widget->window, you are responsible for invalidating both the old and new allocation of the widget when the widget is moved and responsible for invalidating regions newly when the widget increases size.

Params:
bool redrawOnAllocate if %TRUE, the entire widget will be redrawn when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn.

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.

Params:
bool sensitive %TRUE to make the widget sensitive

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.

In most cases, gtk_window_set_default_size() is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request. When dealing with window sizes, gtk_window_set_geometry_hints() can be a useful function as well.

Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.

The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.

If the size request in a given direction is -1 (unset), then the “natural” size request of the widget will be used instead.

The size request set here does not include any margin from the #GtkWidget properties margin-left, margin-right, margin-top, and margin-bottom, but it does include pretty much all other padding or border properties set by any subclass of #GtkWidget.

Params:
int width width @widget should request, or -1 to unset
int height height @widget should request, or -1 to unset

void setStateFlags (GtkStateFlags flags, bool clear);
This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.).

This function accepts the values %GTK_STATE_FLAG_DIR_LTR and %GTK_STATE_FLAG_DIR_RTL but ignores them. If you want to set the widget's direction, use gtk_widget_set_direction().

It is worth mentioning that any other state than %GTK_STATE_FLAG_INSENSITIVE, will be propagated down to all non-internal children if @widget is a #GtkContainer, while %GTK_STATE_FLAG_INSENSITIVE itself will be propagated down to all #GtkContainer children by different means than turning on the state flag down the hierarchy, both gtk_widget_get_state_flags() and gtk_widget_is_sensitive() will make use of these.

Params:
GtkStateFlags flags State flags to turn on
bool clear Whether to clear state before turning on @flags

Since:
3.0

void setStyle (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.

Deprecated:
Use #GtkStyleContext instead

Params:
Style style a #GtkStyle, or %NULL to remove the effect of a previous call to gtk_widget_set_style() and go back to the default style

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_set_support_multidevice() will have to be called manually on them.

Params:
bool supportMultidevice %TRUE to support input from multiple devices.

Since:
3.0

void setTooltipMarkup (string markup);
Sets @markup as the contents of the tooltip, which is marked up with the [Pango text markup language][PangoMarkupFormat].

This function will take care of setting #GtkWidget:has-tooltip to %TRUE and of the default handler for the #GtkWidget::query-tooltip signal.

See also the #GtkWidget:tooltip-markup property and gtk_tooltip_set_markup().

Params:
string markup the contents of the tooltip for @widget, or %NULL

Since:
2.12

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.

See also the #GtkWidget:tooltip-text property and gtk_tooltip_set_text().

Params:
string text the contents of the tooltip for @widget

Since:
2.12

void setTooltipWindow (Window customWindow);
Replaces the default, usually yellow, 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.

If the custom window should have the default theming it needs to have the name “gtk-tooltip”, see gtk_widget_set_name().

Params:
Window customWindow a #GtkWindow, or %NULL

Since:
2.12

void setValign (GtkAlign alig);
Sets the vertical alignment of @widget. See the #GtkWidget:valign property.

Params:
GtkAlign alig the vertical alignment

void setVexpand (bool expand);
Sets whether the widget would like any available extra vertical space.

See gtk_widget_set_hexpand() for more detail.

Params:
bool expand whether to expand

void setVexpandSet (bool set);
Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will be used.

See gtk_widget_set_hexpand_set() for more detail.

Params:
bool set value for vexpand-set property

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_get_visible().

This function simply calls gtk_widget_show() or gtk_widget_hide() but is nicer to use when the visibility of the widget depends on some condition.

Params:
bool visible whether the widget should be shown or not

Since:
2.18

void setVisual (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_get_screen(), so handling the #GtkWidget::screen-changed signal is necessary.

Setting a new @visual will not cause @widget to recreate its windows, so you should call this function before @widget is realized.

Params:
Visual visual visual to be used or %NULL to unset a previous one

void setWindow (GdkWin 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_new(), or the window of its parent widget as returned by gtk_widget_get_parent_window().

Widgets must indicate whether they will create their own #GdkWindow by calling gtk_widget_set_has_window(). This is usually done in the widget’s init() function.

Note that this function does not add any reference to @window.

Params:
GdkWin window a #GdkWindow

Since:
2.18

void shapeCombineRegion (Region region);
Sets a shape for this widget’s GDK window. This allows for transparent windows etc., see gdk_window_shape_combine_region() for more information.

Params:
Region region shape to be added, or %NULL to remove an existing shape

Since:
3.0

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_show_all() on the container, instead of individually showing the widgets.

Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.

When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.

void showAll ();
Recursively shows a widget, and any child widgets (if the widget is a container).

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.

void sizeAllocate (GtkAllocation* allocation);
This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets.

In this function, the allocation may be adjusted. It will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual method on the child will be used to adjust the allocation. Standard adjustments include removing the widget’s margins, and applying the widget’s #GtkWidget:halign and #GtkWidget:valign properties.

For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline() instead.

Params:
GtkAllocation* allocation position and size to be allocated to @widget

void sizeAllocateWithBaseline (GtkAllocation* allocation, int baseline);
This function is only used by #GtkContainer subclasses, to assign a size, position and (optionally) baseline to their child widgets.

In this function, the allocation and baseline may be adjusted. It will be forced to a 1x1 minimum size, and the adjust_size_allocation virtual and adjust_baseline_allocation methods on the child will be used to adjust the allocation and baseline. Standard adjustments include removing the widget's margins, and applying the widget’s #GtkWidget:halign and #GtkWidget:valign properties.

If the child widget does not have a valign of %GTK_ALIGN_BASELINE the baseline argument is ignored and -1 is used instead.

Params:
GtkAllocation* allocation position and size to be allocated to @widget
int baseline The baseline of the child, or -1

Since:
3.10

void sizeRequest (out 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_size_allocate().

You can also call this function from an application, with some caveats. Most notably, getting a size request requires the widget to be associated with a screen, because font information may be needed. Multihead-aware applications should keep this in mind.

Also remember that the size request is not necessarily the size a widget will actually be allocated.

Deprecated:
Use gtk_widget_get_preferred_size() instead.

Params:
Requisition requisition a #GtkRequisition to be filled in

void styleAttach ();
This function attaches the widget’s #GtkStyle to the widget's #GdkWindow. It is a replacement for

|[ widget->style = gtk_style_attach (widget->style, widget->window); ]|

and should only ever be called in a derived widget’s “realize” implementation which does not chain up to its parent class' “realize” implementation, because one of the parent classes (finally #GtkWidget) would attach the style itself.

Deprecated:
This step is unnecessary with #GtkStyleContext.

Since:
2.20

void styleGetProperty (string propertyName, Value value);
Gets the value of a style property of @widget.

Params:
string propertyName the name of a style property
Value value location to return the property value

void styleGetValist (string firstPropertyName, void* varArgs);
Non-vararg variant of gtk_widget_style_get(). Used primarily by language bindings.

Params:
string firstPropertyName the name of the first property to get
void* varArgs a va_list of pairs of property names and locations to return the property values, starting with the location for @first_property_name.

void thawChildNotify ();
Reverts the effect of a previous call to gtk_widget_freeze_child_notify(). This causes all queued #GtkWidget::child-notify signals on @widget to be emitted.

bool translateCoordinates (Widget destWidget, int srcX, int srcY, out int destX, out 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.

Params:
Widget destWidget a #GtkWidget
int srcX X position relative to @src_widget
int srcY Y position relative to @src_widget
int destX location to store X position relative to @dest_widget
int destY location to store Y position relative to @dest_widget

Return:
%FALSE if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in *@dest_x and *@dest_y. Otherwise %TRUE.

void triggerTooltipQuery ();
Triggers a tooltip query on the display where the toplevel of @widget is located. See gtk_tooltip_trigger_tooltip_query() for more information.

Since:
2.12

void unmap ();
This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.

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.

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).

void unregisterWindow (GdkWin window);
Unregisters a #GdkWindow from the widget that was previously set up with gtk_widget_register_window(). You need to call this when the window is no longer used by the widget, such as when you destroy it.

Params:
GdkWin window a #GdkWindow

Since:
3.8

void unsetStateFlags (GtkStateFlags flags);
This function is for use in widget implementations. Turns off flag values for the current widget state (insensitive, prelighted, etc.). See gtk_widget_set_state_flags().

Params:
GtkStateFlags flags State flags to turn off

Since:
3.0

void addOnButtonPress (bool delegate(GdkEventButton*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventButton which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnButtonPress (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventButton which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnButtonRelease (bool delegate(GdkEventButton*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventButton which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnButtonRelease (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventButton which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnCanActivateAccel (bool delegate(uint, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This signal is present to allow applications and derived widgets to override the default #GtkWidget handling for determining whether an accelerator can be activated.

Params:
signalId the ID of a signal installed on @widget

Return:
%TRUE if the signal can be activated.

void addOnChildNotify (void delegate(ParamSpec, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal's detail holds the property name.

Params:
childProperty the #GParamSpec of the changed child property

void addOnCompositedChanged (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::composited-changed signal is emitted when the composited status of @widgets screen changes. See gdk_screen_is_composited().

void addOnConfigure (bool delegate(GdkEventConfigure*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::configure-event signal will be emitted when the size, position or stacking of the @widget's window has changed.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventConfigure which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnConfigure (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::configure-event signal will be emitted when the size, position or stacking of the @widget's window has changed.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventConfigure which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnDamage (bool delegate(GdkEventExpose*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Emitted when a redirected window belonging to @widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.

Params:
event the #GdkEventExpose event

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

Since:
2.14

void addOnDamage (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Emitted when a redirected window belonging to @widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.

Params:
event the #GdkEventExpose event

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

Since:
2.14

void addOnDelete (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::delete-event signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Connecting gtk_widget_hide_on_delete() to this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it.

Params:
event the event which triggered this signal

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnDestroy (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.

void addOnDestroyEvent (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::destroy-event signal is emitted when a #GdkWindow is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the event which triggered this signal

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnDirectionChanged (void delegate(GtkTextDirection, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::direction-changed signal is emitted when the text direction of a widget changes.

Params:
previousDirection the previous text direction of @widget

void addOnDragBegin (void delegate(DragContext, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().

Note that some widgets set up a drag icon in the default handler of this signal, so you may have to use g_signal_connect_after() to override what the default handler did.

Params:
context the drag context

void addOnDragDataDelete (void delegate(DragContext, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-data-delete signal is emitted on the drag source when a drag with the action %GDK_ACTION_MOVE is successfully completed. The signal handler is responsible for deleting the data that has been dropped. What "delete" means depends on the context of the drag operation.

Params:
context the drag context

void addOnDragDataGet (void delegate(DragContext, SelectionData, uint, uint, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-data-get signal is emitted on the drag source when the drop site requests the data which is dragged. It is the responsibility of the signal handler to fill @data with the data in the format which is indicated by @info. See gtk_selection_data_set() and gtk_selection_data_set_text().

Params:
context the drag context
data the #GtkSelectionData to be filled with the dragged data
info the info that has been registered with the target in the #GtkTargetList
time the timestamp at which the data was requested

void addOnDragDataReceived (void delegate(DragContext, int, int, SelectionData, uint, uint, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-data-received signal is emitted on the drop site when the dragged data has been received. If the data was received in order to determine whether the drop will be accepted, the handler is expected to call gdk_drag_status() and not finish the drag. If the data was received in response to a #GtkWidget::drag-drop signal (and this is the last target to be received), the handler for this signal is expected to process the received data and then call gtk_drag_finish(), setting the @success parameter depending on whether the data was processed successfully.

Applications must create some means to determine why the signal was emitted and therefore whether to call gdk_drag_status() or gtk_drag_finish().

The handler may inspect the selected action with gdk_drag_context_get_selected_action() before calling gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the following example: |[ void drag_data_received (GtkWidget *widget, GdkDragContext *context, gint x, gint y, GtkSelectionData *data, guint info, guint time) { if ((data->length >= 0) && (data->format == 8)) { GdkDragAction action;

// handle data here

action = gdk_drag_context_get_selected_action (context); if (action == GDK_ACTION_ASK) { GtkWidget *dialog; gint response;

dialog = gtk_message_dialog_new (NULL, GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT, GTK_MESSAGE_INFO, GTK_BUTTONS_YES_NO, "Move the data ?\n"); response = gtk_dialog_run (GTK_DIALOG (dialog)); gtk_widget_destroy (dialog);

if (response == GTK_RESPONSE_YES) action = GDK_ACTION_MOVE; else action = GDK_ACTION_COPY; }

gtk_drag_finish (context, TRUE, action == GDK_ACTION_MOVE, time); } else gtk_drag_finish (context, FALSE, FALSE, time); } ]|

Params:
context the drag context
x where the drop happened
y where the drop happened
data the received data
info the info that has been registered with the target in the #GtkTargetList
time the timestamp at which the data was received

void addOnDragDrop (bool delegate(DragContext, int, int, uint, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-drop signal is emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing is necessary. Otherwise, the handler returns %TRUE. In this case, the handler must ensure that gtk_drag_finish() is called to let the source know that the drop is done. The call to gtk_drag_finish() can be done either directly or in a #GtkWidget::drag-data-received handler which gets triggered by calling gtk_drag_get_data() to receive the data for one or more of the supported targets.

Params:
context the drag context
x the x coordinate of the current cursor position
y the y coordinate of the current cursor position
time the timestamp of the motion event

Return:
whether the cursor position is in a drop zone

void addOnDragEnd (void delegate(DragContext, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-end signal is emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in #GtkWidget::drag-begin.

Params:
context the drag context

void addOnDragFailed (bool delegate(DragContext, GtkDragResult, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-failed signal is emitted on the drag source when a drag has failed. The signal handler may hook custom code to handle a failed DND operation based on the type of error, it returns %TRUE is the failure has been already handled (not showing the default "drag operation failed" animation), otherwise it returns %FALSE.

Params:
context the drag context
result the result of the drag operation

Return:
%TRUE if the failed drag operation has been already handled.

Since:
2.12

void addOnDragLeave (void delegate(DragContext, uint, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-leave signal is emitted on the drop site when the cursor leaves the widget. A typical reason to connect to this signal is to undo things done in #GtkWidget::drag-motion, e.g. undo highlighting with gtk_drag_unhighlight().

Likewise, the #GtkWidget::drag-leave signal is also emitted before the ::drag-drop signal, for instance to allow cleaning up of a preview item created in the #GtkWidget::drag-motion signal handler.

Params:
context the drag context
time the timestamp of the motion event

void addOnDragMotion (bool delegate(DragContext, int, int, uint, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::drag-motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing is necessary. Otherwise, the handler returns %TRUE. In this case, the handler is responsible for providing the necessary information for displaying feedback to the user, by calling gdk_drag_status().

If the decision whether the drop will be accepted or rejected can't be made based solely on the cursor position and the type of the data, the handler may inspect the dragged data by calling gtk_drag_get_data() and defer the gdk_drag_status() call to the #GtkWidget::drag-data-received handler. Note that you cannot not pass #GTK_DEST_DEFAULT_DROP, #GTK_DEST_DEFAULT_MOTION or #GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set() when using the drag-motion signal that way.

Also note that there is no drag-enter signal. The drag receiver has to keep track of whether he has received any drag-motion signals since the last #GtkWidget::drag-leave and if not, treat the drag-motion signal as an "enter" signal. Upon an "enter", the handler will typically highlight the drop site with gtk_drag_highlight(). |[ static void drag_motion (GtkWidget *widget, GdkDragContext *context, gint x, gint y, guint time) { GdkAtom target;

PrivateData *private_data = GET_PRIVATE_DATA (widget);

if (!private_data->drag_highlight) { private_data->drag_highlight = 1; gtk_drag_highlight (widget); }

target = gtk_drag_dest_find_target (widget, context, NULL); if (target == GDK_NONE) gdk_drag_status (context, 0, time); else { private_data->pending_status = gdk_drag_context_get_suggested_action (context); gtk_drag_get_data (widget, context, target, time); }

return TRUE; }

static void drag_data_received (GtkWidget *widget, GdkDragContext *context, gint x, gint y, GtkSelectionData *selection_data, guint info, guint time) { PrivateData *private_data = GET_PRIVATE_DATA (widget);

if (private_data->suggested_action) { private_data->suggested_action = 0;

// We are getting this data due to a request in drag_motion, // rather than due to a request in drag_drop, so we are just // supposed to call gdk_drag_status(), not actually paste in // the data.

str = gtk_selection_data_get_text (selection_data); if (!data_is_acceptable (str)) gdk_drag_status (context, 0, time); else gdk_drag_status (context, private_data->suggested_action, time); } else { // accept the drop } } ]|

Params:
context the drag context
x the x coordinate of the current cursor position
y the y coordinate of the current cursor position
time the timestamp of the motion event

Return:
whether the cursor position is in a drop zone

void addOnEnterNotify (bool delegate(GdkEventCrossing*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::enter-notify-event will be emitted when the pointer enters the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_ENTER_NOTIFY_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventCrossing which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnEnterNotify (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::enter-notify-event will be emitted when the pointer enters the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_ENTER_NOTIFY_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventCrossing which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOn (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The GTK+ main loop will emit three signals for each GDK event delivered to a widget: one generic ::event signal, another, more specific, signal that matches the type of event delivered (e.g. #GtkWidget::key-press-event) and finally a generic #GtkWidget::event-after signal.

Params:
event the #GdkEvent which triggered this signal

Return:
%TRUE to stop other handlers from being invoked for the event and to cancel the emission of the second specific ::event signal. %FALSE to propagate the event further and to allow the emission of the second signal. The ::event-after signal is emitted regardless of the return value.

void addOnEventAfter (void delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
After the emission of the #GtkWidget::event signal and (optionally) the second more specific signal, ::event-after will be emitted regardless of the previous two signals handlers return values.

Params:
event the #GdkEvent which triggered this signal

void addOnFocus (bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnFocusIn (bool delegate(GdkEventFocus*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::focus-in-event signal will be emitted when the keyboard focus enters the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_FOCUS_CHANGE_MASK mask.

Params:
event the #GdkEventFocus which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnFocusIn (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::focus-in-event signal will be emitted when the keyboard focus enters the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_FOCUS_CHANGE_MASK mask.

Params:
event the #GdkEventFocus which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnFocusOut (bool delegate(GdkEventFocus*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::focus-out-event signal will be emitted when the keyboard focus leaves the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_FOCUS_CHANGE_MASK mask.

Params:
event the #GdkEventFocus which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnFocusOut (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::focus-out-event signal will be emitted when the keyboard focus leaves the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_FOCUS_CHANGE_MASK mask.

Params:
event the #GdkEventFocus which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnGrabBroken (bool delegate(GdkEventGrabBroken*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Emitted when a pointer or keyboard grab on a window belonging to @widget gets broken.

On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again.

Params:
event the #GdkEventGrabBroken event

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

Since:
2.8

void addOnGrabBroken (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Emitted when a pointer or keyboard grab on a window belonging to @widget gets broken.

On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again.

Params:
event the #GdkEventGrabBroken event

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

Since:
2.8

void addOnGrabNotify (void delegate(bool, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.

A widget is shadowed by a gtk_grab_add() when the topmost grab widget in the grab stack of its window group is not its ancestor.

Params:
wasGrabbed %FALSE if the widget becomes shadowed, %TRUE if it becomes unshadowed

void addOnHide (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::hide signal is emitted when @widget is hidden, for example with gtk_widget_hide().

void addOnHierarchyChanged (void delegate(Widget, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::hierarchy-changed signal is emitted when the anchored state of a widget changes. A widget is “anchored” when its toplevel ancestor is a #GtkWindow. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa.

Params:
previousToplevel the previous toplevel ancestor, or %NULL if the widget was previously unanchored

void addOnKeyPress (bool delegate(GdkEventKey*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_KEY_PRESS_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventKey which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnKeyPress (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_KEY_PRESS_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventKey which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnKeyRelease (bool delegate(GdkEventKey*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::key-release-event signal is emitted when a key is released.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_KEY_RELEASE_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventKey which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnKeyRelease (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::key-release-event signal is emitted when a key is released.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_KEY_RELEASE_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventKey which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnKeynavFailed (bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Gets emitted if keyboard navigation fails. See gtk_widget_keynav_failed() for details.

Params:
direction the direction of movement

Return:
%TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s).

Since:
2.12

void addOnLeaveNotify (bool delegate(GdkEventCrossing*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::leave-notify-event will be emitted when the pointer leaves the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_LEAVE_NOTIFY_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventCrossing which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnLeaveNotify (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::leave-notify-event will be emitted when the pointer leaves the @widget's window.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_LEAVE_NOTIFY_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventCrossing which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnMap (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::map signal is emitted when @widget is going to be mapped, that is when the widget is visible (which is controlled with gtk_widget_set_visible()) and all its parents up to the toplevel widget are also visible. Once the map has occurred, #GtkWidget::map-event will be emitted.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of #GtkWidget::unmap.

void addOnMapEvent (bool delegate(GdkEventAny*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::map-event signal will be emitted when the @widget's window is mapped. A window is mapped when it becomes visible on the screen.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventAny which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnMapEvent (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::map-event signal will be emitted when the @widget's window is mapped. A window is mapped when it becomes visible on the screen.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventAny which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnMnemonicActivate (bool delegate(bool, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnMotionNotify (bool delegate(GdkEventMotion*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::motion-notify-event signal is emitted when the pointer moves over the widget's #GdkWindow.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_POINTER_MOTION_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventMotion which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnMotionNotify (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::motion-notify-event signal is emitted when the pointer moves over the widget's #GdkWindow.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_POINTER_MOTION_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventMotion which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnParentSet (void delegate(Widget, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::parent-set signal is emitted when a new parent has been set on a widget.

Params:
oldParent the previous parent, or %NULL if the widget just got its initial parent.

void addOnPopupMenu (bool delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
This signal gets emitted whenever a widget should pop up a context menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the #GtkEntry widget creates a menu with clipboard commands. See the [Popup Menu Migration Checklist][checklist-popup-menu] for an example of how to use this signal.

Return:
%TRUE if a menu was activated

void addOnPropertyNotify (bool delegate(GdkEventProperty*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::property-notify-event signal will be emitted when a property on the @widget's window has been changed or deleted.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_PROPERTY_CHANGE_MASK mask.

Params:
event the #GdkEventProperty which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnPropertyNotify (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::property-notify-event signal will be emitted when a property on the @widget's window has been changed or deleted.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_PROPERTY_CHANGE_MASK mask.

Params:
event the #GdkEventProperty which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnProximityIn (bool delegate(GdkEventProximity*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventProximity which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnProximityIn (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventProximity which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnProximityOut (bool delegate(GdkEventProximity*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventProximity which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnProximityOut (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventProximity which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnQueryTooltip (bool delegate(int, int, bool, Tooltip, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Emitted when #GtkWidget:has-tooltip is %TRUE and the hover timeout has expired with the cursor hovering "above" @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case %TRUE should be returned, %FALSE otherwise. Note that if @keyboard_mode is %TRUE, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

Params:
x the x coordinate of the cursor position where the request has been emitted, relative to @widget's left side
y the y coordinate of the cursor position where the request has been emitted, relative to @widget's top
keyboardMode %TRUE if the tooltip was trigged using the keyboard
tooltip a #GtkTooltip

Return:
%TRUE if @tooltip should be shown right now, %FALSE otherwise.

Since:
2.12

void addOnRealize (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::realize signal is emitted when @widget is associated with a #GdkWindow, which means that gtk_widget_realize() has been called or the widget has been mapped (that is, it is going to be drawn).

void addOnScreenChanged (void delegate(Screen, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::screen-changed signal gets emitted when the screen of a widget has changed.

Params:
previousScreen the previous screen, or %NULL if the widget was not associated with a screen before

void addOnScroll (bool delegate(GdkEventScroll*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_SCROLL_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventScroll which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnScroll (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_SCROLL_MASK mask.

This signal will be sent to the grab widget if there is one.

Params:
event the #GdkEventScroll which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnSelectionClear (bool delegate(GdkEventSelection*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::selection-clear-event signal will be emitted when the the @widget's window has lost ownership of a selection.

Params:
event the #GdkEventSelection which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnSelectionClear (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::selection-clear-event signal will be emitted when the the @widget's window has lost ownership of a selection.

Params:
event the #GdkEventSelection which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnSelectionNotify (bool delegate(GdkEventSelection*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnSelectionNotify (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnSelectionRequest (bool delegate(GdkEventSelection*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the @widget's window.

Params:
event the #GdkEventSelection which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnSelectionRequest (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the @widget's window.

Params:
event the #GdkEventSelection which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnShow (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::show signal is emitted when @widget is shown, for example with gtk_widget_show().

void addOnShowHelp (bool delegate(GtkWidgetHelpType, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnStateChanged (void delegate(GtkStateType, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().

Deprecated:
Use #GtkWidget::state-flags-changed instead.

Params:
state the previous state

void addOnStateFlagsChanged (void delegate(GtkStateFlags, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().

Params:
flags The previous state flags.

Since:
3.0

void addOnStyleSet (void delegate(Style, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::style-set signal is emitted when a new style has been set on a widget. Note that style-modifying functions like gtk_widget_modify_base() also cause this signal to be emitted.

Note that this signal is emitted for changes to the deprecated #GtkStyle. To track changes to the #GtkStyleContext associated with a widget, use the #GtkWidget::style-updated signal.

Deprecated:
Use the #GtkWidget::style-updated signal

Params:
previousStyle the previous style, or %NULL if the widget just got its initial style

void addOnStyleUpdated (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::style-updated signal is emitted when the #GtkStyleContext of a widget is changed. Note that style-modifying functions like gtk_widget_override_color() also cause this signal to be emitted.

Since:
3.0

void addOnUnmap (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::unmap signal is emitted when @widget is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

void addOnUnmapEvent (bool delegate(GdkEventAny*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::unmap-event signal will be emitted when the @widget's window is unmapped. A window is unmapped when it becomes invisible on the screen.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventAny which triggered this signal

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnUnmapEvent (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::unmap-event signal will be emitted when the @widget's window is unmapped. A window is unmapped when it becomes invisible on the screen.

To receive this signal, the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventAny which triggered this signal

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnUnrealize (void delegate(Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::unrealize signal is emitted when the #GdkWindow associated with @widget is destroyed, which means that gtk_widget_unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

void addOnVisibilityNotify (bool delegate(GdkEventVisibility*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::visibility-notify-event will be emitted when the @widget's window is obscured or unobscured.

To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.

Deprecated:
Modern composited windowing systems with pervasive transparency make it impossible to track the visibility of a window reliably, so this signal can not be guaranteed to provide useful information.

Params:
event the #GdkEventVisibility which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnVisibilityNotify (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::visibility-notify-event will be emitted when the @widget's window is obscured or unobscured.

To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.

Deprecated:
Modern composited windowing systems with pervasive transparency make it impossible to track the visibility of a window reliably, so this signal can not be guaranteed to provide useful information.

Params:
event the #GdkEventVisibility which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnWindowState (bool delegate(GdkEventWindowState*, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::window-state-event will be emitted when the state of the toplevel window associated to the @widget changes.

To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventWindowState which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

void addOnWindowState (bool delegate(Event, Widget) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::window-state-event will be emitted when the state of the toplevel window associated to the @widget changes.

To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask automatically for all new windows.

Params:
event the #GdkEventWindowState which triggered this signal.

Return:
%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.

static bool cairoShouldDrawWindow (Context cr, GdkWin window);
This function is supposed to be called in #GtkWidget::draw implementations for widgets that support multiple windows. @cr must be untransformed from invoking of the draw function. This function will return %TRUE if the contents of the given @window are supposed to be drawn and %FALSE otherwise. Note that when the drawing was not initiated by the windowing system this function will return %TRUE for all windows, so you need to draw the bottommost window first. Also, do not use “else if” statements to check which window should be drawn.

Params:
Context cr a cairo context
GdkWin window the window to check. @window may not be an input-only window.

Return:
%TRUE if @window should be drawn

Since:
3.0

static void cairoTransformToWindow (Context cr, Widget widget, GdkWin window);
Transforms the given cairo context @cr that from @widget-relative coordinates to @window-relative coordinates. If the @widget’s window is not an ancestor of @window, no modification will be applied.

This is the inverse to the transformation GTK applies when preparing an expose event to be emitted with the #GtkWidget::draw signal. It is intended to help porting multiwindow widgets from GTK+ 2 to the rendering architecture of GTK+ 3.

Params:
Context cr the cairo context to transform
Widget widget the widget the context is currently centered for
GdkWin window the window to transform the context to

Since:
3.0

static int distributeNaturalAllocation (int extraSpace, uint nRequestedSizes, GtkRequestedSize* sizes);
Distributes @extra_space to child @sizes by bringing smaller children up to natural size first.

The remaining space will be added to the @minimum_size member of the GtkRequestedSize struct. If all sizes reach their natural size then the remaining space is returned.

Params:
int extraSpace Extra space to redistribute among children after subtracting minimum sizes and any child padding from the overall allocation
uint nRequestedSizes Number of requests to fit into the allocation
GtkRequestedSize* sizes An array of structs with a client pointer and a minimum/natural size in the orientation of the allocation.

Return:
The remainder of @extra_space after redistributing space to @sizes.

Page was generated with on Sun Mar 15 20:22:36 2015