Record Class Reference


                    
                    
                    kind

String representation of Records

Declaration

Swift

public override var kind: String { get }

Show on GitHub


                    
                    
                    cprefix

C language symbol prefix

Declaration

Swift

public let cprefix: String

Show on GitHub


                    
                    
                    typegetter

C type getter function

Declaration

Swift

public let typegetter: String

Show on GitHub


                    
                    
                    methods

Methods associated with this record

Declaration

Swift

public let methods: [Method]

Show on GitHub


                    
                    
                    functions

Functions associated with this record

Declaration

Swift

public let functions: [Function]

Show on GitHub


                    
                    
                    constructors

Constructors for this record

Declaration

Swift

public let constructors: [Method]

Show on GitHub


                    
                    
                    properties

Properties of this record

Declaration

Swift

public let properties: [Property]

Show on GitHub


                    
                    
                    signals

List of signals for this record

Declaration

Swift

public let signals: [Signal]

Show on GitHub


                    
                    
                    parentType

Parent type (nil for plain records)

Declaration

Swift

public var parentType: Record? { get }

Show on GitHub


                    
                    
                    rootType

Root class (nil for plain records)

Declaration

Swift

public var rootType: Record { get }

Show on GitHub


                    
                    
                    implements

Names of implemented interfaces

Declaration

Swift

public var implements: [String]

Show on GitHub


                    
                    
                    allMethods

return all functions, methods, and constructors

Declaration

Swift

public var allMethods: [Method] { get }

Show on GitHub


                    
                    
                    inheritedMethods

return all functions, methods, and constructors inherited from ancestors

Declaration

Swift

public var inheritedMethods: [Method] { get }

Show on GitHub


                    
                    
                    init(name:type:ctype:cprefix:typegetter:methods:functions:constructors:properties:signals:interfaces:comment:introspectable:deprecated:)

Designated initialiser

Declaration

Swift

public init(name: String, type: String, ctype: String, cprefix: String, typegetter: String, methods: [Method] = [], functions: [Function] = [], constructors: [Method] = [], properties: [Property] = [], signals: [Signal] = [], interfaces: [String] = [], comment: String = "", introspectable: Bool = false, deprecated: String? = nil)

Parameters

`name`	The name of the record to initialise
`type`	C typedef name of the constant
`ctype`	underlying C type
`cprefix`	prefix used for C language free functions that implement methods for this record
`typegetter`	C type getter function
`methods`	Methods associated with this record
`functions`	Functions associated with this record
`constructors`	Constructors for this record
`properties`	Properties of this record
`signals`	List of signals for this record
`interfaces`	Interfaces implemented by this record
`comment`	Documentation text for the constant
`introspectable`	Set to `true` if introspectable
`deprecated`	Documentation on deprecation status if non-`nil`

Show on GitHub


                    
                    
                    init(node:atIndex:)

Initialiser to construct a record type from XML

Declaration

Swift

public init(node: XMLElement, atIndex i: Int)

Parameters

`node`	`XMLElement` to construct this constant from
`i`	Index within the siblings of the `node`

Show on GitHub


                    
                    
                    methodMatching(_:)

return the first method where the passed predicate closure returns true

Declaration

Swift

public func methodMatching(_ predictate: (Method) -> Bool) -> Method?

Show on GitHub


                    
                    
                    inheritedMethodMatching(_:)

return the first inherited method where the passed predicate closure returns true

Declaration

Swift

public func inheritedMethodMatching(_ predictate: (Method) -> Bool) -> Method?

Show on GitHub


                    
                    
                    anyMethodMatching(_:)

return the first of my own or inherited methods where the passed predicate closure returns true

Declaration

Swift

public func anyMethodMatching(_ predictate: (Method) -> Bool) -> Method?

Show on GitHub

ref

return the retain (ref) method for the given record, if any

Declaration

Swift

public var ref: Method? { get }

Show on GitHub


                    
                    
                    unref

return the release (unref) method for the given record, if any

Declaration

Swift

public var unref: Method? { get }

Show on GitHub


                    
                    
                    has(property:)

return whether the record or one of its parents has a given property

Declaration

Swift

public func has(property name: String) -> Bool

Show on GitHub


                    
                    
                    nonDerivedProperties

return only the properties that are not derived

Declaration

Swift

public var nonDerivedProperties: [Property] { get }

Show on GitHub


                    
                    
                    allProperties

return all properties, including the ones derived from ancestors

Declaration

Swift

public var allProperties: [Property] { get }

Show on GitHub


                    
                    
                    allSignals

return all signals, including the ones derived from ancestors

Declaration

Swift

public var allSignals: [Signal] { get }

Show on GitHub