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.

Returns:

gboolean TRUE if the widget was activatable

Adds widget to container. Typically used for simple containers
such as GtkWindow, GtkFrame, or GtkButton; for more complicated
layout containers such as GtkBox or GtkTable, this function will
pick default packing parameters that may not be correct. So
consider functions such as gtk_box_pack_start() and
gtk_table_attach() as an alternative to gtk_container_add() in
those cases. A widget may be added to only one container at a time;
you can't place the same widget inside two different containers.

Parameters:

Gtk.Widget widget Required (not null)

a widget to be placed inside container

Returns:

none

Installs an accelerator for this widget in accel_group that causes
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_RUN_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.

Parameters:

String accel_signal Required (not null)

widget signal to emit on accelerator activation

Gtk.AccelGroup accel_group Required (not null)

accel group for this widget, added to its toplevel

guint32 accel_key Required (not null)

GDK keyval of the accelerator

Gdk.ModifierType accel_mods Required (not null)

modifier key combination of the accelerator

Gtk.AccelFlags accel_flags Required (not null)

flag accelerators, e.g. GTK_ACCEL_VISIBLE

Returns:

none

Adds a child to buildable. type is an optional string
describing how the child should be added.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

GObject.Object child Required (not null)

child to add

String type

kind of child or NULL

Returns:

none

Adds the device events in the bitfield events to the event mask for

Parameters:

Gdk.Device device Required (not null)

a GdkDevice

Gdk.EventMask events Required (not null)

an event mask, see GdkEventMask

Returns:

none

Adds the events in the bitfield events to the event mask for

Parameters:

gint32 events Required (not null)

an event mask, see GdkEventMask

Returns:

none

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.

Parameters:

Gtk.Widget label Required (not null)

a GtkWidget that acts as a mnemonic label for widget

Returns:

none

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.

Parameters:

guint32 signal_id Required (not null)

the ID of a signal installed on widget

Returns:

gboolean TRUE if the accelerator can be activated.

Returns:

none

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.

Parameters:

Gtk.DirectionType direction Required (not null)

direction of focus movement

Returns:

gboolean TRUE if focus ended up inside widget

Gets the value of a child property for child and container.

Parameters:

Gtk.Widget child Required (not null)

a widget which is a child of container

String property_name Required (not null)

the name of the property to get

GObject.Value value Required (not null)

a location to return the value

Returns:

none

Emits a GtkWidget::child-notify signal for the
child property child_property
on widget.
This is the analogue of g_object_notify() for child properties.

Parameters:

String child_property Required (not null)

the name of a child property installed on the class of widget's parent

Returns:

none

Sets a child property for child and container.

Parameters:

Gtk.Widget child Required (not null)

a widget which is a child of container

String property_name Required (not null)

the name of the property to set

GObject.Value value Required (not null)

the value to set the property to

Returns:

none

Returns the type of the children supported by the container.
Note that this may return G_TYPE_NONE to indicate that no more
children can be added, e.g. for a GtkPaned which already has two
children.

Returns:

Number a GType.

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

Returns:

path_length: guint32

path: String

path_reversed: String

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.

Parameters:

Gtk.Orientation orientation Required (not null)

expand direction

Returns:

gboolean whether widget tree rooted here should be expanded

Constructs a child of buildable with the name name.
GtkBuilder calls this function if a "constructor" has been
specified in the UI definition.

Parameters:

Gtk.Builder builder Required (not null)

GtkBuilder used to construct this object

String name Required (not null)

name of child to construct

Returns:

GObject.Object the constructed child

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

Returns:

Pango.Context the new PangoContext

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, in order to
notify the layout of changes to the base direction or font of this
widget, you must call pango_layout_context_changed() in response to
the GtkWidget::style-updated and GtkWidget::direction-changed signals
for the widget.

Parameters:

String text Required (not null)

text to set on the layout (can be NULL)

Returns:

Pango.Layout the new PangoLayout

This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

the name of the tag

void* data Required (not null)

user data created in custom_tag_start

Returns:

none

This is called at the end of each custom element handled by
the buildable.

Parameters:

Gtk.Builder builder Required (not null)

GtkBuilder used to construct this object

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

name of tag

void* data Required (not null)

user data that will be passed in to parser functions

Returns:

