DeprecatedconstructorOptionalDeprecatedproperties: Partial<Gtk.CellAreaBox.ConstructorProps>Deprecated...args: any[]InternalDeprecated$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.
StaticDeprecated$gtypeDeprecatedspacingThe amount of space to reserve between cells.
Deprecatedval: numberDeprecatedorientationThe orientation of the orientable.
Deprecatededit_The widget currently editing the edited cell
This property is read-only and only changes as
a result of a call gtk_cell_area_activate_cell().
Deprecatededited_The cell in the area that is currently edited
This property is read-only and only changes as
a result of a call gtk_cell_area_activate_cell().
DeprecatededitedThe cell in the area that is currently edited
This property is read-only and only changes as
a result of a call gtk_cell_area_activate_cell().
DeprecatededitThe widget currently editing the edited cell
This property is read-only and only changes as
a result of a call gtk_cell_area_activate_cell().
Deprecatedfocus_The cell in the area that currently has focus
Deprecatedval: Gtk.CellRendererDeprecatedfocusThe cell in the area that currently has focus
Deprecatedval: Gtk.CellRendererDeprecated_Deprecated...args: any[]Deprecatedadd_Adds an attribute mapping to the list in cell_layout.
The column is the column of the model to get a value from, and the
attribute is the property on cell to be set from that value. So for
example if column 2 of the model contains strings, you could have the
“text” attribute of a Gtk.CellRendererText get its values from column 2.
In this context "attribute" and "property" are used interchangeably.
Deprecatedcell: Gtk.CellRendererDeprecatedattribute: stringa property on the renderer
Deprecatedcolumn: numberthe column position on the model to get the attribute from
Deprecatedbind_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.
Deprecatedsource_property: stringthe property on source to bind
Deprecatedtarget: GObject.Objectthe target GObject.Object
Deprecatedtarget_property: stringthe property on target to bind
Deprecatedflags: GObject.BindingFlagsflags 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.
Deprecatedbind_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.
Deprecatedsource_property: stringthe property on source to bind
Deprecatedtarget: GObject.Objectthe target GObject.Object
Deprecatedtarget_property: stringthe property on target to bind
Deprecatedflags: GObject.BindingFlagsflags to pass to GObject.Binding
OptionalDeprecatedtransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
OptionalDeprecatedtransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
OptionalDeprecatednotify: 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.
Deprecated...args: never[]the property on source to bind
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.
Deprecatedblock_Blocks a handler of an instance so it will not be called during any signal emissions
Deprecatedid: numberHandler ID of the handler to be blocked
DeprecatedclearUnsets all the mappings on all renderers on cell_layout and
removes all renderers from cell_layout.
Deprecatedclear_Clears all existing attributes previously set with
gtk_cell_layout_set_attributes().
Deprecatedcell: Gtk.CellRenderera Gtk.CellRenderer to clear the attribute mapping on
SignalDeprecatedconnectDeprecatedsignal: KDeprecatedcallback: SignalCallback<Gtk.CellAreaBox, Gtk.CellAreaBox.SignalSignatures[K]>Deprecatedsignal: stringDeprecatedcallback: (...args: any[]) => anySignalDeprecatedconnect_Deprecatedsignal: KDeprecatedcallback: SignalCallback<Gtk.CellAreaBox, Gtk.CellAreaBox.SignalSignatures[K]>Deprecatedsignal: stringDeprecatedcallback: (...args: any[]) => anyDeprecateddisconnectDisconnects 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.
Deprecatedid: numberHandler ID of the handler to be disconnected
SignalDeprecatedemitDeprecatedsignal: KDeprecated...args: GjsParameters<Gtk.CellAreaBox.SignalSignatures[K]> extends [any, ...Q[]]Deprecatedsignal: stringDeprecated...args: any[]Deprecatedforce_This function is intended for GObject.Object implementations to re-enforce
a floating 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().
Deprecatedfreeze_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.
Deprecatedget_Returns the underlying Gtk.CellArea which might be cell_layout
if called on a Gtk.CellArea or might be null if no Gtk.CellArea
is used by cell_layout.
the cell area used by cell_layout
Deprecatedget_Gets the ID of the buildable object.
Gtk.Builder sets the name based on the ID attribute
of the <object> tag used to construct the buildable.
the ID of the buildable object
Deprecatedget_Returns the cell renderers which have been added to cell_layout.
a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with g_list_free() when no longer needed.
Deprecatedget_Gets a named field from the objects table of associations (see g_object_set_data()).
Deprecatedkey: stringname of the key for that association
the data if found, or null if no such data exists.
Deprecatedget_Retrieves the orientation of the orientable.
the orientation of the orientable
Deprecatedget_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.
Deprecatedproperty_name: stringThe name of the property to get
Deprecatedvalue: anyReturn 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
Deprecatedget_This function gets back user data pointers stored via
g_object_set_qdata().
Deprecatedquark: numberA GLib.Quark, naming the user data pointer
The user data pointer set, or null
Deprecatedget_Gets the spacing added between cell renderers.
the space added between cell renderers in box.
DeprecatedgetvGets 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.
Deprecatednames: string[]the names of each property to get
Deprecatedvalues: any[]the values of each property to get
Deprecatedis_Checks whether object has a floating reference.
true if object has a floating reference
DeprecatednotifyEmits 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.
Deprecatedproperty_name: stringthe name of a property installed on the class of object.
Deprecatednotify_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]);
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec of a property installed on the class of object.
Deprecatedpack_Adds renderer to box, packed with reference to the end of box.
The renderer is packed after (away from end of) any other
Gtk.CellRenderer packed with reference to the end of box.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to add
Deprecatedexpand: booleanwhether renderer should receive extra space when the area receives more than its natural size
Deprecatedalign: booleanwhether renderer should be aligned in adjacent rows
Deprecatedfixed: booleanwhether renderer should have the same size in all rows
Deprecated...args: never[]Deprecatedpack_Adds renderer to box, packed with reference to the start of box.
The renderer is packed after any other Gtk.CellRenderer packed
with reference to the start of box.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to add
Deprecatedexpand: booleanwhether renderer should receive extra space when the area receives more than its natural size
Deprecatedalign: booleanwhether renderer should be aligned in adjacent rows
Deprecatedfixed: booleanwhether renderer should have the same size in all rows
Deprecated...args: never[]DeprecatedrefIncreases 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
Deprecatedref_Increase the reference count of object, and possibly remove the
floating 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
DeprecatedreorderRe-inserts cell at position.
Note that cell has already to be packed into cell_layout
for this to function properly.
Deprecatedcell: Gtk.CellRenderera Gtk.CellRenderer to reorder
Deprecatedposition: numbernew position to insert cell at
Deprecatedrun_Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
DeprecatedsetSets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Deprecatedproperties: { [key: string]: any }Object containing the properties to set
Deprecatedset_Sets the Gtk.CellLayoutDataFunc to use for cell_layout.
This function is used instead of the standard attributes mapping
for setting the column value, and should set the value of cell_layout’s
cell renderer(s) as appropriate.
func may be null to remove a previously set function.
Deprecatedcell: Gtk.CellRendererOptionalDeprecatedfunc: Gtk.CellLayoutDataFuncthe Gtk.CellLayoutDataFunc to use
Deprecatedset_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.
Deprecatedkey: stringname of the key
OptionalDeprecateddata: anydata to associate with that key
Deprecatedset_Sets the orientation of the orientable.
Deprecatedorientation: Gtk.Orientationthe orientable’s new orientation
Deprecatedset_Sets a property on an object.
Deprecatedproperty_name: stringThe name of the property to set
Deprecatedvalue: anyThe value to set the property to
Deprecatedset_Sets the spacing to add between cell renderers in box.
Deprecatedspacing: numberthe space to add between Gtk.CellRenderers
Deprecatedsteal_Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
Deprecatedkey: stringname of the key
the data if found, or null if no such data exists.
Deprecatedsteal_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().
Deprecatedquark: numberA GLib.Quark, naming the user data pointer
The user data pointer set, or null
Deprecatedstop_Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
DeprecateddetailedName: stringName of the signal to stop emission of
Deprecatedthaw_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.
Deprecatedunblock_Unblocks a handler so it will be called again during any signal emissions
Deprecatedid: numberHandler ID of the handler to be unblocked
DeprecatedunrefDecreases 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.
VirtualDeprecatedvfunc_Adds an attribute mapping to the list in cell_layout.
The column is the column of the model to get a value from, and the
attribute is the property on cell to be set from that value. So for
example if column 2 of the model contains strings, you could have the
“text” attribute of a Gtk.CellRendererText get its values from column 2.
In this context "attribute" and "property" are used interchangeably.
Deprecatedcell: Gtk.CellRendererDeprecatedattribute: stringa property on the renderer
Deprecatedcolumn: numberthe column position on the model to get the attribute from
VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_Unsets all the mappings on all renderers on cell_layout and
removes all renderers from cell_layout.
VirtualDeprecatedvfunc_Clears all existing attributes previously set with
gtk_cell_layout_set_attributes().
Deprecatedcell: Gtk.CellRenderera Gtk.CellRenderer to clear the attribute mapping on
VirtualDeprecatedvfunc_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.
VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_Called at the end of each custom element handled by the buildable.
Deprecatedbuilder: Gtk.BuilderGtk.Builder used to construct this object
Deprecatedchild: GObject.Objectchild object or null for non-child tags
Deprecatedtagname: stringname of tag
OptionalDeprecateddata: anyuser data that will be passed in to parser functions
VirtualDeprecatedvfunc_Called for each unknown element under <child>.
Deprecatedbuilder: Gtk.Buildera Gtk.Builder used to construct this object
Deprecatedchild: GObject.Objectchild object or null for non-child tags
Deprecatedtagname: stringname of tag
VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_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.
VirtualDeprecatedvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
VirtualDeprecatedvfunc_Returns the underlying Gtk.CellArea which might be cell_layout
if called on a Gtk.CellArea or might be null if no Gtk.CellArea
is used by cell_layout.
VirtualDeprecatedvfunc_Returns the cell renderers which have been added to cell_layout.
VirtualDeprecatedvfunc_The getter corresponding to set_id. Implement this
if you implement set_id.
VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_VirtualDeprecatedvfunc_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.
VirtualDeprecatedvfunc_Adds the cell to the end of cell_layout. If expand is false, then the
cell is allocated no more space than it needs. Any unused space is
divided evenly between cells for which expand is true.
Note that reusing the same cell renderer is not supported.
Deprecatedcell: Gtk.CellRendererDeprecatedexpand: booleantrue if cell is to be given extra space allocated to cell_layout
VirtualDeprecatedvfunc_Packs the cell into the beginning of cell_layout. If expand is false,
then the cell is allocated no more space than it needs. Any unused space
is divided evenly between cells for which expand is true.
Note that reusing the same cell renderer is not supported.
Deprecatedcell: Gtk.CellRendererDeprecatedexpand: booleantrue if cell is to be given extra space allocated to cell_layout
VirtualDeprecatedvfunc_Called when a builder finishes the parsing of a UI definition. It is normally not necessary to implement this, unless you need to perform special cleanup actions. Gtk.Window sets the Gtk.Widget.visible property here.
VirtualDeprecatedvfunc_Re-inserts cell at position.
Note that cell has already to be packed into cell_layout
for this to function properly.
Deprecatedcell: Gtk.CellRenderera Gtk.CellRenderer to reorder
Deprecatedposition: numbernew position to insert cell at
VirtualDeprecatedvfunc_Sets a property of a buildable object.
It is normally not necessary to implement this, g_object_set_property()
is used by default. Gtk.Window implements this to delay showing itself
(i.e. setting the Gtk.Widget.visible property) until the whole
interface is created.
VirtualDeprecatedvfunc_Sets the Gtk.CellLayoutDataFunc to use for cell_layout.
This function is used instead of the standard attributes mapping
for setting the column value, and should set the value of cell_layout’s
cell renderer(s) as appropriate.
func may be null to remove a previously set function.
Deprecatedcell: Gtk.CellRendererOptionalDeprecatedfunc: Gtk.CellLayoutDataFuncthe Gtk.CellLayoutDataFunc to use
VirtualDeprecatedvfunc_Stores the id attribute given in the Gtk.Builder UI definition. Gtk.Widget stores the name as object data. Implement this method if your object has some notion of “ID” and it makes sense to map the XML id attribute to it.
Deprecatedid: stringVirtualDeprecatedvfunc_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.
Deprecatedwatch_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.
Deprecatedclosure: ClosureGObject.Closure to watch
StaticDeprecatednewDeprecatedactivateActivates area, usually by activating the currently focused
cell, however some subclasses which embed widgets in the area
can also activate a widget if it currently has the focus.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext in context with the current row data
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering on
Deprecatedcell_area: Gdk.Rectanglethe size and location of area relative to widget’s allocation
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState flags for area for this row of data.
Deprecatededit_only: booleanif true then only cell renderers that are Gtk.CellRendererMode.EDITABLE will be activated.
Whether area was successfully activated.
Deprecatedactivate_This is used by Gtk.CellArea subclasses when handling events to activate cells, the base Gtk.CellArea class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering onto
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer in area to activate
Deprecatedevent: Gdk.Eventthe Gdk.Event for which cell activation should occur
Deprecatedcell_area: Gdk.Rectanglethe Gdk.Rectangle in widget relative coordinates of renderer for the current row.
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState for renderer
whether cell activation was successful
DeprecatedaddAdds renderer to area with the default child cell properties.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to add to area
Deprecatedadd_Adds sibling to renderer’s focusable area, focus will be drawn
around renderer and all of its siblings if renderer can
focus for a given row.
Events handled by focus siblings can also activate the given
focusable renderer.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer expected to have focus
Deprecatedsibling: Gtk.CellRendererthe Gtk.CellRenderer to add to renderer’s focus area
Deprecatedapply_Applies any connected attributes to the renderers in
area by pulling the values from tree_model.
Deprecatedtree_model: Gtk.TreeModelthe Gtk.TreeModel to pull values from
Deprecatediter: Gtk.TreeIterthe Gtk.TreeIter in tree_model to apply values for
Deprecatedis_expander: booleanwhether iter has children
Deprecatedis_expanded: booleanwhether iter is expanded in the view and children are visible
Deprecatedattribute_Connects an attribute to apply values from column for the
Gtk.TreeModel in use.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to connect an attribute for
Deprecatedattribute: stringthe attribute name
Deprecatedcolumn: numberthe Gtk.TreeModel column to fetch attribute values from
Deprecatedattribute_Disconnects attribute for the renderer in area so that
attribute will no longer be updated with values from the
model.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to disconnect an attribute for
Deprecatedattribute: stringthe attribute name
Deprecatedattribute_Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped.
Deprecatedrenderer: Gtk.CellRendererDeprecatedattribute: stringan attribute on the renderer
the model column, or -1
Deprecatedcell_Gets the value of a cell property for renderer in area.
Deprecatedrenderer: Gtk.CellRenderera Gtk.CellRenderer inside area
Deprecatedproperty_name: stringthe name of the property to get
Deprecatedvalue: anya location to return the value
Deprecatedcell_Sets a cell property for renderer in area.
Deprecatedrenderer: Gtk.CellRenderera Gtk.CellRenderer inside area
Deprecatedproperty_name: stringthe name of the cell property to set
Deprecatedvalue: anythe value to set the cell property to
Deprecatedcopy_This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.
For instance, Gtk.IconView creates all icons (rows) to have the same width and the cells theirin to have the same horizontal alignments. However each row of icons may have a separate collective height. Gtk.IconView uses this to request the heights of each row based on a context which was already used to request all the row widths that are to be displayed.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext to copy
a newly created Gtk.CellAreaContext copy of context.
Deprecatedcreate_Creates a Gtk.CellAreaContext to be used with area for
all purposes. Gtk.CellAreaContext stores geometry information
for rows for which it was operated on, it is important to use
the same context for the same row of data at all times (i.e.
one should render and handle events with the same Gtk.CellAreaContext
which was used to request the size of those rows of data).
a newly created Gtk.CellAreaContext which can be used with area.
DeprecatedeventDelegates event handling to a Gtk.CellArea.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext for this row of data.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering to
Deprecatedevent: Gdk.Eventthe Gdk.Event to handle
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates for area
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState for area in this row.
true if the event was handled by area.
DeprecatedfocusThis should be called by the area’s owning layout widget
when focus is to be passed to area, or moved within area
for a given direction and row data.
Implementing Gtk.CellArea classes should implement this method to receive and navigate focus in its own way particular to how it lays out cells.
Deprecateddirection: Gtk.DirectionTypetrue if focus remains inside area as a result of this call.
DeprecatedforeachCalls callback for every Gtk.CellRenderer in area.
Deprecatedcallback: Gtk.CellCallbackthe Gtk.CellCallback to call
Deprecatedforeach_Calls callback for every Gtk.CellRenderer in area with the
allocated rectangle inside cell_area.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext for this row of data.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering to
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates and size for area
Deprecatedbackground_area: Gdk.Rectanglethe widget relative coordinates of the background area
Deprecatedcallback: Gtk.CellAllocCallbackthe Gtk.CellAllocCallback to call
Deprecatedget_Derives the allocation of renderer inside area if area
were to be rendered in cell_area.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext used to hold sizes for area.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering on
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to get the allocation for
Deprecatedcell_area: Gdk.Rectanglethe whole allocated area for area in widget for this row
Deprecatedget_Gets the Gtk.CellRenderer at x and y coordinates inside area and optionally
returns the full cell allocation for it inside cell_area.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext used to hold sizes for area.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering on
Deprecatedcell_area: Gdk.Rectanglethe whole allocated area for area in widget for this row
Deprecatedx: numberthe x position
Deprecatedy: numberthe y position
the Gtk.CellRenderer at x and y.
Deprecatedget_Gets the current Gtk.TreePath string for the currently
applied Gtk.TreeIter, this is implicitly updated when
gtk_cell_area_apply_attributes() is called and can be
used to interact with renderers from Gtk.CellArea
subclasses.
The current Gtk.TreePath string for the current attributes applied to area. This string belongs to the area and should not be freed.
Deprecatedget_Gets the Gtk.CellEditable widget currently used to edit the currently edited cell.
The currently active Gtk.CellEditable widget
Deprecatedget_Gets the Gtk.CellRenderer in area that is currently
being edited.
The currently edited Gtk.CellRenderer
Deprecatedget_Retrieves the currently focused cell for area
the currently focused cell in area.
Deprecatedget_Gets the Gtk.CellRenderer which is expected to be focusable
for which renderer is, or may be a sibling.
This is handy for Gtk.CellArea subclasses when handling events, after determining the renderer at the event location it can then chose to activate the focus cell for which the event cell may have been a sibling.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer
the Gtk.CellRenderer for which renderer is a sibling
Deprecatedget_Gets the focus sibling cell renderers for renderer.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer expected to have focus
A GLib.List of Gtk.CellRenderers. The returned list is internal and should not be freed.
Deprecatedget_Retrieves a cell area’s initial minimum and natural height.
area will store some geometrical information in context along the way;
when requesting sizes over an arbitrary number of rows, it’s not important
to check the minimum_height and natural_height of this call but rather to
consult gtk_cell_area_context_get_preferred_height() after a series of
requests.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext to perform this request with
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
Deprecatedget_Retrieves a cell area’s minimum and natural height if it would be given
the specified width.
area stores some geometrical information in context along the way
while calling gtk_cell_area_get_preferred_width(). It’s important to
perform a series of gtk_cell_area_get_preferred_width() requests with
context first and then call gtk_cell_area_get_preferred_height_for_width()
on each cell area individually to get the height for width of each
fully requested row.
If at some point, the width of a single row changes, it should be
requested with gtk_cell_area_get_preferred_width() again and then
the full width of the requested rows checked again with
gtk_cell_area_context_get_preferred_width().
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext which has already been requested for widths.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
Deprecatedwidth: numberthe width for which to check the height of this area
Deprecatedget_Retrieves a cell area’s initial minimum and natural width.
area will store some geometrical information in context along the way;
when requesting sizes over an arbitrary number of rows, it’s not important
to check the minimum_width and natural_width of this call but rather to
consult gtk_cell_area_context_get_preferred_width() after a series of
requests.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext to perform this request with
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
Deprecatedget_Retrieves a cell area’s minimum and natural width if it would be given
the specified height.
area stores some geometrical information in context along the way
while calling gtk_cell_area_get_preferred_height(). It’s important to
perform a series of gtk_cell_area_get_preferred_height() requests with
context first and then call gtk_cell_area_get_preferred_width_for_height()
on each cell area individually to get the height for width of each
fully requested row.
If at some point, the height of a single row changes, it should be
requested with gtk_cell_area_get_preferred_height() again and then
the full height of the requested rows checked again with
gtk_cell_area_context_get_preferred_height().
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext which has already been requested for widths.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
Deprecatedheight: numberthe height for which to check the width of this area
Deprecatedget_Gets whether the area prefers a height-for-width layout or a width-for-height layout.
The Gtk.SizeRequestMode preferred by area.
Deprecatedhas_Checks if area contains renderer.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to check
true if renderer is in the area.
Deprecatedinner_This is a convenience function for Gtk.CellArea implementations
to get the inner area where a given Gtk.CellRenderer will be
rendered. It removes any padding previously added by gtk_cell_area_request_renderer().
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering onto
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates where one of area’s cells is to be placed
Deprecatedis_Returns whether the area can do anything when activated,
after applying new attributes to area.
whether area can do anything when activated.
Deprecatedis_Returns whether sibling is one of renderer’s focus siblings
(see gtk_cell_area_add_focus_sibling()).
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer expected to have focus
Deprecatedsibling: Gtk.CellRendererthe Gtk.CellRenderer to check against renderer’s sibling list
true if sibling is a focus sibling of renderer
DeprecatedremoveRemoves renderer from area.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to remove from area
Deprecatedremove_Removes sibling from renderer’s focus sibling list
(see gtk_cell_area_add_focus_sibling()).
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer expected to have focus
Deprecatedsibling: Gtk.CellRendererthe Gtk.CellRenderer to remove from renderer’s focus area
Deprecatedrequest_This is a convenience function for Gtk.CellArea implementations
to request size for cell renderers. It’s important to use this
function to request size and then use gtk_cell_area_inner_cell_area()
at render and event time since this function will add padding
around the cell for focus painting.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to request size for
Deprecatedorientation: Gtk.Orientationthe Gtk.Orientation in which to request size
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering onto
Deprecatedfor_size: numberthe allocation contextual size to request for, or -1 if the base request for the orientation is to be returned.
Deprecatedset_Explicitly sets the currently focused cell to renderer.
This is generally called by implementations of
Gtk.CellArea.focus or Gtk.CellArea.event,
however it can also be used to implement functions such
as gtk_tree_view_set_cursor_on_cell().
OptionalDeprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to give focus to
DeprecatedsnapshotSnapshots area’s cells according to area’s layout onto at
the given coordinates.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext for this row of data.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering to
Deprecatedsnapshot: Gtk.Snapshotthe Gtk.Snapshot to draw to
Deprecatedbackground_area: Gdk.Rectanglethe widget relative coordinates for area’s background
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates for area
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState for area in this row.
Deprecatedpaint_focus: booleanwhether area should paint focus on focused cells for focused rows or not.
Deprecatedstop_Explicitly stops the editing of the currently edited cell.
If canceled is true, the currently edited cell renderer
will emit the ::editing-canceled signal, otherwise the
the ::editing-done signal will be emitted on the current
edit widget.
See gtk_cell_area_get_edited_cell() and gtk_cell_area_get_edit_widget().
Deprecatedcanceled: booleanwhether editing was canceled.
VirtualDeprecatedvfunc_Activates area, usually by activating the currently focused
cell, however some subclasses which embed widgets in the area
can also activate a widget if it currently has the focus.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext in context with the current row data
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering on
Deprecatedcell_area: Gdk.Rectanglethe size and location of area relative to widget’s allocation
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState flags for area for this row of data.
Deprecatededit_only: booleanif true then only cell renderers that are Gtk.CellRendererMode.EDITABLE will be activated.
VirtualDeprecatedvfunc_Adds renderer to area with the default child cell properties.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to add to area
VirtualDeprecatedvfunc_Applies any connected attributes to the renderers in
area by pulling the values from tree_model.
Deprecatedtree_model: Gtk.TreeModelthe Gtk.TreeModel to pull values from
Deprecatediter: Gtk.TreeIterthe Gtk.TreeIter in tree_model to apply values for
Deprecatedis_expander: booleanwhether iter has children
Deprecatedis_expanded: booleanwhether iter is expanded in the view and children are visible
VirtualDeprecatedvfunc_This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.
For instance, Gtk.IconView creates all icons (rows) to have the same width and the cells theirin to have the same horizontal alignments. However each row of icons may have a separate collective height. Gtk.IconView uses this to request the heights of each row based on a context which was already used to request all the row widths that are to be displayed.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext to copy
VirtualDeprecatedvfunc_Creates a Gtk.CellAreaContext to be used with area for
all purposes. Gtk.CellAreaContext stores geometry information
for rows for which it was operated on, it is important to use
the same context for the same row of data at all times (i.e.
one should render and handle events with the same Gtk.CellAreaContext
which was used to request the size of those rows of data).
VirtualDeprecatedvfunc_Delegates event handling to a Gtk.CellArea.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext for this row of data.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering to
Deprecatedevent: Gdk.Eventthe Gdk.Event to handle
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates for area
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState for area in this row.
VirtualDeprecatedvfunc_This should be called by the area’s owning layout widget
when focus is to be passed to area, or moved within area
for a given direction and row data.
Implementing Gtk.CellArea classes should implement this method to receive and navigate focus in its own way particular to how it lays out cells.
Deprecateddirection: Gtk.DirectionTypeVirtualDeprecatedvfunc_Calls callback for every Gtk.CellRenderer in area.
Deprecatedcallback: Gtk.CellCallbackthe Gtk.CellCallback to call
VirtualDeprecatedvfunc_Calls callback for every Gtk.CellRenderer in area with the
allocated rectangle inside cell_area.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext for this row of data.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering to
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates and size for area
Deprecatedbackground_area: Gdk.Rectanglethe widget relative coordinates of the background area
Deprecatedcallback: Gtk.CellAllocCallbackthe Gtk.CellAllocCallback to call
VirtualDeprecatedvfunc_This should be implemented to report the values of child cell properties for a given child Gtk.CellRenderer.
Deprecatedrenderer: Gtk.CellRendererDeprecatedproperty_id: numberDeprecatedvalue: anyDeprecatedpspec: GObject.ParamSpecVirtualDeprecatedvfunc_Retrieves a cell area’s initial minimum and natural height.
area will store some geometrical information in context along the way;
when requesting sizes over an arbitrary number of rows, it’s not important
to check the minimum_height and natural_height of this call but rather to
consult gtk_cell_area_context_get_preferred_height() after a series of
requests.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext to perform this request with
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
VirtualDeprecatedvfunc_Retrieves a cell area’s minimum and natural height if it would be given
the specified width.
area stores some geometrical information in context along the way
while calling gtk_cell_area_get_preferred_width(). It’s important to
perform a series of gtk_cell_area_get_preferred_width() requests with
context first and then call gtk_cell_area_get_preferred_height_for_width()
on each cell area individually to get the height for width of each
fully requested row.
If at some point, the width of a single row changes, it should be
requested with gtk_cell_area_get_preferred_width() again and then
the full width of the requested rows checked again with
gtk_cell_area_context_get_preferred_width().
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext which has already been requested for widths.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
Deprecatedwidth: numberthe width for which to check the height of this area
VirtualDeprecatedvfunc_Retrieves a cell area’s initial minimum and natural width.
area will store some geometrical information in context along the way;
when requesting sizes over an arbitrary number of rows, it’s not important
to check the minimum_width and natural_width of this call but rather to
consult gtk_cell_area_context_get_preferred_width() after a series of
requests.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext to perform this request with
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
VirtualDeprecatedvfunc_Retrieves a cell area’s minimum and natural width if it would be given
the specified height.
area stores some geometrical information in context along the way
while calling gtk_cell_area_get_preferred_height(). It’s important to
perform a series of gtk_cell_area_get_preferred_height() requests with
context first and then call gtk_cell_area_get_preferred_width_for_height()
on each cell area individually to get the height for width of each
fully requested row.
If at some point, the height of a single row changes, it should be
requested with gtk_cell_area_get_preferred_height() again and then
the full height of the requested rows checked again with
gtk_cell_area_context_get_preferred_height().
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext which has already been requested for widths.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget where area will be rendering
Deprecatedheight: numberthe height for which to check the width of this area
VirtualDeprecatedvfunc_Gets whether the area prefers a height-for-width layout or a width-for-height layout.
VirtualDeprecatedvfunc_Returns whether the area can do anything when activated,
after applying new attributes to area.
VirtualDeprecatedvfunc_Removes renderer from area.
Deprecatedrenderer: Gtk.CellRendererthe Gtk.CellRenderer to remove from area
VirtualDeprecatedvfunc_This should be implemented to handle changes in child
cell properties for a given Gtk.CellRenderer that were previously
installed on the Gtk.CellAreaClass with gtk_cell_area_class_install_cell_property().
Deprecatedrenderer: Gtk.CellRendererDeprecatedproperty_id: numberDeprecatedvalue: anyDeprecatedpspec: GObject.ParamSpecVirtualDeprecatedvfunc_Snapshots area’s cells according to area’s layout onto at
the given coordinates.
Deprecatedcontext: Gtk.CellAreaContextthe Gtk.CellAreaContext for this row of data.
Deprecatedwidget: Gtk.Widgetthe Gtk.Widget that area is rendering to
Deprecatedsnapshot: Gtk.Snapshotthe Gtk.Snapshot to draw to
Deprecatedbackground_area: Gdk.Rectanglethe widget relative coordinates for area’s background
Deprecatedcell_area: Gdk.Rectanglethe widget relative coordinates for area
Deprecatedflags: Gtk.CellRendererStatethe Gtk.CellRendererState for area in this row.
Deprecatedpaint_focus: booleanwhether area should paint focus on focused cells for focused rows or not.
StaticDeprecated_Deprecatedklass: anyStaticDeprecatedcompat_Deprecatedwhat: numberOptionalDeprecateddata: anyStaticDeprecatedfind_StaticDeprecatedfind_StaticDeprecatedinstall_Deprecatedproperty_id: numberthe id for the property
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec for the property
StaticDeprecatedinstall_StaticDeprecatedinstall_Deprecatedproperty_id: numberthe id for the new property
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec for the new property
StaticDeprecatedinterface_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().
Deprecatedg_iface: TypeInterfaceany interface vtable for the interface, or the default vtable for the interface
Deprecatedproperty_name: stringname of a property to look up.
StaticDeprecatedinterface_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.
Deprecatedg_iface: TypeInterfaceany interface vtable for the interface, or the default vtable for the interface.
Deprecatedpspec: GObject.ParamSpecthe GObject.ParamSpec for the new property
StaticDeprecatedinterface_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().
Deprecatedg_iface: TypeInterfaceany interface vtable for the interface, or the default vtable for the interface
StaticDeprecatedlist_StaticDeprecatedlist_StaticDeprecatednewvStaticDeprecatedoverride_Deprecatedproperty_id: numberthe new property ID
Deprecatedname: stringthe name of a property registered in a parent class or in an interface of this class.
A cell area that renders GtkCellRenderers into a row or a column
The Gtk.CellAreaBox renders cell renderers into a row or a column depending on its Gtk.Orientation.
GtkCellAreaBox uses a notion of packing. Packing refers to adding cell renderers with reference to a particular position in a Gtk.CellAreaBox. There are two reference positions: the start and the end of the box. When the Gtk.CellAreaBox is oriented in the Gtk.Orientation.VERTICAL orientation, the start is defined as the top of the box and the end is defined as the bottom. In the Gtk.Orientation.HORIZONTAL orientation start is defined as the left side and the end is defined as the right side.
Alignments of Gtk.CellRenderers rendered in adjacent rows can be configured by configuring the Gtk.CellAreaBox align child cell property with
gtk_cell_area_cell_set_property()or by specifying the "align" argument togtk_cell_area_box_pack_start()andgtk_cell_area_box_pack_end().Deprecated
since 4.10: List views use widgets for displaying their contents