FlagsValue

open class FlagsValue : FlagsValueProtocol

A structure which contains a single flags value, its name, and its nickname.

The FlagsValue type acts as an owner of an underlying GFlagsValue instance. It provides the methods that can operate on this data type through FlagsValueProtocol conformance. Use FlagsValue as a strong reference or owner of a GFlagsValue instance.

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

    For type-safe access, use the generated, typed pointer _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 FlagsValue instance.

    Declaration

    Swift

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

    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 FlagsValue instance.

    Declaration

    Swift

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

    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 FlagsValue 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 FlagsValue 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 FlagsValue instance.

    Declaration

    Swift

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

    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 FlagsValue instance.

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object

  • Designated initialiser from the underlying C data type. GFlagsValue does not allow reference counting, so despite the name no actual retaining will occur. i.e., ownership is transferred to the FlagsValue instance.

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object

  • Reference intialiser for a related type that implements FlagsValueProtocol GFlagsValue does not allow reference counting.

    Declaration

    Swift

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

    Parameters

    other

    an instance of a related type that implements FlagsValueProtocol

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

    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 FlagsValueProtocol.

    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 FlagsValueProtocol.

    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 FlagsValueProtocol.

    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 FlagsValueProtocol.

    Declaration

    Swift

    @inlinable
    public required 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 FlagsValueProtocol.

    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 FlagsValueProtocol.

    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 FlagsValueProtocol.

    Declaration

    Swift

    @inlinable
    public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object