none

This is called for each unknown element under <child>.
if it doesn't.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder used to construct this object

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

name of tag

Object out_values

GLib.MarkupParser parser

void* data

Returns:

gboolean TRUE if a object has a custom implementation, FALSE

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 g_object_ref().
In most cases, only toplevel widgets (windows) require explicit
destruction, because when you destroy a toplevel its children will
be destroyed as well.

Returns:

none

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.

Parameters:

Gtk.Widget widget_pointer Required (not null)

address of a variable that contains widget

Returns:

none

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().
by another GtkWidget than widget.

Parameters:

Gdk.Device device Required (not null)

a GdkDevice

Returns:

gboolean TRUE if there is an ongoing grab on device

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 by GTK+ to get information about the start position of the drag, for
example if the event is a GDK_MOTION_NOTIFY.
Generally there are three cases when you want to start a drag by hand by
calling this function:
1. During a 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 button-press-event handler.
2. During a 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 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.

Parameters:

Gtk.TargetList targets Required (not null)

The targets (data formats) in which the source can provide the data.

Gdk.DragAction actions Required (not null)

A bitmask of the allowed drag actions for this drag.

gint32 button Required (not null)

The button the user clicked to start the drag.

Gdk.Event event Required (not null)

The event that triggered the start of the drag.

Returns:

Gdk.DragContext the context for this drag.

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.

Parameters:

gint32 start_x Required (not null)

X coordinate of start of drag

gint32 start_y Required (not null)

Y coordinate of start of drag

gint32 current_x Required (not null)

current X coordinate

gint32 current_y Required (not null)

current Y coordinate

Returns:

gboolean TRUE if the drag threshold has been passed.

Add the image targets supported by GtkSelection 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().

Returns:

none

Add the text targets supported by GtkSelection 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().

Returns:

none

Add the URI targets supported by GtkSelection 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().

Returns:

none

Looks for a match between the supported targets of context and the
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.
and the dest can accept, or GDK_NONE

Parameters:

Gdk.DragContext context Required (not null)

drag context

Gtk.TargetList target_list

list of droppable targets, or NULL to use gtk_drag_dest_get_target_list (widget).

Returns:

Gdk.Atom first target that the source offers

Returns the list of targets this widget can accept from
drag-and-drop.

Returns:

Gtk.TargetList the GtkTargetList, or NULL if none

Returns whether the widget has been configured to always
emit ::drag-motion signals.

Returns:

gboolean TRUE if the widget always emits ::drag-motion events

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);
}
]|

Parameters:

Gtk.DestDefaults flags Required (not null)

which types of default drag behavior to use

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

gint32 n_targets Required (not null)

the number of entries in targets

Gdk.DragAction actions Required (not null)

a bitmask of possible actions for a drop onto this widget.

Returns:

none

Set up this widget to proxy drags elsewhere.

Parameters:

Gdk.Window proxy_window Required (not null)

window to which forward drag events

Gdk.DragProtocol protocol Required (not null)

Drag protocol which the dest widget accepts

gboolean use_coordinates Required (not null)

If true, send the same coordinates to the destination, because it is a embedded subwindow.

Returns:

none

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

Parameters:

Gtk.TargetList target_list

list of droppable targets, or NULL for none

Returns:

none

Tells the widget to emit ::drag-motion and ::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.

Parameters:

gboolean track_motion Required (not null)

whether to accept all targets

Returns:

none

Unregister this widget as a drag target.

Returns:

none

Get the data for a drag or drop

Parameters:

Gdk.DragContext context Required (not null)

drag context

Gdk.Atom target Required (not null)

format to retrieve the data in.

guint32 time_ Required (not null)

timestamp of triggering event.

Returns:

none

Highlight the given widget in the default manner.

Returns:

none

Add the writable image targets supported by GtkSelection 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().

Returns:

none

Add the text targets supported by GtkSelection 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().

Returns:

none

Add the URI targets supported by GtkSelection 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().

Returns:

none

Gets the list of targets this widget can provide for
drag-and-drop.

Returns:

Gtk.TargetList the GtkTargetList, or NULL if none

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.

Parameters:

Gdk.ModifierType start_button_mask Required (not null)

the bitmask of buttons that can start the drag

Array targets

the table of targets that the drag will support, may be NULL

