ColorSelectionProtocol

public protocol ColorSelectionProtocol : BoxProtocol

The ColorSelectionProtocol protocol exposes the methods and properties of an underlying GtkColorSelection 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 ColorSelection. Alternatively, use ColorSelectionRef 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 GtkColorSelection instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkColorSelection instance.

    Default Implementation

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

    Declaration

    Swift

    var color_selection_ptr: UnsafeMutablePointer<GtkColorSelection>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ColorSelectionProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ColorSelection Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: ColorSelectionPropertyName, 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 ColorSelection property

    Declaration

    Swift

    @inlinable
func get(property: ColorSelectionPropertyName) -> 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 ColorSelection property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ColorSelection signals

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ColorSelectionSignalName, 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 ColorSelectionSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ColorSelectionSignalName, 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

  • This signal is emitted when the color changes in the GtkColorSelection according to its update policy.

    Note

    This represents the underlying color-changed signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onColorChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorSelectionRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var colorChangedSignal: ColorSelectionSignalName { 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::current-alpha signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyCurrentAlpha(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorSelectionRef, _ 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 notifyCurrentAlpha signal is emitted
    Show on GitHub
  • notifyCurrentAlphaSignal Extension method

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

    Declaration

    Swift

    static var notifyCurrentAlphaSignal: ColorSelectionSignalName { 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::current-color signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyCurrentColor(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorSelectionRef, _ 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 notifyCurrentColor signal is emitted
    Show on GitHub
  • notifyCurrentColorSignal Extension method

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

    Declaration

    Swift

    static var notifyCurrentColorSignal: ColorSelectionSignalName { 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::current-rgba signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyCurrentRGBA(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorSelectionRef, _ 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 notifyCurrentRGBA signal is emitted
    Show on GitHub
  • notifyCurrentRGBASignal Extension method

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

    Declaration

    Swift

    static var notifyCurrentRGBASignal: ColorSelectionSignalName { 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::has-opacity-control signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyHasOpacityControl(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorSelectionRef, _ 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 notifyHasOpacityControl signal is emitted
    Show on GitHub

  • Typed notify::has-opacity-control signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyHasOpacityControlSignal: ColorSelectionSignalName { 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::has-palette signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyHasPalette(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ColorSelectionRef, _ 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 notifyHasPalette signal is emitted
    Show on GitHub
  • notifyHasPaletteSignal Extension method

    Typed notify::has-palette signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyHasPaletteSignal: ColorSelectionSignalName { get }
    Show on GitHub

ColorSelection Class: ColorSelectionProtocol extension (methods and fields)

  • getCurrentAlpha() Extension method

    Returns the current alpha value.

    Declaration

    Swift

    @inlinable
func getCurrentAlpha() -> guint16
    Show on GitHub
  • getCurrent(color:) Extension method

    Sets color to be the current color in the GtkColorSelection widget.

    get_current_color is deprecated: Use gtk_color_selection_get_current_rgba() instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getCurrent<ColorT>(color: ColorT) where ColorT : ColorProtocol
    Show on GitHub
  • getCurrent(rgba:) Extension method

    Sets rgba to be the current color in the GtkColorSelection widget.

    Declaration

    Swift

    @inlinable
func getCurrent<RGBAT>(rgba: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub
  • getHasOpacityControl() Extension method

    Determines whether the colorsel has an opacity control.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getHasOpacityControl() -> Bool
    Show on GitHub
  • getHasPalette() Extension method

    Determines whether the color selector has a color palette.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getHasPalette() -> Bool
    Show on GitHub
  • getPreviousAlpha() Extension method

    Returns the previous alpha value.

    Declaration

    Swift

    @inlinable
func getPreviousAlpha() -> guint16
    Show on GitHub
  • getPrevious(color:) Extension method

    Fills color in with the original color value.

    get_previous_color is deprecated: Use gtk_color_selection_get_previous_rgba() instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getPrevious<ColorT>(color: ColorT) where ColorT : ColorProtocol
    Show on GitHub
  • getPrevious(rgba:) Extension method

    Fills rgba in with the original color value.

    Declaration

    Swift

    @inlinable
func getPrevious<RGBAT>(rgba: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub
  • setCurrent(alpha:) Extension method

    Sets the current opacity to be alpha.

    The first time this is called, it will also set the original opacity to be alpha too.

    Declaration

    Swift

    @inlinable
func setCurrent(alpha: guint16)
    Show on GitHub
  • setCurrent(color:) Extension method

    Sets the current color to be color.

    The first time this is called, it will also set the original color to be color too.

    set_current_color is deprecated: Use gtk_color_selection_set_current_rgba() instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setCurrent<ColorT>(color: ColorT) where ColorT : ColorProtocol
    Show on GitHub
  • setCurrent(rgba:) Extension method

    Sets the current color to be rgba.

    The first time this is called, it will also set the original color to be rgba too.

    Declaration

    Swift

    @inlinable
func setCurrent<RGBAT>(rgba: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub

  • Sets the colorsel to use or not use opacity.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setHasOpacityControl(hasOpacity: Bool)
    Show on GitHub
  • set(hasPalette:) Extension method

    Shows and hides the palette based upon the value of has_palette.

    Declaration

    Swift

    @inlinable
func set(hasPalette: Bool)
    Show on GitHub
  • setPrevious(alpha:) Extension method

    Sets the “previous” alpha to be alpha.

    This function should be called with some hesitations, as it might seem confusing to have that alpha change.

    Declaration

    Swift

    @inlinable
func setPrevious(alpha: guint16)
    Show on GitHub
  • setPrevious(color:) Extension method

    Sets the “previous” color to be color.

    This function should be called with some hesitations, as it might seem confusing to have that color change. Calling gtk_color_selection_set_current_color() will also set this color the first time it is called.

    set_previous_color is deprecated: Use gtk_color_selection_set_previous_rgba() instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setPrevious<ColorT>(color: ColorT) where ColorT : ColorProtocol
    Show on GitHub
  • setPrevious(rgba:) Extension method

    Sets the “previous” color to be rgba.

    This function should be called with some hesitations, as it might seem confusing to have that color change. Calling gtk_color_selection_set_current_rgba() will also set this color the first time it is called.

    Declaration

    Swift

    @inlinable
func setPrevious<RGBAT>(rgba: RGBAT) where RGBAT : RGBAProtocol
    Show on GitHub
  • currentAlpha Extension method

    Returns the current alpha value.

    Declaration

    Swift

    @inlinable
var currentAlpha: guint16 { get nonmutating set }
    Show on GitHub
  • hasOpacityControl Extension method

    Determines whether the colorsel has an opacity control.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
var hasOpacityControl: Bool { get nonmutating set }
    Show on GitHub
  • hasPalette Extension method

    Determines whether the color selector has a color palette.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
var hasPalette: Bool { get nonmutating set }
    Show on GitHub
  • isAdjusting Extension method

    Gets the current state of the colorsel.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
var isAdjusting: Bool { get }
    Show on GitHub
  • previousAlpha Extension method

    Returns the previous alpha value.

    Declaration

    Swift

    @inlinable
var previousAlpha: guint16 { get nonmutating set }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GtkBox { get }
    Show on GitHub