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:

Boolean

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)

Returns:

none

Parameters:

String accel_signal Required (not null)

Gtk.AccelGroup accel_group Required (not null)

Number accel_key Required (not null)

Gdk.ModifierType accel_mods Required (not null)

Gtk.AccelFlags accel_flags Required (not null)

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)

GObject.Object child Required (not null)

String type

kind of child or NULL

Returns:

none

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

Parameters:

Number events Required (not null)

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)

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:

Number signal_id Required (not null)

Returns:

Boolean

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. This function replaces gtk_container_focus() from GTK+ 1.2. It was necessary to check that the child was visible, sensitive, and focusable before calling gtk_container_focus(). gtk_widget_child_focus() returns FALSE if the widget is not currently in a focusable state, so there's no need for those checks.

Parameters:

Gtk.DirectionType direction Required (not null)

Returns:

Boolean

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

Parameters:

Gtk.Widget child Required (not null)

String property_name Required (not null)

GObject.Value value Required (not null)

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)

class of widget's parent

Returns:

none

Sets a child property for child and container.

Parameters:

Gtk.Widget child Required (not null)

String property_name Required (not null)

GObject.Value value Required (not null)

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

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

path: String

path_reversed: String

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)

String name Required (not null)

Returns:

GObject.Object

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

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-set and GtkWidget::direction-changed signals for the widget.

Parameters:

String text Required (not null)

Returns:

Pango.Layout

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)

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

void* data Required (not null)

Returns:

none

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

Parameters:

Gtk.Builder builder Required (not null)

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

void* data Required (not null)

Returns:

none

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

Parameters:

Gtk.Builder builder Required (not null)

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

GLib.MarkupParser parser Required (not null)

void* data Required (not null)

to parser functions

Returns:

Boolean

Destroys a widget. Equivalent to gtk_object_destroy(), except that you don't have to cast the widget to GtkObject. 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

In GTK+ 1.2, this function would immediately render the region area of a widget, by invoking the virtual draw method of a widget. In GTK+ 2.0, the draw method is gone, and instead gtk_widget_draw() simply invalidates the specified region of the widget, then updates the invalid region of the widget immediately. Usually you don't want to update the region immediately for performance reasons, so in general gtk_widget_queue_draw_area() is a better choice if you want to draw a region of a widget.

Parameters:

Gdk.Rectangle area Required (not null)

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)

Returns:

Boolean

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)

void* callback_data Required (not null)

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)

void* callback_data Required (not null)

Returns:

none

Parameters:

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

Function (Object object, void* data, Number n_args, Arg args) : none Required (not null)

void* callback_data Required (not null)

Function (void* data) : none Required (not null)

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 GtkAction that widget is a proxy for. See also gtk_action_get_proxies(). NULL, if it is not attached to an action.

Returns:

Gtk.Action

Retrieves the widget's allocation.

Returns:

Gdk.Rectangle

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)

Returns:

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

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

Returns:

Boolean

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

Returns:

Number

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

Returns:

Boolean

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

Returns:

Boolean

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

Parameters:

Gtk.Requisition requisition Required (not null)

Returns:

none

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:

Boolean

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)

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

Gets the colormap that will be used to render widget. No reference will be added to the returned colormap; it should not be unreferenced.

Returns:

Gdk.Colormap the colormap used by widget

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

Returns:

String

Parameters:

String key Required (not null)

Returns:

void*

Parameters:

Number data_id Required (not null)

Returns:

void*

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

Returns:

Gtk.TextDirection

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:

Boolean

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:

Number

Retrieves the extension events the widget will receive; see gdk_input_set_extension_events().

Returns:

Gdk.ExtensionMode

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:

Boolean

Returns the current focus child widget inside container. inside container, or NULL if none is set.

Returns:

Gtk.Widget

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

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

Returns:

Boolean

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

Returns:

Boolean

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

Returns:

Boolean

Get the internal child called childname of the buildable object.

Parameters:

Gtk.Builder builder Required (not null)

String childname Required (not null)

Returns:

GObject.Object

Whether the widget is mapped.

Returns:

Boolean

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. 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. This rc style is

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

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

Returns:

Boolean

Retrieves the orientation of the orientable.

Returns:

Gtk.Orientation

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

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

y: Number

Determines whether widget is realized.

Returns:

Boolean

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:

Boolean

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.

Returns:

Gtk.Requisition

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

Returns:

Gtk.ResizeMode

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:

Boolean

Gets the settings object holding the settings (global property settings, RC file information, etc) 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 use, call gtk_widget_size_request() instead of this function.

