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