GI.Gtk.Objects.BookmarkList

BookmarkList is a list model that wraps GBookmarkFile. It presents a ListModel and fills it asynchronously with the GFileInfos returned from that function.

The GFileInfos in the list have some attributes in the recent namespace added: recent[private](#g:signal:private) (boolean) and recent:applications (stringv).

Exported types

newtype BookmarkList

Memory-managed wrapper type.

Constructors

BookmarkList (ManagedPtr BookmarkList)

Instances

Eq BookmarkList

Defined in GI.Gtk.Objects.BookmarkList

Methods

(==) :: BookmarkList -> BookmarkList -> Bool

(/=) :: BookmarkList -> BookmarkList -> Bool

GObject BookmarkList

Defined in GI.Gtk.Objects.BookmarkList

ManagedPtrNewtype BookmarkList

Defined in GI.Gtk.Objects.BookmarkList

Methods

toManagedPtr :: BookmarkList -> ManagedPtr BookmarkList

TypedObject BookmarkList

Defined in GI.Gtk.Objects.BookmarkList

Methods

glibType :: IO GType

HasParentTypes BookmarkList

Defined in GI.Gtk.Objects.BookmarkList

IsGValue (Maybe BookmarkList)

Convert BookmarkList to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.BookmarkList

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe BookmarkList -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe BookmarkList)

type ParentTypes BookmarkList

Defined in GI.Gtk.Objects.BookmarkList

type ParentTypes BookmarkList = '[Object, ListModel]

class (GObject o, IsDescendantOf BookmarkList o) => IsBookmarkList o

Type class for types which can be safely cast to BookmarkList, for instance with toBookmarkList.

Instances

(GObject o, IsDescendantOf BookmarkList o) => IsBookmarkList o

Defined in GI.Gtk.Objects.BookmarkList

toBookmarkList :: (MonadIO m, IsBookmarkList o) => o -> m BookmarkList

Cast to BookmarkList, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, isLoading, itemsChanged, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAttributes, getData, getFilename, getIoPriority, getItem, getItemType, getNItems, getProperty, getQdata.

Setters

setAttributes, setData, setDataFull, setIoPriority, setProperty.

getAttributes

bookmarkListGetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsBookmarkList a)

=> a

self: a BookmarkList

-> m (Maybe Text)

Returns: The queried attributes

Gets the attributes queried on the children.

getFilename

bookmarkListGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsBookmarkList a)

=> a

self: a BookmarkList

-> m Text

Returns: the filename of the .xbel file

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

getIoPriority

bookmarkListGetIoPriority

Arguments

:: (HasCallStack, MonadIO m, IsBookmarkList a)

=> a

self: a BookmarkList

-> m Int32

Returns: The IO priority.

Gets the IO priority set via bookmarkListSetIoPriority.

isLoading

bookmarkListIsLoading

Arguments

:: (HasCallStack, MonadIO m, IsBookmarkList a)

=> a

self: a BookmarkList

-> m Bool

Returns: True if self is loading

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.

new

bookmarkListNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

filename: The bookmark file to load

-> Maybe Text

attributes: The attributes to query

-> m BookmarkList

Returns: a new BookmarkList

Creates a new BookmarkList with the given attributes.

setAttributes

bookmarkListSetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsBookmarkList a)

=> a

self: a BookmarkList

-> Maybe Text

attributes: the attributes to enumerate

-> m ()

Sets the attributes to be enumerated and starts the enumeration.

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

setIoPriority

bookmarkListSetIoPriority

Arguments

:: (HasCallStack, MonadIO m, IsBookmarkList a)

=> a

self: a BookmarkList

-> Int32

ioPriority: IO priority to use

-> m ()

Sets the IO priority to use while loading files.

The default IO priority is PRIORITY_DEFAULT.

Properties

attributes

The attributes to query

clearBookmarkListAttributes :: (MonadIO m, IsBookmarkList o) => o -> m ()

Set the value of the “attributes” property to Nothing. When overloading is enabled, this is equivalent to

clear #attributes

constructBookmarkListAttributes :: (IsBookmarkList o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “attributes” property. This is rarely needed directly, but it is used by new.

getBookmarkListAttributes :: (MonadIO m, IsBookmarkList o) => o -> m (Maybe Text)

Get the value of the “attributes” property. When overloading is enabled, this is equivalent to

get bookmarkList #attributes

setBookmarkListAttributes :: (MonadIO m, IsBookmarkList o) => o -> Text -> m ()

Set the value of the “attributes” property. When overloading is enabled, this is equivalent to

set bookmarkList [ #attributes := value ]

filename

No description available in the introspection data.

constructBookmarkListFilename :: (IsBookmarkList o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “filename” property. This is rarely needed directly, but it is used by new.

getBookmarkListFilename :: (MonadIO m, IsBookmarkList o) => o -> m Text

Get the value of the “filename” property. When overloading is enabled, this is equivalent to

get bookmarkList #filename

ioPriority

Priority used when loading

constructBookmarkListIoPriority :: (IsBookmarkList o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “io-priority” property. This is rarely needed directly, but it is used by new.

getBookmarkListIoPriority :: (MonadIO m, IsBookmarkList o) => o -> m Int32

Get the value of the “io-priority” property. When overloading is enabled, this is equivalent to

get bookmarkList #ioPriority

setBookmarkListIoPriority :: (MonadIO m, IsBookmarkList o) => o -> Int32 -> m ()

Set the value of the “io-priority” property. When overloading is enabled, this is equivalent to

set bookmarkList [ #ioPriority := value ]

loading

True if files are being loaded

getBookmarkListLoading :: (MonadIO m, IsBookmarkList o) => o -> m Bool

Get the value of the “loading” property. When overloading is enabled, this is equivalent to

get bookmarkList #loading