Package org.gnome.gtk

Class IconPaintable

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.IconPaintable

All Implemented Interfaces:

Proxy, Paintable, SymbolicPaintable

@Generated("io.github.jwharm.JavaGI")
public class IconPaintable
extends GObject
implements Paintable, SymbolicPaintable

Contains information found when looking up an icon in GtkIconTheme.

GtkIconPaintable implements GdkPaintable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IconPaintable.Builder<B extends IconPaintable.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.gdk.Paintable

Paintable.InvalidateContentsCallback, Paintable.InvalidateSizeCallback, Paintable.PaintableImpl, Paintable.PaintableInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.SymbolicPaintable

SymbolicPaintable.SymbolicPaintableImpl, SymbolicPaintable.SymbolicPaintableInterface

Constructor Summary

Constructors

Constructor	Description
IconPaintable(MemorySegment address)	Create a IconPaintable proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected IconPaintable	asParent()	Returns this instance as if it were its parent type.
static IconPaintable.Builder<? extends IconPaintable.Builder>	builder()	A IconPaintable.Builder object constructs a IconPaintable with the specified properties.
static IconPaintable	forFile(File file, int size, int scale)	Creates a GtkIconPaintable for a file with a given size and scale.
File	getFile()	Gets the GFile that was used to load the icon.
String	getIconName()	Get the icon name being used for this icon.
static Type	getType()	Get the GType of the IconPaintable class
boolean	isSymbolic()	Checks if the icon is symbolic or not.

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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.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.gdk.Paintable

computeConcreteSize, emitInvalidateContents, emitInvalidateSize, getCurrentImage, getFlags, getIntrinsicAspectRatio, getIntrinsicHeight, getIntrinsicWidth, invalidateContents, invalidateSize, onInvalidateContents, onInvalidateSize, snapshot

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.SymbolicPaintable

snapshotSymbolic

Constructor Details

IconPaintable

public IconPaintable(MemorySegment address)

Create a IconPaintable proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the IconPaintable class

Returns:

the GType

asParent

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

forFile

public static IconPaintable forFile(File file,
 int size,
 int scale)

Creates a GtkIconPaintable for a file with a given size and scale.

The icon can then be rendered by using it as a GdkPaintable.

Parameters:

file - a GFile

size - desired icon size, in application pixels

scale - the desired scale

Returns:

a GtkIconPaintable containing for the icon. Unref with g_object_unref()

getFile

public File getFile()

Gets the GFile that was used to load the icon.

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

Returns:

the GFile for the icon

getIconName

public String getIconName()

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 null.

Returns:

the themed icon-name for the icon, or null if its not a themed icon.

isSymbolic

public boolean isSymbolic()

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.

Returns:

true if the icon is symbolic, false otherwise

builder

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

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