Class Emblem

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.Emblem

All Implemented Interfaces:

Icon, Proxy

@Generated("org.javagi.JavaGI")
public class Emblem
extends GObject
implements Icon

GEmblem is an implementation of Icon that supports having an emblem, which is an icon with additional properties. It can than be added to a EmblemedIcon.

Currently, only metainformation about the emblem's origin is supported. More may be added in the future.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Icon

Icon.Icon$Impl, Icon.IconIface

Constructor Summary

Constructors

Constructor	Description
Emblem()	Create a new Emblem.
Emblem(MemorySegment address)	Create a Emblem instance for the provided memory address.
Emblem(Icon icon)	Creates a new emblem for icon.

Method Summary

Modifier and Type	Method	Description
protected Emblem	asParent()	Return this instance as if it were its parent type.
static Emblem.Builder<? extends Emblem.Builder>	builder()	A Emblem.Builder object constructs a Emblem with the specified properties.
Icon	getIcon()	Gives back the icon from emblem.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
EmblemOrigin	getOrigin()	Gets the origin of the emblem.
static @Nullable Type	getType()	Get the GType of the Emblem class.
static Emblem	withOrigin(Icon icon, EmblemOrigin origin)	Creates a new emblem for icon.

Methods inherited from class 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Methods inherited from interface Icon

equal, hash, serialize, serializeToString

Methods inherited from interface Proxy

handle

Constructor Details

Emblem

public Emblem(MemorySegment address)

Create a Emblem instance for the provided memory address.

Parameters:

address - the memory address of the native object

Emblem

public Emblem(Icon icon)

Creates a new emblem for icon.

Parameters:

icon - a GIcon containing the icon.

Since:

2.18

Emblem

public Emblem()

Create a new Emblem.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Emblem class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Emblem asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

withOrigin

public static Emblem withOrigin(Icon icon,
 EmblemOrigin origin)

Creates a new emblem for icon.

Parameters:

icon - a GIcon containing the icon.

origin - a GEmblemOrigin enum defining the emblem's origin

Returns:

a new GEmblem.

Since:

2.18

getIcon

public Icon getIcon()

Gives back the icon from emblem.

Returns:

a GIcon. The returned object belongs to the emblem and should not be modified or freed.

Since:

2.18

getOrigin

public EmblemOrigin getOrigin()

Gets the origin of the emblem.

Returns:

the origin of the emblem

Since:

2.18

builder

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

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

Returns:

the builder object