Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ColorButtonActivateCallback

[326:7] extends: object

Generated low-level callback wrapper for GIR callback activate.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ColorButtonActivateCallback (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, 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: ColorButtonMeta

[466:14] static extends: object

Generated metadata helpers for ColorButton class surfaces.

Methods

  • properties ()

    Returns property metadata for ColorButton.

    • @r A list.
  • signals ()

    Returns signal metadata for ColorButton.

    • @r A list.

class: ColorButtonColorsetCallback

[396:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ColorButtonColorsetCallback (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, 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: ColorButton

[19:7] extends: object

The GtkColorButton allows to open a color chooser dialog to change the color. An example GtkColorButton It is suitable widget for selecting a color in a preference dialog. # CSS nodes colorbutton ╰── button.color ╰── [content] GtkColorButton has a single CSS node with name colorbutton which contains a button node. To differentiate it from a plain GtkButton, it gets the .color style class.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • ColorButton (rgba = null)

    Creates a new color button. This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a color chooser dialog will open, allowing the user to select a color. The swatch will be updated to reflect the new color when the user finishes.

    • @p rgba is A GdkRGBA to set the current color with.
  • 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.
  • asWidget ()

    Wraps this handle as Widget.

    • @r A Widget object.
  • asAccessible ()

    Wraps this handle as Accessible.

    • @r A Accessible object.
  • asBuildable ()

    Wraps this handle as Buildable.

    • @r A Buildable object.
  • asColorChooser ()

    Wraps this handle as ColorChooser.

    • @r A ColorChooser object.
  • asConstraintTarget ()

    Wraps this handle as ConstraintTarget.

    • @r A ConstraintTarget object.
  • 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.
  • setOnActivate (callback Fn, UserData = null)

    Emitted to when the color button is activated. The ::activate signal on GtkMenuButton is an action signal and emitting it causes the button to pop up its dialog.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (ColorButton Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnColorset (callback Fn, UserData = null)

    Emitted when the user selects a color. When handling this signal, use [method@Gtk.ColorChooser.get_rgba] to find out which color was just selected. Note that this signal is only emitted when the user changes the color. If you need to react to programmatic color changes as well, use the notify::rgba signal.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (ColorButton Self).
    • @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.

  • setModal (bool Value)

    Whether the color chooser dialog should be modal.

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

    Whether the color chooser should open in editor mode. This property should be used in cases where the palette in the editor would be redundant, such as when the color button is already part of a palette.

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

    The title of the color chooser dialog

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

    Gets whether the dialog is modal.

  • get_title ()

    Gets the title of the color chooser dialog.

  • set_modal (bool modal)

    Sets whether the dialog should be modal.

    • @p modal is %TRUE to make the dialog modal.
    • @r None.
  • set_title (string title)

    Sets the title for the color chooser dialog.

    • @p title is String containing new window title.
    • @r None.