Package ch.bailu.gtk.gtk

Class DragIcon

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gobject.InitiallyUnowned

ch.bailu.gtk.gtk.Widget

ch.bailu.gtk.gtk.DragIcon

All Implemented Interfaces:

PointerInterface

public class DragIcon
extends Widget

`GtkDragIcon` is 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 [func@Gtk.DragIcon.get_for_drag] to get the icon for a drag. You can
then use it like any other widget and use [method@Gtk.DragIcon.set_child]
to set whatever widget should be used for the drag icon.

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

https://docs.gtk.org/gtk4/class.DragIcon.html

Nested Class Summary

Nested classes/interfaces inherited from class ch.bailu.gtk.gtk.Widget

Widget.OnDestroy, Widget.OnDestroyNotify, Widget.OnDirectionChanged, Widget.OnHide, Widget.OnKeynavFailed, Widget.OnMap, Widget.OnMnemonicActivate, Widget.OnMoveFocus, Widget.OnQueryTooltip, Widget.OnRealize, Widget.OnShow, Widget.OnStateFlagsChanged, Widget.OnTickCallback, Widget.OnUnmap, Widget.OnUnrealize

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields inherited from class ch.bailu.gtk.gtk.Widget

SIGNAL_ON_DESTROY, SIGNAL_ON_DIRECTION_CHANGED, SIGNAL_ON_HIDE, SIGNAL_ON_KEYNAV_FAILED, SIGNAL_ON_MAP, SIGNAL_ON_MNEMONIC_ACTIVATE, SIGNAL_ON_MOVE_FOCUS, SIGNAL_ON_QUERY_TOOLTIP, SIGNAL_ON_REALIZE, SIGNAL_ON_SHOW, SIGNAL_ON_STATE_FLAGS_CHANGED, SIGNAL_ON_UNMAP, SIGNAL_ON_UNREALIZE

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
DragIcon(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
Accessible	asAccessible()	Implements interface Accessible.
Buildable	asBuildable()	Implements interface Buildable.
ConstraintTarget	asConstraintTarget()	Implements interface ConstraintTarget.
Native	asNative()	Implements interface Native.
Root	asRoot()	Implements interface Root.
static Widget	createWidgetForValue(Value value)	Creates a widget that can be used as a drag icon for the given @value.
Widget	getChild()	Gets the widget currently used as drag icon.
static ClassHandler	getClassHandler()
static Widget	getForDrag(Drag drag)	Gets the `GtkDragIcon` in use with @drag.
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
void	setChild(Widget child)	Sets the widget to display as the drag icon.
static void	setFromPaintable(Drag drag, Paintable paintable, int hot_x, int hot_y)	Creates a `GtkDragIcon` that shows @paintable, and associates it with the drag operation.

Methods inherited from class ch.bailu.gtk.gtk.Widget

actionSetEnabled, actionSetEnabled, activate, activateAction, activateAction, activateActionVariant, activateActionVariant, activateDefault, addController, addCssClass, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, 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, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeCssClass, removeMnemonicLabel, removeTickCallback, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipMarkup, setTooltipText, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, snapshotChild, triggerTooltipQuery, unmap, unparent, unrealize, unsetStateFlags

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

DragIcon

public DragIcon(PointerContainer pointer)

Method Details

getClassHandler

public static ClassHandler getClassHandler()

getChild

public 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`

createWidgetForValue

public static Widget createWidgetForValue(@Nonnull
 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.

getForDrag

public static Widget getForDrag(@Nonnull
 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`

setFromPaintable

public static void setFromPaintable(@Nonnull
 Drag drag,
 @Nonnull
 Paintable paintable,
 int hot_x,
 int hot_y)

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

hot_x - X coordinate of the hotspot

hot_y - Y coordinate of the hotspot

asAccessible

public Accessible asAccessible()

Implements interface Accessible. Call this to get access to interface functions.

Overrides:

asAccessible in class Widget

Returns:

Accessible

asBuildable

public Buildable asBuildable()

Implements interface Buildable. Call this to get access to interface functions.

Overrides:

asBuildable in class Widget

Returns:

Buildable

asConstraintTarget

public ConstraintTarget asConstraintTarget()

Implements interface ConstraintTarget. Call this to get access to interface functions.

Overrides:

asConstraintTarget in class Widget

Returns:

ConstraintTarget

asNative

public Native asNative()

Implements interface Native. Call this to get access to interface functions.

Returns:

Native

asRoot

public Root asRoot()

Implements interface Root. Call this to get access to interface functions.

Returns:

Root

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()