ColorChooserProtocol

public protocol ColorChooserProtocol

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 [classGtk.ColorChooserWidget], [classGtk.ColorChooserDialog] and [classGtk.ColorButton].

The ColorChooserProtocol protocol exposes the methods and properties of an underlying GtkColorChooser instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see ColorChooser. Alternatively, use ColorChooserRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkColorChooser instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • color_chooser_ptr Default implementation

    Typed pointer to the underlying GtkColorChooser instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkColorChooser instance.

    Declaration

    Swift

    var color_chooser_ptr: UnsafeMutablePointer<GtkColorChooser>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ColorChooserProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ColorChooser Interface

  • Bind a ColorChooserPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: ColorChooserPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a ColorChooser property

    Declaration

    Swift

    @inlinable
func get(property: ColorChooserPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a ColorChooser property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: ColorChooserPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ColorChooser signals

  • Connect a Swift signal handler to the given, typed ColorChooserSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ColorChooserSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed ColorChooserSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ColorChooserSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

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

    Note

    This represents the underlying color-activated signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onColorActivated(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorChooserRef, _ color: Gdk.RGBARef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    color

    the color
    handler

    The signal handler to call Run the given callback whenever the colorActivated signal is emitted
    Show on GitHub
  • colorActivatedSignal Extension method

    Typed color-activated signal for using the connect(signal:) methods

    Declaration

    Swift

    static var colorActivatedSignal: ColorChooserSignalName { get }
    Show on GitHub
  • onNotifyRgba(flags:handler:) Extension method

    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.

    Note

    This represents the underlying notify::rgba signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyRgba(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorChooserRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyRgba signal is emitted
    Show on GitHub
  • notifyRgbaSignal Extension method

    Typed notify::rgba signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyRgbaSignal: ColorChooserSignalName { get }
    Show on GitHub

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

    Note

    This represents the underlying notify::use-alpha signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyUseAlpha(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorChooserRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyUseAlpha signal is emitted
    Show on GitHub
  • notifyUseAlphaSignal Extension method

    Typed notify::use-alpha signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyUseAlphaSignal: ColorChooserSignalName { get }
    Show on GitHub

ColorChooser Interface: ColorChooserProtocol extension (methods and fields)

  • Adds a palette to the color chooser.

    If orientation is horizontal, the colors are grouped in rows, with colors_per_line colors in each row. If horizontal is false, the colors are grouped in columns instead.

    The default color palette of [classGtk.ColorChooserWidget] has 45 colors, organized in columns of 5 colors (this includes some grays).

    The layout of the color chooser widget works best when the palettes have 9-10 columns.

    Calling this function for the first time has the side effect of removing the default color palette from the color chooser.

    If colors is nil, removes all previously added palettes.

    Declaration

    Swift

    @inlinable
func addPalette(orientation: GtkOrientation, colorsPerLine: Int, nColors: Int, colors: UnsafeMutablePointer<GdkRGBA>! = nil)
    Show on GitHub
  • getRgba(color:) Extension method

    Gets the currently-selected color.

    Declaration

    Swift

    @inlinable
func getRgba<RGBAT>(color: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub
  • getUseAlpha() Extension method

    Returns whether the color chooser shows the alpha channel.

    Declaration

    Swift

    @inlinable
func getUseAlpha() -> Bool
    Show on GitHub
  • setRgba(color:) Extension method

    Sets the color.

    Declaration

    Swift

    @inlinable
func setRgba<RGBAT>(color: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub
  • set(useAlpha:) Extension method

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

    Declaration

    Swift

    @inlinable
func set(useAlpha: Bool)
    Show on GitHub
  • useAlpha Extension method

    Returns whether the color chooser shows the alpha channel.

    Declaration

    Swift

    @inlinable
var useAlpha: Bool { get nonmutating set }
    Show on GitHub