Creates a new #GtkSeparator with the given orientation.
Returns this, for use in with statements.
Get builder for gtk.separator.Separator
Get orientation property.
Set orientation property.
Retrieves the orientation of the orientable.
Sets the orientation of the orientable.
Returns this, for use in with statements.
Get builder for gtk.widget.Widget
Get doubleBuffered property.
Set doubleBuffered property.
Get expand property.
Set expand property.
Get focusOnClick property.
Set focusOnClick property.
Get halign property.
Set halign property.
Get hasTooltip property.
Set hasTooltip property.
Get hexpand property.
Set hexpand property.
Get hexpandSet property.
Set hexpandSet property.
Get margin property.
Set margin property.
Get marginBottom property.
Set marginBottom property.
Get marginEnd property.
Set marginEnd property.
Get marginLeft property.
Set marginLeft property.
Get marginRight property.
Set marginRight property.
Get marginStart property.
Set marginStart property.
Get marginTop property.
Set marginTop property.
Get opacity property.
Set opacity property.
Get scaleFactor property.
Get style property.
Set style property.
Get tooltipMarkup property.
Set tooltipMarkup property.
Get tooltipText property.
Set tooltipText property.
Get valign property.
Set valign property.
Get vexpand property.
Set vexpand property.
Get vexpandSet property.
Set vexpandSet property.
Get window property.
Obtains the current default reading direction. See gtk.widget.Widget.setDefaultDirection.
Returns the default style used by all widgets initially.
Cancels the effect of a previous call to gtk.widget.Widget.pushCompositeChild.
Makes all newly-created widgets as composite children until the corresponding gtk.widget.Widget.popCompositeChild call.
Sets the default reading direction for widgets where the direction has not been explicitly set by gtk.widget.Widget.setDirection.
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.
Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. The accel_group needs to be added to the widget’s toplevel via gtk.window.Window.addAccelGroup, and the signal must be of type G_SIGNAL_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use gtk.accel_map.AccelMap.addEntry and gtk.widget.Widget.setAccelPath or gtk.menu_item.MenuItem.setAccelPath instead.
Adds the device events in the bitfield events to the event mask for widget. See gtk.widget.Widget.setDeviceEvents for details.
Adds the events in the bitfield events to the event mask for widget. See gtk.widget.Widget.setEvents and the [input handling overview][event-masks] for details.
Adds a widget to the list of mnemonic labels for this widget. (See gtk.widget.Widget.listMnemonicLabels). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well, by using a connection to the #GtkWidget::destroy signal or a weak notifier.
Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a #GtkLabel), then you will have to call gtk.widget.Widget.queueResize or gtk.widget.Widget.queueDrawArea yourself.
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.
This function is used by custom widget implementations; if you're writing an app, you’d use gtk.widget.Widget.grabFocus to move the focus to a particular widget, and gtk.container.Container.setFocusChain to change the focus tab order. So you may want to investigate those functions instead.
Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on widget.
Same as gtk.widget.Widget.path, but always uses the name of a widget’s type, never uses a custom name set with gtk.widget.Widget.setName.
Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at gtk.widget.Widget.getHexpand or gtk.widget.Widget.getVexpand.
Creates a new #PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget. See also gtk.widget.Widget.getPangoContext.
Creates a new #PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Destroys a widget.
This function sets *widget_pointer to null if widget_pointer != null. It’s intended to be used as a callback connected to the “destroy” signal of a widget. You connect gtk.widget.Widget.destroyed as a signal handler, and pass the address of your widget variable as user data. Then when the widget is destroyed, the variable will be set to null. Useful for example to avoid multiple copies of the same dialog.
Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. This may be used in the #GtkWidget::grab-notify signal to check for specific devices. See gtk.global.deviceGrabAdd.
This function is equivalent to gtk.widget.Widget.dragBeginWithCoordinates, passing -1, -1 as coordinates.
Initiates a drag on the source side. The function only needs to be used when the application is starting drags itself, and is not needed when gtk.widget.Widget.dragSourceSet is used.
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.
Add the image targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addImageTargets and gtk.widget.Widget.dragDestSetTargetList.
Add the text targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addTextTargets and gtk.widget.Widget.dragDestSetTargetList.
Add the URI targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addUriTargets and gtk.widget.Widget.dragDestSetTargetList.
Looks for a match between the supported targets of context and the dest_target_list, returning the first matching target, otherwise returning GDK_NONE. dest_target_list should usually be the return value from gtk.widget.Widget.dragDestGetTargetList, but some widgets may have different valid targets for different parts of the widget; in that case, they will have to implement a drag_motion handler that passes the correct target list to this function.
Returns the list of targets this widget can accept from drag-and-drop.
Returns whether the widget has been configured to always emit #GtkWidget::drag-motion signals.
Sets a widget as a potential drop destination, and adds default behaviors.
Sets this widget as a proxy for drops to another window.
Sets the target types that this widget can accept from drag-and-drop. The widget must first be made into a drag destination with gtk.widget.Widget.dragDestSet.
Tells the widget to emit #GtkWidget::drag-motion and #GtkWidget::drag-leave events regardless of the targets and the gtk.types.DestDefaults.Motion flag.
Clears information about a drop destination set with gtk.widget.Widget.dragDestSet. The widget will no longer receive notification of drags.
Gets the data associated with a drag. When the data is received or the retrieval fails, GTK+ will emit a #GtkWidget::drag-data-received signal. Failure of the retrieval is indicated by the length field of the selection_data signal parameter being negative. However, when gtk.widget.Widget.dragGetData is called implicitely because the gtk.types.DestDefaults.Drop was set, then the widget will not receive notification of failed drops.
Highlights a widget as a currently hovered drop target. To end the highlight, call gtk.widget.Widget.dragUnhighlight. GTK+ calls this automatically if gtk.types.DestDefaults.Highlight is set.
Add the writable image targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addImageTargets and gtk.widget.Widget.dragSourceSetTargetList.
Add the text targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addTextTargets and gtk.widget.Widget.dragSourceSetTargetList.
Add the URI targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with info = 0. If you need another value, use gtk.target_list.TargetList.addUriTargets and gtk.widget.Widget.dragSourceSetTargetList.
Gets the list of targets this widget can provide for drag-and-drop.
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.
Sets the icon that will be used for drags from a particular source to icon. See the docs for #GtkIconTheme for more details.
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.
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.
Sets the icon that will be used for drags from a particular source to a stock icon.
Changes the target types that this widget offers for drag-and-drop. The widget must first be made into a drag source with gtk.widget.Widget.dragSourceSet.
Undoes the effects of gtk.widget.Widget.dragSourceSet.
Removes a highlight set by gtk.widget.Widget.dragHighlight from a widget.
Draws widget to cr. The top left corner of the widget will be drawn to the currently set origin point of cr.
Ensures that widget has a style (widget->style).
Notifies the user about an input-related error on this widget. If the #GtkSettings:gtk-error-bell setting is true, it calls gdk.window.Window.beep, otherwise it does nothing.
Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don’t use this function; instead, use gtk.global.mainDoEvent so the event will behave as if it were in the event queue. Don’t synthesize expose events; instead, use gdk.window.Window.invalidateRect to invalidate a region of the window.
Stops emission of #GtkWidget::child-notify signals on widget. The signals are queued until gtk.widget.Widget.thawChildNotify is called on widget.
Returns the accessible object that describes the widget to an assistive technology.
Retrieves the #GActionGroup that was registered using prefix. The resulting #GActionGroup may have been registered to widget or any #GtkWidget in its ancestry.
Returns the baseline that has currently been allocated to widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function, and when allocating child widgets in #GtkWidget::size_allocate.
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.
Retrieves the widget’s allocated size.
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.
Retrieves the widget’s allocation.
Gets the first ancestor of widget with type widget_type. For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that’s an ancestor of widget. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel #GtkWindow in the docs for gtk.widget.Widget.getToplevel.
Determines whether the application intends to draw on the widget in an #GtkWidget::draw handler.
Determines whether widget can be a default widget. See gtk.widget.Widget.setCanDefault.
Determines whether widget can own the input focus. See gtk.widget.Widget.setCanFocus.
This function is only for use in widget implementations. Obtains widget->requisition, unless someone has forced a particular geometry on the widget (e.g. with gtk.widget.Widget.setSizeRequest), in which case it returns that geometry instead of the widget's requisition.
Gets the value set with gtk.widget.Widget.setChildVisible. If you feel a need to use this function, your code probably needs reorganization.
Retrieves the widget’s clip area.
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.
Obtains the composite name of a widget.
Returns whether device can interact with widget and its children. See gtk.widget.Widget.setDeviceEnabled.
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.
Gets the reading direction for a particular widget. See gtk.widget.Widget.setDirection.
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.
Determines whether the widget is double buffered.
Returns the event mask (see #GdkEventMask) for the widget. These are the events that the widget will receive.
Returns whether the widget should grab focus when it is clicked with the mouse. See gtk.widget.Widget.setFocusOnClick.
Gets the font map that has been set with gtk.widget.Widget.setFontMap.
Returns the #cairo_font_options_t used for Pango rendering. When not set, the defaults font options for the #GdkScreen will be used.
Obtains the frame clock for a widget. The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call gdk.frame_clock.FrameClock.getFrameTime, in order to get a time to use for animating. For example you might record the start of the animation with an initial value from gdk.frame_clock.FrameClock.getFrameTime, and then update the animation by calling gdk.frame_clock.FrameClock.getFrameTime again during each repaint.
Gets the value of the #GtkWidget:halign property.
Returns the current value of the has-tooltip property. See #GtkWidget:has-tooltip for more information.
Determines whether widget has a #GdkWindow of its own. See gtk.widget.Widget.setHasWindow.
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.
Gets whether gtk.widget.Widget.setHexpand has been used to explicitly set the expand flag on this widget.
Whether the widget is mapped.
Gets the value of the #GtkWidget:margin-bottom property.
Gets the value of the #GtkWidget:margin-end property.
Gets the value of the #GtkWidget:margin-left property.
Gets the value of the #GtkWidget:margin-right property.
Gets the value of the #GtkWidget:margin-start property.
Gets the value of the #GtkWidget:margin-top property.
Returns the modifier mask the widget’s windowing system backend uses for a particular purpose.
Returns the current modifier style for the widget. (As set by gtk.widget.Widget.modifyStyle.) If no style has previously set, a new #GtkRcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call gtk.widget.Widget.modifyStyle, passing in the returned rc style, to make sure that your changes take effect.
Retrieves the name of a widget. See gtk.widget.Widget.setName for the significance of widget names.
Returns the current value of the #GtkWidget:no-show-all property, which determines whether calls to gtk.widget.Widget.showAll will affect this widget.
Fetches the requested opacity for this widget. See gtk.widget.Widget.setOpacity.
Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk.widget.Widget.createPangoContext, this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by using the #GtkWidget::screen-changed signal on the widget.
Returns the parent container of widget.
Gets widget’s parent window, or null if it does not have one.
Returns the #GtkWidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created.
Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as widget->window coordinates for widgets that return true for gtk.widget.Widget.getHasWindow; and are relative to widget->allocation.x, widget->allocation.y otherwise.
Retrieves a widget’s initial minimum and natural height.
Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified width, or the default height if width is -1. The baselines may be -1 which means that no baseline is requested for this widget.
Retrieves a widget’s minimum and natural height if it would be given the specified width.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Retrieves a widget’s initial minimum and natural width.
Retrieves a widget’s minimum and natural width if it would be given the specified height.
Determines whether widget is realized.
Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Retrieves the widget’s requisition.
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.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).
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.
Returns the widget’s sensitivity (in the sense of returning the value that has been set using gtk.widget.Widget.setSensitive).
Gets the settings object holding the settings used for this widget.
Gets the size request that was explicitly set for the widget using gtk.widget.Widget.setSizeRequest. A value of -1 stored in width or height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used instead. See gtk.widget.Widget.setSizeRequest. To get the size a widget will actually request, call gtk.widget.Widget.getPreferredSize instead of this function.
Returns the widget’s state. See gtk.widget.Widget.setState.
Returns the widget state as a flag set. It is worth mentioning that the effective gtk.types.StateFlags.Insensitive state will be returned, that is, also based on parent insensitivity, even if widget itself is sensitive.
Simply an accessor function that returns widget->style.
Returns the style context associated to widget. The returned object is guaranteed to be the same for the lifetime of widget.
Returns true if widget is multiple pointer aware. See gtk.widget.Widget.setSupportMultidevice for more information.
Fetch an object build from the template XML for widget_type in this widget instance.
Gets the contents of the tooltip for widget.
Gets the contents of the tooltip for widget.
Returns the #GtkWindow of the current tooltip. This can be the GtkWindow created by default, or the custom tooltip window set using gtk.widget.Widget.setTooltipWindow.
This function returns the topmost widget in the container hierarchy widget is a part of. If widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced.
Gets the value of the #GtkWidget:valign property.
Gets the value of the #GtkWidget:valign property, including gtk.types.Align.Baseline.
Gets whether the widget would like any available extra vertical space.
Gets whether gtk.widget.Widget.setVexpand has been used to explicitly set the expand flag on this widget.
Determines whether the widget is visible. If you want to take into account whether the widget’s parent is also marked as visible, use gtk.widget.Widget.isVisible instead.
Gets the visual that will be used to render widget.
Returns the widget’s window if it is realized, null otherwise
Makes widget the current grabbed widget.
Causes widget to become the default widget. widget must be able to be a default widget; typically you would ensure this yourself by calling gtk.widget.Widget.setCanDefault with a true value. The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, gtk.widget.Widget.activate should affect them. Note that #GtkEntry widgets require the “activates-default” property set to true before they activate the default widget when Enter is pressed and the #GtkEntry is focused.
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.
Removes the grab from the given widget.
Determines whether widget is the current default widget within its toplevel. See gtk.widget.Widget.setCanDefault.
Determines if the widget has the global input focus. See gtk.widget.Widget.isFocus for the difference between having the global input focus, and only having the focus within a toplevel.
Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).
Determines if the widget style has been looked up through the rc mechanism.
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.
Determines if the widget should show a visible indication that it has the global input focus. This is a convenience function for use in ::draw handlers that takes into account whether focus indication should currently be shown in the toplevel window of widget. See gtk.window.Window.getFocusVisible for more information about focus indication.
Reverses the effects of gtk.widget.Widget.show, causing the widget to be hidden (invisible to the user).
Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk.widget.Widget.hide on its argument, then returns true. If connected to ::delete-event, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when ::delete-event is received.
Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work.
Creates and initializes child widgets defined in templates. This function must be called in the instance initializer for any class which assigned itself a template using gtk.widget_class.WidgetClass.setTemplate
Sets an input shape for this widget’s GDK window. This allows for windows which react to mouse click in a nonrectangular region, see gdk.window.Window.inputShapeCombineRegion for more information.
Inserts group into widget. Children of widget that implement #GtkActionable can then be associated with actions in group by setting their “action-name” to prefix.action-name.
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.
Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.
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.
Determines whether widget can be drawn to. A widget can be drawn to if it is mapped and visible.
Determines if the widget is the focus widget within its toplevel. (This does not mean that the #GtkWidget:has-focus property is necessarily set; #GtkWidget:has-focus will only be set if the toplevel widget additionally has the global input focus.)
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive
Determines whether widget is a toplevel widget.
Determines whether the widget and all its parents are marked as visible.
This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of gtk.widget.Widget.childFocus:
Lists the closures used by widget for accelerator group connections with gtk.accel_group.AccelGroup.connectByPath or gtk.accel_group.AccelGroup.connect. The closures can be used to monitor accelerator changes on widget, by connecting to the GtkAccelGroup::accel-changed signal of the #GtkAccelGroup of a closure which can be found out with gtk.accel_group.AccelGroup.fromAccelClosure.
Retrieves a null-terminated array of strings containing the prefixes of #GActionGroup's available to widget.
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, gtk.label.Label.setMnemonicWidget).
This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.
Emits the #GtkWidget::mnemonic-activate signal.
Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see gtk.widget.Widget.modifyText) for widgets such as #GtkEntry and #GtkTextView. See also gtk.widget.Widget.modifyStyle.
Sets the background color for a widget in a particular state.
Sets the cursor color to use in a widget, overriding the #GtkWidget cursor-color and secondary-cursor-color style properties.
Sets the foreground color for a widget in a particular state.
Sets the font to use for a widget.
Modifies style values on the widget.
Sets the text color for a widget in a particular state.
Sets the background color to use for a widget.
Sets the color to use for a widget.
Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. All other style values are left untouched. See also gtk.widget.Widget.modifyStyle.
Sets the font to use for a widget. All other style values are left untouched. See gtk.widget.Widget.overrideColor.
Sets a symbolic color for a widget.
Obtains the full path to widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from gtk.widget.Widget.getName. Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the widget by default (e.g. “GtkButton”) or can be set to an application-specific value with gtk.widget.Widget.setName. By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. path_reversed_p fills in the path in reverse order, i.e. starting with widget’s name instead of starting with the name of widget’s outermost ancestor.
This function is only for use in widget implementations.
Mark widget as needing to recompute its expand flags. Call this function when setting legacy expand child properties on the child of a container.
Equivalent to calling gtk.widget.Widget.queueDrawArea for the entire area of a widget.
Convenience function that calls gtk.widget.Widget.queueDrawRegion on the region created from the given coordinates.
Invalidates the area of widget defined by region by calling gdk.window.Window.invalidateRegion on the widget’s window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.
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.
This function works like gtk.widget.Widget.queueResize, except that the widget is not invalidated.
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.
Computes the intersection of a widget’s area and region, returning the intersection. The result may be empty, use cairo.region.Region.isEmpty to check.
Registers a #GdkWindow with the widget and sets it up so that the widget receives events for it. Call gtk.widget.Widget.unregisterWindow when destroying the window.
Removes an accelerator from widget, previously installed with gtk.widget.Widget.addAccelerator.
Removes a widget from the list of mnemonic labels for this widget. (See gtk.widget.Widget.listMnemonicLabels). The widget must have previously been added to the list with gtk.widget.Widget.addMnemonicLabel.
Removes a tick callback previously registered with gtk.widget.Widget.addTickCallback.
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.
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.
Moves a widget from one #GtkContainer to another, handling reference count issues to avoid destroying the widget.
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.
Updates the style context of widget and all descendants by updating its widget path. #GtkContainers may want to use this on a child when reordering it in a way that a different style might apply to it. See also gtk.container.Container.getPathForChild.
Very rarely-used function. This function is used to emit an expose event on a widget. This function is not normally used directly. The only time it is used is when propagating an expose event to a windowless child widget (gtk.widget.Widget.getHasWindow is false), and that is normally done using gtk.container.Container.propagateDraw.
Sends the focus change event to widget
Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. This removes any accelerators (for any accelerator group) installed by previous calls to gtk.widget.Widget.setAccelPath. Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. (See gtk.accel_map.AccelMap.save.)
Sets the widget’s allocation. This should not be used directly, but from within a widget’s size_allocate method.
Sets whether the application intends to draw on the widget in an #GtkWidget::draw handler.
Specifies whether widget can be a default widget. See gtk.widget.Widget.grabDefault for details about the meaning of “default”.
Specifies whether widget can own the input focus. See gtk.widget.Widget.grabFocus for actually setting the input focus on a widget.
Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with gtk.widget.Widget.show.
Sets the widget’s clip. This must not be used directly, but from within a widget’s size_allocate method. It must be called after gtk.widget.Widget.setAllocation (or after chaining up to the parent class), because that function resets the clip.
Sets a widgets composite name. The widget must be a composite child of its parent; see gtk.widget.Widget.pushCompositeChild.
Enables or disables a #GdkDevice to interact with widget and all its children.
Sets the device event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive from device. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk.widget.Widget.addDeviceEvents for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with windowless widgets (which return false from gtk.widget.Widget.getHasWindow); to get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.
Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
Widgets are double buffered by default; you can use this function to turn off the buffering. “Double buffered” simply means that gdk.window.Window.beginDrawFrame and gdk.window.Window.endDrawFrame are called automatically around expose events sent to the widget. gdk.window.Window.beginDrawFrame diverts all drawing to a widget's window to an offscreen buffer, and gdk.window.Window.endDrawFrame draws the buffer to the screen. The result is that users see the window update in one smooth step, and don’t see individual graphics primitives being rendered.
Sets the event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk.widget.Widget.addEvents for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with widgets that have no window. (See gtk.widget.Widget.getHasWindow). To get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.
Sets whether the widget should grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.
Sets the font map to use for Pango rendering. When not set, the widget will inherit the font map from its parent.
Sets the #cairo_font_options_t used for Pango rendering in this widget. When not set, the default font options for the #GdkScreen will be used.
Sets the horizontal alignment of widget. See the #GtkWidget:halign property.
Sets the has-tooltip property on widget to has_tooltip. See #GtkWidget:has-tooltip for more information.
Specifies whether widget has a #GdkWindow of its own. Note that all realized widgets have a non-null “window” pointer (gtk.widget.Widget.getWindow never returns a null window when a widget is realized), but for many of them it’s actually the #GdkWindow of one of its parent widgets. Widgets that do not create a window for themselves in #GtkWidget::realize must announce this by calling this function with has_window = false.
Sets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
Sets whether the hexpand flag (see gtk.widget.Widget.getHexpand) will be used.
Marks the widget as being mapped.
Sets the bottom margin of widget. See the #GtkWidget:margin-bottom property.
Sets the end margin of widget. See the #GtkWidget:margin-end property.
Sets the left margin of widget. See the #GtkWidget:margin-left property.
Sets the right margin of widget. See the #GtkWidget:margin-right property.
Sets the start margin of widget. See the #GtkWidget:margin-start property.
Sets the top margin of widget. See the #GtkWidget:margin-top property.
Widgets can be named, which allows you to refer to them from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for #GtkStyleContext).
Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk.widget.Widget.showAll will affect this widget.
Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Opacity values are clamped to the [0,1] range.). This works on both toplevel widget, and child widgets, although there are some limitations:
This function is useful only when implementing subclasses of #GtkContainer. Sets the container as the parent of widget, and takes care of some details such as updating the state and style of the child to reflect its new location. The opposite function is gtk.widget.Widget.unparent.
Sets a non default parent window for widget.
Marks the widget as being realized. This function must only be called after all #GdkWindows for the widget have been created and registered.
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.
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.
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.
Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. You can use this function to force a widget to be larger than it normally would be.
This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as gtk.widget.Widget.setSensitive.
This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.).
Used to set the #GtkStyle for a widget (widget->style). Since GTK 3, this function does nothing, the passed in style is ignored.
Enables or disables multiple pointer awareness. If this setting is true, widget will start receiving multiple, per device enter/leave events. Note that if custom #GdkWindows are created in #GtkWidget::realize, gdk.window.Window.setSupportMultidevice will have to be called manually on them.
Sets markup as the contents of the tooltip, which is marked up with the [Pango text markup language]PangoMarkupFormat.
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.
Replaces the default window used for displaying tooltips with custom_window. GTK+ will take care of showing and hiding custom_window at the right moment, to behave likewise as the default tooltip window. If custom_window is null, the default tooltip window will be used.
Sets the vertical alignment of widget. See the #GtkWidget:valign property.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag (see gtk.widget.Widget.getVexpand) will be used.
Sets the visibility state of widget. Note that setting this to true doesn’t mean the widget is actually viewable, see gtk.widget.Widget.getVisible.
Sets the visual that should be used for by widget and its children for creating #GdkWindows. The visual must be on the same #GdkScreen as returned by gtk.widget.Widget.getScreen, so handling the #GtkWidget::screen-changed signal is necessary.
Sets a widget’s window. This function should only be used in a widget’s #GtkWidget::realize implementation. The window passed is usually either new window created with gdk.window.Window.new_, or the window of its parent widget as returned by gtk.widget.Widget.getParentWindow.
Sets a shape for this widget’s GDK window. This allows for transparent windows etc., see gdk.window.Window.shapeCombineRegion for more information.
Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. If you want to show all the widgets in a container, it’s easier to call gtk.widget.Widget.showAll on the container, instead of individually showing the widgets.
Recursively shows a widget, and any child widgets (if the widget is a container).
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.
This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets.
This function is only used by #GtkContainer subclasses, to assign a size, position and (optionally) baseline to their child widgets.
This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk.widget.Widget.sizeAllocate.
This function attaches the widget’s #GtkStyle to the widget's #GdkWindow. It is a replacement for
Gets the value of a style property of widget.
Reverts the effect of a previous call to gtk.widget.Widget.freezeChildNotify. This causes all queued #GtkWidget::child-notify signals on widget to be emitted.
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.
Triggers a tooltip query on the display where the toplevel of widget is located. See gtk.tooltip.Tooltip.triggerTooltipQuery for more information.
This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.
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.
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).
Unregisters a #GdkWindow from the widget that was previously set up with gtk.widget.Widget.registerWindow. You need to call this when the window is no longer used by the widget, such as when you destroy it.
This function is for use in widget implementations. Turns off flag values for the current widget state (insensitive, prelighted, etc.). See gtk.widget.Widget.setStateFlags.
Connect to AccelClosuresChanged signal.
Connect to ButtonPressEvent signal.
Connect to ButtonReleaseEvent signal.
Connect to CanActivateAccel signal.
Connect to ChildNotify signal.
Connect to CompositedChanged signal.
Connect to ConfigureEvent signal.
Connect to DamageEvent signal.
Connect to DeleteEvent signal.
Connect to Destroy signal.
Connect to DestroyEvent signal.
Connect to DirectionChanged signal.
Connect to DragBegin signal.
Connect to DragDataDelete signal.
Connect to DragDataGet signal.
Connect to DragDataReceived signal.
Connect to DragDrop signal.
Connect to DragEnd signal.
Connect to DragFailed signal.
Connect to DragLeave signal.
Connect to DragMotion signal.
Connect to Draw signal.
Connect to EnterNotifyEvent signal.
Connect to Event signal.
Connect to EventAfter signal.
Connect to Focus signal.
Connect to FocusInEvent signal.
Connect to FocusOutEvent signal.
Connect to GrabBrokenEvent signal.
Connect to GrabFocus signal.
Connect to GrabNotify signal.
Connect to Hide signal.
Connect to HierarchyChanged signal.
Connect to KeyPressEvent signal.
Connect to KeyReleaseEvent signal.
Connect to KeynavFailed signal.
Connect to LeaveNotifyEvent signal.
Connect to Map signal.
Connect to MapEvent signal.
Connect to MnemonicActivate signal.
Connect to MotionNotifyEvent signal.
Connect to MoveFocus signal.
Connect to ParentSet signal.
Connect to PopupMenu signal.
Connect to PropertyNotifyEvent signal.
Connect to ProximityInEvent signal.
Connect to ProximityOutEvent signal.
Connect to QueryTooltip signal.
Connect to Realize signal.
Connect to ScreenChanged signal.
Connect to ScrollEvent signal.
Connect to SelectionClearEvent signal.
Connect to SelectionGet signal.
Connect to SelectionNotifyEvent signal.
Connect to SelectionReceived signal.
Connect to SelectionRequestEvent signal.
Connect to Show signal.
Connect to ShowHelp signal.
Connect to SizeAllocate signal.
Connect to StateChanged signal.
Connect to StateFlagsChanged signal.
Connect to StyleSet signal.
Connect to StyleUpdated signal.
Connect to TouchEvent signal.
Connect to Unmap signal.
Connect to UnmapEvent signal.
Connect to Unrealize signal.
Connect to VisibilityNotifyEvent signal.
Connect to WindowStateEvent signal.
Get orientation property.
Set orientation property.
Retrieves the orientation of the orientable.
Sets the orientation of the orientable.
GtkSeparator is a horizontal or vertical separator widget, depending on the value of the #GtkOrientable:orientation property, used to group the widgets within a window. It displays a line with a shadow to make it appear sunken into the interface.
CSS nodes
GtkSeparator has a single CSS node with name separator. The node gets one of the .horizontal or .vertical style classes.