goocanvas Reference Manual

Synopsis

public interface CanvasItem {
    public    weak bool                 can_focus                 { get; set; } ;
    public    weak string               description               { get; set; } ;
    public    weak CanvasItem           parent                    { get; set; } ;
    public    weak CanvasPointerEvents  pointer_events            { get; set; } ;
    public    weak string               title                     { get; set; } ;
    public    weak CairoMatrix          transform                 { get; set; } ;
    public    weak CanvasItemVisibility  visibility                { get; set; } ;
    public    weak double               visibility_threshold      { get; set; } ;


    public    signal bool               button_press_event        ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               button_release_event      ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal void               child_notify              ( GLib.ParamSpec      pspec )  ;
    public    signal bool               enter_notify_event        ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               focus_in_event            ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               focus_out_event           ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               grab_broken_event         ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               key_press_event           ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               key_release_event         ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               leave_notify_event        ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;
    public    signal bool               motion_notify_event       ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;


    public    void                      animate                   ( double              x,
                                                                    double              y,
                                                                    double              scale,
                                                                    double              degrees,
                                                                    bool                absolute,
                                                                    int                 duration,
                                                                    int                 step_time,
                                                                    CanvasAnimateType   type ) ;
    public    static weak GLib.ParamSpec  class_find_child_property ( GLib.ObjectClass    iclass,
                                                                    string              property_name ) ;
    public    static void               class_install_child_property ( GLib.ObjectClass    iclass,
                                                                    uint                property_id,
                                                                    GLib.ParamSpec      pspec ) ;
    public    static weak GLib.ParamSpec  class_list_child_properties ( GLib.ObjectClass    iclass,
                                                                    uint                n_properties ) ;
    public    void                      ensure_updated            (  ) ;
    public    int                       find_child                ( CanvasItem          child ) ;
    public    void                      get_child_properties      ( CanvasItem          child ) ;
    public    void                      get_child_properties_valist ( CanvasItem          child,
                                                                    void**              var_args ) ;
    public    bool                      is_container              (  ) ;
    public    void                      lower                     ( CanvasItem          below ) ;
    public    void                      raise                     ( CanvasItem          above ) ;
    public    void                      remove                    (  ) ;
    public    void                      rotate                    ( double              degrees,
                                                                    double              cx,
                                                                    double              cy ) ;
    public    void                      scale                     ( double              sx,
                                                                    double              sy ) ;
    public    void                      set_child_properties      ( CanvasItem          child ) ;
    public    void                      set_child_properties_valist ( CanvasItem          child,
                                                                    void**              var_args ) ;
    public    void                      set_simple_transform      ( double              x,
                                                                    double              y,
                                                                    double              scale,
                                                                    double              rotation ) ;
    public    void                      skew_x                    ( double              degrees,
                                                                    double              cx,
                                                                    double              cy ) ;
    public    void                      skew_y                    ( double              degrees,
                                                                    double              cx,
                                                                    double              cy ) ;
    public    void                      stop_animation            (  ) ;
    public    void                      translate                 ( double              tx,
                                                                    double              ty ) ;
    public    abstract void             add_child                 ( CanvasItem          child,
                                                                    int                 position ) ;
    public    abstract void             allocate_area             ( Cairo.Context       cr,
                                                                    CanvasBounds        requested_area,
                                                                    CanvasBounds        allocated_area,
                                                                    double              x_offset,
                                                                    double              y_offset ) ;
    public    abstract void             get_bounds                ( CanvasBounds        bounds ) ;
    public    abstract weak Canvas      get_canvas                (  ) ;
    public    abstract weak CanvasItem  get_child                 ( int                 child_num ) ;
    public    abstract void             get_child_property        ( CanvasItem          child,
                                                                    uint                property_id,
                                                                    GLib.Value          value,
                                                                    GLib.ParamSpec      pspec ) ;
    public    abstract weak GLib.List   get_items_at              ( double              x,
                                                                    double              y,
                                                                    Cairo.Context       cr,
                                                                    bool                is_pointer_event,
                                                                    bool                parent_is_visible,
                                                                    GLib.List           found_items ) ;
    public    abstract weak CanvasItemModel  get_model                 (  ) ;
    public    abstract int              get_n_children            (  ) ;
    public    abstract weak CanvasItem  get_parent                (  ) ;
    public    abstract bool             get_requested_area        ( Cairo.Context       cr,
                                                                    CanvasBounds        requested_area ) ;
    public    abstract double           get_requested_height      ( Cairo.Context       cr,
                                                                    double              width ) ;
    public    abstract weak CanvasStyle  get_style                 (  ) ;
    public    abstract bool             get_transform             ( Cairo.Matrix        transform ) ;
    public    abstract bool             get_transform_for_child   ( CanvasItem          child,
                                                                    Cairo.Matrix        transform ) ;
    public    abstract bool             is_visible                (  ) ;
    public    abstract void             move_child                ( int                 old_position,
                                                                    int                 new_position ) ;
    public    abstract void             paint                     ( Cairo.Context       cr,
                                                                    CanvasBounds        bounds,
                                                                    double              scale ) ;
    public    abstract bool             query_tooltip             ( double              x,
                                                                    double              y,
                                                                    bool                keyboard_tooltip,
                                                                    void**              tooltip ) ;
    public    abstract void             remove_child              ( int                 child_num ) ;
    public    abstract void             request_update            (  ) ;
    public    abstract void             set_canvas                ( Canvas              canvas ) ;
    public    abstract void             set_child_property        ( CanvasItem          child,
                                                                    uint                property_id,
                                                                    GLib.Value          value,
                                                                    GLib.ParamSpec      pspec ) ;
    public    abstract void             set_model                 ( CanvasItemModel     model ) ;
    public    abstract void             set_parent                ( CanvasItem          parent ) ;
    public    abstract void             set_style                 ( CanvasStyle         style ) ;
    public    abstract void             set_transform             ( Cairo.Matrix        transform ) ;
    public    abstract void             update                    ( bool                entire_tree,
                                                                    Cairo.Context       cr,
                                                                    CanvasBounds        bounds ) ;
}

