DiaCanvasView

DiaCanvas2 Reference Manual: Version 0.9.0
<<< Previous Page	Home	Up	Next Page >>>

Details

DIA_CANVAS_VIEW()

#define DIA_CANVAS_VIEW(obj)			(GTK_CHECK_CAST ((obj), DIA_TYPE_CANVAS_VIEW, DiaCanvasView))

obj :

struct DiaCanvasView

struct DiaCanvasView;

Visual (interactive) representation of a diagram (DiaCanvas).

DIA_CANVAS_VIEW_ITEM_FOCUS()

#define DIA_CANVAS_VIEW_ITEM_FOCUS(obj)		(dia_canvas_view_item_has_focus (DIA_CANVAS_VIEW_ITEM (obj)))

obj :

DIA_CANVAS_VIEW_ITEM_GRAB()

#define DIA_CANVAS_VIEW_ITEM_GRAB(obj)		(GNOME_CANVAS_ITEM (obj)->canvas->grabbed_item == (GnomeCanvasItem*) (obj))

obj :

DIA_CANVAS_VIEW_ITEM_SELECT()

#define DIA_CANVAS_VIEW_ITEM_SELECT(obj)	(dia_canvas_view_item_is_selected (DIA_CANVAS_VIEW_ITEM (obj)))

obj :

DIA_CANVAS_VIEW_ITEM_VISIBLE()

#define DIA_CANVAS_VIEW_ITEM_VISIBLE(obj)	((GTK_OBJECT_FLAGS (obj) & GNOME_CANVAS_ITEM_VISIBLE) != 0)

obj :

dia_canvas_view_new ()

GtkWidget*  dia_canvas_view_new             (DiaCanvas *canvas,
                                             gboolean aa);

Create a new DiaCanvasView object. In most cases you want to set aa to TRUE, since it has the most complete renderer and the best quality.

`canvas` :	A DiaCanvas that contains data that is to be visualized (may be NULL).
`aa` :	Use Anti-alias (LibArt) mode rather that X.
Returns :	A newly create DiaCanvasView.

dia_canvas_view_aa_new ()

GtkWidget*  dia_canvas_view_aa_new          (void);

Create a new anti-aliased canvas. Note that no DiaCanvas object iis yet connected to the canvas view.

Returns :

A newly created DiaCanvasView.

dia_canvas_view_set_zoom ()

void        dia_canvas_view_set_zoom        (DiaCanvasView *view,
                                             gdouble zoom);

Set the zoom factor for the canvas. 1.0 means 100%.

`view` :
`zoom` :

dia_canvas_view_set_canvas ()

void        dia_canvas_view_set_canvas      (DiaCanvasView *view,
                                             DiaCanvas *canvas);

Set the canvas to be viisualized by view. You can only set a canvas if the view doesn't already have a canvas.

`view` :
`canvas` :

dia_canvas_view_unset_canvas ()

void        dia_canvas_view_unset_canvas    (DiaCanvasView *view);

Disconnect the view from it's DiaCanvas.

view :

dia_canvas_view_get_canvas ()

DiaCanvas*  dia_canvas_view_get_canvas      (DiaCanvasView *view);

Get the DiaCanvas that is displayed in the view.

`view` :
Returns :	The canvas.

dia_canvas_view_select_rectangle ()

void        dia_canvas_view_select_rectangle
                                            (DiaCanvasView *view,
                                             DiaRectangle *rect);

Select all object whose bounding box is within rect.

`view` :
`rect` :

dia_canvas_view_request_update ()

void        dia_canvas_view_request_update  (DiaCanvasView *view);

Request an update for all items on the canvas. All shapes will be set to update state too.

view :

dia_canvas_view_get_zoom ()

gdouble     dia_canvas_view_get_zoom        (DiaCanvasView *view);

Get the zoomm factor for the view.

`view` :
Returns :

dia_canvas_view_set_tool ()

void        dia_canvas_view_set_tool        (DiaCanvasView *view,
                                             DiaTool *tool);

Set a tool to use by this canvas view. Tools are used to override the default behavior of the view. tool may be NULL, so the tool is removed from the view.

