Optionalproperties: Partial<Gtk.CellRendererAccel.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeSince 2.10accel_Since 2.10accel_Determines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus.
Since 2.10accel_Since 2.10accelSince 2.10accelDetermines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus.
Since 2.10accelSince 2.10keycodeSpecifies how to align the lines of text with respect to each other.
Note that this property describes how to align the lines of text in case there are several of them. The "xalign" property of Gtk.CellRenderer, on the other hand, sets the horizontal alignment of the whole text.
Background color as a Gdk.Color
since 3.4: Use Gtk.CellRendererText.background_rgba instead.
Background color as a Gdk.Color
since 3.4: Use Gtk.CellRendererText.background_rgba instead.
Cell background as a Gdk.Color
since 3.4: Use Gtk.CellRenderer.cell_background_rgba instead.
Cell background as a Gdk.Color
since 3.4: Use Gtk.CellRenderer.cell_background_rgba instead.
Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string. Setting it to Pango.EllipsizeMode.NONE turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width.
Foreground color as a Gdk.Color
since 3.4: Use Gtk.CellRendererText.foreground_rgba instead.
Foreground color as a Gdk.Color
since 3.4: Use Gtk.CellRendererText.foreground_rgba instead.
The desired maximum width of the cell, in characters. If this property is set to -1, the width will be calculated automatically.
For cell renderers that ellipsize or wrap text; this property controls the maximum reported width of the cell. The cell should not receive any greater allocation unless it is set to expand in its Gtk.CellLayout and all of the cell's siblings have received their natural width.
The desired maximum width of the cell, in characters. If this property is set to -1, the width will be calculated automatically.
For cell renderers that ellipsize or wrap text; this property controls the maximum reported width of the cell. The cell should not receive any greater allocation unless it is set to expand in its Gtk.CellLayout and all of the cell's siblings have received their natural width.
The text that will be displayed in the Gtk.CellRenderer if
Gtk.CellRendererText.editable is true and the cell is empty.
Since 3.6
The text that will be displayed in the Gtk.CellRenderer if
Gtk.CellRendererText.editable is true and the cell is empty.
Since 3.6
SignalconnectSignalconnect_SignalemitVirtualvfunc_Virtualvfunc_StaticnewPasses an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, Gtk.CellRendererToggle toggles when it gets a mouse click.
widget that received the event
widget-dependent string representation of the event location; e.g. for Gtk.TreeView, a string representation of Gtk.TreePath
background area as passed to gtk_cell_renderer_render()
cell area as passed to gtk_cell_renderer_render()
render flags
true if the event was consumed/handled
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
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.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][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().
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.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the aligned area used by cell inside cell_area. Used for finding
the appropriate edit and focus rectangle.
the Gtk.Widget this cell will be rendering to
render flags
cell area which would be passed to gtk_cell_renderer_render()
Fills in xalign and yalign with the appropriate values of cell.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Fills in width and height with the appropriate size of cell.
Fills in xpad and ypad with the appropriate values of cell.
Retreives a renderer’s natural size when rendered to widget.
the Gtk.Widget this cell will be rendering to
Retreives a cell renderers’s minimum and natural height if it were rendered to
widget with the specified width.
the Gtk.Widget this cell will be rendering to
the size which is available for allocation
Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.
the Gtk.Widget this cell will be rendering to
Retreives a renderer’s natural size when rendered to widget.
the Gtk.Widget this cell will be rendering to
Retreives a cell renderers’s minimum and natural width if it were rendered to
widget with the specified height.
the Gtk.Widget this cell will be rendering to
the size which is available for allocation
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.
The Gtk.SizeRequestMode preferred by this renderer.
Returns the cell renderer’s sensitivity.
true if the cell renderer is sensitive
Obtains the width and height needed to render the cell. Used by view
widgets to determine the appropriate size for the cell_area passed to
gtk_cell_renderer_render(). If cell_area is not null, fills in the
x and y offsets (if set) of the cell relative to this location.
Please note that the values set in width and height, as well as those
in x_offset and y_offset are inclusive of the xpad and ypad properties.
Translates the cell renderer state to Gtk.StateFlags, based on the cell renderer and widget sensitivity, and the given Gtk.CellRendererState.
a Gtk.Widget, or null
cell renderer state
the widget state flags applying to cell
Returns the cell renderer’s visibility.
true if the cell renderer is visible
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether the cell renderer can do something when activated.
true if the cell renderer can do anything when activated
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Invokes the virtual render function of the Gtk.CellRenderer. The three
passed-in rectangles are areas in cr. Most renderers will draw within
cell_area; the xalign, yalign, xpad, and ypad fields of the Gtk.CellRenderer
should be honored with respect to cell_area. background_area includes the
blank space around the cell, and also the area containing the tree expander;
so the background_area rectangles for all cells tile to cover the entire
window.
a cairo context to draw to
the widget owning window
entire cell area (including tree expanders and maybe padding on the sides)
area normally rendered by a cell renderer
flags that affect rendering
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the renderer’s alignment within its available space.
the x alignment of the cell renderer
the y alignment of the cell renderer
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets the height of a renderer to explicitly be determined by the “font” and
“y_pad” property set on it. Further changes in these properties do not
affect the height, so they must be accompanied by a subsequent call to this
function. Using this function is unflexible, and should really only be used
if calculating the size of a cell is too slow (ie, a massive number of cells
displayed). If number_of_rows is -1, then the fixed height is unset, and
the height is determined by the properties again.
Number of rows of text each cell renderer is allocated, or -1
Sets the renderer size to be explicit, independent of the properties set.
the width of the cell renderer, or -1
the height of the cell renderer, or -1
Sets the renderer’s padding.
the x padding of the cell renderer
the y padding of the cell renderer
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets the cell renderer’s sensitivity.
the sensitivity of the cell
Sets the cell renderer’s visibility.
the visibility of the cell
Starts editing the contents of this cell, through a new Gtk.CellEditable
widget created by the Gtk.CellRendererClass.start_editing virtual function.
widget that received the event
widget-dependent string representation of the event location; e.g. for Gtk.TreeView, a string representation of Gtk.TreePath
background area as passed to gtk_cell_renderer_render()
cell area as passed to gtk_cell_renderer_render()
render flags
A new Gtk.CellEditable for editing this cell, or null if editing is not possible
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Informs the cell renderer that the editing is stopped.
If canceled is true, the cell renderer will emit the
Gtk.CellRenderer.SignalSignatures.editing_canceled | Gtk.CellRenderer::editing-canceled signal.
This function should be called by cell renderer implementations in response to the Gtk.CellEditable.SignalSignatures.editing_done | Gtk.CellEditable::editing-done signal of Gtk.CellEditable.
true if the editing has been canceled
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
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.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, Gtk.CellRendererToggle toggles when it gets a mouse click.
widget that received the event
widget-dependent string representation of the event location; e.g. for Gtk.TreeView, a string representation of Gtk.TreePath
background area as passed to gtk_cell_renderer_render()
cell area as passed to gtk_cell_renderer_render()
render flags
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_Virtualvfunc_Signal gets emitted when the user cancels the process of editing a cell.
Virtualvfunc_Signal gets emitted when a cell starts to be edited.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Gets the aligned area used by cell inside cell_area. Used for finding
the appropriate edit and focus rectangle.
the Gtk.Widget this cell will be rendering to
render flags
cell area which would be passed to gtk_cell_renderer_render()
Virtualvfunc_Retreives a renderer’s natural size when rendered to widget.
the Gtk.Widget this cell will be rendering to
Virtualvfunc_Retreives a cell renderers’s minimum and natural height if it were rendered to
widget with the specified width.
the Gtk.Widget this cell will be rendering to
the size which is available for allocation
Virtualvfunc_Retreives a renderer’s natural size when rendered to widget.
the Gtk.Widget this cell will be rendering to
Virtualvfunc_Retreives a cell renderers’s minimum and natural width if it were rendered to
widget with the specified height.
the Gtk.Widget this cell will be rendering to
the size which is available for allocation
Virtualvfunc_Virtualvfunc_Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.
Virtualvfunc_Obtains the width and height needed to render the cell. Used by view
widgets to determine the appropriate size for the cell_area passed to
gtk_cell_renderer_render(). If cell_area is not null, fills in the
x and y offsets (if set) of the cell relative to this location.
Please note that the values set in width and height, as well as those
in x_offset and y_offset are inclusive of the xpad and ypad properties.
Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_Invokes the virtual render function of the Gtk.CellRenderer. The three
passed-in rectangles are areas in cr. Most renderers will draw within
cell_area; the xalign, yalign, xpad, and ypad fields of the Gtk.CellRenderer
should be honored with respect to cell_area. background_area includes the
blank space around the cell, and also the area containing the tree expander;
so the background_area rectangles for all cells tile to cover the entire
window.
a cairo context to draw to
the widget owning window
entire cell area (including tree expanders and maybe padding on the sides)
area normally rendered by a cell renderer
flags that affect rendering
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_Starts editing the contents of this cell, through a new Gtk.CellEditable
widget created by the Gtk.CellRendererClass.start_editing virtual function.
widget that received the event
widget-dependent string representation of the event location; e.g. for Gtk.TreeView, a string representation of Gtk.TreePath
background area as passed to gtk_cell_renderer_render()
cell area as passed to gtk_cell_renderer_render()
render flags
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
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Staticset_The object type that implements the accessible for widget_class. The type must be a subtype of Gtk.RendererCellAccessible
Gtk.CellRendererAccel displays a keyboard accelerator (i.e. a key combination like
Control + a). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination.The Gtk.CellRendererAccel cell renderer was added in GTK+ 2.10.