RangeProtocol

public protocol RangeProtocol

AtkRange are used on AtkValue, in order to represent the full range of a given component (for example an slider or a range control), or to define each individual subrange this full range is splitted if available. See AtkValue documentation for further details.

The RangeProtocol protocol exposes the methods and properties of an underlying AtkRange 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 Range. Alternatively, use RangeRef 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 AtkRange instance.

    Declaration

    Swift

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

    Typed pointer to the underlying AtkRange instance.

    Default Implementation

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

    Declaration

    Swift

    var range_ptr: UnsafeMutablePointer<AtkRange>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to RangeProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Range Record: RangeProtocol extension (methods and fields)

  • copy() Extension method

    Returns a new AtkRange that is a exact copy of src

    Declaration

    Swift

    @inlinable
func copy() -> Atk.RangeRef!
    Show on GitHub
  • free() Extension method

    Free range

    Declaration

    Swift

    @inlinable
func free()
    Show on GitHub
  • getDescription() Extension method

    Returns the human readable description of range

    Declaration

    Swift

    @inlinable
func getDescription() -> String!
    Show on GitHub
  • getLowerLimit() Extension method

    Returns the lower limit of range

    Declaration

    Swift

    @inlinable
func getLowerLimit() -> Double
    Show on GitHub
  • getUpperLimit() Extension method

    Returns the upper limit of range

    Declaration

    Swift

    @inlinable
func getUpperLimit() -> Double
    Show on GitHub
  • description Extension method

    Returns the human readable description of range

    Declaration

    Swift

    @inlinable
var description: String! { get }
    Show on GitHub
  • lowerLimit Extension method

    Returns the lower limit of range

    Declaration

    Swift

    @inlinable
var lowerLimit: Double { get }
    Show on GitHub
  • upperLimit Extension method

    Returns the upper limit of range

    Declaration

    Swift

    @inlinable
var upperLimit: Double { get }
    Show on GitHub