gint32 n_targets Required (not null)

the number of items in targets

Gdk.DragAction actions Required (not null)

the bitmask of possible actions for a drag from this widget

Returns:

none

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.

Parameters:

String icon_name Required (not null)

name of icon to use

Returns:

none

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.

Parameters:

GdkPixbuf.Pixbuf pixbuf Required (not null)

the GdkPixbuf for the drag icon

Returns:

none

Sets the icon that will be used for drags from a particular source
to a stock icon.

Parameters:

String stock_id Required (not null)

the ID of the stock icon to use

Returns:

none

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

Parameters:

Gtk.TargetList target_list

list of draggable targets, or NULL for none

Returns:

none

Unregister this widget as a drag source.

Returns:

none

Refresh the given widget to remove the highlight.

Returns:

none

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

Parameters:

cairo.Context cr Required (not null)

a cairo context to draw to

Returns:

none

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.

Returns:

none

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.

Returns:

none

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.
the event was handled)

Parameters:

Gdk.Event event Required (not null)

a GdkEvent

Returns:

gboolean return from the event signal emission (TRUE if

Invokes callback on each child of container, including children
that are considered "internal" (implementation details of the
container). "Internal" children generally weren't added by the user
of the container, but were added by the container implementation
itself. Most applications should use gtk_container_foreach(),
rather than gtk_container_forall().

Parameters:

Function (Widget widget, void* data) : none Required (not null)

a callback

void* callback_data Required (not null)

callback user data

Returns:

none

Invokes callback on each non-internal child of container. See
gtk_container_forall() for details on what constitutes an
"internal" child. Most applications should use
gtk_container_foreach(), rather than gtk_container_forall().

Parameters:

Function (Widget widget, void* data) : none Required (not null)

a callback

void* callback_data Required (not null)

callback user data

Returns:

none

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.

Returns:

none

Returns the accessible object that describes the widget to an
assistive technology.
If no accessibility library is loaded (i.e. no ATK implementation library is
loaded via GTK_MODULES or via another application library,
such as libgnome), then 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
library contains more information about accessible objects and their uses.

Returns:

Atk.Object the AtkObject associated with widget

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.

Returns:

gint32 the height of the widget

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.

Returns:

gint32 the width of the widget

Retrieves the widget's allocation.
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.

Returns:

cairo.RectangleInt

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.

Parameters:

Number widget_type Required (not null)

ancestor type

Returns:

Gtk.Widget the ancestor widget, or NULL if not found

Determines whether the application intends to draw on the widget in
an GtkWidget::draw handler.
See gtk_widget_set_app_paintable()

Returns:

gboolean TRUE if the widget is app paintable

Retrieves the border width of the container. See
gtk_container_set_border_width().

Returns:

guint32 the current border width

Determines whether widget can be a default widget. See
gtk_widget_set_can_default().

Returns:

gboolean TRUE if widget can be a default widget, FALSE otherwise

Determines whether widget can own the input focus. See
gtk_widget_set_can_focus().

Returns:

gboolean TRUE if widget can own the input focus, FALSE otherwise

This function is only for use in widget implementations. Obtains
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().

Returns:

Gtk.Requisition

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.

Returns:

gboolean TRUE if the widget is mapped with the parent.

Returns the container's non-internal children. See
gtk_container_forall() for details on what constitutes an "internal" child.

Returns:

Array a newly-allocated list of the container's non-internal children.

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.
clipboard already exists, a new one will
be created. Once a clipboard object has
been created, it is persistent for all time.

Parameters:

Gdk.Atom selection Required (not null)

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.

Returns:

Gtk.Clipboard the appropriate clipboard object. If no

Obtains the composite name of a widget.
a composite child. The string should be freed when it is no
longer needed.

Returns:

String the composite name of widget, or NULL if widget is not

Returns whether device can interact with widget and its
children. See gtk_widget_set_device_enabled().

Parameters:

Gdk.Device device Required (not null)

a GdkDevice

Returns:

gboolean TRUE is device is enabled for widget

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.

Parameters:

Gdk.Device device Required (not null)

a GdkDevice

Returns:

Gdk.EventMask device event mask for widget

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

Returns:

Gtk.TextDirection the reading direction for the widget.

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.

Returns:

Gdk.Display the GdkDisplay for the toplevel for this widget.

Determines whether the widget is double buffered.
See gtk_widget_set_double_buffered()

Returns:

gboolean TRUE if the widget is double buffered

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

Returns:

gint32 event mask for widget

Retrieves the focus chain of the container, if one has been
set explicitly. If no focus chain has been explicitly
set, GTK+ computes the focus chain based on the positions
of the children. In that case, GTK+ stores NULL in
has been set explicitly.

Parameters:

Object out_values

Array focusable_widgets

Returns:

gboolean TRUE if the focus chain of the container

Returns the current focus child widget inside container. This is not the
currently focused widget. That can be obtained by calling
gtk_window_get_focus().
focus inside container when the conatiner is focussed,
or NULL if none is set.

Returns:

Gtk.Widget The child widget which will receive the

Retrieves the horizontal focus adjustment for the container. See
gtk_container_set_focus_hadjustment ().
none has been set.

Returns:

Gtk.Adjustment the horizontal focus adjustment, or NULL if

Retrieves the vertical focus adjustment for the container. See
gtk_container_set_focus_vadjustment().
none has been set.

Returns:

Gtk.Adjustment the vertical focus adjustment, or NULL if

Gets the value of the GtkWidget:halign property.

Returns:

Gtk.Align the horizontal alignment of widget

Returns the current value of the has-tooltip property. See
GtkWidget:has-tooltip for more information.

Returns:

gboolean current value of has-tooltip on widget.

Determines whether widget has a GdkWindow of its own. See
gtk_widget_set_has_window().

Returns:

gboolean TRUE if widget has a window, FALSE otherwise

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.

Returns:

gboolean whether hexpand flag is set

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.

Returns:

gboolean whether hexpand has been explicitly set

Returns whether the box is homogeneous (all children are the
same size). See gtk_box_set_homogeneous().

Returns:

gboolean TRUE if the box is homogeneous.

Get the internal child called childname of the buildable object.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

String childname Required (not null)

name of child

Returns:

GObject.Object the internal child of the buildable object

Whether the widget is mapped.

Returns:

gboolean TRUE if the widget is mapped, FALSE otherwise.

Gets the value of the GtkWidget:margin-bottom property.

Returns:

gint32 The bottom margin of widget

Gets the value of the GtkWidget:margin-left property.

Returns:

gint32 The left margin of widget

Gets the value of the GtkWidget:margin-right property.

Returns:

gint32 The left margin of widget

Gets the value of the GtkWidget:margin-top property.

Returns:

gint32 The top margin of widget

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

Returns:

Gtk.RcStyle the modifier style for the widget.

Retrieves the name of a widget. See gtk_widget_set_name() for the
significance of widget names.
should not be modified or freed

Returns:

String name of the widget. This string is owned by GTK+ and

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

Returns:

gboolean the current value of the "no-show-all" property.

Retrieves the orientation of the orientable.

Returns:

Gtk.Orientation the orientation of the orientable.

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.
If you create and keep a PangoLayout using this context, you must
deal with changes to the context by calling pango_layout_context_changed()
on the layout in response to the GtkWidget::style-updated and
GtkWidget::direction-changed signals for the widget.

Returns:

Pango.Context the PangoContext for the widget.

Returns the parent container of widget.

Returns:

Gtk.Widget the parent container of widget, or NULL

Gets widget's parent window.

Returns:

Gdk.Window the parent window of widget.

Returns the GtkWidgetPath representing widget, if the widget
is not connected to a toplevel widget, a partial path will be
created.

Returns:

Gtk.WidgetPath The GtkWidgetPath representing widget

Returns a newly created widget path representing all the widget hierarchy
from the toplevel down to child (this one not being included).

Parameters:

Gtk.Widget child Required (not null)

a child of container

Returns:

Gtk.WidgetPath A newly created GtkWidgetPath

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,

Returns:

x: gint32

y: gint32

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.

Returns:

minimum_height: gint32

natural_height: gint32

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.

Parameters:

gint32 width Required (not null)

the width which is available for allocation

Returns:

minimum_height: gint32

natural_height: gint32

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.

Returns:

minimum_size: Gtk.Requisition

natural_size: Gtk.Requisition

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.

Returns:

minimum_width: gint32

natural_width: gint32

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.

Parameters:

gint32 height Required (not null)

the height which is available for allocation

Returns:

minimum_width: gint32

natural_width: gint32

Determines whether widget is realized.

Returns:

gboolean TRUE if widget is realized, FALSE otherwise

Determines whether widget is alyways treated as default widget
withing its toplevel when it has the focus, even if another widget
is the default.
See gtk_widget_set_receives_default().
FALSE otherwise

Returns:

gboolean TRUE if widget acts as default widget when focussed,

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.

Returns:

Gtk.SizeRequestMode The GtkSizeRequestMode preferred by widget.

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.
removed, If you need to cache sizes across requests and allocations,
add an explicit cache to the widget in question instead.

Returns:

Gtk.Requisition

Returns the resize mode for the container. See
gtk_container_set_resize_mode ().

Returns:

Gtk.ResizeMode the current resize mode

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.

Returns:

Gdk.Window the GdkWindow root window for the toplevel for this widget.

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.

Returns:

Gdk.Screen the GdkScreen for the toplevel for this widget.

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

Returns:

gboolean TRUE if the widget is sensitive

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.

Returns:

Gtk.Settings the relevant GtkSettings object

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

Returns:

width: gint32

height: gint32

Gets the value set by gtk_box_set_spacing().

Returns:

gint32 spacing between children

Returns the widget's state. See gtk_widget_set_state().

Returns:

Gtk.StateType the state of widget.

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

Returns:

Gtk.StateFlags The state flags for widget

Simply an accessor function that returns widget->style.

Returns:

Gtk.Style the widget's GtkStyle

Returns the style context associated to widget.
must not be freed.

Returns:

Gtk.StyleContext a GtkStyleContext. This memory is owned by widget and

Returns TRUE if widget is multiple pointer aware. See
gtk_widget_set_support_multidevice() for more information.

Returns:

gboolean TRUE if widget is multidevice aware.

Gets the contents of the tooltip for widget.
returned string with g_free() when done.

Returns:

String the tooltip text, or NULL. You should free the

Gets the contents of the tooltip for widget.
returned string with g_free() when done.

Returns:

String the tooltip text, or NULL. You should free the

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

Returns:

Gtk.Window The GtkWindow of the current tooltip.

This function returns the topmost widget in the container hierarchy
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 check if the TOPLEVEL flags
is set on the result.
|[
GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
if (gtk_widget_is_toplevel (toplevel))
{
/* Perform action on toplevel. */
}
]|
if there's no ancestor.

Returns:

Gtk.Widget the topmost ancestor of widget, or widget itself

Gets the value of the GtkWidget:valign property.

Returns:

Gtk.Align the vertical alignment of widget

Gets whether the widget would like any available extra vertical
space.
See gtk_widget_get_hexpand() for more detail.

Returns:

gboolean whether vexpand flag is set

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.

Returns:

gboolean whether vexpand has been explicitly set

Determines whether the widget is visible. Note that this doesn't
take into account whether the widget's parent is also visible
or the widget is obscured in any way.
See gtk_widget_set_visible().

Returns:

gboolean TRUE if the widget is visible

Gets the visual that will be used to render widget.

Returns:

Gdk.Visual the visual for widget

Returns the widget's window if it is realized, NULL otherwise

Returns:

Gdk.Window widget's window.

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.

Returns:

none

Causes widget to become the default widget. widget must have the
GTK_CAN_DEFAULT flag set; typically you have to set this flag
yourself by calling gtk_widget_set_can_default (widget,
TRUE). 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.

Returns:

none

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.

Returns:

none

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.

Returns:

none

Determines whether widget is the current default widget within its
toplevel. See gtk_widget_set_can_default().
its toplevel, FALSE otherwise

Returns:

gboolean TRUE if widget is the current default widget within

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.

Returns:

gboolean TRUE if the widget has the global input focus.

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

Returns:

gboolean TRUE if the widget is in the grab_widgets stack

Determines if the widget style has been looked up through the rc mechanism.
mechanism, FALSE otherwise.

Returns:

gboolean TRUE if the widget has been looked up through the rc

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.
with the widget.

Returns:

gboolean TRUE if there is a GdkScreen associcated

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

Returns:

none

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.

Returns:

gboolean TRUE

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

Returns:

gboolean TRUE if widget is being destroyed

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.

Parameters:

cairo.Region region

shape to be added, or NULL to remove an existing shape

Returns:

none

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.

Parameters:

cairo.RectangleInt area Required (not null)

a rectangle

cairo.RectangleInt intersection Required (not null)

rectangle to store intersection of widget and area

Returns:

gboolean TRUE if there was an intersection

Determines whether widget is somewhere inside ancestor, possibly with
intermediate containers.
grandchild, great grandchild, etc.

Parameters:

Gtk.Widget ancestor Required (not null)

another GtkWidget

Returns:

gboolean TRUE if ancestor contains widget as a child,

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()).
channel being drawn correctly.

