BookmarkListProtocol

public protocol BookmarkListProtocol : ListModelProtocol, ObjectProtocol

GtkBookmarkList is a list model that wraps GBookmarkFile.

It presents a GListModel and fills it asynchronously with the GFileInfos returned from that function.

The GFileInfos in the list have some attributes in the recent namespace added: recentprivate`(boolean) andrecent:applications` (stringv).

The BookmarkListProtocol protocol exposes the methods and properties of an underlying GtkBookmarkList 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 BookmarkList. Alternatively, use BookmarkListRef 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 GtkBookmarkList instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkBookmarkList instance.

    Default Implementation

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

    Declaration

    Swift

    var bookmark_list_ptr: UnsafeMutablePointer<GtkBookmarkList>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to BookmarkListProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

BookmarkList Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: BookmarkListPropertyName, 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 BookmarkList property

    Declaration

    Swift

    @inlinable
func get(property: BookmarkListPropertyName) -> 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 BookmarkList property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

BookmarkList Class: BookmarkListProtocol extension (methods and fields)

  • getAttributes() Extension method

    Gets the attributes queried on the children.

    Declaration

    Swift

    @inlinable
func getAttributes() -> String!
    Show on GitHub
  • getFilename() Extension method

    Returns the filename of the bookmark file that this list is loading.

    Declaration

    Swift

    @inlinable
func getFilename() -> String!
    Show on GitHub
  • getIoPriority() Extension method

    Gets the IO priority to use while loading file.

    Declaration

    Swift

    @inlinable
func getIoPriority() -> Int
    Show on GitHub
  • set(attributes:) Extension method

    Sets the attributes to be enumerated and starts the enumeration.

    If attributes is nil, no attributes will be queried, but a list of GFileInfos will still be created.

    Declaration

    Swift

    @inlinable
func set(attributes: UnsafePointer<CChar>? = nil)
    Show on GitHub
  • set(ioPriority:) Extension method

    Sets the IO priority to use while loading files.

    The default IO priority is G_PRIORITY_DEFAULT.

    Declaration

    Swift

    @inlinable
func set(ioPriority: Int)
    Show on GitHub
  • attributes Extension method

    The attributes to query.

    Declaration

    Swift

    @inlinable
var attributes: String! { get nonmutating set }
    Show on GitHub
  • filename Extension method

    The bookmark file to load.

    Declaration

    Swift

    @inlinable
var filename: String! { get }
    Show on GitHub
  • ioPriority Extension method

    Gets the IO priority to use while loading file.

    Declaration

    Swift

    @inlinable
var ioPriority: Int { get nonmutating set }
    Show on GitHub
  • isLoading Extension method

    Returns true if the files are currently being loaded.

    Files will be added to self from time to time while loading is going on. The order in which are added is undefined and may change in between runs.

    Declaration

    Swift

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