Returns:

width: Number

height: Number

Create a GdkPixmap of the contents of the widget and its children. Works even if the widget is obscured. The depth and visual of the resulting pixmap is dependent on the widget being snapshot and likely differs from those of a target widget displaying the pixmap. The function gdk_pixbuf_get_from_drawable() can be used to convert the pixmap to a visual independant representation. The snapshot area used by this function is the widget's allocation plus any extra space occupied by additional windows belonging to this widget (such as the arrows of a spin button). Thus, the resulting snapshot pixmap is possibly larger than the allocation. If clip_rect is non-NULL, the resulting pixmap is shrunken to match the specified clip_rect. The (x,y) coordinates of clip_rect are interpreted widget relative. If width or height of clip_rect are 0 or negative, the width or height of the resulting pixmap will be shrunken by the respective amount. For instance a clip_rect { +5, +5, -10, -10 } will chop off 5 pixels at each side of the snapshot pixmap. If non-NULL, clip_rect will contain the exact widget-relative snapshot coordinates upon return. A clip_rect of { -1, -1, 0, 0 } can be used to preserve the auto-grown snapshot area and use clip_rect as a pure output parameter. The returned pixmap can be NULL, if the resulting clip_area was empty.

Parameters:

Gdk.Rectangle clip_rect

a GdkRectangle or NULL

Returns:

Gdk.Pixmap

Gets the value set by gtk_box_set_spacing().

Returns:

Number

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

Returns:

Gtk.StateType

Simply an accessor function that returns widget->style.

Returns:

Gtk.Style the widget's GtkStyle

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

Returns:

String

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

Returns:

String

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

Returns:

void*

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:

Boolean

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

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.

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.

Returns:

none

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

Returns:

Boolean

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:

Boolean

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:

Boolean

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

Returns:

Boolean

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:

Boolean

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

Returns:

none

Recursively hides a widget and any child widgets.

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:

Boolean

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_mask() for more information.

Parameters:

Gdk.Bitmap shape_mask

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

Number offset_x Required (not null)

Number offset_y Required (not null)

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:

Gdk.Rectangle area Required (not null)

Gdk.Rectangle intersection Required (not null)

Returns:

Boolean

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

Parameters:

Gtk.Widget ancestor Required (not null)

Returns:

Boolean

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:

Boolean

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

Returns:

Boolean

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:

Boolean

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

Returns:

Boolean

Determines whether widget is a toplevel widget. Currently only GtkWindow and GtkInvisible are toplevel widgets. Toplevel widgets have no parent widget.

Returns:

Boolean

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)

Returns:

Boolean

Returns a newly allocated list of the widgets, normally labels, for which this widget is a 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:

Boolean group_cycling Required (not null)

Returns:

Boolean

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)

Gdk.Color color

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)

Gdk.Color color

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)

allocated), or NULL to undo the effect of previous calls to of gtk_widget_modify_cursor().

Gdk.Color secondary Required (not null)

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)

Gdk.Color color

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

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)

Gdk.Color color

or NULL to undo the effect of previous calls to of gtk_widget_modify_text().

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)

Boolean expand Required (not null)

to box. The extra space will be divided evenly between all children of box that use this option

Boolean fill Required (not null)

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

Number padding Required (not null)

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 widget to box, packed with reference to the end of box. The child is packed after any other child packed with reference to the start of box. Parameters for how to pack the child widget, GtkBox:expand, GtkBox:fill and GtkBox:padding, are given their default values, TRUE, TRUE, and 0, respectively.

Parameters:

Gtk.Widget widget Required (not null)

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)

Boolean expand Required (not null)

Boolean fill Required (not null)

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

Number padding Required (not null)

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 widget 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 for how to pack the child widget, GtkBox:expand, GtkBox:fill and GtkBox:padding, are given their default values, TRUE, TRUE, and 0, respectively.

Parameters:

Gtk.Widget widget Required (not null)

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)

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

path: String

path_reversed: String

When a container receives an expose event, it must send synthetic expose events to all children that don't have their own GdkWindows. This function provides a convenient way of doing this. A container, when it receives an expose event, calls gtk_container_propagate_expose() once for each child, passing in the event the container received. gtk_container_propagate_expose() takes care of deciding whether an expose event needs to be sent to the child, intersecting the event's area with the child area, and sending the event. In most cases, a container can simply either simply inherit the GtkWidget::expose implementation from GtkContainer, or, do some drawing and then chain to the ::expose implementation from GtkContainer.