Returns:

gboolean TRUE if the widget can rely on its alpha

Determines whether widget can be drawn to. A widget can be drawn
to if it is mapped and visible.

Returns:

gboolean TRUE if widget is drawable, FALSE otherwise

Determines if the widget is the focus widget within its
toplevel. (This does not mean that the HAS_FOCUS flag is
necessarily set; HAS_FOCUS will only be set if the
toplevel widget additionally has the global input focus.)

Returns:

gboolean TRUE if the widget is the focus widget.

Returns the widget's effective sensitivity, which means
it is sensitive itself and also its parent widget is sensitive

Returns:

gboolean TRUE if the widget is effectively sensitive

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.

Returns:

gboolean TRUE if widget is a toplevel, FALSE otherwise

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 looks at the
GtkSettings:gtk-keynav-cursor-only setting and returns FALSE
if the setting is TRUE. This way the entire user interface
becomes cursor-navigatable on input devices such as mobile phones
which only have cursor keys but no tab key.
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.
if the emitting widget should try to handle the keyboard
navigation attempt in its parent container(s).

Parameters:

Gtk.DirectionType direction Required (not null)

direction of focus movement

Returns:

gboolean TRUE if stopping keyboard navigation is fine, FALSE

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().
a newly allocated GList of closures

Returns:

