Package org.gnome.gio

Class ThemedIcon

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.ThemedIcon

All Implemented Interfaces:

Icon, Proxy

@Generated("io.github.jwharm.JavaGI")
public class ThemedIcon
extends GObject
implements Icon

GThemedIcon is an implementation of Icon that supports icon themes.

GThemedIcon contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. GThemedIcon does not provide actual pixmaps for icons, just the icon names. Ideally something like org.gnome.gtk.IconTheme#chooseIcon should be used to resolve the list of names so that fallback icons work nicely with themes that inherit other themes.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

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

Icon.Icon$Impl, Icon.IconIface

Constructor Summary

Constructors

Constructor	Description
ThemedIcon()	Creates a new ThemedIcon.
ThemedIcon(MemorySegment address)	Create a ThemedIcon proxy instance for the provided memory address.
ThemedIcon(String iconname)	Creates a new themed icon for iconname.

Method Summary

Modifier and Type	Method	Description
void	appendName(String iconname)	Append a name to the list of icons from within icon.
protected ThemedIcon	asParent()	Returns this instance as if it were its parent type.
static ThemedIcon.Builder<? extends ThemedIcon.Builder>	builder()	A ThemedIcon.Builder object constructs a ThemedIcon with the specified properties.
static ThemedIcon	fromNames(@Nullable String @Nullable [] iconnames)	Creates a new themed icon for iconnames.
String[]	getNames()	Gets the names of icons from within icon.
static @Nullable Type	getType()	Get the GType of the ThemedIcon class
void	prependName(String iconname)	Prepend a name to the list of icons from within icon.
static ThemedIcon	withDefaultFallbacks(String iconname)	Creates a new themed icon for iconname, and all the names that can be created by shortening iconname at '-' characters.

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 org.gnome.gio.Icon

equal, hash, serialize, serializeToString

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ThemedIcon

public ThemedIcon(MemorySegment address)

Create a ThemedIcon proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ThemedIcon

public ThemedIcon(String iconname)

Creates a new themed icon for iconname.

Parameters:

iconname - a string containing an icon name.

ThemedIcon

public ThemedIcon()

Creates a new ThemedIcon.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ThemedIcon class

Returns:

the GType

asParent

protected ThemedIcon 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

fromNames

public static ThemedIcon fromNames(@Nullable String @Nullable [] iconnames)

Creates a new themed icon for iconnames.

Parameters:

iconnames - an array of strings containing icon names.

Returns:

a new GThemedIcon

withDefaultFallbacks

public static ThemedIcon withDefaultFallbacks(String iconname)

Creates a new themed icon for iconname, and all the names that can be created by shortening iconname at '-' characters.

In the following example, icon1 and icon2 are equivalent:

const char *names[] = {
   "gnome-dev-cdrom-audio",
   "gnome-dev-cdrom",
   "gnome-dev",
   "gnome"
 };

 icon1 = g_themed_icon_new_from_names (names, 4);
 icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
 

Parameters:

iconname - a string containing an icon name

Returns:

a new GThemedIcon.

appendName

public void appendName(String iconname)

Append a name to the list of icons from within icon.

Note that doing so invalidates the hash computed by prior calls to g_icon_hash().

Parameters:

iconname - name of icon to append to list of icons from within icon.

getNames

public String[] getNames()

Gets the names of icons from within icon.

Returns:

a list of icon names.

prependName

public void prependName(String iconname)

Prepend a name to the list of icons from within icon.

Note that doing so invalidates the hash computed by prior calls to g_icon_hash().

Parameters:

iconname - name of icon to prepend to list of icons from within icon.

Since:

2.18

builder

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

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

Returns:

the builder object