IconViewProtocol
public protocol IconViewProtocol : CellLayoutProtocol, ContainerProtocol, ScrollableProtocol
GtkIconView
provides an alternative view on a GtkTreeModel
.
It displays the model as a grid of icons with labels. Like
GtkTreeView
, it allows to select one or multiple items
(depending on the selection mode, see gtk_icon_view_set_selection_mode()
).
In addition to selection with the arrow keys, GtkIconView
supports
rubberband selection, which is controlled by dragging the pointer.
Note that if the tree model is backed by an actual tree store (as
opposed to a flat list where the mapping to icons is obvious),
GtkIconView
will only display the first level of the tree and
ignore the tree’s branches.
CSS nodes
(plain Language Example):
iconview.view
╰── [rubberband]
GtkIconView has a single CSS node with name iconview and style class .view. For rubberband selection, a subnode with name rubberband is used.
The IconViewProtocol
protocol exposes the methods and properties of an underlying GtkIconView
instance.
The default implementation of these can be found in the protocol extension below.
For a concrete class that implements these methods and properties, see IconView
.
Alternatively, use IconViewRef
as a lighweight, unowned
reference if you already have an instance you just want to use.
-
Untyped pointer to the underlying
GtkIconView
instance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get }
-
icon_view_ptr
Default implementationTyped pointer to the underlying
GtkIconView
instance.Default Implementation
Return the stored, untyped pointer as a typed pointer to the
GtkIconView
instance.Declaration
Swift
var icon_view_ptr: UnsafeMutablePointer<GtkIconView>! { get }
-
Required Initialiser for types conforming to
IconViewProtocol
Declaration
Swift
init(raw: UnsafeMutableRawPointer)
-
bind(property:
Extension methodto: _: flags: transformFrom: transformTo: ) Bind a
IconViewPropertyName
source property to a given target object.Declaration
Swift
@discardableResult @inlinable func bind<Q, T>(property source_property: IconViewPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol
Parameters
source_property
the source property to bind
target
the target object to bind to
target_property
the target property to bind to
flags
the flags to pass to the
Binding
transform_from
ValueTransformer
to use for forward transformationtransform_to
ValueTransformer
to use for backwards transformationReturn Value
binding reference or
nil
in case of an error -
get(property:
Extension method) Get the value of a IconView property
Declaration
Swift
@inlinable func get(property: IconViewPropertyName) -> GLibObject.Value
Parameters
property
the property to get the value for
Return Value
the value of the named property
-
set(property:
Extension methodvalue: ) Set the value of a IconView property. Note that this will only have an effect on properties that are writable and not construct-only!
Declaration
Swift
@inlinable func set(property: IconViewPropertyName, value v: GLibObject.Value)
Parameters
property
the property to get the value for
Return Value
the value of the named property
-
connect(signal:
Extension methodflags: handler: ) Connect a Swift signal handler to the given, typed
IconViewSignalName
signalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: IconViewSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int
Parameters
signal
The signal to connect
flags
The connection flags to use
data
A pointer to user data to provide to the callback
destroyData
A
GClosureNotify
C function to destroy the data pointed to byuserData
handler
The Swift signal handler (function or callback) to invoke on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
connect(signal:
Extension methodflags: data: destroyData: signalHandler: ) Connect a C signal handler to the given, typed
IconViewSignalName
signalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: IconViewSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int
Parameters
signal
The signal to connect
flags
The connection flags to use
data
A pointer to user data to provide to the callback
destroyData
A
GClosureNotify
C function to destroy the data pointed to byuserData
signalHandler
The C function to be called on the given signal
Return Value
The signal handler ID (always greater than 0 for successful connections)
-
onActivateCursorItem(flags:
Extension methodhandler: ) A keybinding signal which gets emitted when the user activates the currently focused item.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control activation programmatically.The default bindings for this signal are Space, Return and Enter.
Note
This represents the underlyingactivate-cursor-item
signalDeclaration
Swift
@discardableResult @inlinable func onActivateCursorItem(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef) -> Bool) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
handler
The signal handler to call Run the given callback whenever the
activateCursorItem
signal is emitted -
activateCursorItemSignal
Extension methodTyped
activate-cursor-item
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var activateCursorItemSignal: IconViewSignalName { get }
-
onItemActivated(flags:
Extension methodhandler: ) The
item-activated
signal is emitted when the methodgtk_icon_view_item_activated()
is called, when the user double clicks an item with the “activate-on-single-click” property set tofalse
, or when the user single clicks an item when the “activate-on-single-click” property set totrue
. It is also emitted when a non-editable item is selected and one of the keys: Space, Return or Enter is pressed.Note
This represents the underlyingitem-activated
signalDeclaration
Swift
@discardableResult @inlinable func onItemActivated(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ path: TreePathRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
path
the
GtkTreePath
for the activated itemhandler
The signal handler to call Run the given callback whenever the
itemActivated
signal is emitted -
itemActivatedSignal
Extension methodTyped
item-activated
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var itemActivatedSignal: IconViewSignalName { get }
-
onMoveCursor(flags:
Extension methodhandler: ) The
move-cursor
signal is a keybinding signal which gets emitted when the user initiates a cursor movement.Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the cursor programmatically.The default bindings for this signal include
- Arrow keys which move by individual steps
- Home/End keys which move to the first/last item
- PageUp/PageDown which move by “pages” All of these will extend the selection when combined with the Shift modifier.
Note
This represents the underlyingmove-cursor
signalDeclaration
Swift
@discardableResult @inlinable func onMoveCursor(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ step: MovementStep, _ count: Int) -> Bool) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
step
the granularity of the move, as a
GtkMovementStep
count
the number of
step
units to movehandler
The signal handler to call Run the given callback whenever the
moveCursor
signal is emitted -
moveCursorSignal
Extension methodTyped
move-cursor
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var moveCursorSignal: IconViewSignalName { get }
-
onSelectAll(flags:
Extension methodhandler: ) A keybinding signal which gets emitted when the user selects all items.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection programmatically.The default binding for this signal is Ctrl-a.
Note
This represents the underlyingselect-all
signalDeclaration
Swift
@discardableResult @inlinable func onSelectAll(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
handler
The signal handler to call Run the given callback whenever the
selectAll
signal is emitted -
selectAllSignal
Extension methodTyped
select-all
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var selectAllSignal: IconViewSignalName { get }
-
onSelectCursorItem(flags:
Extension methodhandler: ) A keybinding signal which gets emitted when the user selects the item that is currently focused.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection programmatically.There is no default binding for this signal.
Note
This represents the underlyingselect-cursor-item
signalDeclaration
Swift
@discardableResult @inlinable func onSelectCursorItem(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
handler
The signal handler to call Run the given callback whenever the
selectCursorItem
signal is emitted -
selectCursorItemSignal
Extension methodTyped
select-cursor-item
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var selectCursorItemSignal: IconViewSignalName { get }
-
onSelectionChanged(flags:
Extension methodhandler: ) The
selection-changed
signal is emitted when the selection (i.e. the set of selected items) changes.Note
This represents the underlyingselection-changed
signalDeclaration
Swift
@discardableResult @inlinable func onSelectionChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
handler
The signal handler to call Run the given callback whenever the
selectionChanged
signal is emitted -
selectionChangedSignal
Extension methodTyped
selection-changed
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var selectionChangedSignal: IconViewSignalName { get }
-
onToggleCursorItem(flags:
Extension methodhandler: ) A keybinding signal which gets emitted when the user toggles whether the currently focused item is selected or not. The exact effect of this depend on the selection mode.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection programmatically.There is no default binding for this signal is Ctrl-Space.
Note
This represents the underlyingtoggle-cursor-item
signalDeclaration
Swift
@discardableResult @inlinable func onToggleCursorItem(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
handler
The signal handler to call Run the given callback whenever the
toggleCursorItem
signal is emitted -
toggleCursorItemSignal
Extension methodTyped
toggle-cursor-item
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var toggleCursorItemSignal: IconViewSignalName { get }
-
onUnselectAll(flags:
Extension methodhandler: ) A keybinding signal which gets emitted when the user unselects all items.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection programmatically.The default binding for this signal is Ctrl-Shift-a.
Note
This represents the underlyingunselect-all
signalDeclaration
Swift
@discardableResult @inlinable func onUnselectAll(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
handler
The signal handler to call Run the given callback whenever the
unselectAll
signal is emitted -
unselectAllSignal
Extension methodTyped
unselect-all
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var unselectAllSignal: IconViewSignalName { get }
-
onNotifyActivateOnSingleClick(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::activate-on-single-click
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyActivateOnSingleClick(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyActivateOnSingleClick
signal is emitted -
notifyActivateOnSingleClickSignal
Extension methodTyped
notify::activate-on-single-click
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyActivateOnSingleClickSignal: IconViewSignalName { get }
-
onNotifyCellArea(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::cell-area
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyCellArea(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyCellArea
signal is emitted -
notifyCellAreaSignal
Extension methodTyped
notify::cell-area
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyCellAreaSignal: IconViewSignalName { get }
-
onNotifyColumnSpacing(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::column-spacing
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyColumnSpacing(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyColumnSpacing
signal is emitted -
notifyColumnSpacingSignal
Extension methodTyped
notify::column-spacing
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyColumnSpacingSignal: IconViewSignalName { get }
-
onNotifyColumns(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::columns
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyColumns(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyColumns
signal is emitted -
notifyColumnsSignal
Extension methodTyped
notify::columns
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyColumnsSignal: IconViewSignalName { get }
-
onNotifyItemOrientation(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::item-orientation
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyItemOrientation(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyItemOrientation
signal is emitted -
notifyItemOrientationSignal
Extension methodTyped
notify::item-orientation
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyItemOrientationSignal: IconViewSignalName { get }
-
onNotifyItemPadding(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::item-padding
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyItemPadding(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyItemPadding
signal is emitted -
notifyItemPaddingSignal
Extension methodTyped
notify::item-padding
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyItemPaddingSignal: IconViewSignalName { get }
-
onNotifyItemWidth(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::item-width
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyItemWidth(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyItemWidth
signal is emitted -
notifyItemWidthSignal
Extension methodTyped
notify::item-width
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyItemWidthSignal: IconViewSignalName { get }
-
onNotifyMargin(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::margin
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyMargin(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyMargin
signal is emitted -
notifyMarginSignal
Extension methodTyped
notify::margin
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyMarginSignal: IconViewSignalName { get }
-
onNotifyMarkupColumn(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::markup-column
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyMarkupColumn(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyMarkupColumn
signal is emitted -
notifyMarkupColumnSignal
Extension methodTyped
notify::markup-column
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyMarkupColumnSignal: IconViewSignalName { get }
-
onNotifyModel(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::model
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyModel(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyModel
signal is emitted -
notifyModelSignal
Extension methodTyped
notify::model
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyModelSignal: IconViewSignalName { get }
-
onNotifyPixbufColumn(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::pixbuf-column
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyPixbufColumn(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyPixbufColumn
signal is emitted -
notifyPixbufColumnSignal
Extension methodTyped
notify::pixbuf-column
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyPixbufColumnSignal: IconViewSignalName { get }
-
onNotifyReorderable(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::reorderable
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyReorderable(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyReorderable
signal is emitted -
notifyReorderableSignal
Extension methodTyped
notify::reorderable
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyReorderableSignal: IconViewSignalName { get }
-
onNotifyRowSpacing(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::row-spacing
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyRowSpacing(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyRowSpacing
signal is emitted -
notifyRowSpacingSignal
Extension methodTyped
notify::row-spacing
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyRowSpacingSignal: IconViewSignalName { get }
-
onNotifySelectionMode(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::selection-mode
signalDeclaration
Swift
@discardableResult @inlinable func onNotifySelectionMode(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifySelectionMode
signal is emitted -
notifySelectionModeSignal
Extension methodTyped
notify::selection-mode
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifySelectionModeSignal: IconViewSignalName { get }
-
onNotifySpacing(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::spacing
signalDeclaration
Swift
@discardableResult @inlinable func onNotifySpacing(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifySpacing
signal is emitted -
notifySpacingSignal
Extension methodTyped
notify::spacing
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifySpacingSignal: IconViewSignalName { get }
-
onNotifyTextColumn(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::text-column
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyTextColumn(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyTextColumn
signal is emitted -
notifyTextColumnSignal
Extension methodTyped
notify::text-column
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyTextColumnSignal: IconViewSignalName { get }
-
onNotifyTooltipColumn(flags:
Extension methodhandler: ) The notify signal is emitted on an object when one of its properties has its value set through
g_object_set_property()
,g_object_set()
, et al.Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with
G_PARAM_EXPLICIT_NOTIFY
, then any call tog_object_set_property()
results innotify
being emitted, even if the new value is the same as the old. If they did passG_PARAM_EXPLICIT_NOTIFY
, then this signal is emitted only when they explicitly callg_object_notify()
org_object_notify_by_pspec()
, and common practice is to do that only when the value has actually changed.This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the
g_signal_connect()
call, like this:(C Language Example):
g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view)
It is important to note that you must use canonical parameter names as detail strings for the notify signal.
Note
This represents the underlyingnotify::tooltip-column
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyTooltipColumn(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: IconViewRef, _ pspec: ParamSpecRef) -> Void) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
pspec
the
GParamSpec
of the property which changed.handler
The signal handler to call Run the given callback whenever the
notifyTooltipColumn
signal is emitted -
notifyTooltipColumnSignal
Extension methodTyped
notify::tooltip-column
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyTooltipColumnSignal: IconViewSignalName { get }
-
convertWidgetToBinWindowCoords(wx:
Extension methodwy: bx: by: ) Converts widget coordinates to coordinates for the bin_window, as expected by e.g.
gtk_icon_view_get_path_at_pos()
.Declaration
Swift
@inlinable func convertWidgetToBinWindowCoords(wx: Int, wy: Int, bx: UnsafeMutablePointer<gint>!, by: UnsafeMutablePointer<gint>!)
-
createDragIcon(path:
Extension method) Creates a
cairo_surface_t
representation of the item atpath
. This image is used for a drag icon.Declaration
Swift
@inlinable func createDragIcon<TreePathT>(path: TreePathT) -> Cairo.SurfaceRef! where TreePathT : TreePathProtocol
-
enableModelDragDest(targets:
Extension methodnTargets: actions: ) Turns
icon_view
into a drop destination for automatic DND. Calling this method setsGtkIconView:reorderable
tofalse
.Declaration
Swift
@inlinable func enableModelDragDest(targets: UnsafePointer<GtkTargetEntry>!, nTargets: Int, actions: Gdk.DragAction)
-
enableModelDragSource(startButtonMask:
Extension methodtargets: nTargets: actions: ) Turns
icon_view
into a drag source for automatic DND. Calling this method setsGtkIconView:reorderable
tofalse
.Declaration
Swift
@inlinable func enableModelDragSource(startButtonMask: Gdk.ModifierType, targets: UnsafePointer<GtkTargetEntry>!, nTargets: Int, actions: Gdk.DragAction)
-
getActivateOnSingleClick()
Extension methodGets the setting set by
gtk_icon_view_set_activate_on_single_click()
.Declaration
Swift
@inlinable func getActivateOnSingleClick() -> Bool
-
getCellRect(path:
Extension methodcell: rect: ) Fills the bounding rectangle in widget coordinates for the cell specified by
path
andcell
. Ifcell
isnil
the main cell area is used.This function is only valid if
icon_view
is realized.Declaration
Swift
@inlinable func getCellRect<RectangleT, TreePathT>(path: TreePathT, cell: CellRendererRef? = nil, rect: RectangleT) -> Bool where RectangleT : RectangleProtocol, TreePathT : TreePathProtocol
-
getCellRect(path:
Extension methodcell: rect: ) Fills the bounding rectangle in widget coordinates for the cell specified by
path
andcell
. Ifcell
isnil
the main cell area is used.This function is only valid if
icon_view
is realized.Declaration
Swift
@inlinable func getCellRect<CellRendererT, RectangleT, TreePathT>(path: TreePathT, cell: CellRendererT?, rect: RectangleT) -> Bool where CellRendererT : CellRendererProtocol, RectangleT : RectangleProtocol, TreePathT : TreePathProtocol
-
getColumnSpacing()
Extension methodReturns the value of the
column-spacing
property.Declaration
Swift
@inlinable func getColumnSpacing() -> Int
-
getColumns()
Extension methodReturns the value of the
columns
property.Declaration
Swift
@inlinable func getColumns() -> Int
-
getCursor(path:
Extension methodcell: ) Fills in
path
andcell
with the current cursor path and cell. If the cursor isn’t currently set, then *path
will benil
. If no cell currently has focus, then *cell
will benil
.The returned
GtkTreePath
must be freed withgtk_tree_path_free()
.Declaration
Swift
@inlinable func getCursor(path: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, cell: UnsafeMutablePointer<UnsafeMutablePointer<GtkCellRenderer>?>! = nil) -> Bool
-
getDestItemAtPos(dragX:
Extension methoddragY: path: pos: ) Determines the destination item for a given position.
Declaration
Swift
@inlinable func getDestItemAtPos(dragX: Int, dragY: Int, path: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, pos: UnsafeMutablePointer<GtkIconViewDropPosition>! = nil) -> Bool
-
getDragDestItem(path:
Extension methodpos: ) Gets information about the item that is highlighted for feedback.
Declaration
Swift
@inlinable func getDragDestItem(path: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, pos: UnsafeMutablePointer<GtkIconViewDropPosition>! = nil)
-
getItemAtPos(x:
Extension methody: path: cell: ) Finds the path at the point (
x
,y
), relative to bin_window coordinates. In contrast togtk_icon_view_get_path_at_pos()
, this function also obtains the cell at the specified position. The returned path should be freed withgtk_tree_path_free()
. Seegtk_icon_view_convert_widget_to_bin_window_coords()
for converting widget coordinates to bin_window coordinates.Declaration
Swift
@inlinable func getItemAtPos(x: Int, y: Int, path: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, cell: UnsafeMutablePointer<UnsafeMutablePointer<GtkCellRenderer>?>! = nil) -> Bool
-
getItemColumn(path:
Extension method) Gets the column in which the item
path
is currently displayed. Column numbers start at 0.Declaration
Swift
@inlinable func getItemColumn<TreePathT>(path: TreePathT) -> Int where TreePathT : TreePathProtocol
-
getItemOrientation()
Extension methodReturns the value of the
item-orientation
property which determines whether the labels are drawn beside the icons instead of below.Declaration
Swift
@inlinable func getItemOrientation() -> GtkOrientation
-
getItemPadding()
Extension methodReturns the value of the
item-padding
property.Declaration
Swift
@inlinable func getItemPadding() -> Int
-
getItemRow(path:
Extension method) Gets the row in which the item
path
is currently displayed. Row numbers start at 0.Declaration
Swift
@inlinable func getItemRow<TreePathT>(path: TreePathT) -> Int where TreePathT : TreePathProtocol
-
getItemWidth()
Extension methodReturns the value of the
item-width
property.Declaration
Swift
@inlinable func getItemWidth() -> Int
-
getMargin()
Extension methodReturns the value of the
margin
property.Declaration
Swift
@inlinable func getMargin() -> Int
-
getMarkupColumn()
Extension methodReturns the column with markup text for
icon_view
.Declaration
Swift
@inlinable func getMarkupColumn() -> Int
-
getModel()
Extension methodReturns the model the
GtkIconView
is based on. Returnsnil
if the model is unset.Declaration
Swift
@inlinable func getModel() -> TreeModelRef!
-
getPathAtPos(x:
Extension methody: ) Finds the path at the point (
x
,y
), relative to bin_window coordinates. Seegtk_icon_view_get_item_at_pos()
, if you are also interested in the cell at the specified position. Seegtk_icon_view_convert_widget_to_bin_window_coords()
for converting widget coordinates to bin_window coordinates.Declaration
Swift
@inlinable func getPathAtPos(x: Int, y: Int) -> TreePathRef!
-
getPixbufColumn()
Extension methodReturns the column with pixbufs for
icon_view
.Declaration
Swift
@inlinable func getPixbufColumn() -> Int
-
getReorderable()
Extension methodRetrieves whether the user can reorder the list via drag-and-drop. See
gtk_icon_view_set_reorderable()
.Declaration
Swift
@inlinable func getReorderable() -> Bool
-
getRowSpacing()
Extension methodReturns the value of the
row-spacing
property.Declaration
Swift
@inlinable func getRowSpacing() -> Int
-
getSelectedItems()
Extension methodCreates a list of paths of all selected items. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of
GtkTreeRowReferences
. To do this, you can usegtk_tree_row_reference_new()
.To free the return value, use: (C Language Example):
g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);
Declaration
Swift
@inlinable func getSelectedItems() -> GLib.ListRef!
-
getSelectionMode()
Extension methodGets the selection mode of the
icon_view
.Declaration
Swift
@inlinable func getSelectionMode() -> GtkSelectionMode
-
getSpacing()
Extension methodReturns the value of the
spacing
property.Declaration
Swift
@inlinable func getSpacing() -> Int
-
getTextColumn()
Extension methodReturns the column with text for
icon_view
.Declaration
Swift
@inlinable func getTextColumn() -> Int
-
getTooltipColumn()
Extension methodReturns the column of
icon_view
’s model which is being used for displaying tooltips onicon_view
’s rows.Declaration
Swift
@inlinable func getTooltipColumn() -> Int
-
getTooltipContext(x:
Extension methody: keyboardTip: model: path: iter: ) This function is supposed to be used in a
GtkWidget::query-tooltip
signal handler forGtkIconView
. Thex
,y
andkeyboard_tip
values which are received in the signal handler, should be passed to this function without modification.The return value indicates whether there is an icon view item at the given coordinates (
true
) or not (false
) for mouse tooltips. For keyboard tooltips the item returned will be the cursor item. Whentrue
, then any ofmodel
,path
anditer
which have been provided will be set to point to that row and the corresponding model.x
andy
will always be converted to be relative toicon_view
’s bin_window ifkeyboard_tooltip
isfalse
.Declaration
Swift
@inlinable func getTooltipContext(x: UnsafeMutablePointer<gint>!, y: UnsafeMutablePointer<gint>!, keyboardTip: Bool, model: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreeModel>?>! = nil, path: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, iter: TreeIterRef? = nil) -> Bool
-
getTooltipContext(x:
Extension methody: keyboardTip: model: path: iter: ) This function is supposed to be used in a
GtkWidget::query-tooltip
signal handler forGtkIconView
. Thex
,y
andkeyboard_tip
values which are received in the signal handler, should be passed to this function without modification.The return value indicates whether there is an icon view item at the given coordinates (
true
) or not (false
) for mouse tooltips. For keyboard tooltips the item returned will be the cursor item. Whentrue
, then any ofmodel
,path
anditer
which have been provided will be set to point to that row and the corresponding model.x
andy
will always be converted to be relative toicon_view
’s bin_window ifkeyboard_tooltip
isfalse
.Declaration
Swift
@inlinable func getTooltipContext<TreeIterT>(x: UnsafeMutablePointer<gint>!, y: UnsafeMutablePointer<gint>!, keyboardTip: Bool, model: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreeModel>?>! = nil, path: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, iter: TreeIterT?) -> Bool where TreeIterT : TreeIterProtocol
-
getVisibleRange(startPath:
Extension methodendPath: ) Sets
start_path
andend_path
to be the first and last visible path. Note that there may be invisible paths in between.Both paths should be freed with
gtk_tree_path_free()
after use.Declaration
Swift
@inlinable func getVisibleRange(startPath: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil, endPath: UnsafeMutablePointer<UnsafeMutablePointer<GtkTreePath>?>! = nil) -> Bool
-
itemActivated(path:
Extension method) Activates the item determined by
path
.Declaration
Swift
@inlinable func itemActivated<TreePathT>(path: TreePathT) where TreePathT : TreePathProtocol
-
pathIsSelected(path:
Extension method) Returns
true
if the icon pointed to bypath
is currently selected. Ifpath
does not point to a valid location,false
is returned.Declaration
Swift
@inlinable func pathIsSelected<TreePathT>(path: TreePathT) -> Bool where TreePathT : TreePathProtocol
-
scrollTo(path:
Extension methoduseAlign: rowAlign: colAlign: ) Moves the alignments of
icon_view
to the position specified bypath
.row_align
determines where the row is placed, andcol_align
determines wherecolumn
is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.If
use_align
isfalse
, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the item onto the screen. This means that the item will be scrolled to the edge closest to its current position. If the item is currently visible on the screen, nothing is done.This function only works if the model is set, and
path
is a valid row on the model. If the model changes before theicon_view
is realized, the centered path will be modified to reflect this change.Declaration
Swift
@inlinable func scrollTo<TreePathT>(path: TreePathT, useAlign: Bool, rowAlign: Double, colAlign: Double) where TreePathT : TreePathProtocol
-
selectAll()
Extension methodSelects all the icons.
icon_view
must has its selection mode set toGTK_SELECTION_MULTIPLE
.Declaration
Swift
@inlinable func selectAll()
-
select(path:
Extension method) Selects the row at
path
.Declaration
Swift
@inlinable func select<TreePathT>(path: TreePathT) where TreePathT : TreePathProtocol
-
selectedForeach(func:
Extension methoddata: ) Calls a function for each selected icon. Note that the model or selection cannot be modified from within this function.
Declaration
Swift
@inlinable func selectedForeach(func: GtkIconViewForeachFunc?, data: gpointer! = nil)
-
setActivateOnSingleClick(single:
Extension method) Causes the
GtkIconView::item-activated
signal to be emitted on a single click instead of a double click.Declaration
Swift
@inlinable func setActivateOnSingleClick(single: Bool)
-
set(columnSpacing:
Extension method) Sets the
column-spacing
property which specifies the space which is inserted between the columns of the icon view.Declaration
Swift
@inlinable func set(columnSpacing: Int)
-
set(columns:
Extension method) -
setCursor(path:
Extension methodcell: startEditing: ) Sets the current keyboard focus to be at
path
, and selects it. This is useful when you want to focus the user’s attention on a particular item. Ifcell
is notnil
, then focus is given to the cell specified by it. Additionally, ifstart_editing
istrue
, then editing should be started in the specified cell.This function is often followed by
gtk_widget_grab_focus (icon_view)
in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.Declaration
Swift
@inlinable func setCursor<TreePathT>(path: TreePathT, cell: CellRendererRef? = nil, startEditing: Bool) where TreePathT : TreePathProtocol
-
setCursor(path:
Extension methodcell: startEditing: ) Sets the current keyboard focus to be at
path
, and selects it. This is useful when you want to focus the user’s attention on a particular item. Ifcell
is notnil
, then focus is given to the cell specified by it. Additionally, ifstart_editing
istrue
, then editing should be started in the specified cell.This function is often followed by
gtk_widget_grab_focus (icon_view)
in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.Declaration
Swift
@inlinable func setCursor<CellRendererT, TreePathT>(path: TreePathT, cell: CellRendererT?, startEditing: Bool) where CellRendererT : CellRendererProtocol, TreePathT : TreePathProtocol
-
setDragDestItem(path:
Extension methodpos: ) Sets the item that is highlighted for feedback.
Declaration
Swift
@inlinable func setDragDestItem(path: TreePathRef? = nil, pos: GtkIconViewDropPosition)
-
setDragDestItem(path:
Extension methodpos: ) Sets the item that is highlighted for feedback.
Declaration
Swift
@inlinable func setDragDestItem<TreePathT>(path: TreePathT?, pos: GtkIconViewDropPosition) where TreePathT : TreePathProtocol
-
setItem(orientation:
Extension method) Sets the
item-orientation
property which determines whether the labels are drawn beside the icons instead of below.Declaration
Swift
@inlinable func setItem(orientation: GtkOrientation)
-
set(itemPadding:
Extension method) Sets the
GtkIconView:item-padding
property which specifies the padding around each of the icon view’s items.Declaration
Swift
@inlinable func set(itemPadding: Int)
-
set(itemWidth:
Extension method) Sets the
item-width
property which specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size.Declaration
Swift
@inlinable func set(itemWidth: Int)
-
set(margin:
Extension method) Sets the
margin
property which specifies the space which is inserted at the top, bottom, left and right of the icon view.Declaration
Swift
@inlinable func set(margin: Int)
-
setMarkup(column:
Extension method) Sets the column with markup information for
icon_view
to becolumn
. The markup column must be of typeG_TYPE_STRING
. If the markup column is set to something, it overrides the text column set bygtk_icon_view_set_text_column()
.Declaration
Swift
@inlinable func setMarkup(column: Int)
-
set(model:
Extension method) Sets the model for a
GtkIconView
. If theicon_view
already has a model set, it will remove it before setting the new model. Ifmodel
isnil
, then it will unset the old model.Declaration
Swift
@inlinable func set(model: TreeModelRef? = nil)
-
set(model:
Extension method) Sets the model for a
GtkIconView
. If theicon_view
already has a model set, it will remove it before setting the new model. Ifmodel
isnil
, then it will unset the old model.Declaration
Swift
@inlinable func set<TreeModelT>(model: TreeModelT?) where TreeModelT : TreeModelProtocol
-
setPixbuf(column:
Extension method) Sets the column with pixbufs for
icon_view
to becolumn
. The pixbuf column must be of typeGDK_TYPE_PIXBUF
Declaration
Swift
@inlinable func setPixbuf(column: Int)
-
set(reorderable:
Extension method) This function is a convenience function to allow you to reorder models that support the
GtkTreeDragSourceIface
and theGtkTreeDragDestIface
. BothGtkTreeStore
andGtkListStore
support these. Ifreorderable
istrue
, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model’s row_inserted and row_deleted signals. The reordering is implemented by setting up the icon view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose.This function does not give you any degree of control over the order – any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.
Declaration
Swift
@inlinable func set(reorderable: Bool)
-
set(rowSpacing:
Extension method) Sets the
row-spacing
property which specifies the space which is inserted between the rows of the icon view.Declaration
Swift
@inlinable func set(rowSpacing: Int)
-
setSelection(mode:
Extension method) Sets the selection mode of the
icon_view
.Declaration
Swift
@inlinable func setSelection(mode: GtkSelectionMode)
-
set(spacing:
Extension method) Sets the
spacing
property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.Declaration
Swift
@inlinable func set(spacing: Int)
-
setText(column:
Extension method) Sets the column with text for
icon_view
to becolumn
. The text column must be of typeG_TYPE_STRING
.Declaration
Swift
@inlinable func setText(column: Int)
-
setTooltipCell(tooltip:
Extension methodpath: cell: ) Sets the tip area of
tooltip
to the area whichcell
occupies in the item pointed to bypath
. See alsogtk_tooltip_set_tip_area()
.See also
gtk_icon_view_set_tooltip_column()
for a simpler alternative.Declaration
Swift
@inlinable func setTooltipCell<TooltipT, TreePathT>(tooltip: TooltipT, path: TreePathT, cell: CellRendererRef? = nil) where TooltipT : TooltipProtocol, TreePathT : TreePathProtocol
-
setTooltipCell(tooltip:
Extension methodpath: cell: ) Sets the tip area of
tooltip
to the area whichcell
occupies in the item pointed to bypath
. See alsogtk_tooltip_set_tip_area()
.See also
gtk_icon_view_set_tooltip_column()
for a simpler alternative.Declaration
Swift
@inlinable func setTooltipCell<CellRendererT, TooltipT, TreePathT>(tooltip: TooltipT, path: TreePathT, cell: CellRendererT?) where CellRendererT : CellRendererProtocol, TooltipT : TooltipProtocol, TreePathT : TreePathProtocol
-
setTooltip(column:
Extension method) If you only plan to have simple (text-only) tooltips on full items, you can use this function to have
GtkIconView
handle these automatically for you.column
should be set to the column inicon_view
’s model containing the tooltip texts, or -1 to disable this feature.When enabled,
GtkWidget:has-tooltip
will be set totrue
andicon_view
will connect aGtkWidget::query-tooltip
signal handler.Note that the signal handler sets the text with
gtk_tooltip_set_markup()
, so &, <, etc have to be escaped in the text.Declaration
Swift
@inlinable func setTooltip(column: Int)
-
setTooltipItem(tooltip:
Extension methodpath: ) Sets the tip area of
tooltip
to be the area covered by the item atpath
. See alsogtk_icon_view_set_tooltip_column()
for a simpler alternative. See alsogtk_tooltip_set_tip_area()
.Declaration
Swift
@inlinable func setTooltipItem<TooltipT, TreePathT>(tooltip: TooltipT, path: TreePathT) where TooltipT : TooltipProtocol, TreePathT : TreePathProtocol
-
unselectAll()
Extension methodUnselects all the icons.
Declaration
Swift
@inlinable func unselectAll()
-
unselect(path:
Extension method) Unselects the row at
path
.Declaration
Swift
@inlinable func unselect<TreePathT>(path: TreePathT) where TreePathT : TreePathProtocol
-
unsetModelDragDest()
Extension methodUndoes the effect of
gtk_icon_view_enable_model_drag_dest()
. Calling this method setsGtkIconView:reorderable
tofalse
.Declaration
Swift
@inlinable func unsetModelDragDest()
-
unsetModelDragSource()
Extension methodUndoes the effect of
gtk_icon_view_enable_model_drag_source()
. Calling this method setsGtkIconView:reorderable
tofalse
.Declaration
Swift
@inlinable func unsetModelDragSource()
-
activateOnSingleClick
Extension methodGets the setting set by
gtk_icon_view_set_activate_on_single_click()
.Declaration
Swift
@inlinable var activateOnSingleClick: Bool { get nonmutating set }
-
columnSpacing
Extension methodReturns the value of the
column-spacing
property.Declaration
Swift
@inlinable var columnSpacing: Int { get nonmutating set }
-
columns
Extension methodThe columns property contains the number of the columns in which the items should be displayed. If it is -1, the number of columns will be chosen automatically to fill the available area.
Declaration
Swift
@inlinable var columns: Int { get nonmutating set }
-
itemOrientation
Extension methodReturns the value of the
item-orientation
property which determines whether the labels are drawn beside the icons instead of below.Declaration
Swift
@inlinable var itemOrientation: GtkOrientation { get nonmutating set }
-
itemPadding
Extension methodReturns the value of the
item-padding
property.Declaration
Swift
@inlinable var itemPadding: Int { get nonmutating set }
-
itemWidth
Extension methodReturns the value of the
item-width
property.Declaration
Swift
@inlinable var itemWidth: Int { get nonmutating set }
-
margin
Extension methodThe margin property specifies the space which is inserted at the edges of the icon view.
Declaration
Swift
@inlinable var margin: Int { get nonmutating set }
-
markupColumn
Extension methodReturns the column with markup text for
icon_view
.Declaration
Swift
@inlinable var markupColumn: Int { get nonmutating set }
-
model
Extension methodUndocumented
Declaration
Swift
@inlinable var model: TreeModelRef! { get nonmutating set }
-
pixbufColumn
Extension methodReturns the column with pixbufs for
icon_view
.Declaration
Swift
@inlinable var pixbufColumn: Int { get nonmutating set }
-
reorderable
Extension methodThe reorderable property specifies if the items can be reordered by DND.
Declaration
Swift
@inlinable var reorderable: Bool { get nonmutating set }
-
rowSpacing
Extension methodReturns the value of the
row-spacing
property.Declaration
Swift
@inlinable var rowSpacing: Int { get nonmutating set }
-
selectedItems
Extension methodCreates a list of paths of all selected items. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of
GtkTreeRowReferences
. To do this, you can usegtk_tree_row_reference_new()
.To free the return value, use: (C Language Example):
g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);
Declaration
Swift
@inlinable var selectedItems: GLib.ListRef! { get }
-
selectionMode
Extension methodGets the selection mode of the
icon_view
.Declaration
Swift
@inlinable var selectionMode: GtkSelectionMode { get nonmutating set }
-
spacing
Extension methodThe spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.
Declaration
Swift
@inlinable var spacing: Int { get nonmutating set }
-
textColumn
Extension methodReturns the column with text for
icon_view
.Declaration
Swift
@inlinable var textColumn: Int { get nonmutating set }
-
tooltipColumn
Extension methodReturns the column of
icon_view
’s model which is being used for displaying tooltips onicon_view
’s rows.Declaration
Swift
@inlinable var tooltipColumn: Int { get nonmutating set }
-
parent
Extension methodUndocumented
Declaration
Swift
@inlinable var parent: GtkContainer { get }