GLArea

#GtkGLArea is a widget that allows drawing with OpenGL.

#GtkGLArea sets up its own #GdkGLContext for the window it creates, and creates a custom GL framebuffer that the widget will do GL rendering onto. It also ensures that this framebuffer is the default GL rendering target when rendering.

In order to draw, you have to connect to the #GtkGLArea::render signal, or subclass #GtkGLArea and override the @GtkGLAreaClass.render() virtual function.

The #GtkGLArea widget ensures that the #GdkGLContext is associated with the widget's drawing area, and it is kept updated when the size and position of the drawing area changes.

Drawing with GtkGLArea ##

The simplest way to draw using OpenGL commands in a #GtkGLArea is to create a widget instance and connect to the #GtkGLArea::render signal:

|[ // create a GtkGLArea instance GtkWidget *gl_area = gtk_gl_area_new ();

// connect to the "render" signal g_signal_connect (gl_area, "render", G_CALLBACK (render), NULL); ]|

The render() function will be called when the #GtkGLArea is ready for you to draw its content:

|[ static gboolean render (GtkGLArea *area, GdkGLContext *context) { // inside this function it's safe to use GL; the given // #GdkGLContext has been made current to the drawable // surface used by the #GtkGLArea and the viewport has // already been set to be the size of the allocation

// we can start by clearing the buffer glClearColor (0, 0, 0, 0); glClear (GL_COLOR_BUFFER_BIT);

// draw your object draw_an_object ();

// we completed our drawing; the draw commands will be // flushed at the end of the signal emission chain, and // the buffers will be drawn on the window return TRUE; } ]|

If you need to initialize OpenGL state, e.g. buffer objects or shaders, you should use the #GtkWidget::realize signal; you can use the #GtkWidget::unrealize signal to clean up. Since the #GdkGLContext creation and initialization may fail, you will need to check for errors, using gtk_gl_area_get_error(). An example of how to safely initialize the GL state is:

|[ static void on_realize (GtkGLarea *area) { // We need to make the context current if we want to // call GL API gtk_gl_area_make_current (area);

// If there were errors during the initialization or // when trying to make the context current, this // function will return a #GError for you to catch if (gtk_gl_area_get_error (area) != NULL) return;

// You can also use gtk_gl_area_set_error() in order // to show eventual initialization errors on the // GtkGLArea widget itself GError *internal_error = NULL; init_buffer_objects (&error); if (error != NULL) { gtk_gl_area_set_error (area, error); g_error_free (error); return; }

init_shaders (&error); if (error != NULL) { gtk_gl_area_set_error (area, error); g_error_free (error); return; } } ]|

If you need to change the options for creating the #GdkGLContext you should use the #GtkGLArea::create-context signal.

class GLArea : Widget {

protected

GtkGLArea* gtkGLArea;

GtkGLArea* getGLAreaStruct();

void* getStruct();

void setStruct(GObject* obj);

this(GtkGLArea* gtkGLArea, bool ownedRef);

static GType getType();

this();

void attachBuffers();

bool getAutoRender();

GLContext getContext();

ErrorG getError();

bool getHasAlpha();

bool getHasDepthBuffer();

bool getHasStencilBuffer();

void getRequiredVersion(int major, int minor);

void makeCurrent();

void queueRender();

void setAutoRender(bool autoRender);

void setError(ErrorG error);

void setHasAlpha(bool hasAlpha);

void setHasDepthBuffer(bool hasDepthBuffer);

void setHasStencilBuffer(bool hasStencilBuffer);

void setRequiredVersion(int major, int minor);

int[string] connectedSignals;

GLContext delegate(GLArea)[] onCreateContextListeners;

void addOnCreateContext(GLContext delegate(GLArea) dlg, ConnectFlags connectFlags);

static GdkGLContext* callBackCreateContext(GtkGLArea* glareaStruct, GLArea _glarea);

bool delegate(GLContext, GLArea)[] onRenderListeners;

void addOnRender(bool delegate(GLContext, GLArea) dlg, ConnectFlags connectFlags);

static int callBackRender(GtkGLArea* glareaStruct, GdkGLContext* context, GLArea _glarea);

void delegate(int, int, GLArea)[] onResizeListeners;

void addOnResize(void delegate(int, int, GLArea) dlg, ConnectFlags connectFlags);

static void callBackResize(GtkGLArea* glareaStruct, int width, int height, GLArea _glarea);

}

Constructors

this this(GtkGLArea* gtkGLArea, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new #GtkGLArea widget.

Members

Functions

addOnCreateContext void addOnCreateContext(GLContext delegate(GLArea) dlg, ConnectFlags connectFlags): The ::create-context signal is emitted when the widget is being realized, and allows you to override how the GL context is created. This is useful when you want to reuse an existing GL context, or if you want to try creating different kinds of GL options.
addOnRender void addOnRender(bool delegate(GLContext, GLArea) dlg, ConnectFlags connectFlags): The ::render signal is emitted every time the contents of the #GtkGLArea should be redrawn.
addOnResize void addOnResize(void delegate(int, int, GLArea) dlg, ConnectFlags connectFlags): The ::resize signal is emitted once when the widget is realized, and then each time the widget is changed while realized. This is useful in order to keep GL state up to date with the widget size, like for instance camera properties which may depend on the width/height ratio.
attachBuffers void attachBuffers(): Ensures that the @area framebuffer object is made the current draw and read target, and that all the required buffers for the @area are created and bound to the frambuffer.
getAutoRender bool getAutoRender(): Returns whether the area is in auto render mode or not.
getContext GLContext getContext(): Retrieves the #GdkGLContext used by @area.
getError ErrorG getError(): Gets the current error set on the @area.
getGLAreaStruct GtkGLArea* getGLAreaStruct(): Get the main Gtk struct
getHasAlpha bool getHasAlpha(): Returns whether the area has an alpha component.
getHasDepthBuffer bool getHasDepthBuffer(): Returns whether the area has a depth buffer.
getHasStencilBuffer bool getHasStencilBuffer(): Returns whether the area has a stencil buffer.
getRequiredVersion void getRequiredVersion(int major, int minor): Retrieves the required version of OpenGL set using gtk_gl_area_set_required_version().
getStruct void* getStruct(): the main Gtk struct as a void*
makeCurrent void makeCurrent(): Ensures that the #GdkGLContext used by @area is associated with the #GtkGLArea.
queueRender void queueRender(): Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget, ensuring that the #GtkGLArea::render signal is emitted during the draw.
setAutoRender void setAutoRender(bool autoRender): If @auto_render is %TRUE the #GtkGLArea::render signal will be emitted every time the widget draws. This is the default and is useful if drawing the widget is faster.
setError void setError(ErrorG error): Sets an error on the area which will be shown instead of the GL rendering. This is useful in the #GtkGLArea::create-context signal if GL context creation fails.
setHasAlpha void setHasAlpha(bool hasAlpha): If @has_alpha is %TRUE the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget.
setHasDepthBuffer void setHasDepthBuffer(bool hasDepthBuffer): If @has_depth_buffer is %TRUE the widget will allocate and enable a depth buffer for the target framebuffer. Otherwise there will be none.
setHasStencilBuffer void setHasStencilBuffer(bool hasStencilBuffer): If @has_stencil_buffer is %TRUE the widget will allocate and enable a stencil buffer for the target framebuffer. Otherwise there will be none.
setRequiredVersion void setRequiredVersion(int major, int minor): Sets the required version of OpenGL to be used when creating the context for the widget.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackCreateContext GdkGLContext* callBackCreateContext(GtkGLArea* glareaStruct, GLArea _glarea): Undocumented in source. Be warned that the author may not have intended to support it.
callBackRender int callBackRender(GtkGLArea* glareaStruct, GdkGLContext* context, GLArea _glarea): Undocumented in source. Be warned that the author may not have intended to support it.
callBackResize void callBackResize(GtkGLArea* glareaStruct, int width, int height, GLArea _glarea): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()

Variables

connectedSignals int[string] connectedSignals;: Undocumented in source.
gtkGLArea GtkGLArea* gtkGLArea;: the main Gtk struct
onCreateContextListeners GLContext delegate(GLArea)[] onCreateContextListeners;: Undocumented in source.
onRenderListeners bool delegate(GLContext, GLArea)[] onRenderListeners;: Undocumented in source.
onResizeListeners void delegate(int, int, GLArea)[] onResizeListeners;: Undocumented in source.

Inherited Members

gtkWidget GtkWidget* gtkWidget;: the main Gtk struct
getWidgetStruct GtkWidget* getWidgetStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
__anonymous mixin ImplementorT!(GtkWidget): Undocumented in source.
__anonymous mixin BuildableT!(GtkWidget): Undocumented in source.
getWidgetClass GtkWidgetClass* getWidgetClass(): Undocumented in source. Be warned that the author may not have intended to support it.
getWidth int getWidth()
getHeight int getHeight()
setCursor void setCursor(Cursor cursor): Sets the cursor.
resetCursor void resetCursor(): Resets the cursor. don't know if this is implemented by GTK+. Seems that it's not
modifyFont void modifyFont(string family, int size): Modifies the font for this widget. This just calls modifyFont(new PgFontDescription(PgFontDescription.fromString(family ~ " " ~ size)));
onEvent bool onEvent(GdkEvent* event)
onButtonPressEvent bool onButtonPressEvent(GdkEventButton* event)
onButtonReleaseEvent bool onButtonReleaseEvent(GdkEventButton* event)
onScrollEvent bool onScrollEvent(GdkEventScroll* event)
onMotionNotifyEvent bool onMotionNotifyEvent(GdkEventMotion* event)
onDeleteEvent bool onDeleteEvent(GdkEventAny* event)
onDestroyEvent bool onDestroyEvent(GdkEventAny* event)
onKeyPressEvent bool onKeyPressEvent(GdkEventKey* event)
onKeyReleaseEvent bool onKeyReleaseEvent(GdkEventKey* event)
onEnterNotifyEvent bool onEnterNotifyEvent(GdkEventCrossing* event)
onLeaveNotifyEvent bool onLeaveNotifyEvent(GdkEventCrossing* event)
onConfigureEvent bool onConfigureEvent(GdkEventConfigure* event)
onFocusInEvent bool onFocusInEvent(GdkEventFocus* event)
onFocusOutEvent bool onFocusOutEvent(GdkEventFocus* event)
onMapEvent bool onMapEvent(GdkEventAny* event)
onUnmapEvent bool onUnmapEvent(GdkEventAny* event)
onPropertyNotifyEvent bool onPropertyNotifyEvent(GdkEventProperty* event)
onSelectionClearEvent bool onSelectionClearEvent(GdkEventSelection* event)
onSelectionRequestEvent bool onSelectionRequestEvent(GdkEventSelection* event)
onSelectionNotifyEvent bool onSelectionNotifyEvent(GdkEventSelection* event)
onProximityInEvent bool onProximityInEvent(GdkEventProximity* event)
onProximityOutEvent bool onProximityOutEvent(GdkEventProximity* event)
onVisibilityNotifyEvent bool onVisibilityNotifyEvent(GdkEventVisibility* event)
onWindowStateEvent bool onWindowStateEvent(GdkEventWindowState* event)
onDamageEvent bool onDamageEvent(GdkEventExpose* event)
onGrabBrokenEvent bool onGrabBrokenEvent(GdkEventGrabBroken* event)
addTickCallback void addTickCallback(bool delegate(Widget, FrameClock) callback): Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren't changing widget properties that would trigger that (for example, changing the text of a gtk.Label), then you will have to call queueResize() or queuDrawArea() yourself.
tickCallbackListeners bool delegate(Widget, FrameClock)[] tickCallbackListeners;: Undocumented in source.
gtkTickCallback int gtkTickCallback(GtkWidget* widgetStruct, GdkFrameClock* frameClock, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
scopedOnDrawListeners bool delegate(Scoped!Context, Widget)[] scopedOnDrawListeners;: Undocumented in source.
addOnDraw void addOnDraw(bool delegate(Scoped!Context, Widget) dlg, ConnectFlags connectFlags): This signal is emitted when a widget is supposed to render itself. The widget's top left corner must be painted at the origin of the passed in context and be sized to the values returned by getAllocatedWidth() and getAllocatedHeight().
callBackScopedDraw int callBackScopedDraw(GtkWidget* widgetStruct, cairo_t* cr, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDrawListeners bool delegate(Context, Widget)[] onDrawListeners;: Undocumented in source.
addOnDraw deprecated void addOnDraw(bool delegate(Context, Widget) dlg, ConnectFlags connectFlags): This signal is emitted when a widget is supposed to render itself. The @widget's top left corner must be painted at the origin of the passed in context and be sized to the values returned by gtk_widget_get_allocated_width() and gtk_widget_get_allocated_height().
callBackDraw int callBackDraw(GtkWidget* widgetStruct, cairo_t* cr, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
destroy void destroy(): Destroys a widget.
getType GType getType()
getDefaultDirection GtkTextDirection getDefaultDirection(): Obtains the current default reading direction. See gtk_widget_set_default_direction().
getDefaultStyle Style getDefaultStyle(): Returns the default style used by all widgets initially.
popCompositeChild void popCompositeChild(): Cancels the effect of a previous call to gtk_widget_push_composite_child().
pushCompositeChild void pushCompositeChild(): Makes all newly-created widgets as composite children until the corresponding gtk_widget_pop_composite_child() call.
setDefaultDirection void setDefaultDirection(GtkTextDirection dir): Sets the default reading direction for widgets where the direction has not been explicitly set by gtk_widget_set_direction().
activate bool activate(): For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If @widget isn't activatable, the function returns %FALSE.
addAccelerator void addAccelerator(string accelSignal, AccelGroup accelGroup, uint accelKey, GdkModifierType accelMods, GtkAccelFlags accelFlags): Installs an accelerator for this @widget in @accel_group that causes @accel_signal to be emitted if the accelerator is activated. The @accel_group needs to be added to the widget’s toplevel via gtk_window_add_accel_group(), and the signal must be of type %G_SIGNAL_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or gtk_menu_item_set_accel_path() instead.
addDeviceEvents void addDeviceEvents(Device device, GdkEventMask events): Adds the device events in the bitfield @events to the event mask for @widget. See gtk_widget_set_device_events() for details.
addEvents void addEvents(int events): Adds the events in the bitfield @events to the event mask for @widget. See gtk_widget_set_events() and the [input handling overview][event-masks] for details.
addMnemonicLabel void addMnemonicLabel(Widget label): Adds a widget to the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well, by using a connection to the #GtkWidget::destroy signal or a weak notifier.
addTickCallback uint addTickCallback(GtkTickCallback callback, void* userData, GDestroyNotify notify): Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a #GtkLabel), then you will have to call gtk_widget_queue_resize() or gtk_widget_queue_draw_area() yourself.
canActivateAccel bool canActivateAccel(uint signalId): Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel signal on @widget; if the signal isn’t overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped.
childFocus bool childFocus(GtkDirectionType direction): This function is used by custom widget implementations; if you're writing an app, you’d use gtk_widget_grab_focus() to move the focus to a particular widget, and gtk_container_set_focus_chain() to change the focus tab order. So you may want to investigate those functions instead.
childNotify void childNotify(string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on @widget.
classPath void classPath(uint pathLength, string path, string pathReversed): Same as gtk_widget_path(), but always uses the name of a widget’s type, never uses a custom name set with gtk_widget_set_name().
computeExpand bool computeExpand(GtkOrientation orientation): Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().
createPangoContext PgContext createPangoContext(): 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_get_pango_context().
createPangoLayout PgLayout createPangoLayout(string text): Creates a new #PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
destroyed void destroyed(Widget widgetPointer): This function sets *@widget_pointer to %NULL if @widget_pointer != %NULL. It’s intended to be used as a callback connected to the “destroy” signal of a widget. You connect gtk_widget_destroyed() as a signal handler, and pass the address of your widget variable as user data. Then when the widget is destroyed, the variable will be set to %NULL. Useful for example to avoid multiple copies of the same dialog.
deviceIsShadowed bool deviceIsShadowed(Device device): Returns %TRUE if @device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to @widget. This may be used in the #GtkWidget::grab-notify signal to check for specific devices. See gtk_device_grab_add().
dragBegin DragContext dragBegin(TargetList targets, GdkDragAction actions, int button, Event event): This function is equivalent to gtk_drag_begin_with_coordinates(), passing -1, -1 as coordinates.
dragBeginWithCoordinates DragContext dragBeginWithCoordinates(TargetList targets, GdkDragAction actions, int button, Event event, int x, int y): Initiates a drag on the source side. The function only needs to be used when the application is starting drags itself, and is not needed when gtk_drag_source_set() is used.
dragCheckThreshold bool dragCheckThreshold(int startX, int startY, int currentX, int currentY): Checks to see if a mouse drag starting at (@start_x, @start_y) and ending at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation.
dragDestAddImageTargets void dragDestAddImageTargets(): Add the image targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_image_targets() and gtk_drag_dest_set_target_list().
dragDestAddTextTargets void dragDestAddTextTargets(): Add the text targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_text_targets() and gtk_drag_dest_set_target_list().
dragDestAddUriTargets void dragDestAddUriTargets(): Add the URI targets supported by #GtkSelectionData to the target list of the drag destination. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_uri_targets() and gtk_drag_dest_set_target_list().
dragDestFindTarget GdkAtom dragDestFindTarget(DragContext context, TargetList targetList): Looks for a match between the supported targets of @context and the @dest_target_list, returning the first matching target, otherwise returning %GDK_NONE. @dest_target_list should usually be the return value from gtk_drag_dest_get_target_list(), but some widgets may have different valid targets for different parts of the widget; in that case, they will have to implement a drag_motion handler that passes the correct target list to this function.
dragDestGetTargetList TargetList dragDestGetTargetList(): Returns the list of targets this widget can accept from drag-and-drop.
dragDestGetTrackMotion bool dragDestGetTrackMotion(): Returns whether the widget has been configured to always emit #GtkWidget::drag-motion signals.
dragDestSet void dragDestSet(GtkDestDefaults flags, TargetEntry[] targets, GdkDragAction actions): Sets a widget as a potential drop destination, and adds default behaviors.
dragDestSetProxy void dragDestSetProxy(GdkWin proxyWindow, GdkDragProtocol protocol, bool useCoordinates): Sets this widget as a proxy for drops to another window.
dragDestSetTargetList void dragDestSetTargetList(TargetList targetList): Sets the target types that this widget can accept from drag-and-drop. The widget must first be made into a drag destination with gtk_drag_dest_set().
dragDestSetTrackMotion void dragDestSetTrackMotion(bool trackMotion): Tells the widget to emit #GtkWidget::drag-motion and #GtkWidget::drag-leave events regardless of the targets and the %GTK_DEST_DEFAULT_MOTION flag.
dragDestUnset void dragDestUnset(): Clears information about a drop destination set with gtk_drag_dest_set(). The widget will no longer receive notification of drags.
dragGetData void dragGetData(DragContext context, GdkAtom target, uint time): Gets the data associated with a drag. When the data is received or the retrieval fails, GTK+ will emit a #GtkWidget::drag-data-received signal. Failure of the retrieval is indicated by the length field of the @selection_data signal parameter being negative. However, when gtk_drag_get_data() is called implicitely because the %GTK_DEST_DEFAULT_DROP was set, then the widget will not receive notification of failed drops.
dragHighlight void dragHighlight(): Highlights a widget as a currently hovered drop target. To end the highlight, call gtk_drag_unhighlight(). GTK+ calls this automatically if %GTK_DEST_DEFAULT_HIGHLIGHT is set.
dragSourceAddImageTargets void dragSourceAddImageTargets(): Add the writable image targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_image_targets() and gtk_drag_source_set_target_list().
dragSourceAddTextTargets void dragSourceAddTextTargets(): Add the text targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_text_targets() and gtk_drag_source_set_target_list().
dragSourceAddUriTargets void dragSourceAddUriTargets(): Add the URI targets supported by #GtkSelectionData to the target list of the drag source. The targets are added with @info = 0. If you need another value, use gtk_target_list_add_uri_targets() and gtk_drag_source_set_target_list().
dragSourceGetTargetList TargetList dragSourceGetTargetList(): Gets the list of targets this widget can provide for drag-and-drop.
dragSourceSet void dragSourceSet(GdkModifierType startButtonMask, TargetEntry[] targets, GdkDragAction actions): Sets up a widget so that GTK+ will start a drag operation when the user clicks and drags on the widget. The widget must have a window.
dragSourceSetIconGicon void dragSourceSetIconGicon(IconIF icon): Sets the icon that will be used for drags from a particular source to @icon. See the docs for #GtkIconTheme for more details.
dragSourceSetIconName void dragSourceSetIconName(string iconName): Sets the icon that will be used for drags from a particular source to a themed icon. See the docs for #GtkIconTheme for more details.
dragSourceSetIconPixbuf void dragSourceSetIconPixbuf(Pixbuf pixbuf): Sets the icon that will be used for drags from a particular widget from a #GdkPixbuf. GTK+ retains a reference for @pixbuf and will release it when it is no longer needed.
dragSourceSetIconStock void dragSourceSetIconStock(string stockId): Sets the icon that will be used for drags from a particular source to a stock icon.
dragSourceSetTargetList void dragSourceSetTargetList(TargetList targetList): Changes the target types that this widget offers for drag-and-drop. The widget must first be made into a drag source with gtk_drag_source_set().
dragSourceUnset void dragSourceUnset(): Undoes the effects of gtk_drag_source_set().
dragUnhighlight void dragUnhighlight(): Removes a highlight set by gtk_drag_highlight() from a widget.
draw void draw(Context cr): Draws @widget to @cr. The top left corner of the widget will be drawn to the currently set origin point of @cr.
ensureStyle void ensureStyle(): Ensures that @widget has a style (@widget->style).
errorBell void errorBell(): Notifies the user about an input-related error on this widget. If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls gdk_window_beep(), otherwise it does nothing.
event bool event(Event event): Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don’t use this function; instead, use gtk_main_do_event() so the event will behave as if it were in the event queue. Don’t synthesize expose events; instead, use gdk_window_invalidate_rect() to invalidate a region of the window.
freezeChildNotify void freezeChildNotify(): Stops emission of #GtkWidget::child-notify signals on @widget. The signals are queued until gtk_widget_thaw_child_notify() is called on @widget.
getAccessible ObjectAtk getAccessible(): Returns the accessible object that describes the widget to an assistive technology.
getActionGroup ActionGroupIF getActionGroup(string prefix): Retrieves the #GActionGroup that was registered using @prefix. The resulting #GActionGroup may have been registered to @widget or any #GtkWidget in its ancestry.
getAllocatedBaseline int getAllocatedBaseline(): Returns the baseline that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function, and when allocating child widgets in #GtkWidget::size_allocate.
getAllocatedHeight int getAllocatedHeight(): Returns the height that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function.
getAllocatedSize void getAllocatedSize(GtkAllocation allocation, int baseline): Retrieves the widget’s allocated size.
getAllocatedWidth int getAllocatedWidth(): Returns the width that has currently been allocated to @widget. This function is intended to be used when implementing handlers for the #GtkWidget::draw function.
getAllocation void getAllocation(GtkAllocation allocation): Retrieves the widget’s allocation.
getAncestor Widget getAncestor(GType widgetType): Gets the first ancestor of @widget with type @widget_type. For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first #GtkBox that’s an ancestor of @widget. No reference will be added to the returned widget; it should not be unreferenced. See note about checking for a toplevel #GtkWindow in the docs for gtk_widget_get_toplevel().
getAppPaintable bool getAppPaintable(): Determines whether the application intends to draw on the widget in an #GtkWidget::draw handler.
getCanDefault bool getCanDefault(): Determines whether @widget can be a default widget. See gtk_widget_set_can_default().
getCanFocus bool getCanFocus(): Determines whether @widget can own the input focus. See gtk_widget_set_can_focus().
getChildRequisition void getChildRequisition(Requisition requisition): This function is only for use in widget implementations. Obtains @widget->requisition, unless someone has forced a particular geometry on the widget (e.g. with gtk_widget_set_size_request()), in which case it returns that geometry instead of the widget's requisition.
getChildVisible bool getChildVisible(): Gets the value set with gtk_widget_set_child_visible(). If you feel a need to use this function, your code probably needs reorganization.
getClip void getClip(GtkAllocation clip): Retrieves the widget’s clip area.
getClipboard Clipboard getClipboard(GdkAtom selection): Returns the clipboard object for the given selection to be used with @widget. @widget must have a #GdkDisplay associated with it, so must be attached to a toplevel window.
getCompositeName string getCompositeName(): Obtains the composite name of a widget.
getDeviceEnabled bool getDeviceEnabled(Device device): Returns whether @device can interact with @widget and its children. See gtk_widget_set_device_enabled().
getDeviceEvents GdkEventMask getDeviceEvents(Device device): Returns the events mask for the widget corresponding to an specific device. These are the events that the widget will receive when @device operates on it.
getDirection GtkTextDirection getDirection(): Gets the reading direction for a particular widget. See gtk_widget_set_direction().
getDisplay Display getDisplay(): Get the #GdkDisplay for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top.
getDoubleBuffered bool getDoubleBuffered(): Determines whether the widget is double buffered.
getEvents int getEvents(): Returns the event mask (see #GdkEventMask) for the widget. These are the events that the widget will receive.
getFocusOnClick bool getFocusOnClick(): Returns whether the widget should grab focus when it is clicked with the mouse. See gtk_widget_set_focus_on_click().
getFontMap PgFontMap getFontMap(): Gets the font map that has been set with gtk_widget_set_font_map().
getFontOptions FontOption getFontOptions(): Returns the #cairo_font_options_t used for Pango rendering. When not set, the defaults font options for the #GdkScreen will be used.
getFrameClock FrameClock getFrameClock(): Obtains the frame clock for a widget. The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call gdk_frame_clock_get_frame_time(), in order to get a time to use for animating. For example you might record the start of the animation with an initial value from gdk_frame_clock_get_frame_time(), and then update the animation by calling gdk_frame_clock_get_frame_time() again during each repaint.
getHalign GtkAlign getHalign(): Gets the value of the #GtkWidget:halign property.
getHasTooltip bool getHasTooltip(): Returns the current value of the has-tooltip property. See #GtkWidget:has-tooltip for more information.
getHasWindow bool getHasWindow(): Determines whether @widget has a #GdkWindow of its own. See gtk_widget_set_has_window().
getHexpand bool getHexpand(): Gets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
getHexpandSet bool getHexpandSet(): Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
getMapped bool getMapped(): Whether the widget is mapped.
getMarginBottom int getMarginBottom(): Gets the value of the #GtkWidget:margin-bottom property.
getMarginEnd int getMarginEnd(): Gets the value of the #GtkWidget:margin-end property.
getMarginLeft int getMarginLeft(): Gets the value of the #GtkWidget:margin-left property.
getMarginRight int getMarginRight(): Gets the value of the #GtkWidget:margin-right property.
getMarginStart int getMarginStart(): Gets the value of the #GtkWidget:margin-start property.
getMarginTop int getMarginTop(): Gets the value of the #GtkWidget:margin-top property.
getModifierMask GdkModifierType getModifierMask(GdkModifierIntent intent): Returns the modifier mask the @widget’s windowing system backend uses for a particular purpose.
getModifierStyle RcStyle getModifierStyle(): Returns the current modifier style for the widget. (As set by gtk_widget_modify_style().) If no style has previously set, a new #GtkRcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc style, you must call gtk_widget_modify_style(), passing in the returned rc style, to make sure that your changes take effect.
getName string getName(): Retrieves the name of a widget. See gtk_widget_set_name() for the significance of widget names.
getNoShowAll bool getNoShowAll(): Returns the current value of the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() will affect this widget.
getOpacity double getOpacity(): Fetches the requested opacity for this widget. See gtk_widget_set_opacity().
getPangoContext PgContext getPangoContext(): Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk_widget_create_pango_context(), this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by using the #GtkWidget::screen-changed signal on the widget.
getParent Widget getParent(): Returns the parent container of @widget.
getParentWindow GdkWin getParentWindow(): Gets @widget’s parent window.
getPath WidgetPath getPath(): Returns the #GtkWidgetPath representing @widget, if the widget is not connected to a toplevel widget, a partial path will be created.
getPointer void getPointer(int x, int y): Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as @widget->window coordinates for widgets that return %TRUE for gtk_widget_get_has_window(); and are relative to @widget->allocation.x, @widget->allocation.y otherwise.
getPreferredHeight void getPreferredHeight(int minimumHeight, int naturalHeight): Retrieves a widget’s initial minimum and natural height.
getPreferredHeightAndBaselineForWidth void getPreferredHeightAndBaselineForWidth(int width, int minimumHeight, int naturalHeight, int minimumBaseline, int naturalBaseline): Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified @width, or the default height if @width is -1. The baselines may be -1 which means that no baseline is requested for this widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(int width, int minimumHeight, int naturalHeight): Retrieves a widget’s minimum and natural height if it would be given the specified @width.
getPreferredSize void getPreferredSize(Requisition minimumSize, Requisition naturalSize): Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
getPreferredWidth void getPreferredWidth(int minimumWidth, int naturalWidth): Retrieves a widget’s initial minimum and natural width.
getPreferredWidthForHeight void getPreferredWidthForHeight(int height, int minimumWidth, int naturalWidth): Retrieves a widget’s minimum and natural width if it would be given the specified @height.
getRealized bool getRealized(): Determines whether @widget is realized.
getReceivesDefault bool getReceivesDefault(): Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
getRequestMode GtkSizeRequestMode getRequestMode(): Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
getRequisition void getRequisition(Requisition requisition): Retrieves the widget’s requisition.
getRootWindow GdkWin getRootWindow(): Get the root window where this widget is located. This function can only be called after the widget has been added to a widget hierarchy with #GtkWindow at the top.
getScaleFactor int getScaleFactor(): Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).
getScreen Screen getScreen(): Get the #GdkScreen from the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top.
getSensitive bool getSensitive(): Returns the widget’s sensitivity (in the sense of returning the value that has been set using gtk_widget_set_sensitive()).
getSettings Settings getSettings(): Gets the settings object holding the settings used for this widget.
getSizeRequest void getSizeRequest(int width, int height): Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). A value of -1 stored in @width or @height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used instead. See gtk_widget_set_size_request(). To get the size a widget will actually request, call gtk_widget_get_preferred_size() instead of this function.
getStateFlags GtkStateFlags getStateFlags(): Returns the widget state as a flag set. It is worth mentioning that the effective %GTK_STATE_FLAG_INSENSITIVE state will be returned, that is, also based on parent insensitivity, even if @widget itself is sensitive.
getStyle Style getStyle(): Simply an accessor function that returns @widget->style.
getStyleContext StyleContext getStyleContext(): Returns the style context associated to @widget.
getSupportMultidevice bool getSupportMultidevice(): Returns %TRUE if @widget is multiple pointer aware. See gtk_widget_set_support_multidevice() for more information.
getTemplateChild ObjectG getTemplateChild(GType widgetType, string name): Fetch an object build from the template XML for @widget_type in this @widget instance.
getTooltipMarkup string getTooltipMarkup(): Gets the contents of the tooltip for @widget.
getTooltipText string getTooltipText(): Gets the contents of the tooltip for @widget.
getTooltipWindow Window getTooltipWindow(): Returns the #GtkWindow of the current tooltip. This can be the GtkWindow created by default, or the custom tooltip window set using gtk_widget_set_tooltip_window().
getToplevel Widget getToplevel(): This function returns the topmost widget in the container hierarchy @widget is a part of. If @widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced.
getValign GtkAlign getValign(): Gets the value of the #GtkWidget:valign property.
getValignWithBaseline GtkAlign getValignWithBaseline(): Gets the value of the #GtkWidget:valign property, including %GTK_ALIGN_BASELINE.
getVexpand bool getVexpand(): Gets whether the widget would like any available extra vertical space.
getVexpandSet bool getVexpandSet(): Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
getVisible bool getVisible(): Determines whether the widget is visible. If you want to take into account whether the widget’s parent is also marked as visible, use gtk_widget_is_visible() instead.
getVisual Visual getVisual(): Gets the visual that will be used to render @widget.
getWindow GdkWin getWindow(): Returns the widget’s window if it is realized, %NULL otherwise
grabAdd void grabAdd(): Makes @widget the current grabbed widget.
grabDefault void grabDefault(): Causes @widget to become the default widget. @widget must be able to be a default widget; typically you would ensure this yourself by calling gtk_widget_set_can_default() with a %TRUE value. The default widget is activated when the user presses Enter in a window. Default widgets must be activatable, that is, gtk_widget_activate() should affect them. Note that #GtkEntry widgets require the “activates-default” property set to %TRUE before they activate the default widget when Enter is pressed and the #GtkEntry is focused.
grabFocus void grabFocus(): Causes @widget to have the keyboard focus for the #GtkWindow it's inside. @widget must be a focusable widget, such as a #GtkEntry; something like #GtkFrame won’t work.
grabRemove void grabRemove(): Removes the grab from the given widget.
hasDefault bool hasDefault(): Determines whether @widget is the current default widget within its toplevel. See gtk_widget_set_can_default().
hasFocus bool hasFocus(): Determines if the widget has the global input focus. See gtk_widget_is_focus() for the difference between having the global input focus, and only having the focus within a toplevel.
hasGrab bool hasGrab(): Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse).
hasRcStyle bool hasRcStyle(): Determines if the widget style has been looked up through the rc mechanism.
hasScreen bool hasScreen(): Checks whether there is a #GdkScreen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top.
hasVisibleFocus bool hasVisibleFocus(): Determines if the widget should show a visible indication that it has the global input focus. This is a convenience function for use in ::draw handlers that takes into account whether focus indication should currently be shown in the toplevel window of @widget. See gtk_window_get_focus_visible() for more information about focus indication.
hide void hide(): Reverses the effects of gtk_widget_show(), causing the widget to be hidden (invisible to the user).
hideOnDelete bool hideOnDelete(): Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk_widget_hide() on its argument, then returns %TRUE. If connected to ::delete-event, the result is that clicking the close button for a window (on the window frame, top right corner usually) will hide but not destroy the window. By default, GTK+ destroys windows when ::delete-event is received.
inDestruction bool inDestruction(): Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work.
initTemplate void initTemplate(): Creates and initializes child widgets defined in templates. This function must be called in the instance initializer for any class which assigned itself a template using gtk_widget_class_set_template()
inputShapeCombineRegion void inputShapeCombineRegion(Region region): Sets an input shape for this widget’s GDK window. This allows for windows which react to mouse click in a nonrectangular region, see gdk_window_input_shape_combine_region() for more information.
insertActionGroup void insertActionGroup(string name, ActionGroupIF group): Inserts @group into @widget. Children of @widget that implement #GtkActionable can then be associated with actions in @group by setting their “action-name” to @prefix.action-name.
intersect bool intersect(GdkRectangle* area, GdkRectangle* intersection): Computes the intersection of a @widget’s area and @area, storing the intersection in @intersection, and returns %TRUE if there was an intersection. @intersection may be %NULL if you’re only interested in whether there was an intersection.
isAncestor bool isAncestor(Widget ancestor): Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
isComposited bool isComposited(): Whether @widget can rely on having its alpha channel drawn correctly. On X11 this function returns whether a compositing manager is running for @widget’s screen.
isDrawable bool isDrawable(): Determines whether @widget can be drawn to. A widget can be drawn to if it is mapped and visible.
isFocus bool isFocus(): Determines if the widget is the focus widget within its toplevel. (This does not mean that the #GtkWidget:has-focus property is necessarily set; #GtkWidget:has-focus will only be set if the toplevel widget additionally has the global input focus.)
isSensitive bool isSensitive(): Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive
isToplevel bool isToplevel(): Determines whether @widget is a toplevel widget.
isVisible bool isVisible(): Determines whether the widget and all its parents are marked as visible.
keynavFailed bool keynavFailed(GtkDirectionType direction): This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of gtk_widget_child_focus():
listAccelClosures ListG listAccelClosures(): Lists the closures used by @widget for accelerator group connections with gtk_accel_group_connect_by_path() or gtk_accel_group_connect(). The closures can be used to monitor accelerator changes on @widget, by connecting to the @GtkAccelGroup::accel-changed signal of the #GtkAccelGroup of a closure which can be found out with gtk_accel_group_from_accel_closure().
listActionPrefixes string[] listActionPrefixes(): Retrieves a %NULL-terminated array of strings containing the prefixes of #GActionGroup's available to @widget.
listMnemonicLabels ListG listMnemonicLabels(): Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, gtk_label_set_mnemonic_widget()).
map void map(): This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.
mnemonicActivate bool mnemonicActivate(bool groupCycling): Emits the #GtkWidget::mnemonic-activate signal.
modifyBase void modifyBase(GtkStateType state, Color color): Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see gtk_widget_modify_text()) for widgets such as #GtkEntry and #GtkTextView. See also gtk_widget_modify_style().
modifyBg void modifyBg(GtkStateType state, Color color): Sets the background color for a widget in a particular state.
modifyCursor void modifyCursor(Color primary, Color secondary): Sets the cursor color to use in a widget, overriding the #GtkWidget cursor-color and secondary-cursor-color style properties.
modifyFg void modifyFg(GtkStateType state, Color color): Sets the foreground color for a widget in a particular state.
modifyFont void modifyFont(PgFontDescription fontDesc): Sets the font to use for a widget.
modifyStyle void modifyStyle(RcStyle style): Modifies style values on the widget.
modifyText void modifyText(GtkStateType state, Color color): Sets the text color for a widget in a particular state.
overrideBackgroundColor void overrideBackgroundColor(GtkStateFlags state, RGBA color): Sets the background color to use for a widget.
overrideColor void overrideColor(GtkStateFlags state, RGBA color): Sets the color to use for a widget.
overrideCursor void overrideCursor(RGBA cursor, RGBA secondaryCursor): Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. All other style values are left untouched. See also gtk_widget_modify_style().
overrideFont void overrideFont(PgFontDescription fontDesc): Sets the font to use for a widget. All other style values are left untouched. See gtk_widget_override_color().
overrideSymbolicColor void overrideSymbolicColor(string name, RGBA color): Sets a symbolic color for a widget.
path void path(uint pathLength, string path, string pathReversed): Obtains the full path to @widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from gtk_widget_get_name(). Paths are used to apply styles to a widget in gtkrc configuration files. Widget names are the type of the widget by default (e.g. “GtkButton”) or can be set to an application-specific value with gtk_widget_set_name(). By setting the name of a widget, you allow users or theme authors to apply styles to that specific widget in their gtkrc file. @path_reversed_p fills in the path in reverse order, i.e. starting with @widget’s name instead of starting with the name of @widget’s outermost ancestor.
queueAllocate void queueAllocate(): This function is only for use in widget implementations.
queueComputeExpand void queueComputeExpand(): Mark @widget as needing to recompute its expand flags. Call this function when setting legacy expand child properties on the child of a container.
queueDraw void queueDraw(): Equivalent to calling gtk_widget_queue_draw_area() for the entire area of a widget.
queueDrawArea void queueDrawArea(int x, int y, int width, int height): Convenience function that calls gtk_widget_queue_draw_region() on the region created from the given coordinates.
queueDrawRegion void queueDrawRegion(Region region): Invalidates the area of @widget defined by @region by calling gdk_window_invalidate_region() on the widget’s window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, roughly), the window will receive expose events for the union of all regions that have been invalidated.
queueResize void queueResize(): This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a #GtkLabel, #GtkLabel queues a resize to ensure there’s enough space for the new text.
queueResizeNoRedraw void queueResizeNoRedraw(): This function works like gtk_widget_queue_resize(), except that the widget is not invalidated.
realize void realize(): Creates the GDK (windowing system) resources associated with a widget. For example, @widget->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.
regionIntersect Region regionIntersect(Region region): Computes the intersection of a @widget’s area and @region, returning the intersection. The result may be empty, use cairo_region_is_empty() to check.
registerWindow void registerWindow(GdkWin window): Registers a #GdkWindow with the widget and sets it up so that the widget receives events for it. Call gtk_widget_unregister_window() when destroying the window.
removeAccelerator bool removeAccelerator(AccelGroup accelGroup, uint accelKey, GdkModifierType accelMods): Removes an accelerator from @widget, previously installed with gtk_widget_add_accelerator().
removeMnemonicLabel void removeMnemonicLabel(Widget label): Removes a widget from the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). The widget must have previously been added to the list with gtk_widget_add_mnemonic_label().
removeTickCallback void removeTickCallback(uint id): Removes a tick callback previously registered with gtk_widget_add_tick_callback().
renderIcon Pixbuf renderIcon(string stockId, GtkIconSize size, string detail): A convenience function that uses the theme settings for @widget to look up @stock_id and render it to a pixbuf. @stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size such as #GTK_ICON_SIZE_MENU. @detail should be a string that identifies the widget or code doing the rendering, so that theme engines can special-case rendering for that widget or code.
renderIconPixbuf Pixbuf renderIconPixbuf(string stockId, GtkIconSize size): A convenience function that uses the theme engine and style settings for @widget to look up @stock_id and render it to a pixbuf. @stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size such as #GTK_ICON_SIZE_MENU.
reparent void reparent(Widget newParent): Moves a widget from one #GtkContainer to another, handling reference count issues to avoid destroying the widget.
resetRcStyles void resetRcStyles(): Reset the styles of @widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings.
resetStyle void resetStyle(): 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_get_path_for_child().
sendExpose int sendExpose(Event event): Very rarely-used function. This function is used to emit an expose event on a widget. This function is not normally used directly. The only time it is used is when propagating an expose event to a windowless child widget (gtk_widget_get_has_window() is %FALSE), and that is normally done using gtk_container_propagate_draw().
sendFocusChange bool sendFocusChange(Event event): Sends the focus change @event to @widget
setAccelPath void setAccelPath(string accelPath, AccelGroup accelGroup): Given an accelerator group, @accel_group, and an accelerator path, @accel_path, sets up an accelerator in @accel_group so whenever the key binding that is defined for @accel_path is pressed, @widget will be activated. This removes any accelerators (for any accelerator group) installed by previous calls to gtk_widget_set_accel_path(). Associating accelerators with paths allows them to be modified by the user and the modifications to be saved for future use. (See gtk_accel_map_save().)
setAllocation void setAllocation(GtkAllocation* allocation): Sets the widget’s allocation. This should not be used directly, but from within a widget’s size_allocate method.
setAppPaintable void setAppPaintable(bool appPaintable): Sets whether the application intends to draw on the widget in an #GtkWidget::draw handler.
setCanDefault void setCanDefault(bool canDefault): Specifies whether @widget can be a default widget. See gtk_widget_grab_default() for details about the meaning of “default”.
setCanFocus void setCanFocus(bool canFocus): Specifies whether @widget can own the input focus. See gtk_widget_grab_focus() for actually setting the input focus on a widget.
setChildVisible void setChildVisible(bool isVisible): Sets whether @widget should be mapped along with its when its parent is mapped and @widget has been shown with gtk_widget_show().
setClip void setClip(GtkAllocation* clip): 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_set_allocation() (or after chaining up to the parent class), because that function resets the clip.
setCompositeName void setCompositeName(string name): Sets a widgets composite name. The widget must be a composite child of its parent; see gtk_widget_push_composite_child().
setDeviceEnabled void setDeviceEnabled(Device device, bool enabled): Enables or disables a #GdkDevice to interact with @widget and all its children.
setDeviceEvents void setDeviceEvents(Device device, GdkEventMask events): Sets the device event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive from @device. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk_widget_add_device_events() for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with windowless widgets (which return %FALSE from gtk_widget_get_has_window()); to get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.
setDirection void setDirection(GtkTextDirection dir): Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
setDoubleBuffered void setDoubleBuffered(bool doubleBuffered): Widgets are double buffered by default; you can use this function to turn off the buffering. “Double buffered” simply means that gdk_window_begin_paint_region() and gdk_window_end_paint() are called automatically around expose events sent to the widget. gdk_window_begin_paint_region() diverts all drawing to a widget's window to an offscreen buffer, and gdk_window_end_paint() draws the buffer to the screen. The result is that users see the window update in one smooth step, and don’t see individual graphics primitives being rendered.
setEvents void setEvents(int events): Sets the event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget’s functionality, so be careful. This function must be called while a widget is unrealized. Consider gtk_widget_add_events() for widgets that are already realized, or if you want to preserve the existing event mask. This function can’t be used with widgets that have no window. (See gtk_widget_get_has_window()). To get events on those widgets, place them inside a #GtkEventBox and receive events on the event box.
setFocusOnClick void setFocusOnClick(bool focusOnClick): 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.
setFontMap void setFontMap(PgFontMap fontMap): Sets the font map to use for Pango rendering. When not set, the widget will inherit the font map from its parent.
setFontOptions void setFontOptions(FontOption options): 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.
setHalign void setHalign(GtkAlign alig): Sets the horizontal alignment of @widget. See the #GtkWidget:halign property.
setHasTooltip void setHasTooltip(bool hasTooltip): Sets the has-tooltip property on @widget to @has_tooltip. See #GtkWidget:has-tooltip for more information.
setHasWindow void setHasWindow(bool hasWindow): Specifies whether @widget has a #GdkWindow of its own. Note that all realized widgets have a non-%NULL “window” pointer (gtk_widget_get_window() never returns a %NULL window when a widget is realized), but for many of them it’s actually the #GdkWindow of one of its parent widgets. Widgets that do not create a %window for themselves in #GtkWidget::realize must announce this by calling this function with @has_window = %FALSE.
setHexpand void setHexpand(bool expand): Sets whether the widget would like any available extra horizontal space. When a user resizes a #GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
setHexpandSet void setHexpandSet(bool set): Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will be used.
setMapped void setMapped(bool mapped): Marks the widget as being realized.
setMarginBottom void setMarginBottom(int margin): Sets the bottom margin of @widget. See the #GtkWidget:margin-bottom property.
setMarginEnd void setMarginEnd(int margin): Sets the end margin of @widget. See the #GtkWidget:margin-end property.
setMarginLeft void setMarginLeft(int margin): Sets the left margin of @widget. See the #GtkWidget:margin-left property.
setMarginRight void setMarginRight(int margin): Sets the right margin of @widget. See the #GtkWidget:margin-right property.
setMarginStart void setMarginStart(int margin): Sets the start margin of @widget. See the #GtkWidget:margin-start property.
setMarginTop void setMarginTop(int margin): Sets the top margin of @widget. See the #GtkWidget:margin-top property.
setName void setName(string name): Widgets can be named, which allows you to refer to them from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for #GtkStyleContext).
setNoShowAll void setNoShowAll(bool noShowAll): Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() will affect this widget.
setOpacity void setOpacity(double opacity): Request the @widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Opacity values are clamped to the [0,1] range.). This works on both toplevel widget, and child widgets, although there are some limitations:
setParent void setParent(Widget parent): This function is useful only when implementing subclasses of #GtkContainer. Sets the container as the parent of @widget, and takes care of some details such as updating the state and style of the child to reflect its new location. The opposite function is gtk_widget_unparent().
setParentWindow void setParentWindow(GdkWin parentWindow): Sets a non default parent window for @widget.
setRealized void setRealized(bool realized): Marks the widget as being realized. This function must only be called after all #GdkWindows for the @widget have been created and registered.
setReceivesDefault void setReceivesDefault(bool receivesDefault): Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
setRedrawOnAllocate void setRedrawOnAllocate(bool redrawOnAllocate): Sets whether the entire widget is queued for drawing when its size allocation changes. By default, this setting is %TRUE and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this setting off will improve performance.
setSensitive void setSensitive(bool sensitive): Sets the sensitivity of a widget. A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits.
setSizeRequest void setSizeRequest(int width, int height): Sets the minimum size of a widget; that is, the widget’s size request will be at least @width by @height. You can use this function to force a widget to be larger than it normally would be.
setStateFlags void setStateFlags(GtkStateFlags flags, bool clear): This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.).
setStyle void setStyle(Style style): Used to set the #GtkStyle for a widget (@widget->style). Since GTK 3, this function does nothing, the passed in style is ignored.
setSupportMultidevice void setSupportMultidevice(bool supportMultidevice): Enables or disables multiple pointer awareness. If this setting is %TRUE, @widget will start receiving multiple, per device enter/leave events. Note that if custom #GdkWindows are created in #GtkWidget::realize, gdk_window_set_support_multidevice() will have to be called manually on them.
setTooltipMarkup void setTooltipMarkup(string markup): Sets @markup as the contents of the tooltip, which is marked up with the [Pango text markup language]PangoMarkupFormat.
setTooltipText void setTooltipText(string text): Sets @text as the contents of the tooltip. This function will take care of setting #GtkWidget:has-tooltip to %TRUE and of the default handler for the #GtkWidget::query-tooltip signal.
setTooltipWindow void setTooltipWindow(Window customWindow): Replaces the default, usually yellow, window used for displaying tooltips with @custom_window. GTK+ will take care of showing and hiding @custom_window at the right moment, to behave likewise as the default tooltip window. If @custom_window is %NULL, the default tooltip window will be used.
setValign void setValign(GtkAlign alig): Sets the vertical alignment of @widget. See the #GtkWidget:valign property.
setVexpand void setVexpand(bool expand): Sets whether the widget would like any available extra vertical space.
setVexpandSet void setVexpandSet(bool set): Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will be used.
setVisible void setVisible(bool visible): Sets the visibility state of @widget. Note that setting this to %TRUE doesn’t mean the widget is actually viewable, see gtk_widget_get_visible().
setVisual void setVisual(Visual visual): Sets the visual that should be used for by widget and its children for creating #GdkWindows. The visual must be on the same #GdkScreen as returned by gtk_widget_get_screen(), so handling the #GtkWidget::screen-changed signal is necessary.
setWindow void setWindow(GdkWin window): Sets a widget’s window. This function should only be used in a widget’s #GtkWidget::realize implementation. The %window passed is usually either new window created with gdk_window_new(), or the window of its parent widget as returned by gtk_widget_get_parent_window().
shapeCombineRegion void shapeCombineRegion(Region region): Sets a shape for this widget’s GDK window. This allows for transparent windows etc., see gdk_window_shape_combine_region() for more information.
show void show(): Flags a widget to be displayed. Any widget that isn’t shown will not appear on the screen. If you want to show all the widgets in a container, it’s easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets.
showAll void showAll(): Recursively shows a widget, and any child widgets (if the widget is a container).
showNow void showNow(): Shows a widget. If the widget is an unmapped toplevel widget (i.e. a #GtkWindow that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.
sizeAllocate void sizeAllocate(GtkAllocation* allocation): This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets.
sizeAllocateWithBaseline void sizeAllocateWithBaseline(GtkAllocation* allocation, int baseline): This function is only used by #GtkContainer subclasses, to assign a size, position and (optionally) baseline to their child widgets.
sizeRequest void sizeRequest(Requisition requisition): This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk_widget_size_allocate().
styleAttach void styleAttach(): This function attaches the widget’s #GtkStyle to the widget's #GdkWindow. It is a replacement for
styleGetProperty void styleGetProperty(string propertyName, Value value): Gets the value of a style property of @widget.
styleGetValist void styleGetValist(string firstPropertyName, void* varArgs): Non-vararg variant of gtk_widget_style_get(). Used primarily by language bindings.
thawChildNotify void thawChildNotify(): Reverts the effect of a previous call to gtk_widget_freeze_child_notify(). This causes all queued #GtkWidget::child-notify signals on @widget to be emitted.
translateCoordinates bool translateCoordinates(Widget destWidget, int srcX, int srcY, int destX, int destY): Translate coordinates relative to @src_widget’s allocation to coordinates relative to @dest_widget’s allocations. In order to perform this operation, both widgets must be realized, and must share a common toplevel.
triggerTooltipQuery void triggerTooltipQuery(): Triggers a tooltip query on the display where the toplevel of @widget is located. See gtk_tooltip_trigger_tooltip_query() for more information.
unmap void unmap(): This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.
unparent void unparent(): This function is only for use in widget implementations. Should be called by implementations of the remove method on #GtkContainer, to dissociate a child from the container.
unrealize void unrealize(): This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as @widget->window).
unregisterWindow void unregisterWindow(GdkWin window): Unregisters a #GdkWindow from the widget that was previously set up with gtk_widget_register_window(). You need to call this when the window is no longer used by the widget, such as when you destroy it.
unsetStateFlags void unsetStateFlags(GtkStateFlags flags): This function is for use in widget implementations. Turns off flag values for the current widget state (insensitive, prelighted, etc.). See gtk_widget_set_state_flags().
connectedSignals int[string] connectedSignals;: Undocumented in source.
onAccelClosuresChangedListeners void delegate(Widget)[] onAccelClosuresChangedListeners;: Undocumented in source.
addOnAccelClosuresChanged void addOnAccelClosuresChanged(void delegate(Widget) dlg, ConnectFlags connectFlags)
callBackAccelClosuresChanged void callBackAccelClosuresChanged(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onButtonPressListeners bool delegate(GdkEventButton*, Widget)[] onButtonPressListeners;: Undocumented in source.
addOnButtonPress void addOnButtonPress(bool delegate(GdkEventButton*, Widget) dlg, ConnectFlags connectFlags): The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.
callBackButtonPress int callBackButtonPress(GtkWidget* widgetStruct, GdkEventButton* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onButtonPressEventGenericListeners bool delegate(Event, Widget)[] onButtonPressEventGenericListeners;: Undocumented in source.
addOnButtonPress void addOnButtonPress(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.
callBackButtonPressEventGeneric int callBackButtonPressEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onButtonReleaseListeners bool delegate(GdkEventButton*, Widget)[] onButtonReleaseListeners;: Undocumented in source.
addOnButtonRelease void addOnButtonRelease(bool delegate(GdkEventButton*, Widget) dlg, ConnectFlags connectFlags): The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.
callBackButtonRelease int callBackButtonRelease(GtkWidget* widgetStruct, GdkEventButton* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onButtonReleaseEventGenericListeners bool delegate(Event, Widget)[] onButtonReleaseEventGenericListeners;: Undocumented in source.
addOnButtonRelease void addOnButtonRelease(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.
callBackButtonReleaseEventGeneric int callBackButtonReleaseEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onCanActivateAccelListeners bool delegate(uint, Widget)[] onCanActivateAccelListeners;: Undocumented in source.
addOnCanActivateAccel void addOnCanActivateAccel(bool delegate(uint, Widget) dlg, ConnectFlags connectFlags): 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.
callBackCanActivateAccel int callBackCanActivateAccel(GtkWidget* widgetStruct, uint signalId, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onChildNotifyListeners void delegate(ParamSpec, Widget)[] onChildNotifyListeners;: Undocumented in source.
addOnChildNotify void addOnChildNotify(void delegate(ParamSpec, Widget) dlg, ConnectFlags connectFlags): The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal's detail holds the property name.
callBackChildNotify void callBackChildNotify(GtkWidget* widgetStruct, GParamSpec* childProperty, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onCompositedChangedListeners void delegate(Widget)[] onCompositedChangedListeners;: Undocumented in source.
addOnCompositedChanged void addOnCompositedChanged(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::composited-changed signal is emitted when the composited status of @widgets screen changes. See gdk_screen_is_composited().
callBackCompositedChanged void callBackCompositedChanged(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onConfigureListeners bool delegate(GdkEventConfigure*, Widget)[] onConfigureListeners;: Undocumented in source.
addOnConfigure void addOnConfigure(bool delegate(GdkEventConfigure*, Widget) dlg, ConnectFlags connectFlags): The ::configure-event signal will be emitted when the size, position or stacking of the @widget's window has changed.
callBackConfigure int callBackConfigure(GtkWidget* widgetStruct, GdkEventConfigure* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onConfigureEventGenericListeners bool delegate(Event, Widget)[] onConfigureEventGenericListeners;: Undocumented in source.
addOnConfigure void addOnConfigure(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::configure-event signal will be emitted when the size, position or stacking of the @widget's window has changed.
callBackConfigureEventGeneric int callBackConfigureEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDamageListeners bool delegate(GdkEventExpose*, Widget)[] onDamageListeners;: Undocumented in source.
addOnDamage void addOnDamage(bool delegate(GdkEventExpose*, Widget) dlg, ConnectFlags connectFlags): Emitted when a redirected window belonging to @widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.
callBackDamage int callBackDamage(GtkWidget* widgetStruct, GdkEventExpose* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDamageEventGenericListeners bool delegate(Event, Widget)[] onDamageEventGenericListeners;: Undocumented in source.
addOnDamage void addOnDamage(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): Emitted when a redirected window belonging to @widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.
callBackDamageEventGeneric int callBackDamageEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDeleteListeners bool delegate(Event, Widget)[] onDeleteListeners;: Undocumented in source.
addOnDelete void addOnDelete(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::delete-event signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Connecting gtk_widget_hide_on_delete() to this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it.
callBackDelete int callBackDelete(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDestroyListeners void delegate(Widget)[] onDestroyListeners;: Undocumented in source.
addOnDestroy void addOnDestroy(void delegate(Widget) dlg, ConnectFlags connectFlags): Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.
callBackDestroy void callBackDestroy(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDestroyEventListeners bool delegate(Event, Widget)[] onDestroyEventListeners;: Undocumented in source.
addOnDestroyEvent void addOnDestroyEvent(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::destroy-event signal is emitted when a #GdkWindow is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time.
callBackDestroyEvent int callBackDestroyEvent(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDirectionChangedListeners void delegate(GtkTextDirection, Widget)[] onDirectionChangedListeners;: Undocumented in source.
addOnDirectionChanged void addOnDirectionChanged(void delegate(GtkTextDirection, Widget) dlg, ConnectFlags connectFlags): The ::direction-changed signal is emitted when the text direction of a widget changes.
callBackDirectionChanged void callBackDirectionChanged(GtkWidget* widgetStruct, GtkTextDirection previousDirection, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragBeginListeners void delegate(DragContext, Widget)[] onDragBeginListeners;: Undocumented in source.
addOnDragBegin void addOnDragBegin(void delegate(DragContext, Widget) dlg, ConnectFlags connectFlags): The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
callBackDragBegin void callBackDragBegin(GtkWidget* widgetStruct, GdkDragContext* context, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragDataDeleteListeners void delegate(DragContext, Widget)[] onDragDataDeleteListeners;: Undocumented in source.
addOnDragDataDelete void addOnDragDataDelete(void delegate(DragContext, Widget) dlg, ConnectFlags connectFlags): The ::drag-data-delete signal is emitted on the drag source when a drag with the action %GDK_ACTION_MOVE is successfully completed. The signal handler is responsible for deleting the data that has been dropped. What "delete" means depends on the context of the drag operation.
callBackDragDataDelete void callBackDragDataDelete(GtkWidget* widgetStruct, GdkDragContext* context, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragDataGetListeners void delegate(DragContext, SelectionData, uint, uint, Widget)[] onDragDataGetListeners;: Undocumented in source.
addOnDragDataGet void addOnDragDataGet(void delegate(DragContext, SelectionData, uint, uint, Widget) dlg, ConnectFlags connectFlags): The ::drag-data-get signal is emitted on the drag source when the drop site requests the data which is dragged. It is the responsibility of the signal handler to fill @data with the data in the format which is indicated by @info. See gtk_selection_data_set() and gtk_selection_data_set_text().
callBackDragDataGet void callBackDragDataGet(GtkWidget* widgetStruct, GdkDragContext* context, GtkSelectionData* data, uint info, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragDataReceivedListeners void delegate(DragContext, int, int, SelectionData, uint, uint, Widget)[] onDragDataReceivedListeners;: Undocumented in source.
addOnDragDataReceived void addOnDragDataReceived(void delegate(DragContext, int, int, SelectionData, uint, uint, Widget) dlg, ConnectFlags connectFlags): The ::drag-data-received signal is emitted on the drop site when the dragged data has been received. If the data was received in order to determine whether the drop will be accepted, the handler is expected to call gdk_drag_status() and not finish the drag. If the data was received in response to a #GtkWidget::drag-drop signal (and this is the last target to be received), the handler for this signal is expected to process the received data and then call gtk_drag_finish(), setting the @success parameter depending on whether the data was processed successfully.
callBackDragDataReceived void callBackDragDataReceived(GtkWidget* widgetStruct, GdkDragContext* context, int x, int y, GtkSelectionData* data, uint info, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragDropListeners bool delegate(DragContext, int, int, uint, Widget)[] onDragDropListeners;: Undocumented in source.
addOnDragDrop void addOnDragDrop(bool delegate(DragContext, int, int, uint, Widget) dlg, ConnectFlags connectFlags): The ::drag-drop signal is emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing is necessary. Otherwise, the handler returns %TRUE. In this case, the handler must ensure that gtk_drag_finish() is called to let the source know that the drop is done. The call to gtk_drag_finish() can be done either directly or in a #GtkWidget::drag-data-received handler which gets triggered by calling gtk_drag_get_data() to receive the data for one or more of the supported targets.
callBackDragDrop int callBackDragDrop(GtkWidget* widgetStruct, GdkDragContext* context, int x, int y, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragEndListeners void delegate(DragContext, Widget)[] onDragEndListeners;: Undocumented in source.
addOnDragEnd void addOnDragEnd(void delegate(DragContext, Widget) dlg, ConnectFlags connectFlags): The ::drag-end signal is emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in #GtkWidget::drag-begin.
callBackDragEnd void callBackDragEnd(GtkWidget* widgetStruct, GdkDragContext* context, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragFailedListeners bool delegate(DragContext, GtkDragResult, Widget)[] onDragFailedListeners;: Undocumented in source.
addOnDragFailed void addOnDragFailed(bool delegate(DragContext, GtkDragResult, Widget) dlg, ConnectFlags connectFlags): The ::drag-failed signal is emitted on the drag source when a drag has failed. The signal handler may hook custom code to handle a failed DnD operation based on the type of error, it returns %TRUE is the failure has been already handled (not showing the default "drag operation failed" animation), otherwise it returns %FALSE.
callBackDragFailed int callBackDragFailed(GtkWidget* widgetStruct, GdkDragContext* context, GtkDragResult result, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragLeaveListeners void delegate(DragContext, uint, Widget)[] onDragLeaveListeners;: Undocumented in source.
addOnDragLeave void addOnDragLeave(void delegate(DragContext, uint, Widget) dlg, ConnectFlags connectFlags): The ::drag-leave signal is emitted on the drop site when the cursor leaves the widget. A typical reason to connect to this signal is to undo things done in #GtkWidget::drag-motion, e.g. undo highlighting with gtk_drag_unhighlight().
callBackDragLeave void callBackDragLeave(GtkWidget* widgetStruct, GdkDragContext* context, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onDragMotionListeners bool delegate(DragContext, int, int, uint, Widget)[] onDragMotionListeners;: Undocumented in source.
addOnDragMotion void addOnDragMotion(bool delegate(DragContext, int, int, uint, Widget) dlg, ConnectFlags connectFlags): The ::drag-motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns %FALSE and no further processing is necessary. Otherwise, the handler returns %TRUE. In this case, the handler is responsible for providing the necessary information for displaying feedback to the user, by calling gdk_drag_status().
callBackDragMotion int callBackDragMotion(GtkWidget* widgetStruct, GdkDragContext* context, int x, int y, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onEnterNotifyListeners bool delegate(GdkEventCrossing*, Widget)[] onEnterNotifyListeners;: Undocumented in source.
addOnEnterNotify void addOnEnterNotify(bool delegate(GdkEventCrossing*, Widget) dlg, ConnectFlags connectFlags): The ::enter-notify-event will be emitted when the pointer enters the @widget's window.
callBackEnterNotify int callBackEnterNotify(GtkWidget* widgetStruct, GdkEventCrossing* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onEnterNotifyEventGenericListeners bool delegate(Event, Widget)[] onEnterNotifyEventGenericListeners;: Undocumented in source.
addOnEnterNotify void addOnEnterNotify(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::enter-notify-event will be emitted when the pointer enters the @widget's window.
callBackEnterNotifyEventGeneric int callBackEnterNotifyEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onListeners bool delegate(Event, Widget)[] onListeners;: Undocumented in source.
addOn void addOn(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The GTK+ main loop will emit three signals for each GDK event delivered to a widget: one generic ::event signal, another, more specific, signal that matches the type of event delivered (e.g. #GtkWidget::key-press-event) and finally a generic #GtkWidget::event-after signal.
callBack int callBack(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onEventAfterListeners void delegate(Event, Widget)[] onEventAfterListeners;: Undocumented in source.
addOnEventAfter void addOnEventAfter(void delegate(Event, Widget) dlg, ConnectFlags connectFlags): After the emission of the #GtkWidget::event signal and (optionally) the second more specific signal, ::event-after will be emitted regardless of the previous two signals handlers return values.
callBackEventAfter void callBackEventAfter(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusListeners bool delegate(GtkDirectionType, Widget)[] onFocusListeners;: Undocumented in source.
addOnFocus void addOnFocus(bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags): Return: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
callBackFocus int callBackFocus(GtkWidget* widgetStruct, GtkDirectionType direction, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusInListeners bool delegate(GdkEventFocus*, Widget)[] onFocusInListeners;: Undocumented in source.
addOnFocusIn void addOnFocusIn(bool delegate(GdkEventFocus*, Widget) dlg, ConnectFlags connectFlags): The ::focus-in-event signal will be emitted when the keyboard focus enters the @widget's window.
callBackFocusIn int callBackFocusIn(GtkWidget* widgetStruct, GdkEventFocus* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusInEventGenericListeners bool delegate(Event, Widget)[] onFocusInEventGenericListeners;: Undocumented in source.
addOnFocusIn void addOnFocusIn(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::focus-in-event signal will be emitted when the keyboard focus enters the @widget's window.
callBackFocusInEventGeneric int callBackFocusInEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusOutListeners bool delegate(GdkEventFocus*, Widget)[] onFocusOutListeners;: Undocumented in source.
addOnFocusOut void addOnFocusOut(bool delegate(GdkEventFocus*, Widget) dlg, ConnectFlags connectFlags): The ::focus-out-event signal will be emitted when the keyboard focus leaves the @widget's window.
callBackFocusOut int callBackFocusOut(GtkWidget* widgetStruct, GdkEventFocus* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onFocusOutEventGenericListeners bool delegate(Event, Widget)[] onFocusOutEventGenericListeners;: Undocumented in source.
addOnFocusOut void addOnFocusOut(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::focus-out-event signal will be emitted when the keyboard focus leaves the @widget's window.
callBackFocusOutEventGeneric int callBackFocusOutEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onGrabBrokenListeners bool delegate(GdkEventGrabBroken*, Widget)[] onGrabBrokenListeners;: Undocumented in source.
addOnGrabBroken void addOnGrabBroken(bool delegate(GdkEventGrabBroken*, Widget) dlg, ConnectFlags connectFlags): Emitted when a pointer or keyboard grab on a window belonging to @widget gets broken.
callBackGrabBroken int callBackGrabBroken(GtkWidget* widgetStruct, GdkEventGrabBroken* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onGrabBrokenEventGenericListeners bool delegate(Event, Widget)[] onGrabBrokenEventGenericListeners;: Undocumented in source.
addOnGrabBroken void addOnGrabBroken(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): Emitted when a pointer or keyboard grab on a window belonging to @widget gets broken.
callBackGrabBrokenEventGeneric int callBackGrabBrokenEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onGrabFocusListeners void delegate(Widget)[] onGrabFocusListeners;: Undocumented in source.
addOnGrabFocus void addOnGrabFocus(void delegate(Widget) dlg, ConnectFlags connectFlags)
callBackGrabFocus void callBackGrabFocus(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onGrabNotifyListeners void delegate(bool, Widget)[] onGrabNotifyListeners;: Undocumented in source.
addOnGrabNotify void addOnGrabNotify(void delegate(bool, Widget) dlg, ConnectFlags connectFlags): The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.
callBackGrabNotify void callBackGrabNotify(GtkWidget* widgetStruct, bool wasGrabbed, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onHideListeners void delegate(Widget)[] onHideListeners;: Undocumented in source.
addOnHide void addOnHide(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::hide signal is emitted when @widget is hidden, for example with gtk_widget_hide().
callBackHide void callBackHide(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onHierarchyChangedListeners void delegate(Widget, Widget)[] onHierarchyChangedListeners;: Undocumented in source.
addOnHierarchyChanged void addOnHierarchyChanged(void delegate(Widget, Widget) dlg, ConnectFlags connectFlags): The ::hierarchy-changed signal is emitted when the anchored state of a widget changes. A widget is “anchored” when its toplevel ancestor is a #GtkWindow. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa.
callBackHierarchyChanged void callBackHierarchyChanged(GtkWidget* widgetStruct, GtkWidget* previousToplevel, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onKeyPressListeners bool delegate(GdkEventKey*, Widget)[] onKeyPressListeners;: Undocumented in source.
addOnKeyPress void addOnKeyPress(bool delegate(GdkEventKey*, Widget) dlg, ConnectFlags connectFlags): The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.
callBackKeyPress int callBackKeyPress(GtkWidget* widgetStruct, GdkEventKey* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onKeyPressEventGenericListeners bool delegate(Event, Widget)[] onKeyPressEventGenericListeners;: Undocumented in source.
addOnKeyPress void addOnKeyPress(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.
callBackKeyPressEventGeneric int callBackKeyPressEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onKeyReleaseListeners bool delegate(GdkEventKey*, Widget)[] onKeyReleaseListeners;: Undocumented in source.
addOnKeyRelease void addOnKeyRelease(bool delegate(GdkEventKey*, Widget) dlg, ConnectFlags connectFlags): The ::key-release-event signal is emitted when a key is released.
callBackKeyRelease int callBackKeyRelease(GtkWidget* widgetStruct, GdkEventKey* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onKeyReleaseEventGenericListeners bool delegate(Event, Widget)[] onKeyReleaseEventGenericListeners;: Undocumented in source.
addOnKeyRelease void addOnKeyRelease(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::key-release-event signal is emitted when a key is released.
callBackKeyReleaseEventGeneric int callBackKeyReleaseEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onKeynavFailedListeners bool delegate(GtkDirectionType, Widget)[] onKeynavFailedListeners;: Undocumented in source.
addOnKeynavFailed void addOnKeynavFailed(bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags): Gets emitted if keyboard navigation fails. See gtk_widget_keynav_failed() for details.
callBackKeynavFailed int callBackKeynavFailed(GtkWidget* widgetStruct, GtkDirectionType direction, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onLeaveNotifyListeners bool delegate(GdkEventCrossing*, Widget)[] onLeaveNotifyListeners;: Undocumented in source.
addOnLeaveNotify void addOnLeaveNotify(bool delegate(GdkEventCrossing*, Widget) dlg, ConnectFlags connectFlags): The ::leave-notify-event will be emitted when the pointer leaves the @widget's window.
callBackLeaveNotify int callBackLeaveNotify(GtkWidget* widgetStruct, GdkEventCrossing* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onLeaveNotifyEventGenericListeners bool delegate(Event, Widget)[] onLeaveNotifyEventGenericListeners;: Undocumented in source.
addOnLeaveNotify void addOnLeaveNotify(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::leave-notify-event will be emitted when the pointer leaves the @widget's window.
callBackLeaveNotifyEventGeneric int callBackLeaveNotifyEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMapListeners void delegate(Widget)[] onMapListeners;: Undocumented in source.
addOnMap void addOnMap(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::map signal is emitted when @widget is going to be mapped, that is when the widget is visible (which is controlled with gtk_widget_set_visible()) and all its parents up to the toplevel widget are also visible. Once the map has occurred, #GtkWidget::map-event will be emitted.
callBackMap void callBackMap(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMapEventListeners bool delegate(GdkEventAny*, Widget)[] onMapEventListeners;: Undocumented in source.
addOnMapEvent void addOnMapEvent(bool delegate(GdkEventAny*, Widget) dlg, ConnectFlags connectFlags): The ::map-event signal will be emitted when the @widget's window is mapped. A window is mapped when it becomes visible on the screen.
callBackMapEvent int callBackMapEvent(GtkWidget* widgetStruct, GdkEventAny* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMapEventGenericListeners bool delegate(Event, Widget)[] onMapEventGenericListeners;: Undocumented in source.
addOnMapEvent void addOnMapEvent(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::map-event signal will be emitted when the @widget's window is mapped. A window is mapped when it becomes visible on the screen.
callBackMapEventGeneric int callBackMapEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMnemonicActivateListeners bool delegate(bool, Widget)[] onMnemonicActivateListeners;: Undocumented in source.
addOnMnemonicActivate void addOnMnemonicActivate(bool delegate(bool, Widget) dlg, ConnectFlags connectFlags): Return: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
callBackMnemonicActivate int callBackMnemonicActivate(GtkWidget* widgetStruct, bool arg1, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMotionNotifyListeners bool delegate(GdkEventMotion*, Widget)[] onMotionNotifyListeners;: Undocumented in source.
addOnMotionNotify void addOnMotionNotify(bool delegate(GdkEventMotion*, Widget) dlg, ConnectFlags connectFlags): The ::motion-notify-event signal is emitted when the pointer moves over the widget's #GdkWindow.
callBackMotionNotify int callBackMotionNotify(GtkWidget* widgetStruct, GdkEventMotion* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMotionNotifyEventGenericListeners bool delegate(Event, Widget)[] onMotionNotifyEventGenericListeners;: Undocumented in source.
addOnMotionNotify void addOnMotionNotify(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::motion-notify-event signal is emitted when the pointer moves over the widget's #GdkWindow.
callBackMotionNotifyEventGeneric int callBackMotionNotifyEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onMoveFocusListeners void delegate(GtkDirectionType, Widget)[] onMoveFocusListeners;: Undocumented in source.
addOnMoveFocus void addOnMoveFocus(void delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags)
callBackMoveFocus void callBackMoveFocus(GtkWidget* widgetStruct, GtkDirectionType direction, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onParentSetListeners void delegate(Widget, Widget)[] onParentSetListeners;: Undocumented in source.
addOnParentSet void addOnParentSet(void delegate(Widget, Widget) dlg, ConnectFlags connectFlags): The ::parent-set signal is emitted when a new parent has been set on a widget.
callBackParentSet void callBackParentSet(GtkWidget* widgetStruct, GtkWidget* oldParent, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onPopupMenuListeners bool delegate(Widget)[] onPopupMenuListeners;: Undocumented in source.
addOnPopupMenu void addOnPopupMenu(bool delegate(Widget) dlg, ConnectFlags connectFlags): This signal gets emitted whenever a widget should pop up a context menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the #GtkEntry widget creates a menu with clipboard commands. See the [Popup Menu Migration Checklist][checklist-popup-menu] for an example of how to use this signal.
callBackPopupMenu int callBackPopupMenu(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onPropertyNotifyListeners bool delegate(GdkEventProperty*, Widget)[] onPropertyNotifyListeners;: Undocumented in source.
addOnPropertyNotify void addOnPropertyNotify(bool delegate(GdkEventProperty*, Widget) dlg, ConnectFlags connectFlags): The ::property-notify-event signal will be emitted when a property on the @widget's window has been changed or deleted.
callBackPropertyNotify int callBackPropertyNotify(GtkWidget* widgetStruct, GdkEventProperty* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onPropertyNotifyEventGenericListeners bool delegate(Event, Widget)[] onPropertyNotifyEventGenericListeners;: Undocumented in source.
addOnPropertyNotify void addOnPropertyNotify(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::property-notify-event signal will be emitted when a property on the @widget's window has been changed or deleted.
callBackPropertyNotifyEventGeneric int callBackPropertyNotifyEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onProximityInListeners bool delegate(GdkEventProximity*, Widget)[] onProximityInListeners;: Undocumented in source.
addOnProximityIn void addOnProximityIn(bool delegate(GdkEventProximity*, Widget) dlg, ConnectFlags connectFlags): To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.
callBackProximityIn int callBackProximityIn(GtkWidget* widgetStruct, GdkEventProximity* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onProximityInEventGenericListeners bool delegate(Event, Widget)[] onProximityInEventGenericListeners;: Undocumented in source.
addOnProximityIn void addOnProximityIn(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.
callBackProximityInEventGeneric int callBackProximityInEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onProximityOutListeners bool delegate(GdkEventProximity*, Widget)[] onProximityOutListeners;: Undocumented in source.
addOnProximityOut void addOnProximityOut(bool delegate(GdkEventProximity*, Widget) dlg, ConnectFlags connectFlags): To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.
callBackProximityOut int callBackProximityOut(GtkWidget* widgetStruct, GdkEventProximity* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onProximityOutEventGenericListeners bool delegate(Event, Widget)[] onProximityOutEventGenericListeners;: Undocumented in source.
addOnProximityOut void addOnProximityOut(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): To receive this signal the #GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.
callBackProximityOutEventGeneric int callBackProximityOutEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onQueryTooltipListeners bool delegate(int, int, bool, Tooltip, Widget)[] onQueryTooltipListeners;: Undocumented in source.
addOnQueryTooltip void addOnQueryTooltip(bool delegate(int, int, bool, Tooltip, Widget) dlg, ConnectFlags connectFlags): Emitted when #GtkWidget:has-tooltip is %TRUE and the hover timeout has expired with the cursor hovering "above" @widget; or emitted when @widget got focus in keyboard mode.
callBackQueryTooltip int callBackQueryTooltip(GtkWidget* widgetStruct, int x, int y, bool keyboardMode, GtkTooltip* tooltip, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onRealizeListeners void delegate(Widget)[] onRealizeListeners;: Undocumented in source.
addOnRealize void addOnRealize(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::realize signal is emitted when @widget is associated with a #GdkWindow, which means that gtk_widget_realize() has been called or the widget has been mapped (that is, it is going to be drawn).
callBackRealize void callBackRealize(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onScreenChangedListeners void delegate(Screen, Widget)[] onScreenChangedListeners;: Undocumented in source.
addOnScreenChanged void addOnScreenChanged(void delegate(Screen, Widget) dlg, ConnectFlags connectFlags): The ::screen-changed signal gets emitted when the screen of a widget has changed.
callBackScreenChanged void callBackScreenChanged(GtkWidget* widgetStruct, GdkScreen* previousScreen, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onScrollListeners bool delegate(GdkEventScroll*, Widget)[] onScrollListeners;: Undocumented in source.
addOnScroll void addOnScroll(bool delegate(GdkEventScroll*, Widget) dlg, ConnectFlags connectFlags): The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.
callBackScroll int callBackScroll(GtkWidget* widgetStruct, GdkEventScroll* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onScrollEventGenericListeners bool delegate(Event, Widget)[] onScrollEventGenericListeners;: Undocumented in source.
addOnScroll void addOnScroll(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.
callBackScrollEventGeneric int callBackScrollEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionClearListeners bool delegate(GdkEventSelection*, Widget)[] onSelectionClearListeners;: Undocumented in source.
addOnSelectionClear void addOnSelectionClear(bool delegate(GdkEventSelection*, Widget) dlg, ConnectFlags connectFlags): The ::selection-clear-event signal will be emitted when the the @widget's window has lost ownership of a selection.
callBackSelectionClear int callBackSelectionClear(GtkWidget* widgetStruct, GdkEventSelection* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionClearEventGenericListeners bool delegate(Event, Widget)[] onSelectionClearEventGenericListeners;: Undocumented in source.
addOnSelectionClear void addOnSelectionClear(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::selection-clear-event signal will be emitted when the the @widget's window has lost ownership of a selection.
callBackSelectionClearEventGeneric int callBackSelectionClearEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionGetListeners void delegate(SelectionData, uint, uint, Widget)[] onSelectionGetListeners;: Undocumented in source.
addOnSelectionGet void addOnSelectionGet(void delegate(SelectionData, uint, uint, Widget) dlg, ConnectFlags connectFlags)
callBackSelectionGet void callBackSelectionGet(GtkWidget* widgetStruct, GtkSelectionData* data, uint info, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionNotifyListeners bool delegate(GdkEventSelection*, Widget)[] onSelectionNotifyListeners;: Undocumented in source.
addOnSelectionNotify void addOnSelectionNotify(bool delegate(GdkEventSelection*, Widget) dlg, ConnectFlags connectFlags): Return: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
callBackSelectionNotify int callBackSelectionNotify(GtkWidget* widgetStruct, GdkEventSelection* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionNotifyEventGenericListeners bool delegate(Event, Widget)[] onSelectionNotifyEventGenericListeners;: Undocumented in source.
addOnSelectionNotify void addOnSelectionNotify(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): Return: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
callBackSelectionNotifyEventGeneric int callBackSelectionNotifyEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionReceivedListeners void delegate(SelectionData, uint, Widget)[] onSelectionReceivedListeners;: Undocumented in source.
addOnSelectionReceived void addOnSelectionReceived(void delegate(SelectionData, uint, Widget) dlg, ConnectFlags connectFlags)
callBackSelectionReceived void callBackSelectionReceived(GtkWidget* widgetStruct, GtkSelectionData* data, uint time, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionRequestListeners bool delegate(GdkEventSelection*, Widget)[] onSelectionRequestListeners;: Undocumented in source.
addOnSelectionRequest void addOnSelectionRequest(bool delegate(GdkEventSelection*, Widget) dlg, ConnectFlags connectFlags): The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the @widget's window.
callBackSelectionRequest int callBackSelectionRequest(GtkWidget* widgetStruct, GdkEventSelection* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSelectionRequestEventGenericListeners bool delegate(Event, Widget)[] onSelectionRequestEventGenericListeners;: Undocumented in source.
addOnSelectionRequest void addOnSelectionRequest(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the @widget's window.
callBackSelectionRequestEventGeneric int callBackSelectionRequestEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onShowListeners void delegate(Widget)[] onShowListeners;: Undocumented in source.
addOnShow void addOnShow(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::show signal is emitted when @widget is shown, for example with gtk_widget_show().
callBackShow void callBackShow(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onShowHelpListeners bool delegate(GtkWidgetHelpType, Widget)[] onShowHelpListeners;: Undocumented in source.
addOnShowHelp void addOnShowHelp(bool delegate(GtkWidgetHelpType, Widget) dlg, ConnectFlags connectFlags): Return: %TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further.
callBackShowHelp int callBackShowHelp(GtkWidget* widgetStruct, GtkWidgetHelpType helpType, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onSizeAllocateListeners void delegate(Allocation, Widget)[] onSizeAllocateListeners;: Undocumented in source.
addOnSizeAllocate void addOnSizeAllocate(void delegate(Allocation, Widget) dlg, ConnectFlags connectFlags)
callBackSizeAllocate void callBackSizeAllocate(GtkWidget* widgetStruct, Allocation allocation, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onStateChangedListeners void delegate(GtkStateType, Widget)[] onStateChangedListeners;: Undocumented in source.
addOnStateChanged void addOnStateChanged(void delegate(GtkStateType, Widget) dlg, ConnectFlags connectFlags): The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().
callBackStateChanged void callBackStateChanged(GtkWidget* widgetStruct, GtkStateType state, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onStateFlagsChangedListeners void delegate(GtkStateFlags, Widget)[] onStateFlagsChangedListeners;: Undocumented in source.
addOnStateFlagsChanged void addOnStateFlagsChanged(void delegate(GtkStateFlags, Widget) dlg, ConnectFlags connectFlags): The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().
callBackStateFlagsChanged void callBackStateFlagsChanged(GtkWidget* widgetStruct, GtkStateFlags flags, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onStyleSetListeners void delegate(Style, Widget)[] onStyleSetListeners;: Undocumented in source.
addOnStyleSet void addOnStyleSet(void delegate(Style, Widget) dlg, ConnectFlags connectFlags): The ::style-set signal is emitted when a new style has been set on a widget. Note that style-modifying functions like gtk_widget_modify_base() also cause this signal to be emitted.
callBackStyleSet void callBackStyleSet(GtkWidget* widgetStruct, GtkStyle* previousStyle, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onStyleUpdatedListeners void delegate(Widget)[] onStyleUpdatedListeners;: Undocumented in source.
addOnStyleUpdated void addOnStyleUpdated(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::style-updated signal is emitted when the #GtkStyleContext of a widget is changed. Note that style-modifying functions like gtk_widget_override_color() also cause this signal to be emitted.
callBackStyleUpdated void callBackStyleUpdated(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onTouchListeners bool delegate(Event, Widget)[] onTouchListeners;: Undocumented in source.
addOnTouch void addOnTouch(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags)
callBackTouch int callBackTouch(GtkWidget* widgetStruct, GdkEvent* object, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onUnmapListeners void delegate(Widget)[] onUnmapListeners;: Undocumented in source.
addOnUnmap void addOnUnmap(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::unmap signal is emitted when @widget is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden.
callBackUnmap void callBackUnmap(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onUnmapEventListeners bool delegate(GdkEventAny*, Widget)[] onUnmapEventListeners;: Undocumented in source.
addOnUnmapEvent void addOnUnmapEvent(bool delegate(GdkEventAny*, Widget) dlg, ConnectFlags connectFlags): The ::unmap-event signal will be emitted when the @widget's window is unmapped. A window is unmapped when it becomes invisible on the screen.
callBackUnmapEvent int callBackUnmapEvent(GtkWidget* widgetStruct, GdkEventAny* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onUnmapEventGenericListeners bool delegate(Event, Widget)[] onUnmapEventGenericListeners;: Undocumented in source.
addOnUnmapEvent void addOnUnmapEvent(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::unmap-event signal will be emitted when the @widget's window is unmapped. A window is unmapped when it becomes invisible on the screen.
callBackUnmapEventGeneric int callBackUnmapEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onUnrealizeListeners void delegate(Widget)[] onUnrealizeListeners;: Undocumented in source.
addOnUnrealize void addOnUnrealize(void delegate(Widget) dlg, ConnectFlags connectFlags): The ::unrealize signal is emitted when the #GdkWindow associated with @widget is destroyed, which means that gtk_widget_unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).
callBackUnrealize void callBackUnrealize(GtkWidget* widgetStruct, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onVisibilityNotifyListeners bool delegate(GdkEventVisibility*, Widget)[] onVisibilityNotifyListeners;: Undocumented in source.
addOnVisibilityNotify void addOnVisibilityNotify(bool delegate(GdkEventVisibility*, Widget) dlg, ConnectFlags connectFlags): The ::visibility-notify-event will be emitted when the @widget's window is obscured or unobscured.
callBackVisibilityNotify int callBackVisibilityNotify(GtkWidget* widgetStruct, GdkEventVisibility* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onVisibilityNotifyEventGenericListeners bool delegate(Event, Widget)[] onVisibilityNotifyEventGenericListeners;: Undocumented in source.
addOnVisibilityNotify void addOnVisibilityNotify(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::visibility-notify-event will be emitted when the @widget's window is obscured or unobscured.
callBackVisibilityNotifyEventGeneric int callBackVisibilityNotifyEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onWindowStateListeners bool delegate(GdkEventWindowState*, Widget)[] onWindowStateListeners;: Undocumented in source.
addOnWindowState void addOnWindowState(bool delegate(GdkEventWindowState*, Widget) dlg, ConnectFlags connectFlags): The ::window-state-event will be emitted when the state of the toplevel window associated to the @widget changes.
callBackWindowState int callBackWindowState(GtkWidget* widgetStruct, GdkEventWindowState* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
onWindowStateEventGenericListeners bool delegate(Event, Widget)[] onWindowStateEventGenericListeners;: Undocumented in source.
addOnWindowState void addOnWindowState(bool delegate(Event, Widget) dlg, ConnectFlags connectFlags): The ::window-state-event will be emitted when the state of the toplevel window associated to the @widget changes.
callBackWindowStateEventGeneric int callBackWindowStateEventGeneric(GtkWidget* widgetStruct, GdkEvent* event, Widget _widget): Undocumented in source. Be warned that the author may not have intended to support it.
cairoShouldDrawWindow bool cairoShouldDrawWindow(Context cr, GdkWin window): This function is supposed to be called in #GtkWidget::draw implementations for widgets that support multiple windows. @cr must be untransformed from invoking of the draw function. This function will return %TRUE if the contents of the given @window are supposed to be drawn and %FALSE otherwise. Note that when the drawing was not initiated by the windowing system this function will return %TRUE for all windows, so you need to draw the bottommost window first. Also, do not use “else if” statements to check which window should be drawn.
cairoTransformToWindow void cairoTransformToWindow(Context cr, Widget widget, GdkWin window): Transforms the given cairo context @cr that from @widget-relative coordinates to @window-relative coordinates. If the @widget’s window is not an ancestor of @window, no modification will be applied.
distributeNaturalAllocation int distributeNaturalAllocation(int extraSpace, uint nRequestedSizes, GtkRequestedSize* sizes): Distributes @extra_space to child @sizes by bringing smaller children up to natural size first.

GLArea

Drawing with GtkGLArea ##

Constructors

Members

Functions

Static functions

Variables

Inherited Members

From Widget

Meta

Since

Source