DragIcon
open class DragIcon : Widget, DragIconProtocol
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 [funcGtk.DragIcon.get_for_drag
] to get the icon for a drag. You can
then use it like any other widget and use [methodGtk.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.
The DragIcon
type acts as a reference-counted owner of an underlying GtkDragIcon
instance.
It provides the methods that can operate on this data type through DragIconProtocol
conformance.
Use DragIcon
as a strong reference or owner of a GtkDragIcon
instance.
-
Designated initialiser from the underlying `C` data type.
This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the
DragIcon
instance.Declaration
Swift
@inlinable public init(_ op: UnsafeMutablePointer<GtkDragIcon>)
Parameters
op
pointer to the underlying object
-
Designated initialiser from a constant pointer to the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theDragIcon
instance.Declaration
Swift
@inlinable public init(_ op: UnsafePointer<GtkDragIcon>)
Parameters
op
pointer to the underlying object
-
Optional initialiser from a non-mutating
gpointer
to the underlyingC
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theDragIcon
instance.Declaration
Swift
@inlinable override public init!(gpointer op: gpointer?)
Parameters
op
gpointer to the underlying object
-
Optional initialiser from a non-mutating
gconstpointer
to the underlyingC
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theDragIcon
instance.Declaration
Swift
@inlinable override public init!(gconstpointer op: gconstpointer?)
Parameters
op
pointer to the underlying object
-
Optional initialiser from a constant pointer to the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theDragIcon
instance.Declaration
Swift
@inlinable public init!(_ op: UnsafePointer<GtkDragIcon>?)
Parameters
op
pointer to the underlying object
-
Optional initialiser from the underlying
C
data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theDragIcon
instance.Declaration
Swift
@inlinable public init!(_ op: UnsafeMutablePointer<GtkDragIcon>?)
Parameters
op
pointer to the underlying object
-
Designated initialiser from the underlying
C
data type. Will retainGtkDragIcon
. i.e., ownership is transferred to theDragIcon
instance.Declaration
Swift
@inlinable public init(retaining op: UnsafeMutablePointer<GtkDragIcon>)
Parameters
op
pointer to the underlying object
-
Reference intialiser for a related type that implements
DragIconProtocol
Will retainGtkDragIcon
.Declaration
Swift
@inlinable public init<T>(dragIcon other: T) where T : DragIconProtocol
Parameters
other
an instance of a related type that implements
DragIconProtocol
-
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable override public init<T>(cPointer p: UnsafeMutablePointer<T>)
Parameters
cPointer
pointer to the underlying object
-
Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)
Parameters
cPointer
pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable override public init(raw p: UnsafeRawPointer)
Parameters
p
raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable override public init(retainingRaw raw: UnsafeRawPointer)
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable public required init(raw p: UnsafeMutableRawPointer)
Parameters
p
mutable raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable required public init(retainingRaw raw: UnsafeMutableRawPointer)
Parameters
raw
mutable raw pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable override public init(opaquePointer p: OpaquePointer)
Parameters
p
opaque pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
DragIconProtocol
.Declaration
Swift
@inlinable override public init(retainingOpaquePointer p: OpaquePointer)
Parameters
p
opaque pointer to the underlying object
-
Creates a widget that can be used as a drag icon for the given
value
.Supported types include strings,
GdkRGBA
andGtkTextBuffer
. If GTK does not know how to create a widget for a given value, it will returnnil
.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.Declaration
Swift
@inlinable public static func createWidgetFor<ValueT>(value: ValueT) -> Widget! where ValueT : ValueProtocol
-
Gets the
GtkDragIcon
in use withdrag
.If no drag icon exists yet, a new one will be created and shown.
Declaration
Swift
@inlinable public static func getFor<DragT>(drag: DragT) -> Widget! where DragT : DragProtocol