Array

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.
mnemonic labels; free this list
with g_list_free() when you are done with it.

Returns:

Array the list of

This function is only for use in widget implementations. Causes
a widget to be mapped if it isn't already.

Returns:

none

Emits the GtkWidget::mnemonic-activate signal.
The default handler for this signal activates the widget if
is TRUE.

Parameters:

gboolean group_cycling Required (not null)

TRUE if there are other widgets with the same mnemonic

Returns:

gboolean TRUE if the signal has been handled

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.

Parameters:

Gtk.StateType state Required (not null)

the state for which to set the base color

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

Returns:

none

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.

Parameters:

Gtk.StateType state Required (not null)

the state for which to set the background color

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

Returns:

none

Sets the cursor color to use in a widget, overriding the
GtkWidget:cursor-color and GtkWidget:secondary-cursor-color
style properties.
All other style values are left untouched.
See also gtk_widget_modify_style().

Parameters:

Gdk.Color primary Required (not null)

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

Gdk.Color secondary Required (not null)

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

Returns:

none

Sets the foreground color for a widget in a particular state.
All other style values are left untouched.
See also gtk_widget_modify_style().

Parameters:

Gtk.StateType state Required (not null)

the state for which to set the foreground color

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

Returns:

none

Sets the font to use for a widget.
All other style values are left untouched.
See also gtk_widget_modify_style().

