Documentation Language: Swift

Class

GIR.Record

a data type record to create a protocol/struct/class for

class Record

Topics

Initializers

Instance Properties

V
allMethods

return all functions, methods, and constructors

V
allProperties

return all properties, including the ones derived from ancestors

V
allSignals

return all signals, including the ones derived from ancestors

V
className

swift class name for this record

V
classRef

Class reference for this record

V
classType

Type of the Class for this record

V
constructors

Constructors for this record

V
correspondingCType

Corresponding C type of the record (gir-1.0.rnc:214)

V
cprefix

C language symbol prefix

V
fields

Fieldss of this record

V
functions

Functions associated with this record

V
implements

Names of implemented interfaces

V
inheritedMethods

return all functions, methods, and constructors inherited from ancestors

V
isGTypeStructForType

Name of type which is defined by this record

V
kind

String representation of Records

V
methods

Methods associated with this record

V
nonDerivedProperties

return only the properties that are not derived

V
parentType

Name of the function that returns the GType for this record (nil if unspecified)

V
properties

Properties of this record

V
protocolName

Name of the Protocol for this record

V
protocolRef

Protocol reference for this record

V
protocolType

Type of the Protocol for this record

V
ptrName

return the typed pointer name

V
records

records contained within this record

V
ref

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

V
rootType

Root class (nil for plain records)

V
signals

List of signals for this record

V
structName

Name of the Ref struct for this record

V
structNamePrefixedIfNecessary

Return the name of the Ref struct type correspondingg to the receiver

V
structRef

Struct reference for this record

V
structType

Type of the Ref struct for this record

V
swift

swift node name for this record

V
typeStruct

Type struct (e.g. class definition), typically nil for records

V
typegetter

C type getter function

V
unref

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

Instance Methods

F
anyMethodMatching(_:)

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

F
has(property:)

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

F
inheritedMethodMatching(_:)

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

F
methodMatching(_:)

return the first method where the passed predicate closure returns true

F
registerKnownType()

Register this type as a record type

Relationships

Inherits From

Inherited By

Conforms To

See Also

GIR element models

C
GIR.Thing

GIR named thing class

C
GIR.Datatype

GIR type class

C
GIR.CType

a type with an underlying C type entry

C
GIR.Alias

a type alias is just a type with an underlying C type

C
GIR.Argument

data type representing a function/method argument or return type

C
GIR.Bitfield

a bitfield is defined akin to an enumeration

C
GIR.Callback

a callback is the same as a function, except that the type definition is a @convention(c) callback definition

C
GIR.Class

a class data type record

C
GIR.Constant

an entry for a constant

C
GIR.Enumeration

an enumeration entry

C
GIR.Field

a field is a Property

C
GIR.Function

a function is the same as a method

C
GIR.Interface

an inteface is similar to a class, but can be part of a more complex type graph

C
GIR.Method

data type representing a function/method

C
GIR.Property

a property is a C type