gobject/org.gtkkn.bindings.gobject/SignalGroup

SignalGroup

open class SignalGroup(pointer: <Error class: unknown class><<Error class: unknown class>>) : Object, KGTyped

#GSignalGroup manages to simplify the process of connecting many signals to a #GObject as a group. As such there is no API to disconnect a signal from the group.

In particular, this allows you to:

Change the target instance, which automatically causes disconnection of the signals from the old instance and connecting to the new instance.
Block and unblock signals as a group
Ensuring that blocked state transfers across target instances.

One place you might want to use such a structure is with #GtkTextView and #GtkTextBuffer. Often times, you'll need to connect to many signals on #GtkTextBuffer from a #GtkTextView subclass. This allows you to create a signal group during instance construction, simply bind the #GtkTextView:buffer property to #GSignalGroup:target and connect all the signals you need. When the #GtkTextView:buffer property changes all of the signals will be transitioned correctly.

Skipped during bindings generation

parameter notify: ClosureNotify
method target: Property has no getter
method target-type: Property has no getter nor setter

Since

2.72

Constructors

SignalGroup

constructor(targetType: <Error class: unknown class>)

Creates a new #GSignalGroup for target instances of @target_type.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion : TypeCompanion<SignalGroup>

Properties

gobjectSignalGroupPointer

val gobjectSignalGroupPointer: <Error class: unknown class><<Error class: unknown class>>

gPointer

val gPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

asType

inline fun <T : KGTyped> Object.asType(): T

Convert object into type T.

bindProperty

open fun bindProperty(sourceProperty: String, target: Object, targetProperty: String, flags: BindingFlags): Binding

Creates a binding between @source_property on @source and @target_property on @target.

bindPropertyFull

open fun bindPropertyFull(sourceProperty: String, target: Object, targetProperty: String, flags: BindingFlags, transformTo: Closure, transformFrom: Closure): Binding

Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding.

block

open fun block()

Blocks all signal handlers managed by @self so they will not be called during any signal emissions. Must be unblocked exactly the same number of times it has been blocked to become active again.

connectBind

fun connectBind(connectFlags: ConnectFlags = ConnectFlags(0u), handler: (instance: Object) -> Unit): <Error class: unknown class>

This signal is emitted when #GSignalGroup:target is set to a new value other than null. It is similar to #GObject::notify on target except it will not emit when #GSignalGroup:target is null and also allows for receiving the #GObject without a data-race.

connectNotify

fun connectNotify(connectFlags: ConnectFlags = ConnectFlags(0u), handler: (pspec: ParamSpec) -> Unit): <Error class: unknown class>

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.

connectSwapped

open fun connectSwapped(detailedSignal: String, cHandler: Callback)

Connects @c_handler to the signal @detailed_signal on the target instance of @self.

connectUnbind

fun connectUnbind(connectFlags: ConnectFlags = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

This signal is emitted when the target instance of @self is set to a new #GObject.

dupTarget

open fun dupTarget(): Object?

Gets the target instance used when connecting signals.

forceFloating

open fun forceFloating()

This function is intended for #GObject implementations to re-enforce a floating-ref object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

freezeNotify

open fun freezeNotify()

Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getBooleanProperty

fun Object.getBooleanProperty(propertyName: String): Boolean

getIntProperty

fun Object.getIntProperty(propertyName: String): Int

getProperty

open fun getProperty(propertyName: String, value: Value)

Gets a property of an object.

getStringProperty

fun Object.getStringProperty(propertyName: String): String?

isFloating

open fun isFloating(): Boolean

Checks whether @object has a floating-ref reference.

notify

open fun notify(propertyName: String)

Emits a "notify" signal for the property @property_name on @object.

notifyByPspec

open fun notifyByPspec(pspec: ParamSpec)

Emits a "notify" signal for the property specified by @pspec on @object.

ref

open fun ref(): Object

Increases the reference count of @object.

refSink

open fun refSink(): Object

Increase the reference count of @object, and possibly remove the floating-ref reference, if @object has a floating reference.

runDispose

open fun runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setProperty

open fun setProperty(propertyName: String, value: Value)

Sets a property on an object.

setProperty

fun Object.setProperty(propertyName: String, value: Boolean)

fun Object.setProperty(propertyName: String, value: Int)

fun Object.setProperty(propertyName: String, value: String?)

setTarget

open fun setTarget(target: Object? = null)

Sets the target instance used when connecting signals. Any signal that has been registered with g_signal_group_connect_object() or similar functions will be connected to this object.

thawNotify

open fun thawNotify()

Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted.

unblock

open fun unblock()

Unblocks all signal handlers managed by @self so they will be called again during any signal emissions unless it is blocked again. Must be unblocked exactly the same number of times it has been blocked to become active again.

unref

open fun unref()

Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure

open fun watchClosure(closure: Closure)

This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the