Parameters:

Pango.FontDescription font_desc

the font description to use, or NULL to undo the effect of previous calls to gtk_widget_modify_font()

Returns:

none

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 explicitely set on the widget using gtk_widget_set_style().
The GtkRcStyle structure 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.

Parameters:

Gtk.RcStyle style Required (not null)

the GtkRcStyle holding the style modifications

Returns:

none

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

Parameters:

Gtk.StateType state Required (not null)

the state for which to set the text color

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

Returns:

none

Sets the background color to use for a widget.
All other style values are left untouched.
See gtk_widget_override_color().

Parameters:

Gtk.StateFlags state Required (not null)

the state for which to set the background color

Gdk.RGBA color Required (not null)

the color to assign, or NULL to undo the effect of previous calls to gtk_widget_override_background_color()

Returns:

none

Sets the color to use for a widget.
All other style values are left untouched.

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.

Parameters:

Gtk.StateFlags state Required (not null)

the state for which to set the color

Gdk.RGBA color Required (not null)

the color to assign, or NULL to undo the effect of previous calls to gtk_widget_override_color()

Returns:

none

Sets the cursor color to use in a widget, overriding the
GtkWidget:cursor-color and GtkWidget: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.

Parameters:

Gdk.RGBA cursor Required (not null)

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

