Package org.gnome.gtk

Class BookmarkList

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.BookmarkList

All Implemented Interfaces:

Iterable<FileInfo>, Collection<FileInfo>, List<FileInfo>, SequencedCollection<FileInfo>, ListModel<FileInfo>, Proxy, ListModelJavaList<FileInfo>

@Generated("io.github.jwharm.JavaGI")
public class BookmarkList
extends GObject
implements ListModel<FileInfo>

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: recent::private (boolean) and recent:applications (stringv).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BookmarkList.BookmarkListClass
static class	BookmarkList.Builder<B extends BookmarkList.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.ListModel

ListModel.ItemsChangedCallback, ListModel.ListModel$Impl, ListModel.ListModelInterface

Nested classes/interfaces inherited from interface org.javagi.gio.ListModelJavaList

ListModelJavaList.SubList<E extends @Nullable GObject,List extends ListModelJavaList<E>>

Constructor Summary

Constructors

Constructor	Description
BookmarkList()	Creates a new BookmarkList.
BookmarkList(@Nullable String filename, @Nullable String attributes)	Creates a new GtkBookmarkList with the given attributes.
BookmarkList(MemorySegment address)	Create a BookmarkList proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected BookmarkList	asParent()	Returns this instance as if it were its parent type.
static BookmarkList.Builder<? extends BookmarkList.Builder>	builder()	A BookmarkList.Builder object constructs a BookmarkList with the specified properties.
@Nullable String	getAttributes()	Gets the attributes queried on the children.
String	getFilename()	Returns the filename of the bookmark file that this list is loading.
int	getIoPriority()	Gets the IO priority to use while loading file.
static @Nullable Type	getType()	Get the GType of the BookmarkList class
boolean	isLoading()	Returns true if the files are currently being loaded.
void	setAttributes(@Nullable String attributes)	Sets the attributes to be enumerated and starts the enumeration.
void	setIoPriority(int ioPriority)	Sets the IO priority to use while loading files.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Methods inherited from interface org.gnome.gio.ListModel

emitItemsChanged, getItem, getItemType, getNItems, itemsChanged, onItemsChanged

Methods inherited from interface org.javagi.gio.ListModelJavaList

add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

BookmarkList

public BookmarkList(MemorySegment address)

Create a BookmarkList proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

BookmarkList

public BookmarkList(@Nullable String filename,
 @Nullable String attributes)

Creates a new GtkBookmarkList with the given attributes.

Parameters:

filename - The bookmark file to load

attributes - The attributes to query

BookmarkList

public BookmarkList()

Creates a new BookmarkList.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the BookmarkList class

Returns:

the GType

asParent

protected BookmarkList asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getAttributes

public @Nullable String getAttributes()

Gets the attributes queried on the children.

Returns:

The queried attributes

getFilename

public String getFilename()

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

Returns:

the filename of the .xbel file

getIoPriority

public int getIoPriority()

Gets the IO priority to use while loading file.

Returns:

The IO priority.

isLoading

public boolean isLoading()

Returns true if the files are currently being loaded.

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

Returns:

true if this BookmarkList is loading

setAttributes

public void setAttributes(@Nullable String attributes)

Sets the attributes to be enumerated and starts the enumeration.

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

Parameters:

attributes - the attributes to enumerate

setIoPriority

public void setIoPriority(int ioPriority)

Sets the IO priority to use while loading files.

The default IO priority is G_PRIORITY_DEFAULT.

Parameters:

ioPriority - IO priority to use

builder

public static BookmarkList.Builder<? extends BookmarkList.Builder> builder()

A BookmarkList.Builder object constructs a BookmarkList with the specified properties. Use the various set...() methods to set properties, and finish construction with BookmarkList.Builder.build().

Returns:

the builder object