Code

3a86238526e9901b7d33b4f48cce27356e9648c2
[inkscape.git] / src / ui / dialog / document-properties.cpp
1 /** \file
2  *
3  * Document properties dialog, Gtkmm-style
4  *
5  * Authors:
6  *   bulia byak <buliabyak@users.sf.net>
7  *   Bryce W. Harrington <bryce@bryceharrington.org>
8  *   Lauris Kaplinski <lauris@kaplinski.com>
9  *   Jon Phillips <jon@rejon.org>
10  *   Ralf Stephan <ralf@ark.in-berlin.de> (Gtkmm)
11  *
12  * Copyright (C) 2006-2007 Johan Engelen  <johan@shouraizou.nl>
13  * Copyright (C) 2000 - 2005 Authors
14  *
15  * Released under GNU GPL.  Read the file 'COPYING' for more information
16  */
18 #ifdef HAVE_CONFIG_H
19 # include <config.h>
20 #endif
24 #include <gtkmm.h>
25 #include "ui/widget/color-picker.h"
26 #include "ui/widget/scalar-unit.h"
28 #include "xml/node-event-vector.h"
29 #include "helper/units.h"
30 #include "prefs-utils.h"
32 #include "inkscape.h"
33 #include "verbs.h"
34 #include "document.h"
35 #include "desktop-handles.h"
36 #include "desktop.h"
37 #include "sp-namedview.h"
39 #include "document-properties.h"
41 #include "display/canvas-grid.h"
43 using std::pair;
45 namespace Inkscape {
46 namespace UI {
47 namespace Dialog {
49 #define SPACE_SIZE_X 15
50 #define SPACE_SIZE_Y 10
52 //===================================================
54 //---------------------------------------------------
56 static DocumentProperties *_instance = 0;
58 static void on_child_added(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data);
59 static void on_child_removed(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data);
60 static void on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer);
61 static void on_doc_replaced (SPDesktop* dt, SPDocument* doc);
62 static void on_activate_desktop (Inkscape::Application *, SPDesktop* dt, void*);
63 static void on_deactivate_desktop (Inkscape::Application *, SPDesktop* dt, void*);
65 static Inkscape::XML::NodeEventVector const _repr_events = {
66     on_child_added, /* child_added */
67     on_child_removed, /* child_removed */
68     on_repr_attr_changed,
69     NULL, /* content_changed */
70     NULL  /* order_changed */
71 };
74 DocumentProperties*
75 DocumentProperties::create()
76 {
77     if (_instance) return _instance;
78     _instance = new DocumentProperties;
79     _instance->init();
80     return _instance;
81 }
83 void
84 DocumentProperties::destroy()
85 {
86     if (_instance)
87     {
88         delete _instance;
89         _instance = 0;
90     }
91 }
93 DocumentProperties::DocumentProperties()
94     : Dialog ("dialogs.documentoptions", SP_VERB_DIALOG_NAMEDVIEW),
95       _page_page(1, 1), _page_guides(1, 1),
96       _page_snap(1, 1), _page_grids(1, 1),
97       _grids_button_new(_("_New"), _("Create new grid.")),
98       _grids_button_remove(_("_Remove"), _("Remove selected grid.")),
99       _prefs_path("dialogs.documentoptions")
101     set_resizable (false);
102     _tt.enable();
103     get_vbox()->set_spacing (4);
104     get_vbox()->pack_start (_notebook, true, true);
106     _notebook.append_page(_page_page,      _("Page"));
107     _notebook.append_page(_page_guides,    _("Guides"));
108     _notebook.append_page(_page_grids,     _("Grids"));
109     _notebook.append_page(_page_snap,      _("Snapping"));
111     build_page();
112     build_guides();
113     build_gridspage();
114     build_snap();
116     _grids_button_new.signal_clicked().connect(sigc::mem_fun(*this, &DocumentProperties::onNewGrid));
117     _grids_button_remove.signal_clicked().connect(sigc::mem_fun(*this, &DocumentProperties::onRemoveGrid));
120 void
121 DocumentProperties::init()
123     update();
125     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(SP_ACTIVE_DESKTOP));
126     repr->addListener (&_repr_events, this);
127     Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(SP_ACTIVE_DESKTOP)->root);
128     root->addListener (&_repr_events, this);
130     _doc_replaced_connection = SP_ACTIVE_DESKTOP->connectDocumentReplaced (sigc::ptr_fun (on_doc_replaced));
132     g_signal_connect(G_OBJECT(INKSCAPE), "activate_desktop",
133                      G_CALLBACK(on_activate_desktop), 0);
135     g_signal_connect(G_OBJECT(INKSCAPE), "deactivate_desktop",
136                      G_CALLBACK(on_deactivate_desktop), 0);
138     show_all_children();
140     present();
143 DocumentProperties::~DocumentProperties()
145     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(SP_ACTIVE_DESKTOP));
146     repr->removeListenerByData (this);
147     Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(SP_ACTIVE_DESKTOP)->root);
148     root->removeListenerByData (this);
149     _doc_replaced_connection.disconnect();
152 //========================================================================
154 /**
155  * Helper function that attaches widgets in a 3xn table. The widgets come in an
156  * array that has two entries per table row. The two entries code for four
157  * possible cases: (0,0) means insert space in first column; (0, non-0) means
158  * widget in columns 2-3; (non-0, 0) means label in columns 1-3; and
159  * (non-0, non-0) means two widgets in columns 2 and 3.
160 **/
161 inline void
162 attach_all(Gtk::Table &table, Gtk::Widget *const arr[], unsigned const n, int start = 0)
164     for (unsigned i = 0, r = start; i < n; i += 2)
165     {
166         if (arr[i] && arr[i+1])
167         {
168             table.attach(*arr[i],   1, 2, r, r+1,
169                       Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
170             table.attach(*arr[i+1], 2, 3, r, r+1,
171                       Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
172         }
173         else
174         {
175             if (arr[i+1])
176                 table.attach(*arr[i+1], 1, 3, r, r+1,
177                       Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
178             else if (arr[i])
179             {
180                 Gtk::Label& label = reinterpret_cast<Gtk::Label&>(*arr[i]);
181                 label.set_alignment (0.0);
182                 table.attach (label, 0, 3, r, r+1,
183                       Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
184             }
185             else
186             {
187                 Gtk::HBox *space = manage (new Gtk::HBox);
188                 space->set_size_request (SPACE_SIZE_X, SPACE_SIZE_Y);
189                 table.attach (*space, 0, 1, r, r+1,
190                       (Gtk::AttachOptions)0, (Gtk::AttachOptions)0,0,0);
191             }
192         }
193         ++r;
194     }
197 void
198 DocumentProperties::build_page()
200     _page_page.show();
202     _rcp_bg.init (_("Back_ground:"), _("Background color"), _("Color and transparency of the page background (also used for bitmap export)"),
203                    "pagecolor", "inkscape:pageopacity", _wr);
204     _rcb_canb.init (_("Show page _border"), _("If set, rectangular page border is shown"), "showborder", _wr, false);
205     _rcb_bord.init (_("Border on _top of drawing"), _("If set, border is always on top of the drawing"), "borderlayer", _wr, false);
206     _rcp_bord.init (_("Border _color:"), _("Page border color"),
207                     _("Color of the page border"),
208                     "bordercolor", "borderopacity", _wr);
209     _rcb_shad.init (_("_Show border shadow"), _("If set, page border shows a shadow on its right and lower side"), "inkscape:showpageshadow", _wr, false);
210     _rum_deflt.init (_("Default _units:"), "inkscape:document-units", _wr);
212     Gtk::Label* label_gen = manage (new Gtk::Label);
213     label_gen->set_markup (_("<b>General</b>"));
214     Gtk::Label* label_bor = manage (new Gtk::Label);
215     label_bor->set_markup (_("<b>Border</b>"));
216     Gtk::Label *label_for = manage (new Gtk::Label);
217     label_for->set_markup (_("<b>Format</b>"));
218     _page_sizer.init (_wr);
220     Gtk::Widget *const widget_array[] =
221     {
222         label_gen,         0,
223         _rum_deflt._label, _rum_deflt._sel,
224         _rcp_bg._label,    _rcp_bg._cp,
225         0,                 0,
226         label_for,         0,
227         0,                 &_page_sizer,
228         0,                 0,
229         label_bor,         0,
230         0,                 _rcb_canb._button,
231         0,                 _rcb_bord._button,
232         0,                 _rcb_shad._button,
233         _rcp_bord._label,  _rcp_bord._cp,
234     };
236     attach_all(_page_page.table(), widget_array, G_N_ELEMENTS(widget_array));
239 void
240 DocumentProperties::build_guides()
242     _page_guides.show();
244     _rcb_sgui.init (_("Show _guides"), _("Show or hide guides"), "showguides", _wr);
245     _rcp_gui.init (_("Guide co_lor:"), _("Guideline color"),
246                    _("Color of guidelines"), "guidecolor", "guideopacity", _wr);
247     _rcp_hgui.init (_("_Highlight color:"), _("Highlighted guideline color"),
248                     _("Color of a guideline when it is under mouse"),
249                     "guidehicolor", "guidehiopacity", _wr);
250     Gtk::Label *label_gui = manage (new Gtk::Label);
251     label_gui->set_markup (_("<b>Guides</b>"));
253     Gtk::Widget *const widget_array[] =
254     {
255         label_gui,       0,
256         0,               _rcb_sgui._button,
257         _rcp_gui._label, _rcp_gui._cp,
258         _rcp_hgui._label, _rcp_hgui._cp,
259     };
261     attach_all(_page_guides.table(), widget_array, G_N_ELEMENTS(widget_array));
264 void
265 DocumentProperties::build_snap()
267     _page_snap.show();
268         _rcbsnbb.init (_("Snap bounding _boxes"),
269                 _("Snap bounding box corners to grid lines, to guides, and to other bounding boxes"),
270                 "inkscape:snap-bbox", _wr);
271     _rcbsnn.init (_("Snap _nodes"),
272                 _("Snap nodes to grid lines, to guides, to paths, and to other nodes"),
273                 "inkscape:snap-nodes", _wr);
274     _rsu_sno.init (_("Snap s_ensitivity:"), _("Always snap"),
275                   _("Snapping distance, in screen pixels, for snapping to objects"),
276                   _("If set, objects snap to the nearest object, regardless of distance"),
277                   "objecttolerance", _wr);
278     _rsu_sn.init (_("Snap sens_itivity:"), _("Always snap"),
279                   _("Snapping distance, in screen pixels, for snapping to grid"),
280                   _("If set, objects snap to the nearest grid line, regardless of distance"),
281                   "gridtolerance", _wr);
282     _rsu_gusn.init (_("Snap sensiti_vity:"), _("Always snap"),
283                 _("Snapping distance, in screen pixels, for snapping to guides"),
284                 _("If set, objects snap to the nearest guide, regardless of distance"),
285                 "guidetolerance", _wr);
286     Gtk::Label *label_g = manage (new Gtk::Label);
287     label_g->set_markup (_("<b>General</b>"));
288     Gtk::Label *label_o = manage (new Gtk::Label);
289     label_o->set_markup (_("<b>Object Snapping</b>"));
290     Gtk::Label *label_gr = manage (new Gtk::Label);
291     label_gr->set_markup (_("<b>Grid Snapping</b>"));
292     Gtk::Label *label_gu = manage (new Gtk::Label);
293     label_gu->set_markup (_("<b>Guide Snapping</b>"));
295     Gtk::Widget *const array[] =
296     {
297         label_g,            0,
298         0,                  _rcbsnbb._button,
299         0,                  _rcbsnn._button,        
300         label_o,            0,
301         0,                  _rsu_sno._vbox,
302         0, 0,
303         label_gr,           0,
304         0,                  _rsu_sn._vbox,
305         0, 0,
306         label_gu,               0,
307         0,                      _rsu_gusn._vbox,
308     };
310     attach_all(_page_snap.table(), array, G_N_ELEMENTS(array));
311  }
313 /**
314 * Called for _updating_ the dialog (e.g. when a new grid was manually added in XML)
315 */
316 void
317 DocumentProperties::update_gridspage()
319     SPDesktop *dt = SP_ACTIVE_DESKTOP;
320     SPNamedView *nv = sp_desktop_namedview(dt);
322     //remove all tabs
323     while (_grids_notebook.get_current_page() != -1) {
324         _grids_notebook.remove_page(-1);
325     }
327     //add tabs
328     for (GSList const * l = nv->grids; l != NULL; l = l->next) {
329         Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
330         _grids_notebook.append_page(grid->getWidget(), grid->repr->attribute("id"));
332     }
333     _grids_notebook.show_all();
335     _page_grids.table().resize_children();
338 /**
339  * Build grid page of dialog.
340  */
341 void
342 DocumentProperties::build_gridspage()
344     _page_grids.show();
346     /// \todo FIXME: gray out snapping when grid is off.
347     /// Dissenting view: you want snapping without grid.
349     SPDesktop *dt = SP_ACTIVE_DESKTOP;
350     SPNamedView *nv = sp_desktop_namedview(dt);
352     Gtk::Label* label_crea = manage (new Gtk::Label);
353     label_crea->set_markup (_("<b>Creation</b>"));
354     Gtk::Label* label_crea_type = manage (new Gtk::Label);
355     label_crea_type->set_markup (_("Gridtype"));
356     
357     for (gint t = 0; t <= GRID_MAXTYPENR; t++) {
358         _grids_combo_gridtype.append_text( CanvasGrid::getName( (GridType) t ) );
359     }
360     _grids_combo_gridtype.set_active_text( CanvasGrid::getName(GRID_RECTANGULAR) );
361     
362     Gtk::Label* label_def = manage (new Gtk::Label);
363     label_def->set_markup (_("<b>Defined grids</b>"));
365     for (GSList const * l = nv->grids; l != NULL; l = l->next) {
366         Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
367         _grids_notebook.append_page(grid->getWidget(), grid->repr->attribute("id"));
368     }
370     Gtk::Widget *const widget_array[] =
371     {
372         label_crea, 0,
373         label_crea_type, (Gtk::Widget*) &_grids_combo_gridtype,
374         (Gtk::Widget*) &_grids_button_new,         (Gtk::Widget*) &_grids_button_remove, 
375         label_def,         0
376     };
377     attach_all(_page_grids.table(), widget_array, G_N_ELEMENTS(widget_array));
378     _page_grids.table().attach(_grids_notebook, 0, 3, 4, 5,
379                                Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
384 /**
385  * Update dialog widgets from desktop. Also call updateWidget routines of the grids.
386  */
387 void
388 DocumentProperties::update()
390     if (_wr.isUpdating()) return;
392     SPDesktop *dt = SP_ACTIVE_DESKTOP;
393     SPNamedView *nv = sp_desktop_namedview(dt);
395     _wr.setUpdating (true);
396     set_sensitive (true);
398     //-----------------------------------------------------------page page
399     _rcp_bg.setRgba32 (nv->pagecolor);
400     _rcb_canb.setActive (nv->showborder);
401     _rcb_bord.setActive (nv->borderlayer == SP_BORDER_LAYER_TOP);
402     _rcp_bord.setRgba32 (nv->bordercolor);
403     _rcb_shad.setActive (nv->showpageshadow);
405     if (nv->doc_units)
406         _rum_deflt.setUnit (nv->doc_units);
408     double const doc_w_px = sp_document_width(sp_desktop_document(dt));
409     double const doc_h_px = sp_document_height(sp_desktop_document(dt));
410     _page_sizer.setDim (doc_w_px, doc_h_px);
412     //-----------------------------------------------------------guide
413     _rcb_sgui.setActive (nv->showguides);
414     _rcp_gui.setRgba32 (nv->guidecolor);
415     _rcp_hgui.setRgba32 (nv->guidehicolor);
417     //-----------------------------------------------------------snap
418     _rcbsnbb.setActive (nv->snap_manager.getSnapModeBBox());
419     _rcbsnn.setActive (nv->snap_manager.getSnapModeNodes());
420     _rsu_sno.setValue (nv->objecttolerance);
422     _rsu_sn.setValue (nv->gridtolerance);
424     _rsu_gusn.setValue (nv->guidetolerance);
426     //-----------------------------------------------------------grids page
428     update_gridspage();
430     _wr.setUpdating (false);
433 //--------------------------------------------------------------------
435 void
436 DocumentProperties::on_response (int id)
438     if (id == Gtk::RESPONSE_DELETE_EVENT || id == Gtk::RESPONSE_CLOSE)
439     {
440         _rcp_bg.closeWindow();
441         _rcp_bord.closeWindow();
442         _rcp_gui.closeWindow();
443         _rcp_hgui.closeWindow();
444     }
446     if (id == Gtk::RESPONSE_CLOSE)
447         hide();
452 static void
453 on_child_added(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data)
455     if (!_instance)
456         return;
458     _instance->update_gridspage();
461 static void
462 on_child_removed(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data)
464     if (!_instance)
465         return;
467     _instance->update_gridspage();
472 /**
473  * Called when XML node attribute changed; updates dialog widgets.
474  */
475 static void
476 on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer)
478     if (!_instance)
479         return;
481     _instance->update();
484 static void
485 on_activate_desktop (Inkscape::Application *, SPDesktop* dt, void*)
487     if (!_instance)
488         return;
490     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(SP_ACTIVE_DESKTOP));
491     repr->addListener (&_repr_events, _instance);
492     Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(SP_ACTIVE_DESKTOP)->root);
493     root->addListener (&_repr_events, _instance);
494     _instance->_doc_replaced_connection = SP_ACTIVE_DESKTOP->connectDocumentReplaced (sigc::ptr_fun (on_doc_replaced));
495     _instance->update();
498 static void
499 on_deactivate_desktop (Inkscape::Application *, SPDesktop* dt, void*)
501     if (!_instance)
502         return;
504     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(SP_ACTIVE_DESKTOP));
505     repr->removeListenerByData (_instance);
506     Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(SP_ACTIVE_DESKTOP)->root);
507     root->removeListenerByData (_instance);
508     _instance->_doc_replaced_connection.disconnect();
511 static void
512 on_doc_replaced (SPDesktop* dt, SPDocument* doc)
514     if (!_instance)
515         return;
517     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(dt));
518     repr->addListener (&_repr_events, _instance);
519     Inkscape::XML::Node *root = SP_OBJECT_REPR(doc->root);
520     root->addListener (&_repr_events, _instance);
521     _instance->update();
527 /*########################################################################
528 # BUTTON CLICK HANDLERS    (callbacks)
529 ########################################################################*/
531 void
532 DocumentProperties::onNewGrid()
534     SPDesktop *dt = SP_ACTIVE_DESKTOP;
535     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(dt));
536     SPDocument *doc = sp_desktop_document(dt);
538     Glib::ustring typestring = _grids_combo_gridtype.get_active_text();
539     CanvasGrid::writeNewGridToRepr(repr, doc, CanvasGrid::getGridTypeFromName(typestring.c_str()));
543 void
544 DocumentProperties::onRemoveGrid()
546     gint pagenum = _grids_notebook.get_current_page();
547     if (pagenum == -1) // no pages
548       return;
549       
550     Gtk::Widget *page = _grids_notebook.get_nth_page(pagenum);
551     if (!page) return;
552     
553     Glib::ustring tabtext = _grids_notebook.get_tab_label_text(*page);
554     
555     // find the grid with name tabtext (it's id) and delete that one.
556     SPDesktop *dt = SP_ACTIVE_DESKTOP;
557     SPNamedView *nv = sp_desktop_namedview(dt);
558     Inkscape::CanvasGrid * found_grid = NULL;
559     for (GSList const * l = nv->grids; l != NULL; l = l->next) {
560         Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
561         gchar const *idtext = grid->repr->attribute("id");
562         if ( !strcmp(tabtext.c_str(), idtext) ) {
563             found_grid = grid;
564             break; // break out of for-loop
565         }
566     }
567     if (found_grid) {
568         // delete the grid that corresponds with the selected tab
569         // when the grid is deleted from SVG, the SPNamedview handler automatically deletes the object, so found_grid becomes an invalid pointer!
570         found_grid->repr->parent()->removeChild(found_grid->repr);
571         sp_document_done(sp_desktop_document(dt), SP_VERB_DIALOG_NAMEDVIEW, _("Remove grid"));
572     }
576 } // namespace Dialog
577 } // namespace UI
578 } // namespace Inkscape
580 /*
581   Local Variables:
582   mode:c++
583   c-file-style:"stroustrup"
584   c-file-offsets:((innamespace . 0)(inline-open . 0))
585   indent-tabs-mode:nilu
586   fill-column:99
587   End:
588 */
589 // vim: filetype=c++:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :