HSVProtocol

public protocol HSVProtocol : WidgetProtocol

GtkHSV is the “color wheel” part of a complete color selector widget. It allows to select a color by determining its HSV components in an intuitive way. Moving the selection around the outer ring changes the hue, and moving the selection point inside the inner triangle changes value and saturation.

GtkHSV has been deprecated together with GtkColorSelection, where it was used.

The HSVProtocol protocol exposes the methods and properties of an underlying GtkHSV 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 HSV. Alternatively, use HSVRef 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 GtkHSV instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkHSV instance.

    Default Implementation

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

    Declaration

    Swift

    var hsv_ptr: UnsafeMutablePointer<GtkHSV>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to HSVProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

HSV Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

HSV signals

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

    Declaration

    Swift

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: HSVSignalName, 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
  • onChanged(flags:handler:) Extension method

    Note

    This represents the underlying changed signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var changedSignal: HSVSignalName { get }
    Show on GitHub
  • onMove(flags:handler:) Extension method

    Note

    This represents the underlying move signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onMove(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: HSVRef, _ object: DirectionType) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    object

    none
    handler

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

    Typed move signal for using the connect(signal:) methods

    Declaration

    Swift

    static var moveSignal: HSVSignalName { get }
    Show on GitHub

HSV Class: HSVProtocol extension (methods and fields)

  • getColor(h:s:v:) Extension method

    Queries the current color in an HSV color selector. Returned values will be in the [0.0, 1.0] range.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getColor(h: UnsafeMutablePointer<gdouble>!, s: UnsafeMutablePointer<gdouble>!, v: UnsafeMutablePointer<gdouble>!)
    Show on GitHub
  • getMetrics(size:ringWidth:) Extension method

    Queries the size and ring width of an HSV color selector.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getMetrics(size: UnsafeMutablePointer<gint>!, ringWidth: UnsafeMutablePointer<gint>!)
    Show on GitHub
  • setColor(h:s:v:) Extension method

    Sets the current color in an HSV color selector. Color component values must be in the [0.0, 1.0] range.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setColor(h: CDouble, s: CDouble, v: CDouble)
    Show on GitHub
  • setMetrics(size:ringWidth:) Extension method

    Sets the size and ring width of an HSV color selector.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setMetrics(size: Int, ringWidth: Int)
    Show on GitHub
  • isAdjusting Extension method

    An HSV color selector can be said to be adjusting if multiple rapid changes are being made to its value, for example, when the user is adjusting the value with the mouse. This function queries whether the HSV color selector is being adjusted or not.

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

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