Gdk.RGBA secondary_cursor Required (not null)

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

Returns:

none

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

Parameters:

Pango.FontDescription font_desc Required (not null)

the font descriptiong to use, or NULL to undo the effect of previous calls to gtk_widget_override_font()

Returns:

none

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.

Parameters:

String name Required (not null)

the name of the symbolic color to modify

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

Returns:

none

Adds child to box, packed with reference to the end of box.
The child is packed after (away from end of) any other child
packed with reference to the end of box.

Parameters:

Gtk.Widget child Required (not null)

the GtkWidget to be added to box

gboolean expand Required (not null)

TRUE if the new child is to be given extra space allocated to box. The extra space will be divided evenly between all children of box that use this option

gboolean fill Required (not null)

TRUE if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to FALSE. A child is always allocated the full height of a GtkHBox and the full width of a GtkVBox. This option affects the other dimension

guint32 padding Required (not null)

extra space in pixels to put between this child and its neighbors, over and above the global amount specified by GtkBox:spacing property. If child is a widget at one of the reference ends of box, then padding pixels are also put between

Returns:

none

Adds child to box, packed with reference to the start of box.
The child is packed after any other child packed with reference
to the start of box.

Parameters:

Gtk.Widget child Required (not null)

the GtkWidget to be added to box

gboolean expand Required (not null)

TRUE if the new child is to be given extra space allocated to box. The extra space will be divided evenly between all children that use this option

gboolean fill Required (not null)

TRUE if space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to FALSE. A child is always allocated the full height of a GtkHBox and the full width of a GtkVBox. This option affects the other dimension

guint32 padding Required (not null)

extra space in pixels to put between this child and its neighbors, over and above the global amount specified by GtkBox:spacing property. If child is a widget at one of the reference ends of box, then padding pixels are also put between

Returns:

none

Called when the builder finishes the parsing of a
GtkBuilder UI definition.
Note that this will be called once for each time
gtk_builder_add_from_file() or gtk_builder_add_from_string()
is called on a builder.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

Returns:

none

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.

Returns:

path_length: guint32

path: String

path_reversed: String

When a container receives a call to the draw function, it must send
synthetic GtkWidget::draw calls to all children that don't have their
own GdkWindows. This function provides a convenient way of doing this.
A container, when it receives a call to its GtkWidget::draw function,
calls gtk_container_propagate_draw() once for each child, passing in
the cr the container received.
gtk_container_propagate_draw() takes care of translating the origin of cr,
and deciding whether the draw needs to be sent to the child. It is a
convenient and optimized way of getting the same effect as calling
gtk_widget_draw() on the child directly.
In most cases, a container can simply either inherit the
GtkWidget::draw implementation from GtkContainer, or do some drawing
and then chain to the ::draw implementation from GtkContainer.

Parameters:

Gtk.Widget child Required (not null)

a child of container

cairo.Context cr Required (not null)

Cairo context as passed to the container. If you want to use cr in container's draw function, consider using cairo_save() and cairo_restore() before calling this function.

Returns:

none

Obtains information about how child is packed into box.

Parameters:

Gtk.Widget child Required (not null)

the GtkWidget of the child to query

Returns:

expand: gboolean

fill: gboolean

padding: guint32

pack_type: Gtk.PackType

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

Returns:

none

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

Returns:

none

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,

Parameters:

gint32 x Required (not null)

x coordinate of upper-left corner of rectangle to redraw

gint32 y Required (not null)

y coordinate of upper-left corner of rectangle to redraw

gint32 width Required (not null)

width of region to draw

gint32 height Required (not null)

height of region to draw

Returns:

none

Invalidates the rectangular 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.

Parameters:

cairo.Region region Required (not null)

region to draw

Returns:

none

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

Returns:

none

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

Returns:

none

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

Returns:

none

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.

Parameters:

cairo.Region region Required (not null)

