Gjsify LogoGjsify Logo

#GooCanvasGroup represents a group of items. Groups can be nested to any depth, to create a hierarchy of items. Items are ordered within each group, with later items being displayed above earlier items.

#GooCanvasGroup is a subclass of #GooCanvasItemSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width". Setting a style property on a #GooCanvasGroup will affect all children of the #GooCanvasGroup (unless the children override the property setting).

#GooCanvasGroup implements the #GooCanvasItem interface, so you can use the #GooCanvasItem functions such as goo_canvas_item_raise() and goo_canvas_item_rotate(), and the properties such as "visibility" and "pointer-events".

If the #GooCanvasGroup:width and #GooCanvasGroup:height properties are set to positive values then the group is clipped to the given size.

To create a #GooCanvasGroup use goo_canvas_group_new().

To get or set the properties of an existing #GooCanvasGroup, use g_object_get() and g_object_set().

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

the bounds of the item, in device space.

field
can_focus: boolean

the canvas.

field
clip_fill_rule: GooCanvas.CairoFillRule
clip_path: string

The sequence of commands describing the clip path of the item, specified as a string using the same syntax as in the Scalable Vector Graphics (SVG) path element.

description: string
fill_color: string
fill_color_gdk_rgba: Gdk.RGBA

The color to use to paint the interior of the item, specified as a GdkRGBA. To disable painting set the 'fill-pattern' property to NULL.

fill_color_rgba: number
fill_pattern: any
fill_pixbuf: Pixbuf
font: string
font_desc: FontDescription
g_type_instance: TypeInstance
height: number
items: object[]
line_join_miter_limit: number
line_width: number

the item's model, if it has one.

field
need_entire_subtree_update: number

if all descendants need to be updated.

field
need_update: number

if the item needs to recompute its bounds and redraw.

field

the parent item.

field

data that is common to both the model and view classes. If the canvas item has a model, this will point to the model's #GooCanvasItemSimpleData, otherwise the canvas item will have its own #GooCanvasItemSimpleData.

field
stroke_color: string
stroke_color_gdk_rgba: Gdk.RGBA

The color to use for the item's perimeter, specified as a GdkRGBA. To disable painting set the 'stroke-pattern' property to NULL.

stroke_color_rgba: number
stroke_pattern: any
stroke_pixbuf: Pixbuf
title: string
tooltip: string

The tooltip to display for the item, or %NULL to display no tooltip.

Note that this property has no effect unless the #GtkWidget:has-tooltip property is set to %TRUE on the #GooCanvas containing this item.

transform: any
visibility_threshold: number
width: number
x: number
y: number
name: string

