Class DragIcon

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.DragIcon

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Native, Root, Proxy

@Generated("org.javagi.JavaGI")
public class DragIcon
extends Widget
implements Accessible, Buildable, ConstraintTarget, Native, Root

A GtkRoot implementation for drag icons.

A drag icon moves with the pointer during a Drag-and-Drop operation and is destroyed when the drag ends.

To set up a drag icon and associate it with an ongoing drag operation, use getForDrag(Drag) to get the icon for a drag. You can then use it like any other widget and use setChild(Widget) to set whatever widget should be used for the drag icon.

Keep in mind that drag icons do not allow user input.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

Nested classes/interfaces inherited from class InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface Native

Native.Native$Impl, Native.NativeInterface

Nested classes/interfaces inherited from interface Root

Root.Root$Impl, Root.RootInterface

Constructor Summary

Constructors

Constructor	Description
DragIcon()	Create a new DragIcon.
DragIcon(MemorySegment address)	Create a DragIcon instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected DragIcon	asParent()	Return this instance as if it were its parent type.
static DragIcon.Builder<? extends DragIcon.Builder>	builder()	A DragIcon.Builder object constructs a DragIcon with the specified properties.
static @Nullable Widget	createWidgetForValue(Value value)	Creates a widget that can be used as a drag icon for the given value.
@Nullable Widget	getChild()	Gets the widget currently used as drag icon.
static DragIcon	getForDrag(Drag drag)	Gets the GtkDragIcon in use with drag.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the DragIcon class.
void	setChild(@Nullable Widget child)	Sets the widget to display as the drag icon.
static void	setFromPaintable(Drag drag, Paintable paintable, int hotX, int hotY)	Creates a GtkDragIcon that shows paintable, and associates it with the drag operation.

Methods inherited from class Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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 Accessible

announce, getAccessibleId, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface Buildable

getBuildableId

Methods inherited from interface Native

getRenderer, getSurface, getSurfaceTransform, realize, unrealize

Methods inherited from interface Proxy

handle

Methods inherited from interface Root

getDisplay, getFocus, setFocus

Constructor Details

DragIcon

public DragIcon(MemorySegment address)

Create a DragIcon instance for the provided memory address.

Parameters:

address - the memory address of the native object

DragIcon

public DragIcon()

Create a new DragIcon.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the DragIcon class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected DragIcon 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 Widget

Returns:

the instance as if it were its parent type

getForDrag

public static DragIcon getForDrag(Drag drag)

Gets the GtkDragIcon in use with drag.

If no drag icon exists yet, a new one will be created and shown.

Parameters:

drag - a GdkDrag

Returns:

the GtkDragIcon

createWidgetForValue

public static @Nullable Widget createWidgetForValue(Value value)

Creates a widget that can be used as a drag icon for the given value.

Supported types include strings, GdkRGBA and GtkTextBuffer. If GTK does not know how to create a widget for a given value, it will return null.

This method is used to set the default drag icon on drag-and-drop operations started by GtkDragSource, so you don't need to set a drag icon using this function there.

Parameters:

value - a GValue

Returns:

A new GtkWidget for displaying value as a drag icon.

setFromPaintable

public static void setFromPaintable(Drag drag,
 Paintable paintable,
 int hotX,
 int hotY)

Creates a GtkDragIcon that shows paintable, and associates it with the drag operation.

The hotspot position on the paintable is aligned with the hotspot of the cursor.

Parameters:

drag - a GdkDrag

paintable - a GdkPaintable to display

hotX - X coordinate of the hotspot

hotY - Y coordinate of the hotspot

getChild

public @Nullable Widget getChild()

Gets the widget currently used as drag icon.

Returns:

The drag icon

setChild

public void setChild(@Nullable Widget child)

Sets the widget to display as the drag icon.

Parameters:

child - a GtkWidget

builder

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

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

Returns:

the builder object