IconSource

open class IconSource : IconSourceProtocol

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

Show on GitHub
  • ptr 
    Untyped pointer to the underlying `GtkIconSource` instance.

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

    Declaration

    Swift

    public let ptr: UnsafeMutableRawPointer!
    Show on GitHub

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

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • 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 IconSource instance.

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • 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 IconSource instance.

    Declaration

    Swift

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

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • 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 IconSource instance.

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • 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 IconSource instance.

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements IconSourceProtocol GtkIconSource does not allow reference counting.

    Declaration

    Swift

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

    Parameters

    other

    an instance of a related type that implements IconSourceProtocol
    Show on GitHub

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

    Declaration

    Swift

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

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

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

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Creates a new GtkIconSource. A GtkIconSource contains a GdkPixbuf (or image filename) that serves as the base image for one or more of the icons in a GtkIconSet, along with a specification for which icons in the icon set will be based on that pixbuf or image file. An icon set contains a set of icons that represent “the same” logical concept in different states, different global text directions, and different sizes.

    So for example a web browser’s “Back to Previous Page” icon might point in a different direction in Hebrew and in English; it might look different when insensitive; and it might change size depending on toolbar mode (small/large icons). So a single icon set would contain all those variants of the icon. GtkIconSet contains a list of GtkIconSource from which it can derive specific icon variants in the set.

    In the simplest case, GtkIconSet contains one source pixbuf from which it derives all variants. The convenience function gtk_icon_set_new_from_pixbuf() handles this case; if you only have one source pixbuf, just use that function.

    If you want to use a different base pixbuf for different icon variants, you create multiple icon sources, mark which variants they’ll be used to create, and add them to the icon set with gtk_icon_set_add_source().

    By default, the icon source has all parameters wildcarded. That is, the icon source will be used as the base icon for any desired text direction, widget state, or icon size.

    new is deprecated: Use #GtkIconTheme instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
public init()
    Show on GitHub