ShortcutsSectionProtocol
public protocol ShortcutsSectionProtocol : BoxProtocol
A GtkShortcutsSection
collects all the keyboard shortcuts and gestures
for a major application mode.
If your application needs multiple sections, you should give each
section a unique [propertyGtk.ShortcutsSection:section-name
] and
a [propertyGtk.ShortcutsSection:title
] that can be shown in the
section selector of the [classGtk.ShortcutsWindow
].
The [propertyGtk.ShortcutsSection:max-height
] property can be used
to influence how the groups in the section are distributed over pages
and columns.
This widget is only meant to be used with [classGtk.ShortcutsWindow
].
The ShortcutsSectionProtocol
protocol exposes the methods and properties of an underlying GtkShortcutsSection
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 ShortcutsSection
.
Alternatively, use ShortcutsSectionRef
as a lighweight, unowned
reference if you already have an instance you just want to use.
-
Untyped pointer to the underlying
GtkShortcutsSection
instance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get }
-
shortcuts_section_ptr
Default implementationTyped pointer to the underlying
GtkShortcutsSection
instance.Default Implementation
Return the stored, untyped pointer as a typed pointer to the
GtkShortcutsSection
instance.Declaration
Swift
var shortcuts_section_ptr: UnsafeMutablePointer<GtkShortcutsSection>! { get }
-
Required Initialiser for types conforming to
ShortcutsSectionProtocol
Declaration
Swift
init(raw: UnsafeMutableRawPointer)
-
bind(property:
Extension methodto: _: flags: transformFrom: transformTo: ) Bind a
ShortcutsSectionPropertyName
source property to a given target object.Declaration
Swift
@discardableResult @inlinable func bind<Q, T>(property source_property: ShortcutsSectionPropertyName, 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 ShortcutsSection property
Declaration
Swift
@inlinable func get(property: ShortcutsSectionPropertyName) -> 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 ShortcutsSection property. Note that this will only have an effect on properties that are writable and not construct-only!
Declaration
Swift
@inlinable func set(property: ShortcutsSectionPropertyName, 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
ShortcutsSectionSignalName
signalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: ShortcutsSectionSignalName, 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
ShortcutsSectionSignalName
signalDeclaration
Swift
@discardableResult @inlinable func connect(signal s: ShortcutsSectionSignalName, 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)
-
onChangeCurrentPage(flags:
Extension methodhandler: ) Note
This represents the underlyingchange-current-page
signalDeclaration
Swift
@discardableResult @inlinable func onChangeCurrentPage(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsSectionRef, _ object: Int) -> Bool) -> Int
Parameters
flags
Flags
unownedSelf
Reference to instance of self
object
none
handler
The signal handler to call Run the given callback whenever the
changeCurrentPage
signal is emitted -
changeCurrentPageSignal
Extension methodTyped
change-current-page
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var changeCurrentPageSignal: ShortcutsSectionSignalName { get }
-
onNotifyMaxHeight(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::max-height
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyMaxHeight(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsSectionRef, _ 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
notifyMaxHeight
signal is emitted -
notifyMaxHeightSignal
Extension methodTyped
notify::max-height
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyMaxHeightSignal: ShortcutsSectionSignalName { get }
-
onNotifySectionName(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::section-name
signalDeclaration
Swift
@discardableResult @inlinable func onNotifySectionName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsSectionRef, _ 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
notifySectionName
signal is emitted -
notifySectionNameSignal
Extension methodTyped
notify::section-name
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifySectionNameSignal: ShortcutsSectionSignalName { get }
-
onNotifyTitle(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::title
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyTitle(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsSectionRef, _ 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
notifyTitle
signal is emitted -
notifyTitleSignal
Extension methodTyped
notify::title
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyTitleSignal: ShortcutsSectionSignalName { get }
-
onNotifyViewName(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::view-name
signalDeclaration
Swift
@discardableResult @inlinable func onNotifyViewName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsSectionRef, _ 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
notifyViewName
signal is emitted -
notifyViewNameSignal
Extension methodTyped
notify::view-name
signal for using theconnect(signal:)
methodsDeclaration
Swift
static var notifyViewNameSignal: ShortcutsSectionSignalName { get }