Package org.gnome.gio

Class EmblemedIcon

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.EmblemedIcon

All Implemented Interfaces:

Icon, Proxy

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

GEmblemedIcon is an implementation of Icon that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via addEmblem(org.gnome.gio.Emblem).

Note that GEmblemedIcon allows no control over the position of the emblems. See also Emblem for more information.

Nested Class Summary

Nested Classes

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

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
EmblemedIcon()	Creates a new EmblemedIcon.
EmblemedIcon(MemorySegment address)	Create a EmblemedIcon proxy instance for the provided memory address.
EmblemedIcon(Icon icon, @Nullable Emblem emblem)	Creates a new emblemed icon for icon with the emblem emblem.

Method Summary

Modifier and Type	Method	Description
void	addEmblem(Emblem emblem)	Adds emblem to the GList of GEmblems.
protected EmblemedIcon	asParent()	Returns this instance as if it were its parent type.
static EmblemedIcon.Builder<? extends EmblemedIcon.Builder>	builder()	A EmblemedIcon.Builder object constructs a EmblemedIcon with the specified properties.
void	clearEmblems()	Removes all the emblems from icon.
List<Emblem>	getEmblems()	Gets the list of emblems for the icon.
Icon	getIcon()	Gets the main icon for emblemed.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the EmblemedIcon class

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, 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

EmblemedIcon

public EmblemedIcon(MemorySegment address)

Create a EmblemedIcon proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

EmblemedIcon

public EmblemedIcon(Icon icon,
 @Nullable Emblem emblem)

Creates a new emblemed icon for icon with the emblem emblem.

Parameters:

icon - a GIcon

emblem - a GEmblem, or null

Since:

2.18

EmblemedIcon

public EmblemedIcon()

Creates a new EmblemedIcon.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the EmblemedIcon class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

addEmblem

public void addEmblem(Emblem emblem)

Adds emblem to the GList of GEmblems.

Parameters:

emblem - a GEmblem

Since:

2.18

clearEmblems

public void clearEmblems()

Removes all the emblems from icon.

Since:

2.28

getEmblems

public List<Emblem> getEmblems()

Gets the list of emblems for the icon.

Returns:

a GList of GEmblems that is owned by this EmblemedIcon

Since:

2.18

getIcon

public Icon getIcon()

Gets the main icon for emblemed.

Returns:

a GIcon that is owned by this EmblemedIcon

Since:

2.18

builder

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

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

Returns:

the builder object