a cairo_region_t, in the same coordinate system as for NO_WINDOW widgets; relative to the parent window of widget->window for widgets with their own window.

Returns:

cairo.Region 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.

Removes widget from container. widget must be inside container.
Note that container will own a reference to widget, and that this
may be the last reference held; so removing a widget from its
container can destroy that widget. If you want to use widget
again, you need to add a reference to it while it's not inside
a container, using g_object_ref(). If you don't want to use widget
again it's usually more efficient to simply destroy it directly
using gtk_widget_destroy() since this will remove it from the
container and help break any circular reference count cycles.

Parameters:

Gtk.Widget widget Required (not null)

a current child of container

Returns:

none

Removes an accelerator from widget, previously installed with
gtk_widget_add_accelerator().

Parameters:

Gtk.AccelGroup accel_group Required (not null)

accel group for this widget

guint32 accel_key Required (not null)

GDK keyval of the accelerator

Gdk.ModifierType accel_mods Required (not null)

modifier key combination of the accelerator

Returns:

gboolean whether an accelerator was installed and could be removed

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

Parameters:

Gtk.Widget label Required (not null)

a GtkWidget that was previously set as a mnemnic label for

Returns:

none

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().
stock ID wasn't known

Parameters:

String stock_id Required (not null)

a stock ID

gint32 size Required (not null)

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

Returns:

GdkPixbuf.Pixbuf a new pixbuf, or NULL if the

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().
stock ID wasn't known

Parameters:

String stock_id Required (not null)

a stock ID

gint32 size Required (not null)

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

Returns:

GdkPixbuf.Pixbuf a new pixbuf, or NULL if the

Moves child to a new position in the list of box children.
The list is the children field of
GtkBox-struct, and contains both widgets packed GTK_PACK_START
as well as widgets packed GTK_PACK_END, in the order that these
widgets were added to box.
A widget's position in the box children list determines where
the widget is packed into box. A child widget at some position
in the list will be packed just after all other widgets of the
same packing type that appear earlier in the list.

Parameters:

Gtk.Widget child Required (not null)

the GtkWidget to move

gint32 position Required (not null)

the new position for child in the list of children of box, starting from 0. If negative, indicates the end of the list

Returns:

none

Moves a widget from one GtkContainer to another, handling reference
count issues to avoid destroying the widget.

Parameters:

Gtk.Widget new_parent Required (not null)

a GtkContainer to move the widget into

Returns:

none

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.

Returns:

none

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

Returns:

none

Returns:

none

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().
the event was handled)

Parameters:

Gdk.Event event Required (not null)

a expose GdkEvent

Returns:

gint32 return from the event signal emission (TRUE if

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);
]|
if the event was handled, and FALSE otherwise

Parameters:

Gdk.Event event Required (not null)

a GdkEvent of type GDK_FOCUS_CHANGE

Returns:

gboolean the return value from the event signal emission: TRUE

Given an accelerator group, accel_group, and an accelerator path,
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().

Parameters:

String accel_path

path used to look up the accelerator

Gtk.AccelGroup accel_group

a GtkAccelGroup.

Returns:

none

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.

Parameters:

cairo.RectangleInt allocation Required (not null)

a pointer to a GtkAllocation to copy from

Returns:

none

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.

Parameters:

gboolean app_paintable Required (not null)

TRUE if the application will paint on the widget

Returns:

none

Sets the border width of the container.
The border width of a container is the amount of space to leave
around the outside of the container. The only exception to this is
GtkWindow; because toplevel windows can't leave space outside,
they leave the space inside. The border is added on all sides of
the container. To add space to only one side, one approach is to
create a GtkAlignment widget, call gtk_widget_set_size_request()
to give it a size, and place it on the side of the container as
a spacer.

Parameters:

guint32 border_width Required (not null)

amount of blank space to leave outside the container. Valid values are in the range 0-65535 pixels.

Returns:

none

Sets the property name name to value on the buildable object.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

String name Required (not null)

name of property

GObject.Value value Required (not null)

value of property

Returns:

none

Specifies whether widget can be a default widget. See
gtk_widget_grab_default() for details about the meaning of
"default".

Parameters:

gboolean can_default Required (not null)

whether or not widget can be a default widget.

Returns:

none