GLAreaSignalName

public enum GLAreaSignalName : String, SignalNameProtocol

Undocumented

  • Emitted when the widget is being realized.

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

    If context creation fails then the signal handler can use [methodGtk.GLArea.set_error] to register a more detailed error of how the construction failed.

    Declaration

    Swift

    case createContext = "create-context"
  • 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.

    This signal is not suitable for saving widget state.

    Declaration

    Swift

    case destroy = "destroy"
  • Emitted when the text direction of a widget changes.

    Declaration

    Swift

    case directionChanged = "direction-changed"
  • Emitted when widget is hidden.

    Declaration

    Swift

    case hide = "hide"
  • Emitted if keyboard navigation fails.

    See [methodGtk.Widget.keynav_failed] for details.

    Declaration

    Swift

    case keynavFailed = "keynav-failed"
  • map

    Emitted when widget is going to be mapped.

    A widget is mapped when the widget is visible (which is controlled with [propertyGtk.Widget:visible]) and all its parents up to the toplevel widget are also visible.

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

    Declaration

    Swift

    case map = "map"
  • Emitted when a widget is activated via a mnemonic.

    The default handler for this signal activates widget if group_cycling is false, or just makes widget grab focus if group_cycling is true.

    Declaration

    Swift

    case mnemonicActivate = "mnemonic-activate"
  • Emitted when the focus is moved.

    Declaration

    Swift

    case moveFocus = "move-focus"
  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                      G_CALLBACK (gtk_text_view_target_list_notify),
                      text_view)
    

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Declaration

    Swift

    case notify = "notify"
  • Emitted when the widgets tooltip is about to be shown.

    This happens when the [propertyGtk.Widget:has-tooltip] property is true and the hover timeout has expired with the cursor hovering “above” widget; or emitted when widget got focus in keyboard mode.

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

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

    Declaration

    Swift

    case queryTooltip = "query-tooltip"
  • Emitted when widget is associated with a GdkSurface.

    This means that [methodGtk.Widget.realize] has been called or the widget has been mapped (that is, it is going to be drawn).

    Declaration

    Swift

    case realize = "realize"
  • Emitted every time the contents of the GtkGLArea should be redrawn.

    The context is bound to the area prior to emitting this function, and the buffers are painted to the window once the emission terminates.

    Declaration

    Swift

    case render = "render"
  • 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.

    The GL context for the area is guaranteed to be current when this signal is emitted.

    The default handler sets up the GL viewport.

    Declaration

    Swift

    case resize = "resize"
  • Emitted when widget is shown.

    Declaration

    Swift

    case show = "show"
  • Emitted when the widget state changes.

    See [methodGtk.Widget.get_state_flags].

    Declaration

    Swift

    case stateFlagsChanged = "state-flags-changed"
  • Emitted when widget is going to be unmapped.

    A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

    As unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

    Declaration

    Swift

    case unmap = "unmap"
  • Emitted when the GdkSurface associated with widget is destroyed.

    This means that [methodGtk.Widget.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden).

    Declaration

    Swift

    case unrealize = "unrealize"
  • If set to true the render signal will be emitted every time the widget draws.

    This is the default and is useful if drawing the widget is faster.

    If set to false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering [methodGtk.GLArea.queue_render] must be called. This mode is useful when the scene changes seldom, but takes a long time to redraw.

    Declaration

    Swift

    case notifyAutoRender = "notify::auto-render"
  • Whether the widget or any of its descendents can accept the input focus.

    This property is meant to be set by widget implementations, typically in their instance init function.

    Declaration

    Swift

    case notifyCanFocus = "notify::can-focus"
  • Whether the widget can receive pointer events.

    Declaration

    Swift

    case notifyCanTarget = "notify::can-target"
  • The GdkGLContext used by the GtkGLArea widget.

    The GtkGLArea widget is responsible for creating the GdkGLContext instance. If you need to render with other kinds of buffers (stencil, depth, etc), use render buffers.

    Declaration

    Swift

    case notifyContext = "notify::context"
  • A list of css classes applied to this widget.

    Declaration

    Swift

    case notifyCssClasses = "notify::css-classes"
  • The name of this widget in the CSS tree.

    This property is meant to be set by widget implementations, typically in their instance init function.

    Declaration

    Swift

    case notifyCssName = "notify::css-name"
  • The cursor used by widget.

    Declaration

    Swift

    case notifyCursor = "notify::cursor"
  • Whether the widget should grab focus when it is clicked with the mouse.

    This property is only relevant for widgets that can take focus.

    Declaration

    Swift

    case notifyFocusOnClick = "notify::focus-on-click"
  • Whether this widget itself will accept the input focus.

    Declaration

    Swift

    case notifyFocusable = "notify::focusable"
  • How to distribute horizontal space if widget gets extra space.

    Declaration

    Swift

    case notifyHalign = "notify::halign"
  • Whether the widget is the default widget.

    Declaration

    Swift

    case notifyHasDefault = "notify::has-default"
  • If set to true the widget will allocate and enable a depth buffer for the target framebuffer.

    Declaration

    Swift

    case notifyHasDepthBuffer = "notify::has-depth-buffer"
  • Whether the widget has the input focus.

    Declaration

    Swift

    case notifyHasFocus = "notify::has-focus"
  • If set to true the widget will allocate and enable a stencil buffer for the target framebuffer.

    Declaration

    Swift

    case notifyHasStencilBuffer = "notify::has-stencil-buffer"
  • Enables or disables the emission of the query-tooltip signal on widget.

    A value of true indicates that widget can have a tooltip, in this case the widget will be queried using [signalGtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

    Declaration

    Swift

    case notifyHasTooltip = "notify::has-tooltip"
  • Override for height request of the widget.

    If this is -1, the natural request will be used.

    Declaration

    Swift

    case notifyHeightRequest = "notify::height-request"
  • Whether to expand horizontally.

    Declaration

    Swift

    case notifyHexpand = "notify::hexpand"
  • Whether to use the hexpand property.

    Declaration

    Swift

    case notifyHexpandSet = "notify::hexpand-set"
  • The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

    This property is meant to be set by widget implementations, typically in their instance init function.

    Declaration

    Swift

    case notifyLayoutManager = "notify::layout-manager"
  • Margin on bottom side of widget.

    This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

    Declaration

    Swift

    case notifyMarginBottom = "notify::margin-bottom"
  • Margin on end of widget, horizontally.

    This property supports left-to-right and right-to-left text directions.

    This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

    Declaration

    Swift

    case notifyMarginEnd = "notify::margin-end"
  • Margin on start of widget, horizontally.

    This property supports left-to-right and right-to-left text directions.

    This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

    Declaration

    Swift

    case notifyMarginStart = "notify::margin-start"
  • Margin on top side of widget.

    This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

    Declaration

    Swift

    case notifyMarginTop = "notify::margin-top"
  • The name of the widget.

    Declaration

    Swift

    case notifyName = "notify::name"
  • The requested opacity of the widget.

    Declaration

    Swift

    case notifyOpacity = "notify::opacity"
  • How content outside the widget’s content area is treated.

    This property is meant to be set by widget implementations, typically in their instance init function.

    Declaration

    Swift

    case notifyOverflow = "notify::overflow"
  • The parent widget of this widget.

    Declaration

    Swift

    case notifyParent = "notify::parent"
  • Whether the widget will receive the default action when it is focused.

    Declaration

    Swift

    case notifyReceivesDefault = "notify::receives-default"
  • The GtkRoot widget of the widget tree containing this widget.

    This will be nil if the widget is not contained in a root widget.

    Declaration

    Swift

    case notifyRoot = "notify::root"
  • The scale factor of the widget.

    Declaration

    Swift

    case notifyScaleFactor = "notify::scale-factor"
  • Whether the widget responds to input.

    Declaration

    Swift

    case notifySensitive = "notify::sensitive"
  • Sets the text of tooltip to be the given string, which is marked up with Pango markup.

    Also see [methodGtk.Tooltip.set_markup].

    This is a convenience property which will take care of getting the tooltip shown if the given string is not nil: [propertyGtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

    Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

    Declaration

    Swift

    case notifyTooltipMarkup = "notify::tooltip-markup"
  • Sets the text of tooltip to be the given string.

    Also see [methodGtk.Tooltip.set_text].

    This is a convenience property which will take care of getting the tooltip shown if the given string is not nil: [propertyGtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

    Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

    Declaration

    Swift

    case notifyTooltipText = "notify::tooltip-text"
  • If set to true the widget will try to create a GdkGLContext using OpenGL ES instead of OpenGL.

    Declaration

    Swift

    case notifyUseEs = "notify::use-es"
  • How to distribute vertical space if widget gets extra space.

    Declaration

    Swift

    case notifyValign = "notify::valign"
  • Whether to expand vertically.

    Declaration

    Swift

    case notifyVexpand = "notify::vexpand"
  • Whether to use the vexpand property.

    Declaration

    Swift

    case notifyVexpandSet = "notify::vexpand-set"
  • Whether the widget is visible.

    Declaration

    Swift

    case notifyVisible = "notify::visible"
  • Override for width request of the widget.

    If this is -1, the natural request will be used.

    Declaration

    Swift

    case notifyWidthRequest = "notify::width-request"