Description

Details

Signal Details

button_press_event
    public    signal bool               button_press_event        ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

button_release_event
    public    signal bool               button_release_event      ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

child_notify
    public    signal void               child_notify              ( GLib.ParamSpec      pspec )  ;		

enter_notify_event
    public    signal bool               enter_notify_event        ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

focus_in_event
    public    signal bool               focus_in_event            ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

focus_out_event
    public    signal bool               focus_out_event           ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

grab_broken_event
    public    signal bool               grab_broken_event         ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

key_press_event
    public    signal bool               key_press_event           ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

key_release_event
    public    signal bool               key_release_event         ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

leave_notify_event
    public    signal bool               leave_notify_event        ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

motion_notify_event
    public    signal bool               motion_notify_event       ( CanvasItem          target,
                                                                    Gdk.Event           event )  ;		

Property Details

can_focus
    public    weak bool                 can_focus                 { get; set; } ;		

description
    public    weak string               description               { get; set; } ;		

parent
    public    weak CanvasItem           parent                    { get; set; } ;		

pointer_events
    public    weak CanvasPointerEvents  pointer_events            { get; set; } ;		

title
    public    weak string               title                     { get; set; } ;		

transform
    public    weak CairoMatrix          transform                 { get; set; } ;		

visibility
    public    weak CanvasItemVisibility  visibility                { get; set; } ;		

visibility_threshold
    public    weak double               visibility_threshold      { get; set; } ;		

Method Details

animate ()
    public    void                      animate                   ( double              x,
                                                                    double              y,
                                                                    double              scale,
                                                                    double              degrees,
                                                                    bool                absolute,
                                                                    int                 duration,
                                                                    int                 step_time,
                                                                    CanvasAnimateType   type ) ;		

class_find_child_property ()
    public    static weak GLib.ParamSpec  class_find_child_property ( GLib.ObjectClass    iclass,
                                                                    string              property_name ) ;		

class_install_child_property ()
    public    static void               class_install_child_property ( GLib.ObjectClass    iclass,
                                                                    uint                property_id,
                                                                    GLib.ParamSpec      pspec ) ;		

class_list_child_properties ()
    public    static weak GLib.ParamSpec  class_list_child_properties ( GLib.ObjectClass    iclass,
                                                                    uint                n_properties ) ;		

ensure_updated ()
    public    void                      ensure_updated            (  ) ;		

find_child ()
    public    int                       find_child                ( CanvasItem          child ) ;		

get_child_properties ()
    public    void                      get_child_properties      ( CanvasItem          child ) ;		

get_child_properties_valist ()
    public    void                      get_child_properties_valist ( CanvasItem          child,
                                                                    void**              var_args ) ;		

is_container ()
    public    bool                      is_container              (  ) ;		

lower ()
    public    void                      lower                     ( CanvasItem          below ) ;		

raise ()
    public    void                      raise                     ( CanvasItem          above ) ;		

remove ()
    public    void                      remove                    (  ) ;		

rotate ()
    public    void                      rotate                    ( double              degrees,
                                                                    double              cx,
                                                                    double              cy ) ;		

