IconPaintableProtocol

public protocol IconPaintableProtocol : ObjectProtocol, PaintableProtocol

Contains information found when looking up an icon in GtkIconTheme.

GtkIconPaintable implements GdkPaintable.

The IconPaintableProtocol protocol exposes the methods and properties of an underlying GtkIconPaintable instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see IconPaintable. Alternatively, use IconPaintableRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkIconPaintable instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • icon_paintable_ptr Default implementation

    Typed pointer to the underlying GtkIconPaintable instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkIconPaintable instance.

    Declaration

    Swift

    var icon_paintable_ptr: UnsafeMutablePointer<GtkIconPaintable>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to IconPaintableProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

IconPaintable Class

  • Bind a IconPaintablePropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: IconPaintablePropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a IconPaintable property

    Declaration

    Swift

    @inlinable
func get(property: IconPaintablePropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a IconPaintable property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: IconPaintablePropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

IconPaintable Class: IconPaintableProtocol extension (methods and fields)

  • getFile() Extension method

    Gets the GFile that was used to load the icon.

    Returns nil if the icon was not loaded from a file.

    Declaration

    Swift

    @inlinable
func getFile() -> GIO.FileRef!
    Show on GitHub
  • getIconName() Extension method

    Get the icon name being used for this icon.

    When an icon looked up in the icon theme was not available, the icon theme may use fallback icons - either those specified to gtk_icon_theme_lookup_icon() or the always-available “image-missing”. The icon chosen is returned by this function.

    If the icon was created without an icon theme, this function returns nil.

    Declaration

    Swift

    @inlinable
func getIconName() -> String!
    Show on GitHub
  • file Extension method

    The file representing the icon, if any.

    Declaration

    Swift

    @inlinable
var file: GIO.FileRef! { get }
    Show on GitHub
  • iconName Extension method

    Get the icon name being used for this icon.

    When an icon looked up in the icon theme was not available, the icon theme may use fallback icons - either those specified to gtk_icon_theme_lookup_icon() or the always-available “image-missing”. The icon chosen is returned by this function.

    If the icon was created without an icon theme, this function returns nil.

    Declaration

    Swift

    @inlinable
var iconName: String! { get }
    Show on GitHub
  • isSymbolic Extension method

    Checks if the icon is symbolic or not.

    This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future.

    Note that to render a symbolic GtkIconPaintable properly (with recoloring), you have to set its icon name on a GtkImage.

    Declaration

    Swift

    @inlinable
var isSymbolic: Bool { get }
    Show on GitHub