Parameters:

Gtk.Widget child Required (not null)

Gdk.EventExpose event Required (not null)

Returns:

none

Obtains information about how child is packed into box.

Parameters:

Gtk.Widget child Required (not null)

Boolean expand Required (not null)

Boolean fill Required (not null)

Number padding Required (not null)

Gtk.PackType pack_type Required (not null)

Returns:

expand: Boolean

fill: Boolean

padding: Number

This function does the same as gtk_widget_queue_draw().

Returns:

none

This function is no longer different from gtk_widget_queue_draw_area(), though it once was. Now it just calls gtk_widget_queue_draw_area(). Originally gtk_widget_queue_clear_area() would force a redraw of the background for GTK_NO_WINDOW widgets, and gtk_widget_queue_draw_area() would not. Now both functions ensure the background will be redrawn.

Parameters:

Number x Required (not null)

Number y Required (not null)

Number width Required (not null)

Number height Required (not null)

Returns:

none

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

Returns:

none

Invalidates the rectangular area of widget defined by x, y, 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, or gdk_window_invalidate_rect() directly, to schedule a redraw of a GtkDrawingArea or some portion thereof. Frequently you can just call gdk_window_invalidate_rect() or gdk_window_invalidate_region() instead of this function. Those functions will invalidate only a single window, instead of the widget and all its children. The advantage of adding to the invalidated region compared to simply drawing immediately is efficiency; using an invalid region ensures that you only have to redraw one time.

Parameters:

Number x Required (not null)

Number y Required (not null)

Number width Required (not null)

Number height Required (not null)

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.

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::expose-event. Or simply g_signal_connect () to the GtkWidget::realize signal.

Returns:

none

Gets a reference to an object's AtkObject implementation, if the object implements AtkObjectIface

Returns:

Atk.Object

Computes the intersection of a widget's area and region, returning the intersection. The result may be empty, use gdk_region_empty() to check.

Parameters:

Gdk.Region region Required (not null)

Returns:

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

Returns:

none

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

Parameters:

Gtk.AccelGroup accel_group Required (not null)

Number accel_key Required (not null)

Gdk.ModifierType accel_mods Required (not null)

Returns:

Boolean

Parameters:

String key Required (not null)

Returns:

none

Parameters:

Number data_id Required (not null)

Returns:

none

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)

Returns:

none

Parameters:

String key Required (not null)

Returns:

none

Parameters:

Number key_id Required (not null)

Returns:

none

A convenience function that uses the theme engine and RC file 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().

Parameters:

String stock_id Required (not null)

Number size Required (not null)

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

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)

Number position Required (not null)

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)

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

Recursively resets the shape on this widget and its descendants.

Returns:

none

Returns:

none

Very rarely-used function. This function is used to emit an expose event signals 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_expose(). 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)

Returns:

Number

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)

Returns:

Boolean

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.

Parameters:

Gdk.Rectangle allocation Required (not null)

Returns:

none

Sets whether the application intends to draw on the widget in an GtkWidget::expose-event 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. If this is not suitable (e.g. because you want to make a transparent window using an RGBA visual), you can work around this by doing: |[ gtk_widget_realize (window); gdk_window_set_back_pixmap (window->window, NULL, FALSE); gtk_widget_show (window); ]|

Parameters:

Boolean app_paintable Required (not null)

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:

Number border_width Required (not null)

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)

String name Required (not null)

GObject.Value value Required (not null)

Returns:

none

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

Parameters:

Boolean can_default Required (not null)

Returns:

none

Specifies whether widget can own the input focus. See gtk_widget_grab_focus() for actually setting the input focus on a widget.

Parameters:

Boolean can_focus Required (not null)

Returns:

none

Sets the way child is packed into box.

Parameters:

Gtk.Widget child Required (not null)

Boolean expand Required (not null)

Boolean fill Required (not null)

Number padding Required (not null)

Gtk.PackType pack_type Required (not null)

Returns:

none

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.

Parameters:

Boolean is_visible Required (not null)

Returns:

none

Sets the colormap for the widget to the given value. Widget must not have been previously realized. This probably should only be used from an init() function (i.e. from the constructor for the widget).

Parameters:

Gdk.Colormap colormap Required (not null)

Returns:

none

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

Parameters:

String name Required (not null)

Returns:

none

Parameters:

String key Required (not null)

void* data Required (not null)

Returns:

none

Parameters:

Number data_id Required (not null)

void* data Required (not null)

Returns:

none

Parameters:

Number data_id Required (not null)

void* data Required (not null)

Function (void* data) : none Required (not null)

Returns:

none

Parameters:

String key Required (not null)

void* data Required (not null)

Function (void* data) : none Required (not null)

Returns:

none

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

Parameters:

Gtk.TextDirection dir Required (not null)

Returns:

none

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

Parameters:

Boolean double_buffered Required (not null)

Returns:

none

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 GTK_NO_WINDOW widgets; to get events on those widgets, place them inside a GtkEventBox and receive events on the event box.

Parameters:

Number events Required (not null)

Returns:

none

Sets the extension events mask to mode. See GdkExtensionMode and gdk_input_set_extension_events().

Parameters:

Gdk.ExtensionMode mode Required (not null)

Returns:

none

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of default behaviour by overriding the class closure of this signal.

Parameters:

Gtk.Widget child

a GtkWidget, or NULL

Returns:

none

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

Parameters:

Gtk.Adjustment adjustment Required (not null)

moved among the descendents of container

Returns:

none

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

Parameters:

Gtk.Adjustment adjustment Required (not null)

is moved among the descendents of container

Returns:

none

Sets the has-tooltip property on widget to has_tooltip. See GtkWidget:has-tooltip for more information.

Parameters:

Boolean has_tooltip Required (not null)

Returns:

none

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 create a window for themselves in GtkWidget::realize() however must announce this by calling this function with has_window = TRUE. This function should only be called by widget implementations, and they should call it in their init() function.

Parameters:

Boolean has_window Required (not null)

Returns:

none

Sets the GtkBox:homogeneous property of box, controlling whether or not all children of box are given equal space in the box.

Parameters:

Boolean homogeneous Required (not null)

FALSE for variable allotments

Returns:

none

Marks the widget as being realized. This function should only ever be called in a derived widget's "map" or "unmap" implementation.

Parameters:

Boolean mapped Required (not null)

Returns:

none

Widgets can be named, which allows you to refer to them from a gtkrc file. You can apply a style to widgets with a particular name in the gtkrc file. See the documentation for gtkrc files (on the same page as the docs for GtkRcStyle). Note that widget names are separated by periods in paths (see gtk_widget_path()), so names with embedded periods may cause confusion.

Parameters:

String name Required (not null)

Returns:

none

Sets the GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect this widget. This is mostly for use in constructing widget hierarchies with externally controlled visibility, see GtkUIManager.

Parameters:

Boolean no_show_all Required (not null)

Returns:

none

Sets the orientation of the orientable.

Parameters:

Gtk.Orientation orientation Required (not null)

Returns:

none

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

Parameters:

Gtk.Widget parent Required (not null)

Returns:

none

Sets a non default parent window for widget.

Parameters:

Gdk.Window parent_window Required (not null)

Returns:

none

Marks the widget as being realized. This function should only ever be called in a derived widget's "realize" or "unrealize" implementation.

Parameters:

Boolean realized Required (not null)

Returns:

none

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

Parameters:

Boolean needs_redraws Required (not null)

Returns:

none

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

Parameters:

Boolean receives_default Required (not null)

Returns:

none

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 NO_WINDOW widgets setting this flag to FALSE turns its position changes; this is to allow containers that don't draw anything to avoid excess invalidations. If you set this flag on a NO_WINDOW widget 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.

Parameters:

Boolean redraw_on_allocate Required (not null)

when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn.

Returns:

none

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

Parameters:

Gtk.ResizeMode resize_mode Required (not null)

Returns:

none

For widgets that support scrolling, sets the scroll adjustments and returns TRUE. For widgets that don't support scrolling, does nothing and returns FALSE. Widgets that don't support scrolling can be scrolled by placing them in a GtkViewport, which does support scrolling.

Parameters:

Gtk.Adjustment hadjustment

an adjustment for horizontal scrolling, or NULL

Gtk.Adjustment vadjustment

an adjustment for vertical scrolling, or NULL

Returns:

Boolean

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.

Parameters:

Boolean sensitive Required (not null)

Returns:

none

Sets the minimum size of a widget; that is, the widget's size request will be width by height. You can use this function to force a widget to be either larger or smaller 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. Widgets can't actually be allocated a size less than 1 by 1, but you can pass 0,0 to this function to mean "as small as possible."

Parameters:

Number width Required (not null)

Number height Required (not null)

Returns:

none

Sets the GtkBox:spacing property of box, which is the number of pixels to place between children of box.

Parameters:

Number spacing Required (not null)

Returns:

none

