Code

Use "%"-key for toggling the snapper, and modify the related sp-desktop code
[inkscape.git] / src / desktop.h
1 #ifndef SEEN_SP_DESKTOP_H
2 #define SEEN_SP_DESKTOP_H
4 /** \file
5  * SPDesktop: an editable view.
6  *
7  * Author:
8  *   Lauris Kaplinski <lauris@kaplinski.com>
9  *   Frank Felfe <innerspace@iname.com>
10  *   bulia byak <buliabyak@users.sf.net>
11  *   Ralf Stephan <ralf@ark.in-berlin.de>
12  *   John Bintz <jcoswell@coswellproductions.org>
13  *   Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
14  *
15  * Copyright (C) 2007 Johan Engelen
16  * Copyright (C) 2006 John Bintz
17  * Copyright (C) 1999-2005 authors
18  * Copyright (C) 2000-2001 Ximian, Inc.
19  *
20  * Released under GNU GPL, read the file 'COPYING' for more information
21  *
22  */
24 #ifdef HAVE_CONFIG_H
25 #include "config.h"
26 #endif
28 #include <gdk/gdkevents.h>
29 #include <gtk/gtktypeutils.h>
30 #include <sigc++/sigc++.h>
32 #include "libnr/nr-matrix.h"
33 #include "libnr/nr-matrix-fns.h"
34 #include "libnr/nr-rect.h"
35 #include "ui/view/view.h"
36 #include "ui/view/edit-widget-interface.h"
38 class NRRect;
39 class SPCSSAttr;
40 struct _GtkWidget;
41 typedef struct _GtkWidget GtkWidget;
42 struct SPCanvas;
43 struct SPCanvasItem;
44 struct SPCanvasGroup;
45 struct SPDesktopWidget;
46 struct SPEventContext;
47 struct SPItem;
48 struct SPNamedView;
49 struct SPObject;
50 struct SPStyle;
51 struct SPViewWidget;
53 namespace Gtk
54 {
55   class Window;
56 }
58 typedef int sp_verb_t;
62 namespace Inkscape {
63   class Application;
64   class MessageContext;
65   class Selection;
66   class ObjectHierarchy;
67   class LayerManager;
68   class EventLog;
69   namespace UI {
70       namespace Dialog {
71           class DialogManager;
72       }
73   }
74   namespace Whiteboard {
75       class SessionManager;
76   }
77 }
79 /**
80  * Editable view.
81  *
82  * @see \ref desktop-handles.h for desktop macros.
83  */
84 struct SPDesktop : public Inkscape::UI::View::View
85 {
86     Inkscape::UI::Dialog::DialogManager *_dlg_mgr;
87     SPNamedView               *namedview;
88     SPCanvas                  *canvas;
89     /// current selection; will never generally be NULL
90     Inkscape::Selection       *selection;
91     SPEventContext            *event_context;
92     Inkscape::LayerManager    *layer_manager;
93     Inkscape::EventLog        *event_log;
95     SPCanvasItem  *acetate;
96     SPCanvasGroup *main;
97     SPCanvasGroup *gridgroup;
98     SPCanvasGroup *guides;
99     SPCanvasItem  *drawing;
100     SPCanvasGroup *sketch;
101     SPCanvasGroup *controls;
102     SPCanvasItem  *table;       ///< outside-of-page background
103     SPCanvasItem  *page;        ///< page background
104     SPCanvasItem  *page_border; ///< page border
105     SPCSSAttr     *current;     ///< current style
107     GList *zooms_past;
108     GList *zooms_future;
109     unsigned int dkey;
110     unsigned int number;
111     guint window_state;
112     unsigned int interaction_disabled_counter;
113     bool waiting_cursor;
115     /// \todo fixme: This has to be implemented in different way */
116     guint guides_active : 1;
118     // storage for selected dragger used by GrDrag as it's
119     // created and deleted by tools
120     SPItem *gr_item;
121     guint  gr_point_type;
122     guint  gr_point_i;
123     bool   gr_fill_or_stroke;
126     Inkscape::ObjectHierarchy *_layer_hierarchy;
127     gchar * _reconstruction_old_layer_id;
129     sigc::signal<void, sp_verb_t>      _tool_changed;
130     sigc::signal<void, SPObject *>     _layer_changed_signal;
131     sigc::signal<bool, const SPCSSAttr *>::accumulated<StopOnTrue> _set_style_signal;
132     sigc::signal<int, SPStyle *, int>::accumulated<StopOnNonZero> _query_style_signal;
133     sigc::connection connectDocumentReplaced (const sigc::slot<void,SPDesktop*,SPDocument*> & slot)
134     {
135         return _document_replaced_signal.connect (slot);
136     }
138     sigc::connection connectEventContextChanged (const sigc::slot<void,SPDesktop*,SPEventContext*> & slot)
139     {
140         return _event_context_changed_signal.connect (slot);
141     }
142     sigc::connection connectSetStyle (const sigc::slot<bool, const SPCSSAttr *> & slot)
143     {
144         return _set_style_signal.connect (slot);
145     }
146     sigc::connection connectQueryStyle (const sigc::slot<int, SPStyle *, int> & slot)
147     {
148         return _query_style_signal.connect (slot);
149     }
150      // subselection is some sort of selection which is specific to the tool, such as a handle in gradient tool, or a text selection
151     sigc::connection connectToolSubselectionChanged(const sigc::slot<void, gpointer> & slot) {
152         return _tool_subselection_changed.connect(slot);
153     }
154     void emitToolSubselectionChanged(gpointer data);
155     sigc::connection connectCurrentLayerChanged(const sigc::slot<void, SPObject *> & slot) {
156         return _layer_changed_signal.connect(slot);
157     }
159     // Whiteboard changes
161 #ifdef WITH_INKBOARD
162     Inkscape::Whiteboard::SessionManager* whiteboard_session_manager() {
163         return _whiteboard_session_manager;
164     }
166     Inkscape::Whiteboard::SessionManager* _whiteboard_session_manager;
167 #endif
169     SPDesktop();
170     void init (SPNamedView* nv, SPCanvas* canvas);
171     virtual ~SPDesktop();
172     void destroy();
174     Inkscape::MessageContext *guidesMessageContext() const {
175         return _guides_message_context;
176     }
178     void setDisplayModeNormal();
179     void setDisplayModeOutline();
180     void displayModeToggle();
181     int displayMode;
182     int getMode() const { return displayMode; }
184     Inkscape::UI::Widget::Dock* getDock() { return _widget->getDock(); }
186     void set_active (bool new_active);
187     SPObject *currentRoot() const;
188     SPObject *currentLayer() const;
189     void setCurrentLayer(SPObject *object);
190     SPObject *layerForObject(SPObject *object);
191     bool isLayer(SPObject *object) const;
192     bool isWithinViewport(SPItem *item) const;
193     bool itemIsHidden(SPItem const *item) const;
195     void activate_guides (bool activate);
196     void change_document (SPDocument *document);
198     void set_event_context (GtkType type, const gchar *config);
199     void push_event_context (GtkType type, const gchar *config, unsigned int key);
201     void set_coordinate_status (NR::Point p);
202     SPItem *item_from_list_at_point_bottom (const GSList *list, NR::Point const p) const;
203     SPItem *item_at_point (NR::Point const p, bool into_groups, SPItem *upto = NULL) const;
204     SPItem *group_at_point (NR::Point const p) const;
205     NR::Point point() const;
207     NR::Rect get_display_area() const;
208     void set_display_area (double x0, double y0, double x1, double y1, double border, bool log = true);
209     void set_display_area(NR::Rect const &a, NR::Coord border, bool log = true);
210     void zoom_absolute (double cx, double cy, double zoom);
211     void zoom_relative (double cx, double cy, double zoom);
212     void zoom_absolute_keep_point (double cx, double cy, double px, double py, double zoom);
213     void zoom_relative_keep_point (double cx, double cy, double zoom);
214     void zoom_relative_keep_point (NR::Point const &c, double const zoom)
215     {
216             using NR::X;
217             using NR::Y;
218             zoom_relative_keep_point (c[X], c[Y], zoom);
219     }
221     void zoom_page();
222     void zoom_page_width();
223     void zoom_drawing();
224     void zoom_selection();
225     void zoom_grab_focus();
226     double current_zoom() const  { return _d2w.expansion(); }
227     void prev_zoom();
228     void next_zoom();
230     bool scroll_to_point (NR::Point const *s_dt, gdouble autoscrollspeed = 0);
231     void scroll_world (double dx, double dy, bool is_scrolling = false);
232     void scroll_world (NR::Point const scroll, bool is_scrolling = false)
233     {
234         using NR::X;
235         using NR::Y;
236         scroll_world(scroll[X], scroll[Y], is_scrolling);
237     }
239     void getWindowGeometry (gint &x, gint &y, gint &w, gint &h);
240     void setWindowPosition (NR::Point p);
241     void setWindowSize (gint w, gint h);
242     void setWindowTransient (void* p, int transient_policy=1);
243     Gtk::Window* getToplevel();
244     void presentWindow();
245     bool warnDialog (gchar *text);
246     void toggleRulers();
247     void toggleScrollbars();
248     void layoutWidget();
249     void destroyWidget();
250     void setToolboxFocusTo (gchar const* label);
251     void setToolboxAdjustmentValue (gchar const* id, double val);
252     void setToolboxSelectOneValue (gchar const* id, gint val);
253     bool isToolboxButtonActive (gchar const *id);
254     void updateNow();
255     void updateCanvasNow();
257     void enableInteraction();
258     void disableInteraction();
260     void setWaitingCursor();
261     void clearWaitingCursor();
263     void toggleColorProfAdjust();
265     void toggleGrids();
266     void toggleSnapping();
267     bool gridsEnabled() { return grids_visible; }
268     void showGrids(bool show, bool dirty_document = true);
270     bool is_iconified();
271     bool is_maximized();
272     bool is_fullscreen();
274     void iconify();
275     void maximize();
276     void fullscreen();
278     void registerEditWidget (Inkscape::UI::View::EditWidgetInterface *widget)
279     { _widget = widget; }
281     NR::Matrix w2d() const; //transformation from window to desktop coordinates (used for zooming)
282     NR::Point w2d(NR::Point const &p) const;
283     NR::Point d2w(NR::Point const &p) const;
284     NR::Matrix doc2dt() const;
285     NR::Point doc2dt(NR::Point const &p) const;
286     NR::Point dt2doc(NR::Point const &p) const;
288     virtual void setDocument (SPDocument* doc);
289     virtual bool shutdown();
290     virtual void mouseover() {}
291     virtual void mouseout() {}
293     virtual bool onDeleteUI (GdkEventAny*);
294     virtual bool onWindowStateEvent (GdkEventWindowState* event);
296 private:
297     Inkscape::UI::View::EditWidgetInterface       *_widget;
298     Inkscape::Application     *_inkscape;
299     Inkscape::MessageContext  *_guides_message_context;
300     bool _active;
301     NR::Matrix _w2d;
302     NR::Matrix _d2w;
303     NR::Matrix _doc2dt;
305     bool grids_visible; /* don't set this variable directly, use the method below */
306     void set_grids_visible(bool visible);
308     void push_current_zoom (GList**);
310     sigc::signal<void,SPDesktop*,SPDocument*>     _document_replaced_signal;
311     sigc::signal<void>                 _activate_signal;
312     sigc::signal<void>                 _deactivate_signal;
313     sigc::signal<void,SPDesktop*,SPEventContext*> _event_context_changed_signal;
314     sigc::signal<void, gpointer>       _tool_subselection_changed;
316     sigc::connection _activate_connection;
317     sigc::connection _deactivate_connection;
318     sigc::connection _sel_modified_connection;
319     sigc::connection _sel_changed_connection;
320     sigc::connection _reconstruction_start_connection;
321     sigc::connection _reconstruction_finish_connection;
322     sigc::connection _commit_connection;
323     sigc::connection _modified_connection;
325     virtual void onPositionSet (double, double);
326     virtual void onResized (double, double);
327     virtual void onRedrawRequested();
328     virtual void onStatusMessage (Inkscape::MessageType type, gchar const *message);
329     virtual void onDocumentURISet (gchar const* uri);
330     virtual void onDocumentResized (double, double);
332     static void _onActivate (SPDesktop* dt);
333     static void _onDeactivate (SPDesktop* dt);
334     static void _onSelectionModified (Inkscape::Selection *selection, guint flags, SPDesktop *dt);
335 };
337 #endif // SEEN_SP_DESKTOP_H
339 /*
340   Local Variables:
341   mode:c++
342   c-file-style:"stroustrup"
343   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
344   indent-tabs-mode:nil
345   fill-column:99
346   End:
347 */
348 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :