Gjsify LogoGjsify Logo

GooCanvasGridModel represents a model for grid items. A grid consists of a number of equally-spaced horizontal and vertical grid lines, plus an optional border.

It is a subclass of #GooCanvasItemModelSimple and so inherits all of the style properties such as "stroke-color", "fill-color" and "line-width".

It also implements the #GooCanvasItemModel interface, so you can use the #GooCanvasItemModel functions such as goo_canvas_item_model_raise() and goo_canvas_item_model_rotate().

To create a #GooCanvasGridModel use goo_canvas_grid_model_new().

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

To respond to events such as mouse clicks on the grid you must connect to the signal handlers of the corresponding #GooCanvasGrid objects. (See goo_canvas_get_item() and #GooCanvas::item-created.)

The grid's position and size is specified with the #GooCanvasGridModel:x, #GooCanvasGridModel:y, #GooCanvasGridModel:width and #GooCanvasGridModel:height properties.

The #GooCanvasGridModel:x-step and #GooCanvasGridModel:y-step properties specify the distance between grid lines. The #GooCanvasGridModel:x-offset and #GooCanvasGridModel:y-offset properties specify the distance before the first grid lines.

The horizontal or vertical grid lines can be hidden using the #GooCanvasGridModel:show-horz-grid-lines and #GooCanvasGridModel:show-vert-grid-lines properties.

The width of the border can be set using the #GooCanvasGridModel:border-width property. The border is drawn outside the area specified with the #GooCanvasGridModel:x, #GooCanvasGridModel:y, #GooCanvasGridModel:width and #GooCanvasGridModel:height properties.

Other properties allow the colors and widths of the grid lines to be set. The grid line color and width properties override the standard #GooCanvasItemModelSimple:stroke-color and #GooCanvasItemModelSimple:line-width properties, enabling different styles for horizontal and vertical grid lines.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

border_color: string
border_color_gdk_rgba: Gdk.RGBA
border_color_rgba: number
border_pattern: any
border_pixbuf: Pixbuf
border_width: number
can_focus: boolean
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
fill_color_rgba: number
fill_pattern: any
fill_pixbuf: Pixbuf
font: string
font_desc: FontDescription
g_type_instance: TypeInstance
height: number
horz_grid_line_color: string
horz_grid_line_color_gdk_rgba: Gdk.RGBA
horz_grid_line_color_rgba: number
horz_grid_line_pattern: any
horz_grid_line_pixbuf: Pixbuf
horz_grid_line_width: number
line_join_miter_limit: number
line_width: number

the parent model.

field
show_horz_grid_lines: boolean
show_vert_grid_lines: boolean

data used by the canvas item for viewing the model.

field
stroke_color: string
stroke_color_gdk_rgba: Gdk.RGBA
stroke_color_rgba: number
stroke_pattern: any
stroke_pixbuf: Pixbuf
title: string
tooltip: string
transform: any
vert_grid_line_color: string
vert_grid_line_color_gdk_rgba: Gdk.RGBA
vert_grid_line_color_rgba: number
vert_grid_line_pattern: any
vert_grid_line_pixbuf: Pixbuf
vert_grid_line_width: number
vert_grid_lines_on_top: boolean
visibility_threshold: number
width: number
x: number
x_offset: number
x_step: number
y: number
y_offset: number
y_step: number
name: string

Methods

  • animate(x: number, y: number, scale: number, degrees: number, absolute: boolean, duration: number, step_time: number, type: GooCanvas.CanvasAnimateType): void
  • Animates a model 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 model currently has a simple transform. If the model 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

  • disconnect(id: number): void
  • emit(sigName: "notify::border-color", ...args: any[]): void
  • emit(sigName: "notify::border-color-gdk-rgba", ...args: any[]): void
  • emit(sigName: "notify::border-color-rgba", ...args: any[]): void
  • emit(sigName: "notify::border-pattern", ...args: any[]): void
  • emit(sigName: "notify::border-pixbuf", ...args: any[]): void
  • emit(sigName: "notify::border-width", ...args: any[]): void
  • emit(sigName: "notify::height", ...args: any[]): void
  • emit(sigName: "notify::horz-grid-line-color", ...args: any[]): void
  • emit(sigName: "notify::horz-grid-line-color-gdk-rgba", ...args: any[]): void
  • emit(sigName: "notify::horz-grid-line-color-rgba", ...args: any[]): void
  • emit(sigName: "notify::horz-grid-line-pattern", ...args: any[]): void
  • emit(sigName: "notify::horz-grid-line-pixbuf", ...args: any[]): void
  • emit(sigName: "notify::horz-grid-line-width", ...args: any[]): void
  • emit(sigName: "notify::show-horz-grid-lines", ...args: any[]): void
  • emit(sigName: "notify::show-vert-grid-lines", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-line-color", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-line-color-gdk-rgba", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-line-color-rgba", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-line-pattern", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-line-pixbuf", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-line-width", ...args: any[]): void
  • emit(sigName: "notify::vert-grid-lines-on-top", ...args: any[]): void
  • emit(sigName: "notify::width", ...args: any[]): void
  • emit(sigName: "notify::x", ...args: any[]): void
  • emit(sigName: "notify::x-offset", ...args: any[]): void
  • emit(sigName: "notify::x-step", ...args: any[]): void
  • emit(sigName: "notify::y", ...args: any[]): void
  • emit(sigName: "notify::y-offset", ...args: any[]): void
  • emit(sigName: "notify::y-step", ...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
  • 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_n_children(): number
  • 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
  • get_simple_transform(x: number, y: number, scale: number, rotation: number): boolean
  • This function can be used to get the position, scale and rotation of an item model, providing that the model has a simple transformation matrix (e.g. set with goo_canvas_item_model_set_simple_transform(), or using a combination of simple translate, scale and rotate operations). If the model has a complex transformation matrix the results will be incorrect.

    Parameters

    • x: number

      returns the x coordinate of the origin of the model's coordinate space.

    • y: number

      returns the y coordinate of the origin of the model's coordinate space.

    • scale: number

      returns the scale of the model.

    • rotation: number

      returns the clockwise rotation of the model, in degrees (0-360).

    Returns boolean

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

  • 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
  • rotate(degrees: number, cx: number, cy: number): void
  • Rotates the model'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

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

    This function cannot be used to add a model to a group or to change the parent of a model. To do that use the #GooCanvasItemModel: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 model's transformation matrix.

    Parameters

    • x: number

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

    • y: number

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

    • scale: number

      the scale of the model.

    • rotation: number

      the clockwise rotation of the model, in degrees.

    Returns void

  • skew_x(degrees: number, cx: number, cy: number): void
  • Skews the model'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 model'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 model'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

  • vfunc_animation_finished(stopped: boolean): void
  • vfunc_changed(recompute_bounds: boolean): void
  • vfunc_child_added(child_num: number): void
  • vfunc_child_moved(old_child_num: number, new_child_num: number): void
  • vfunc_child_removed(child_num: number): void
  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_n_children(): number
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • 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

  • vfunc_remove_child(child_num: number): void
  • This function is only intended to be used when implementing new canvas item models (specifically container models such as #GooCanvasGroupModel). It sets the parent of the child model.

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

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • 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

  • 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