Package ch.bailu.gtk.gio
Class PropertyAction
java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gio.PropertyAction
- All Implemented Interfaces:
PointerInterface
A #GPropertyAction is a way to get a #GAction with a state value
reflecting and controlling the value of a #GObject property.
The state of the action will correspond to the value of the property.
Changing it will change the property (assuming the requested value
matches the requirements as specified in the #GParamSpec).
Only the most common types are presently supported. Booleans are
mapped to booleans, strings to strings, signed/unsigned integers to
int32/uint32 and floats and doubles to doubles.
If the property is an enum then the state will be string-typed and
conversion will automatically be performed between the enum value and
"nick" string as per the #GEnumValue table.
Flags types are not currently supported.
Properties of object types, boxed types and pointer types are not
supported and probably never will be.
Properties of #GVariant types are not currently supported.
If the property is boolean-valued then the action will have a NULL
parameter type, and activating the action (with no parameter) will
toggle the value of the property.
In all other cases, the parameter type will correspond to the type of
the property.
The general idea here is to reduce the number of locations where a
particular piece of state is kept (and therefore has to be synchronised
between). #GPropertyAction does not have a separate state that is kept
in sync with the property value -- its state is the property value.
For example, it might be useful to create a #GAction corresponding to
the "visible-child-name" property of a #GtkStack so that the current
page can be switched from a menu. The active radio indication in the
menu is then directly determined from the active page of the
#GtkStack.
An anti-example would be binding the "active-id" property on a
#GtkComboBox. This is because the state of the combobox itself is
probably uninteresting and is actually being used to control
something else.
Another anti-example would be to bind to the "visible-child-name"
property of a #GtkStack if this value is actually stored in
#GSettings. In that case, the real source of the value is
#GSettings. If you want a #GAction to control a setting stored in
#GSettings, see g_settings_create_action() instead, and possibly
combine its use with g_settings_bind().
reflecting and controlling the value of a #GObject property.
The state of the action will correspond to the value of the property.
Changing it will change the property (assuming the requested value
matches the requirements as specified in the #GParamSpec).
Only the most common types are presently supported. Booleans are
mapped to booleans, strings to strings, signed/unsigned integers to
int32/uint32 and floats and doubles to doubles.
If the property is an enum then the state will be string-typed and
conversion will automatically be performed between the enum value and
"nick" string as per the #GEnumValue table.
Flags types are not currently supported.
Properties of object types, boxed types and pointer types are not
supported and probably never will be.
Properties of #GVariant types are not currently supported.
If the property is boolean-valued then the action will have a NULL
parameter type, and activating the action (with no parameter) will
toggle the value of the property.
In all other cases, the parameter type will correspond to the type of
the property.
The general idea here is to reduce the number of locations where a
particular piece of state is kept (and therefore has to be synchronised
between). #GPropertyAction does not have a separate state that is kept
in sync with the property value -- its state is the property value.
For example, it might be useful to create a #GAction corresponding to
the "visible-child-name" property of a #GtkStack so that the current
page can be switched from a menu. The active radio indication in the
menu is then directly determined from the active page of the
#GtkStack.
An anti-example would be binding the "active-id" property on a
#GtkComboBox. This is because the state of the combobox itself is
probably uninteresting and is actually being used to control
something else.
Another anti-example would be to bind to the "visible-child-name"
property of a #GtkStack if this value is actually stored in
#GSettings. In that case, the real source of the value is
#GSettings. If you want a #GAction to control a setting stored in
#GSettings, see g_settings_create_action() instead, and possibly
combine its use with g_settings_bind().
-
Nested Class Summary
Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object
Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify -
Field Summary
Fields inherited from class ch.bailu.gtk.gobject.Object
SIGNAL_ON_NOTIFY -
Constructor Summary
ConstructorsConstructorDescriptionPropertyAction(PointerContainer pointer) PropertyAction(Str name, Pointer object, Str property_name) Creates a #GAction corresponding to the value of property
@property_name on @object.PropertyAction(String name, Pointer object, String property_name) Creates a #GAction corresponding to the value of property
@property_name on @object. -
Method Summary
Modifier and TypeMethodDescriptionasAction()Implements interfaceAction.static ClassHandlerstatic intstatic longstatic TypeSystem.TypeSizestatic longstatic TypeSystem.TypeSizeMethods inherited from class ch.bailu.gtk.gobject.Object
addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnrefMethods inherited from class ch.bailu.gtk.type.Pointer
asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacksMethods inherited from class ch.bailu.gtk.type.Type
asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNullMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface ch.bailu.gtk.type.PointerInterface
asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull
-
Constructor Details
-
PropertyAction
-
PropertyAction
Creates a #GAction corresponding to the value of property
@property_name on @object.
The property must be existent and readable and writable (and not
construct-only).
This function takes a reference on @object and doesn't release it
until the action is destroyed.- Parameters:
name- the name of the action to createobject- the object that has the property to wrapproperty_name- the name of the property
-
PropertyAction
Creates a #GAction corresponding to the value of property
@property_name on @object.
The property must be existent and readable and writable (and not
construct-only).
This function takes a reference on @object and doesn't release it
until the action is destroyed.- Parameters:
name- the name of the action to createobject- the object that has the property to wrapproperty_name- the name of the property
-
-
Method Details