`view` :
`tool` :	The DiaTool

dia_canvas_view_select ()

void        dia_canvas_view_select          (DiaCanvasView *view,
                                             DiaCanvasViewItem *item);

Select item. If the item is a composite item (item->item has DIA_COMPOSITE set), the parent is selected.

`view` :
`item` :

dia_canvas_view_select_all ()

void        dia_canvas_view_select_all      (DiaCanvasView *view);

view :

dia_canvas_view_unselect ()

void        dia_canvas_view_unselect        (DiaCanvasView *view,
                                             DiaCanvasViewItem *item);

Unselect root and all children of root. If one of the selected items has the focus, it is de-focused.

`view` :	DiaCanvasView
`item` :

dia_canvas_view_unselect_all ()

void        dia_canvas_view_unselect_all    (DiaCanvasView *view);

Do a dia_canvas_view_unselect() for all items in the canvas view.

view :

dia_canvas_view_focus ()

void        dia_canvas_view_focus           (DiaCanvasView *view,
                                             DiaCanvasViewItem *item);

Set the focus to item.

`view` :
`item` :

dia_canvas_view_move ()

void        dia_canvas_view_move            (DiaCanvasView *view,
                                             gdouble dx,
                                             gdouble dy,
                                             DiaCanvasViewItem *originator);

Move all selected items.

`view` :
`dx` :	movement
`dy` :
`originator` :	the object that recieved the event resulting in the movement.

dia_canvas_view_find_view_item ()

DiaCanvasViewItem* dia_canvas_view_find_view_item
                                            (DiaCanvasView *view,
                                             DiaCanvasItem *item);

Find the DiaCanvasViewItem that visualizes item.

`view` :
`item` :	Item to find.
Returns :	The view item or NULL.

dia_canvas_view_gdk_event_to_dia_event ()

void        dia_canvas_view_gdk_event_to_dia_event
                                            (DiaCanvasView *view,
                                             DiaCanvasViewItem *item,
                                             GdkEvent *gdk_event,
                                             DiaEvent *dia_event);

Convert a GdkEvent to a DiaEvent. DiaCanvasItem's can recieve mouse and keyboard events.

`view` :
`item` :
`gdk_event` :
`dia_event` :

dia_canvas_view_get_active_view ()

DiaCanvasView* dia_canvas_view_get_active_view
                                            (void);

This function returns the view that was last edited (by mouse clock or key event).

Returns :

The last used view.

"`aa`" (gboolean : Read / Write)
"`active-view`" (DiaCanvasView : Read)
"`canvas`" (DiaCanvas : Read / Write)
"`tool`" (DiaTool : Read / Write)
"`zoom`" (DiaTool : Read / Write)

`diacanvasview` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

`diacanvasview` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

`diacanvasview` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.

DiaCanvasView

Name

Synopsis

Object Hierarchy

Implemented Interfaces

Properties

Signal Prototypes

Description

Details

DIA_CANVAS_VIEW()

struct DiaCanvasView

DIA_CANVAS_VIEW_ITEM_FOCUS()

DIA_CANVAS_VIEW_ITEM_GRAB()

DIA_CANVAS_VIEW_ITEM_SELECT()

DIA_CANVAS_VIEW_ITEM_VISIBLE()

dia_canvas_view_new ()

dia_canvas_view_aa_new ()

dia_canvas_view_set_zoom ()

dia_canvas_view_set_canvas ()

dia_canvas_view_unset_canvas ()

dia_canvas_view_get_canvas ()

dia_canvas_view_select_rectangle ()

dia_canvas_view_request_update ()

dia_canvas_view_get_zoom ()

dia_canvas_view_set_tool ()

dia_canvas_view_select ()

dia_canvas_view_select_all ()

dia_canvas_view_unselect ()

dia_canvas_view_unselect_all ()

dia_canvas_view_focus ()

dia_canvas_view_move ()

dia_canvas_view_find_view_item ()

dia_canvas_view_gdk_event_to_dia_event ()

dia_canvas_view_get_active_view ()

Properties

Signals

The "focus-item" signal

The "select-item" signal

The "unselect-item" signal

See Also