Methods

  • This function is only intended to be used when implementing new canvas items, specifically layout items such as #GooCanvasTable.

    It allocates an area to a child #GooCanvasItem.

    Note that the parent layout item will use a transform to move each of its children for the layout, so there is no need for the child item to reposition itself. It only needs to recalculate its device bounds.

    To help recalculate the item's device bounds, the x_offset and y_offset of the child item's allocated position from its requested position are provided. Simple items can just add these to their bounds.

    Parameters

    • cr: cairo.Context

      a cairo context.

    • requested_area: GooCanvas.CanvasBounds

      the area that the item originally requested, in the parent's coordinate space.

    • allocated_area: GooCanvas.CanvasBounds

      the area that the item has been allocated, in the parent's coordinate space.

    • x_offset: number

      the x offset of the allocated area from the requested area in the device coordinate space.

    • y_offset: number

      the y offset of the allocated area from the requested area in the device coordinate space.

    Returns void

  • animate(x: number, y: number, scale: number, degrees: number, absolute: boolean, duration: number, step_time: number, type: GooCanvas.CanvasAnimateType): void
  • Animates an item from its current position to the given offsets, scale and rotation.

    Parameters

    • x: number

      the final x coordinate.

    • y: number

      the final y coordinate.

    • scale: number

      the final scale.

    • degrees: number

      the final rotation. This can be negative to rotate anticlockwise, and can also be greater than 360 to rotate a number of times.

    • absolute: boolean

      if the x, y, scale and degrees values are absolute, or relative to the current transform. Note that absolute animations only work if the item currently has a simple transform. If the item has a shear or some other complicated transform it may result in strange animations.

    • duration: number

      the duration of the animation, in milliseconds (1/1000ths of a second).

    • step_time: number

      the time between each animation step, in milliseconds.

    • type: GooCanvas.CanvasAnimateType

      specifies what happens when the animation finishes.

    Returns void

  • 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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns 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.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • changed(recompute_bounds: boolean): void
  • This function is intended to be used by subclasses of #GooCanvasItemSimple.

    It is used as a callback for the "changed" signal of the item models. It requests an update or redraw of the item as appropriate.

    Parameters

    • recompute_bounds: boolean

      if the item's bounds need to be recomputed.

    Returns void

  • check_style(): void
  • This function is intended to be used by subclasses of #GooCanvasItemSimple, typically in their update() or get_requested_area() methods.

    It ensures that the item's style is setup correctly. If the item has its own #GooCanvasStyle it makes sure the parent is set correctly. If it doesn't have its own style it uses the parent item's style.

    Returns void

  • disconnect(id: number): void
  • emit(sigName: "notify::height", ...args: any[]): void
  • emit(sigName: "notify::width", ...args: any[]): void
  • emit(sigName: "notify::x", ...args: any[]): void
  • emit(sigName: "notify::y", ...args: any[]): void
  • emit(sigName: "notify::antialias", ...args: any[]): void
  • emit(sigName: "notify::clip-fill-rule", ...args: any[]): void
  • emit(sigName: "notify::clip-path", ...args: any[]): void
  • emit(sigName: "notify::fill-color", ...args: any[]): void
  • emit(sigName: "notify::fill-color-gdk-rgba", ...args: any[]): void
  • emit(sigName: "notify::fill-color-rgba", ...args: any[]): void
  • emit(sigName: "notify::fill-pattern", ...args: any[]): void
  • emit(sigName: "notify::fill-pixbuf", ...args: any[]): void
  • emit(sigName: "notify::fill-rule", ...args: any[]): void
  • emit(sigName: "notify::font", ...args: any[]): void
  • emit(sigName: "notify::font-desc", ...args: any[]): void
  • emit(sigName: "notify::hint-metrics", ...args: any[]): void
  • emit(sigName: "notify::line-cap", ...args: any[]): void
  • emit(sigName: "notify::line-dash", ...args: any[]): void
  • emit(sigName: "notify::line-join", ...args: any[]): void
  • emit(sigName: "notify::line-join-miter-limit", ...args: any[]): void
  • emit(sigName: "notify::line-width", ...args: any[]): void
  • emit(sigName: "notify::operator", ...args: any[]): void
  • emit(sigName: "notify::stroke-color", ...args: any[]): void
  • emit(sigName: "notify::stroke-color-gdk-rgba", ...args: any[]): void
  • emit(sigName: "notify::stroke-color-rgba", ...args: any[]): void
  • emit(sigName: "notify::stroke-pattern", ...args: any[]): void
  • emit(sigName: "notify::stroke-pixbuf", ...args: any[]): void
  • emit(sigName: "notify::can-focus", ...args: any[]): void
  • emit(sigName: "notify::description", ...args: any[]): void
  • emit(sigName: "notify::parent", ...args: any[]): void
  • emit(sigName: "notify::pointer-events", ...args: any[]): void
  • emit(sigName: "notify::title", ...args: any[]): void
  • emit(sigName: "notify::tooltip", ...args: any[]): void
  • emit(sigName: "notify::transform", ...args: any[]): void
  • emit(sigName: "notify::visibility", ...args: any[]): void
  • emit(sigName: "notify::visibility-threshold", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • ensure_updated(): void
  • force_floating(): void
  • This function is intended for #GObject 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().

    Returns void

  • freeze_notify(): void
  • 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.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • get_data(key?: string): object
  • get_is_static(): boolean
  • This function is only intended to be used when implementing new canvas items, specifically container items such as #GooCanvasGroup.

    It gets the items at the given point.

    Parameters

    • x: number

      the x coordinate of the point.

    • y: number

      the y coordinate of the point.

    • cr: cairo.Context

      a cairo contect.

    • is_pointer_event: boolean

      %TRUE if the "pointer-events" properties of items should be used to determine which parts of the item are tested.

    • parent_is_visible: boolean

      %TRUE if the parent item is visible (which implies that all ancestors are also visible).

    • found_items: GooCanvas.CanvasItem[]

      the list of items found so far.

    Returns GooCanvas.CanvasItem[]

  • get_line_width(): number
  • get_n_children(): number
  • This function is intended to be used by subclasses of #GooCanvasItemSimple, typically in their update() or get_requested_area() methods.

    It calculates the bounds of the current path, using the item's style settings, and stores the results in the given #GooCanvasBounds struct.

    The returned bounds contains the bounding box of the path in device space, converted to user space coordinates. To calculate the bounds completely in user space, use cairo_identity_matrix() to temporarily reset the current transformation matrix to the identity matrix.

    Parameters

    Returns void

  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • This function is only intended to be used when implementing new canvas items, specifically layout items such as #GooCanvasTable.

    It gets the requested area of a child item, assuming it is allocated the given width. This is useful for text items whose requested height may change depending on the allocated width.

    Parameters

    • cr: cairo.Context

      a cairo context.

    • width: number

      the allocated width.

    • requested_area: GooCanvas.CanvasBounds

      a #GooCanvasBounds to return the requested area in, in the parent's coordinate space. If %FALSE is returned, this is undefined.

    Returns boolean

  • get_requested_height(cr: cairo.Context, width: number): number
  • This function is only intended to be used when implementing new canvas items, specifically layout items such as #GooCanvasTable.

    It gets the requested height of a child item, assuming it is allocated the given width. This is useful for text items whose requested height may change depending on the allocated width.

    Parameters

    • cr: cairo.Context

      a cairo context.

    • width: number

      the width that the item may be allocated.

    Returns number

  • get_simple_transform(): [boolean, number, number, number, number]
  • This function can be used to get the position, scale and rotation of an item, providing that the item has a simple transformation matrix (e.g. set with goo_canvas_item_set_simple_transform(), or using a combination of simple translate, scale and rotate operations). If the item has a complex transformation matrix the results will be incorrect.

    Returns [boolean, number, number, number, number]

  • getv(names: string[], values: any[]): void
  • 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.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • is_container(): boolean
  • is_floating(): boolean
  • is_visible(): boolean
  • Checks if the item is visible.

    This entails checking the item's own visibility setting, as well as those of its ancestors.

    Note that the item may be scrolled off the screen and so may not be actually visible to the user.

    Returns boolean

  • move_child(old_position: number, new_position: number): void
  • notify(property_name: string): void
  • 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.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • This function is only intended to be used when implementing new canvas items, specifically container items such as #GooCanvasGroup.

    It paints the item and all children if they intersect the given bounds.

    Note that the scale argument may be different to the current scale in the #GooCanvasItem, e.g. when the canvas is being printed.

    Parameters

    • cr: cairo.Context

      a cairo context.

    • bounds: GooCanvas.CanvasBounds

      the bounds that need to be repainted, in device space.

    • scale: number

      the scale to use to determine whether an item should be painted. See #GooCanvasItem:visibility-threshold.

    Returns void

  • 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.

    Returns GObject.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().

    Returns GObject.Object

  • remove(): void
  • remove_child(child_num: number): void
  • request_update(): void
  • This function is only intended to be used when implementing new canvas items.

    It requests that an update of the item is scheduled. It will be performed as soon as the application is idle, and before the canvas is redrawn.

    Returns void

  • rotate(degrees: number, cx: number, cy: number): void
  • Rotates the item's coordinate system by the given amount, about the given origin.

    Parameters

    • degrees: number

      the clockwise angle of rotation.

    • cx: number

      the x coordinate of the origin of the rotation.

    • cy: number

      the y coordinate of the origin of the rotation.

    Returns void

  • run_dispose(): void
  • scale(sx: number, sy: number): void
  • set_data(key: string, data?: object): void
  • 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_is_static(is_static: boolean): void
  • Notifies the item that it is static. Static items do not move or change size when the canvas is scrolled or the scale changes.

    Container items such as #GooCanvasGroup should call this function when children are added, to notify children whether they are static or not. Containers should also pass on any changes in their own status to children.

    Parameters

    • is_static: boolean

      if the item is static.

    Returns void

  • This function is only intended to be used when implementing new canvas items (specifically container items such as #GooCanvasGroup). It sets the parent of the child item.

    This function cannot be used to add an item to a group or to change the parent of an item. To do that use the #GooCanvasItem:parent property.

    Parameters

    Returns void

  • set_property(property_name: string, value?: any): void
  • set_simple_transform(x: number, y: number, scale: number, rotation: number): void
  • A convenience function to set the item's transformation matrix.

    Parameters

    • x: number

      the x coordinate of the origin of the item's coordinate space.

    • y: number

      the y coordinate of the origin of the item's coordinate space.

    • scale: number

      the scale of the item.

    • rotation: number

      the clockwise rotation of the item, in degrees.

    Returns void

  • skew_x(degrees: number, cx: number, cy: number): void
  • Skews the item's coordinate system along the x axis by the given amount, about the given origin.

    Parameters

    • degrees: number

      the skew angle.

    • cx: number

      the x coordinate of the origin of the skew transform.

    • cy: number

      the y coordinate of the origin of the skew transform.

    Returns void

  • skew_y(degrees: number, cx: number, cy: number): void
  • Skews the item's coordinate system along the y axis by the given amount, about the given origin.

    Parameters

    • degrees: number

      the skew angle.

    • cx: number

      the x coordinate of the origin of the skew transform.

    • cy: number

      the y coordinate of the origin of the skew transform.

    Returns void

  • steal_data(key?: string): object
  • steal_qdata(quark: number): object
  • 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().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • stop_animation(): void
  • thaw_notify(): void
  • 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::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.

    Returns void

  • translate(tx: number, ty: number): void
  • Translates the origin of the item's coordinate system by the given amounts.

    Parameters

    • tx: number

      the amount to move the origin in the horizontal direction.

    • ty: number

      the amount to move the origin in the vertical direction.

    Returns void

  • unref(): void
  • 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 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 instance. Use g_clear_object() for this.

    Returns void

  • This function is only intended to be used when implementing new canvas items, specifically container items such as #GooCanvasGroup.

    Updates the item, if needed, and any children.

    Parameters

    • entire_tree: boolean

      if the entire subtree should be updated.

    • cr: cairo.Context

      a cairo context.

    • bounds: GooCanvas.CanvasBounds

      a #GooCanvasBounds to return the new bounds in.

    Returns void

  • This function is intended to be used by subclasses of #GooCanvasItemSimple, typically in their get_requested_area() method.

    It converts the item's bounds to a bounding box in its parent's coordinate space. If the item has no transformation matrix set then no conversion is needed.

    Parameters

    Returns void

  • This function is only intended to be used when implementing new canvas items, specifically layout items such as #GooCanvasTable.

    It allocates an area to a child #GooCanvasItem.

    Note that the parent layout item will use a transform to move each of its children for the layout, so there is no need for the child item to reposition itself. It only needs to recalculate its device bounds.

    To help recalculate the item's device bounds, the x_offset and y_offset of the child item's allocated position from its requested position are provided. Simple items can just add these to their bounds.

    virtual

    Parameters

    • cr: cairo.Context

      a cairo context.

    • requested_area: GooCanvas.CanvasBounds

      the area that the item originally requested, in the parent's coordinate space.

    • allocated_area: GooCanvas.CanvasBounds

      the area that the item has been allocated, in the parent's coordinate space.

    • x_offset: number

      the x offset of the allocated area from the requested area in the device coordinate space.

    • y_offset: number

      the y offset of the allocated area from the requested area in the device coordinate space.

    Returns void

  • vfunc_animation_finished(stopped: boolean): void
  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_is_static(): boolean
  • This function is only intended to be used when implementing new canvas items, specifically container items such as #GooCanvasGroup.

    It gets the items at the given point.

    virtual

    Parameters

    • x: number

      the x coordinate of the point.

    • y: number

      the y coordinate of the point.

    • cr: cairo.Context

      a cairo contect.

    • is_pointer_event: boolean

      %TRUE if the "pointer-events" properties of items should be used to determine which parts of the item are tested.

    • parent_is_visible: boolean

      %TRUE if the parent item is visible (which implies that all ancestors are also visible).

    • found_items: GooCanvas.CanvasItem[]

      the list of items found so far.

    Returns GooCanvas.CanvasItem[]

  • vfunc_get_n_children(): number
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • This function is only intended to be used when implementing new canvas items, specifically layout items such as #GooCanvasTable.

    It gets the requested area of a child item, assuming it is allocated the given width. This is useful for text items whose requested height may change depending on the allocated width.

    virtual

    Parameters

    • cr: cairo.Context

      a cairo context.

    • width: number

      the allocated width.

    • requested_area: GooCanvas.CanvasBounds

      a #GooCanvasBounds to return the requested area in, in the parent's coordinate space. If %FALSE is returned, this is undefined.

    Returns boolean

  • vfunc_get_requested_height(cr: cairo.Context, width: number): number
  • This function is only intended to be used when implementing new canvas items, specifically layout items such as #GooCanvasTable.

    It gets the requested height of a child item, assuming it is allocated the given width. This is useful for text items whose requested height may change depending on the allocated width.

    virtual

    Parameters

    • cr: cairo.Context

      a cairo context.

    • width: number

      the width that the item may be allocated.

    Returns number

  • vfunc_is_visible(): boolean
  • Checks if the item is visible.

    This entails checking the item's own visibility setting, as well as those of its ancestors.

    Note that the item may be scrolled off the screen and so may not be actually visible to the user.

    virtual

    Returns boolean

  • vfunc_move_child(old_position: number, new_position: number): void
  • 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.

    virtual

    Parameters

    Returns void

  • This function is only intended to be used when implementing new canvas items, specifically container items such as #GooCanvasGroup.

    It paints the item and all children if they intersect the given bounds.

    Note that the scale argument may be different to the current scale in the #GooCanvasItem, e.g. when the canvas is being printed.

    virtual

    Parameters

    • cr: cairo.Context

      a cairo context.

    • bounds: GooCanvas.CanvasBounds

      the bounds that need to be repainted, in device space.

    • scale: number

      the scale to use to determine whether an item should be painted. See #GooCanvasItem:visibility-threshold.

    Returns void

  • vfunc_query_tooltip(x: number, y: number, keyboard_tooltip: boolean, tooltip: Gtk.Tooltip): boolean
  • vfunc_remove_child(child_num: number): void
  • vfunc_request_update(): void
  • vfunc_set_is_static(is_static: boolean): void
  • Notifies the item that it is static. Static items do not move or change size when the canvas is scrolled or the scale changes.

    Container items such as #GooCanvasGroup should call this function when children are added, to notify children whether they are static or not. Containers should also pass on any changes in their own status to children.

    virtual

    Parameters

    • is_static: boolean

      if the item is static.

    Returns void

  • This function is only intended to be used when implementing new canvas items (specifically container items such as #GooCanvasGroup). It sets the parent of the child item.

    This function cannot be used to add an item to a group or to change the parent of an item. To do that use the #GooCanvasItem:parent property.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • vfunc_simple_is_item_at(x: number, y: number, cr: cairo.Context, is_pointer_event: boolean): boolean
  • watch_closure(closure: TClosure<any, any>): void
  • 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.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • Find the #GParamSpec 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().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • 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().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method