This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as gtk_widget_set_sensitive().

Parameters:

Gtk.StateType state Required (not null)

Returns:

none

Sets the GtkStyle for a widget (widget->style). You probably don't want to use this function; it interacts badly with themes, because themes work by replacing the GtkStyle. Instead, use gtk_widget_modify_style().

Parameters:

Gtk.Style style

a GtkStyle, or NULL to remove the effect of a previous gtk_widget_set_style() and go back to the default style

Returns:

none

Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. 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().

Parameters:

String markup

the contents of the tooltip for widget, or NULL

Returns:

none

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

Parameters:

String text Required (not null)

Returns:

none

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

Parameters:

Gtk.Window custom_window

a GtkWindow, or NULL

Returns:

none

Sets the position of a widget. The funny "u" in the name comes from the "user position" hint specified by the X Window System, and exists for legacy reasons. This function doesn't work if a widget is inside a container; it's only really useful on GtkWindow. Don't use this function to center dialogs over the main application window; most window managers will do the centering on your behalf if you call gtk_window_set_transient_for(), and it's really not possible to get the centering to work correctly in all cases from application code. But if you insist, use gtk_window_set_position() to set GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering manually. Note that although x and y can be individually unset, the position is not honoured unless both x and y are set.

Parameters:

Number x Required (not null)

Number y Required (not null)

Returns:

none

Parameters:

void* data Required (not null)

Returns:

none

Sets the minimum size of a widget; that is, the widget's size request will be width by height. You can use this function to force a widget to be either larger or smaller than it is. The strange "usize" name dates from the early days of GTK+, and derives from X Window System terminology. In many 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 usize will force them to leave the window at least as large as the usize. 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.

Parameters:

Number width Required (not null)

Number height Required (not null)

Returns:

none

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.

Parameters:

Boolean visible Required (not null)

Returns:

none

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.

Parameters:

Gdk.Window window Required (not null)

Returns:

none

Sets a shape for this widget's GDK window. This allows for transparent windows etc., see gdk_window_shape_combine_mask() for more information.

Parameters:

Gdk.Bitmap shape_mask

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

Number offset_x Required (not null)

Number offset_y Required (not null)

Returns:

none

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.

Returns:

none

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

Returns:

none

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.

Returns:

none

Returns:

none

This function is only used by GtkContainer subclasses, to assign a size and position to their child widgets.

Parameters:

Gdk.Rectangle allocation Required (not null)

Returns:

none

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. See also gtk_widget_get_child_requisition().

Parameters:

Gtk.Requisition requisition Required (not null)

Returns:

none

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.

Returns:

none

Gets the value of a style property of widget.

Parameters:

String property_name Required (not null)

GObject.Value value Required (not null)

Returns:

none

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.

Returns:

none

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. was no common ancestor. In this case, nothing is stored in *dest_x and *dest_y. Otherwise TRUE.

Parameters:

Gtk.Widget dest_widget Required (not null)

Number src_x Required (not null)

Number src_y Required (not null)

Object out_values

Number dest_x

Number dest_y

Returns:

Boolean

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

Returns:

none

This function is only for use in widget implementations. Causes a widget to be unmapped if it's currently mapped.

Returns:

none

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.

Returns:

none

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

Returns:

none

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

Returns:

none

Parameters:

Gtk.Widget self

Returns:

{none}

Parameters:

Gtk.Container self

Gtk.Widget object

Returns:

{none}

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. FALSE to propagate the event further.

Parameters:

Gtk.Widget self

Gdk.Event event

Returns:

{Boolean}

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. FALSE to propagate the event further.

Parameters:

Gtk.Widget self

Gdk.Event event

Returns:

{Boolean}

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.

Parameters:

Gtk.Widget self

Number signal_id

Returns:

{Boolean}

Parameters:

Gtk.Container self

Returns:

{none}

The ::child-notify signal is emitted for each child property that has changed on an object. The signal's detail holds the property name.

Parameters:

Gtk.Widget self

GObject.ParamSpec pspec

Returns:

{none}

The ::client-event will be emitted when the widget's window receives a message (via a ClientMessage event) from another application. the event. FALSE to propagate the event further.

Parameters:

Gtk.Widget self

Gdk.Event event

Returns:

{Boolean}

The ::composited-changed signal is emitted when the composited status of widgets screen changes. See gdk_screen_is_composited().

Parameters:

Gtk.Widget self

Returns:

{none}

Parameters:

Gtk.Widget self

Gdk.Event object

Returns:

{Boolean}