Object

open class Object : ObjectProtocol

The Object type acts as a reference-counted owner of an underlying GObject instance. It provides the methods that can operate on this data type through ObjectProtocol conformance. Use Object as a strong reference or owner of a GObject instance.

All the fields in the GObject structure are private to the GObject implementation and should never be accessed directly.

  • ptr
    Untyped pointer to the underlying `GObject` instance.
    

    For type-safe access, use the generated, typed pointer object_ptr property instead.

    Declaration

    Swift

    public let ptr: UnsafeMutableRawPointer!
  • Designated initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init(_ op: UnsafeMutablePointer<GObject>)

    Parameters

    op

    pointer to the underlying object

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init(_ op: UnsafePointer<GObject>)

    Parameters

    op

    pointer to the underlying object

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init!(_ op: UnsafePointer<GObject>?)

    Parameters

    op

    pointer to the underlying object

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init!(_ op: UnsafeMutablePointer<GObject>?)

    Parameters

    op

    pointer to the underlying object

  • Designated initialiser from the underlying C data type. Will retain GObject. i.e., ownership is transferred to the Object instance.

    Declaration

    Swift

    @inlinable
    public init(retaining op: UnsafeMutablePointer<GObject>)

    Parameters

    op

    pointer to the underlying object

  • Reference intialiser for a related type that implements ObjectProtocol Will retain GObject.

    Declaration

    Swift

    @inlinable
    public init<T>(_ other: T) where T : ObjectProtocol

    Parameters

    other

    an instance of a related type that implements ObjectProtocol

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init(retainingRaw raw: UnsafeRawPointer)
  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ObjectProtocol.

    Declaration

    Swift

    @inlinable
    public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object

  • Creates a new instance of a GObject subtype and sets its properties using the provided arrays. Both arrays must have exactly n_properties elements, and the names and values correspond by index.

    Construction parameters (see G_PARAM_CONSTRUCT, G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Declaration

    Swift

    @inlinable
    public init(properties objectType: GType, nProperties: Int, names: UnsafeMutablePointer<UnsafePointer<CChar>?>!, values: UnsafePointer<GValue>!)
  • Creates a new instance of a GObject subtype and sets its properties.

    Construction parameters (see G_PARAM_CONSTRUCT, G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    newv is deprecated: Use g_object_new_with_properties() instead. deprecated. See #GParameter for more information.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    public init(objectType: GType, nParameters: Int, parameters: UnsafeMutablePointer<GParameter>!)
  • Creates a new instance of a GObject subtype and sets its properties using the provided arrays. Both arrays must have exactly n_properties elements, and the names and values correspond by index.

    Construction parameters (see G_PARAM_CONSTRUCT, G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Declaration

    Swift

    @inlinable
    public static func newWith(properties objectType: GType, nProperties: Int, names: UnsafeMutablePointer<UnsafePointer<CChar>?>!, values: UnsafePointer<GValue>!) -> Object!
  • Creates a new instance of a GObject subtype and sets its properties.

    Construction parameters (see G_PARAM_CONSTRUCT, G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    newv is deprecated: Use g_object_new_with_properties() instead. deprecated. See #GParameter for more information.

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    public static func newv(objectType: GType, nParameters: Int, parameters: UnsafeMutablePointer<GParameter>!) -> Object!