scale ()
    public    void                      scale                     ( double              sx,
                                                                    double              sy ) ;		

set_child_properties ()
    public    void                      set_child_properties      ( CanvasItem          child ) ;		

set_child_properties_valist ()
    public    void                      set_child_properties_valist ( CanvasItem          child,
                                                                    void**              var_args ) ;		

set_simple_transform ()
    public    void                      set_simple_transform      ( double              x,
                                                                    double              y,
                                                                    double              scale,
                                                                    double              rotation ) ;		

skew_x ()
    public    void                      skew_x                    ( double              degrees,
                                                                    double              cx,
                                                                    double              cy ) ;		

skew_y ()
    public    void                      skew_y                    ( double              degrees,
                                                                    double              cx,
                                                                    double              cy ) ;		

stop_animation ()
    public    void                      stop_animation            (  ) ;		

translate ()
    public    void                      translate                 ( double              tx,
                                                                    double              ty ) ;		

add_child ()
    public    abstract void             add_child                 ( CanvasItem          child,
                                                                    int                 position ) ;		

allocate_area ()
    public    abstract void             allocate_area             ( Cairo.Context       cr,
                                                                    CanvasBounds        requested_area,
                                                                    CanvasBounds        allocated_area,
                                                                    double              x_offset,
                                                                    double              y_offset ) ;		

get_bounds ()
    public    abstract void             get_bounds                ( CanvasBounds        bounds ) ;		

get_canvas ()
    public    abstract weak Canvas      get_canvas                (  ) ;		

get_child ()
    public    abstract weak CanvasItem  get_child                 ( int                 child_num ) ;		

get_child_property ()
    public    abstract void             get_child_property        ( CanvasItem          child,
                                                                    uint                property_id,
                                                                    GLib.Value          value,
                                                                    GLib.ParamSpec      pspec ) ;		

get_items_at ()
    public    abstract weak GLib.List   get_items_at              ( double              x,
                                                                    double              y,
                                                                    Cairo.Context       cr,
                                                                    bool                is_pointer_event,
                                                                    bool                parent_is_visible,
                                                                    GLib.List           found_items ) ;		

get_model ()
    public    abstract weak CanvasItemModel  get_model                 (  ) ;		

get_n_children ()
    public    abstract int              get_n_children            (  ) ;		

get_parent ()
    public    abstract weak CanvasItem  get_parent                (  ) ;		

get_requested_area ()
    public    abstract bool             get_requested_area        ( Cairo.Context       cr,
                                                                    CanvasBounds        requested_area ) ;		

get_requested_height ()
    public    abstract double           get_requested_height      ( Cairo.Context       cr,
                                                                    double              width ) ;		

get_style ()
    public    abstract weak CanvasStyle  get_style                 (  ) ;		

get_transform ()
    public    abstract bool             get_transform             ( Cairo.Matrix        transform ) ;		

get_transform_for_child ()
    public    abstract bool             get_transform_for_child   ( CanvasItem          child,
                                                                    Cairo.Matrix        transform ) ;		

is_visible ()
    public    abstract bool             is_visible                (  ) ;		

move_child ()
    public    abstract void             move_child                ( int                 old_position,
                                                                    int                 new_position ) ;		

paint ()
    public    abstract void             paint                     ( Cairo.Context       cr,
                                                                    CanvasBounds        bounds,
                                                                    double              scale ) ;		

query_tooltip ()
    public    abstract bool             query_tooltip             ( double              x,
                                                                    double              y,
                                                                    bool                keyboard_tooltip,
                                                                    void**              tooltip ) ;		

remove_child ()
    public    abstract void             remove_child              ( int                 child_num ) ;		

request_update ()
    public    abstract void             request_update            (  ) ;		

set_canvas ()
    public    abstract void             set_canvas                ( Canvas              canvas ) ;		

set_child_property ()
    public    abstract void             set_child_property        ( CanvasItem          child,
                                                                    uint                property_id,
                                                                    GLib.Value          value,
                                                                    GLib.ParamSpec      pspec ) ;		

set_model ()
    public    abstract void             set_model                 ( CanvasItemModel     model ) ;		

set_parent ()
    public    abstract void             set_parent                ( CanvasItem          parent ) ;		

set_style ()
    public    abstract void             set_style                 ( CanvasStyle         style ) ;		

set_transform ()
    public    abstract void             set_transform             ( Cairo.Matrix        transform ) ;		

update ()
    public    abstract void             update                    ( bool                entire_tree,
                                                                    Cairo.Context       cr,
                                                                    CanvasBounds        bounds ) ;		


Created by Valadoc