Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ColorChooserColoractivatedCallback

[215:7] extends: object

Generated low-level callback wrapper for GIR callback color-activated.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ColorChooserColoractivatedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, color, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ColorChooserMeta

[285:14] static extends: object

Generated metadata helpers for ColorChooser interface surfaces.

Methods

  • properties ()

    Returns property metadata for ColorChooser.

    • @r A list.
  • signals ()

    Returns signal metadata for ColorChooser.

    • @r A list.

class: ColorChooser

[17:7] extends: object

GtkColorChooser is an interface that is implemented by widgets for choosing colors. Depending on the situation, colors may be allowed to have alpha (translucency). In GTK, the main widgets that implement this interface are [class@Gtk.ColorChooserWidget], [class@Gtk.ColorChooserDialog] and [class@Gtk.ColorButton].

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • ColorChooser (Handle = null)

    Creates a new ColorChooser by wrapping a native handle or another wrapper.

    • @p Handle is the native handle or another wrapper whose handle to adopt.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.
  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.
  • setOnColoractivated (callback Fn, UserData = null)

    Emitted when a color is activated from the color chooser. This usually happens when the user clicks a color swatch, or a color is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (ColorChooser Self, object Color).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setUsealpha (bool Value)

    Whether colors may have alpha (translucency). When ::use-alpha is %FALSE, the GdkRGBA struct obtained via the [property@Gtk.ColorChooser:rgba] property will be forced to have alpha == 1. Implementations are expected to show alpha by rendering the color over a non-uniform background (like a checkerboard pattern).

    • @p Value is the new property value.
    • @r None.
  • get_use_alpha ()

    Returns whether the color chooser shows the alpha channel.

  • set_rgba (color)

    Sets the color.

    • @p color is the new color.
    • @r None.
  • set_use_alpha (bool use_alpha)

    Sets whether or not the color chooser should use the alpha channel.

    • @p use_alpha is %TRUE if color chooser should use alpha channel, %FALSE if not.
    • @r None.