src/desktop.h

   1 #ifndef SEEN_SP_DESKTOP_H
   2 #define SEEN_SP_DESKTOP_H
   3
   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  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif
  27
  28 #include <gdk/gdkevents.h>
  29 #include <gtk/gtktypeutils.h>
  30 #include <sigc++/sigc++.h>
  31
  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"
  37
  38 #include "display/rendermode.h"
  39
  40 class NRRect;
  41 class SPCSSAttr;
  42 struct _GtkWidget;
  43 typedef struct _GtkWidget GtkWidget;
  44 struct SPCanvas;
  45 struct SPCanvasItem;
  46 struct SPCanvasGroup;
  47 struct SPEventContext;
  48 struct SPItem;
  49 struct SPNamedView;
  50 struct SPObject;
  51 struct SPStyle;
  52
  53 namespace Gtk
  54 {
  55   class Window;
  56 }
  57
  58 typedef int sp_verb_t;
  59
  60
  61
  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   namespace Display {
  78       class TemporaryItemList;
  79       class TemporaryItem;
  80       class SnapIndicator;
  81   }
  82 }
  83
  84 /**
  85  * Editable view.
  86  *
  87  * @see \ref desktop-handles.h for desktop macros.
  88  */
  89 struct SPDesktop : public Inkscape::UI::View::View
  90 {
  91     Inkscape::UI::Dialog::DialogManager *_dlg_mgr;
  92     SPNamedView               *namedview;
  93     SPCanvas                  *canvas;
  94     /// current selection; will never generally be NULL
  95     Inkscape::Selection       *selection;
  96     SPEventContext            *event_context;
  97     Inkscape::LayerManager    *layer_manager;
  98     Inkscape::EventLog        *event_log;
  99
 100     Inkscape::Display::TemporaryItemList *temporary_item_list;
 101     Inkscape::Display::SnapIndicator *snapindicator;
 102
 103     SPCanvasItem  *acetate;
 104     SPCanvasGroup *main;
 105     SPCanvasGroup *gridgroup;
 106     SPCanvasGroup *guides;
 107     SPCanvasItem  *drawing;
 108     SPCanvasGroup *sketch;
 109     SPCanvasGroup *controls;
 110     SPCanvasGroup *tempgroup;   ///< contains temporary canvas items
 111     SPCanvasItem  *table;       ///< outside-of-page background
 112     SPCanvasItem  *page;        ///< page background
 113     SPCanvasItem  *page_border; ///< page border
 114     SPCSSAttr     *current;     ///< current style
 115
 116     GList *zooms_past;
 117     GList *zooms_future;
 118     unsigned int dkey;
 119     unsigned int number;
 120     guint window_state;
 121     unsigned int interaction_disabled_counter;
 122     bool waiting_cursor;
 123
 124     /// \todo fixme: This has to be implemented in different way */
 125     guint guides_active : 1;
 126
 127     // storage for selected dragger used by GrDrag as it's
 128     // created and deleted by tools
 129     SPItem *gr_item;
 130     guint  gr_point_type;
 131     guint  gr_point_i;
 132     bool   gr_fill_or_stroke;
 133
 134
 135     Inkscape::ObjectHierarchy *_layer_hierarchy;
 136     gchar * _reconstruction_old_layer_id;
 137
 138     sigc::signal<void, sp_verb_t>      _tool_changed;
 139     sigc::signal<void, SPObject *>     _layer_changed_signal;
 140     sigc::signal<bool, const SPCSSAttr *>::accumulated<StopOnTrue> _set_style_signal;
 141     sigc::signal<int, SPStyle *, int>::accumulated<StopOnNonZero> _query_style_signal;
 142     sigc::connection connectDocumentReplaced (const sigc::slot<void,SPDesktop*,SPDocument*> & slot)
 143     {
 144         return _document_replaced_signal.connect (slot);
 145     }
 146
 147     sigc::connection connectEventContextChanged (const sigc::slot<void,SPDesktop*,SPEventContext*> & slot)
 148     {
 149         return _event_context_changed_signal.connect (slot);
 150     }
 151     sigc::connection connectSetStyle (const sigc::slot<bool, const SPCSSAttr *> & slot)
 152     {
 153         return _set_style_signal.connect (slot);
 154     }
 155     sigc::connection connectQueryStyle (const sigc::slot<int, SPStyle *, int> & slot)
 156     {
 157         return _query_style_signal.connect (slot);
 158     }
 159      // subselection is some sort of selection which is specific to the tool, such as a handle in gradient tool, or a text selection
 160     sigc::connection connectToolSubselectionChanged(const sigc::slot<void, gpointer> & slot) {
 161         return _tool_subselection_changed.connect(slot);
 162     }
 163     void emitToolSubselectionChanged(gpointer data);
 164     sigc::connection connectCurrentLayerChanged(const sigc::slot<void, SPObject *> & slot) {
 165         return _layer_changed_signal.connect(slot);
 166     }
 167
 168     // Whiteboard changes
 169
 170 #ifdef WITH_INKBOARD
 171     Inkscape::Whiteboard::SessionManager* whiteboard_session_manager() {
 172         return _whiteboard_session_manager;
 173     }
 174
 175     Inkscape::Whiteboard::SessionManager* _whiteboard_session_manager;
 176 #endif
 177
 178     SPDesktop();
 179     void init (SPNamedView* nv, SPCanvas* canvas);
 180     virtual ~SPDesktop();
 181     void destroy();
 182
 183     Inkscape::MessageContext *guidesMessageContext() const {
 184         return _guides_message_context;
 185     }
 186
 187     Inkscape::Display::TemporaryItem * add_temporary_canvasitem (SPCanvasItem *item, guint lifetime);
 188     void remove_temporary_canvasitem (Inkscape::Display::TemporaryItem * tempitem);
 189
 190     void setDisplayModeNormal();
 191     void setDisplayModeOutline();
 192     void displayModeToggle();
 193     Inkscape::RenderMode displayMode;
 194     Inkscape::RenderMode getMode() const { return displayMode; }
 195
 196     Inkscape::UI::Widget::Dock* getDock() { return _widget->getDock(); }
 197
 198     void set_active (bool new_active);
 199     SPObject *currentRoot() const;
 200     SPObject *currentLayer() const;
 201     void setCurrentLayer(SPObject *object);
 202     SPObject *layerForObject(SPObject *object);
 203     bool isLayer(SPObject *object) const;
 204     bool isWithinViewport(SPItem *item) const;
 205     bool itemIsHidden(SPItem const *item) const;
 206
 207     void activate_guides (bool activate);
 208     void change_document (SPDocument *document);
 209
 210     void set_event_context (GtkType type, const gchar *config);
 211     void push_event_context (GtkType type, const gchar *config, unsigned int key);
 212
 213     void set_coordinate_status (NR::Point p);
 214     SPItem *item_from_list_at_point_bottom (const GSList *list, NR::Point const p) const;
 215     SPItem *item_at_point (NR::Point const p, bool into_groups, SPItem *upto = NULL) const;
 216     SPItem *group_at_point (NR::Point const p) const;
 217     NR::Point point() const;
 218
 219     NR::Rect get_display_area() const;
 220     void set_display_area (double x0, double y0, double x1, double y1, double border, bool log = true);
 221     void set_display_area(NR::Rect const &a, NR::Coord border, bool log = true);
 222     void zoom_absolute (double cx, double cy, double zoom);
 223     void zoom_relative (double cx, double cy, double zoom);
 224     void zoom_absolute_keep_point (double cx, double cy, double px, double py, double zoom);
 225     void zoom_relative_keep_point (double cx, double cy, double zoom);
 226     void zoom_relative_keep_point (NR::Point const &c, double const zoom)
 227     {
 228             using NR::X;
 229             using NR::Y;
 230             zoom_relative_keep_point (c[X], c[Y], zoom);
 231     }
 232
 233     void zoom_page();
 234     void zoom_page_width();
 235     void zoom_drawing();
 236     void zoom_selection();
 237     void zoom_grab_focus();
 238     double current_zoom() const  { return NR::expansion(_d2w); }
 239     void prev_zoom();
 240     void next_zoom();
 241
 242     bool scroll_to_point (NR::Point const *s_dt, gdouble autoscrollspeed = 0);
 243     void scroll_world (double dx, double dy, bool is_scrolling = false);
 244     void scroll_world (NR::Point const scroll, bool is_scrolling = false)
 245     {
 246         using NR::X;
 247         using NR::Y;
 248         scroll_world(scroll[X], scroll[Y], is_scrolling);
 249     }
 250
 251     void getWindowGeometry (gint &x, gint &y, gint &w, gint &h);
 252     void setWindowPosition (NR::Point p);
 253     void setWindowSize (gint w, gint h);
 254     void setWindowTransient (void* p, int transient_policy=1);
 255     Gtk::Window* getToplevel();
 256     void presentWindow();
 257     bool warnDialog (gchar *text);
 258     void toggleRulers();
 259     void toggleScrollbars();
 260     void layoutWidget();
 261     void destroyWidget();
 262     void setToolboxFocusTo (gchar const* label);
 263     void setToolboxAdjustmentValue (gchar const* id, double val);
 264     void setToolboxSelectOneValue (gchar const* id, gint val);
 265     bool isToolboxButtonActive (gchar const *id);
 266     void updateNow();
 267     void updateCanvasNow();
 268
 269     void enableInteraction();
 270     void disableInteraction();
 271
 272     void setWaitingCursor();
 273     void clearWaitingCursor();
 274
 275     void toggleColorProfAdjust();
 276
 277     void toggleGrids();
 278     void toggleSnapping();
 279     bool gridsEnabled() { return grids_visible; }
 280     void showGrids(bool show, bool dirty_document = true);
 281
 282     bool is_iconified();
 283     bool is_maximized();
 284     bool is_fullscreen();
 285
 286     void iconify();
 287     void maximize();
 288     void fullscreen();
 289
 290     void registerEditWidget (Inkscape::UI::View::EditWidgetInterface *widget)
 291     { _widget = widget; }
 292
 293     NR::Matrix w2d() const; //transformation from window to desktop coordinates (used for zooming)
 294     NR::Point w2d(NR::Point const &p) const;
 295     NR::Point d2w(NR::Point const &p) const;
 296     NR::Matrix doc2dt() const;
 297     NR::Point doc2dt(NR::Point const &p) const;
 298     NR::Point dt2doc(NR::Point const &p) const;
 299
 300     virtual void setDocument (SPDocument* doc);
 301     virtual bool shutdown();
 302     virtual void mouseover() {}
 303     virtual void mouseout() {}
 304
 305     virtual bool onDeleteUI (GdkEventAny*);
 306     virtual bool onWindowStateEvent (GdkEventWindowState* event);
 307
 308 private:
 309     Inkscape::UI::View::EditWidgetInterface       *_widget;
 310     Inkscape::Application     *_inkscape;
 311     Inkscape::MessageContext  *_guides_message_context;
 312     bool _active;
 313     NR::Matrix _w2d;
 314     NR::Matrix _d2w;
 315     NR::Matrix _doc2dt;
 316
 317     bool grids_visible; /* don't set this variable directly, use the method below */
 318     void set_grids_visible(bool visible);
 319
 320     void push_current_zoom (GList**);
 321
 322     sigc::signal<void,SPDesktop*,SPDocument*>     _document_replaced_signal;
 323     sigc::signal<void>                 _activate_signal;
 324     sigc::signal<void>                 _deactivate_signal;
 325     sigc::signal<void,SPDesktop*,SPEventContext*> _event_context_changed_signal;
 326     sigc::signal<void, gpointer>       _tool_subselection_changed;
 327
 328     sigc::connection _activate_connection;
 329     sigc::connection _deactivate_connection;
 330     sigc::connection _sel_modified_connection;
 331     sigc::connection _sel_changed_connection;
 332     sigc::connection _reconstruction_start_connection;
 333     sigc::connection _reconstruction_finish_connection;
 334     sigc::connection _commit_connection;
 335     sigc::connection _modified_connection;
 336
 337     virtual void onPositionSet (double, double);
 338     virtual void onResized (double, double);
 339     virtual void onRedrawRequested();
 340     virtual void onStatusMessage (Inkscape::MessageType type, gchar const *message);
 341     virtual void onDocumentURISet (gchar const* uri);
 342     virtual void onDocumentResized (double, double);
 343
 344     static void _onActivate (SPDesktop* dt);
 345     static void _onDeactivate (SPDesktop* dt);
 346     static void _onSelectionModified (Inkscape::Selection *selection, guint flags, SPDesktop *dt);
 347 };
 348
 349 #endif // SEEN_SP_DESKTOP_H
 350
 351 /*
 352   Local Variables:
 353   mode:c++
 354   c-file-style:"stroustrup"
 355   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 356   indent-tabs-mode:nil
 357   fill-column:99
 358   End:
 359 */
 360 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :