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