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  */
  17
  18 #ifdef HAVE_CONFIG_H
  19 # include <config.h>
  20 #endif
  21
  22
  23
  24 #include <gtkmm.h>
  25 #include "ui/widget/color-picker.h"
  26 #include "ui/widget/scalar-unit.h"
  27
  28 #include "xml/node-event-vector.h"
  29 #include "helper/units.h"
  30 #include "prefs-utils.h"
  31
  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"
  38
  39 #include "document-properties.h"
  40
  41 #include "display/canvas-grid.h"
  42
  43 using std::pair;
  44
  45 namespace Inkscape {
  46 namespace UI {
  47 namespace Dialog {
  48
  49 #define SPACE_SIZE_X 15
  50 #define SPACE_SIZE_Y 10
  51
  52 //===================================================
  53
  54 //---------------------------------------------------
  55
  56 static DocumentProperties *_instance = 0;
  57
  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*);
  64
  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 };
  72
  73
  74 DocumentProperties*
  75 DocumentProperties::create()
  76 {
  77     if (_instance) return _instance;
  78     _instance = new DocumentProperties;
  79     _instance->init();
  80     return _instance;
  81 }
  82
  83 void
  84 DocumentProperties::destroy()
  85 {
  86     if (_instance)
  87     {
  88         delete _instance;
  89         _instance = 0;
  90     }
  91 }
  92
  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")
 100 {
 101     set_resizable (false);
 102     _tt.enable();
 103     get_vbox()->set_spacing (4);
 104     get_vbox()->pack_start (_notebook, true, true);
 105
 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"));
 110
 111     build_page();
 112     build_guides();
 113     build_gridspage();
 114     build_snap();
 115
 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));
 118 }
 119
 120 void
 121 DocumentProperties::init()
 122 {
 123     update();
 124
 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);
 129
 130     _doc_replaced_connection = SP_ACTIVE_DESKTOP->connectDocumentReplaced (sigc::ptr_fun (on_doc_replaced));
 131
 132     g_signal_connect(G_OBJECT(INKSCAPE), "activate_desktop",
 133                      G_CALLBACK(on_activate_desktop), 0);
 134
 135     g_signal_connect(G_OBJECT(INKSCAPE), "deactivate_desktop",
 136                      G_CALLBACK(on_deactivate_desktop), 0);
 137
 138     show_all_children();
 139
 140     present();
 141 }
 142
 143 DocumentProperties::~DocumentProperties()
 144 {
 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();
 150 }
 151
 152 //========================================================================
 153
 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)
 163 {
 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     }
 195 }
 196
 197 void
 198 DocumentProperties::build_page()
 199 {
 200     _page_page.show();
 201
 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);
 211
 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);
 219
 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     };
 235
 236     attach_all(_page_page.table(), widget_array, G_N_ELEMENTS(widget_array));
 237 }
 238
 239 void
 240 DocumentProperties::build_guides()
 241 {
 242     _page_guides.show();
 243
 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>"));
 252
 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     };
 260
 261     attach_all(_page_guides.table(), widget_array, G_N_ELEMENTS(widget_array));
 262 }
 263
 264 void
 265 DocumentProperties::build_snap()
 266 {
 267     _page_snap.show();
 268
 269     _rcbsnop.init (_("Snap to object _paths"),
 270                 _("Snap to other object paths"),
 271                 "inkscape:object-paths", _wr);
 272     _rcbsnon.init (_("Snap to object _nodes"),
 273                 _("Snap to other object nodes"),
 274                 "inkscape:object-nodes", _wr);
 275     _rsu_sno.init (_("Snap s_ensitivity:"), _("Always snap"),
 276                   _("Snapping distance, in screen pixels, for snapping to objects"),
 277                   _("If set, objects snap to the nearest object, regardless of distance"),
 278                   "objecttolerance", _wr);
 279     _rsu_sn.init (_("Snap sens_itivity:"), _("Always snap"),
 280                   _("Snapping distance, in screen pixels, for snapping to grid"),
 281                   _("If set, objects snap to the nearest grid line, regardless of distance"),
 282                   "gridtolerance", _wr);
 283     _rsu_gusn.init (_("Snap sensiti_vity:"), _("Always snap"),
 284                 _("Snapping distance, in screen pixels, for snapping to guides"),
 285                 _("If set, objects snap to the nearest guide, regardless of distance"),
 286                 "guidetolerance", _wr);
 287     Gtk::Label *label_o = manage (new Gtk::Label);
 288     label_o->set_markup (_("<b>Object Snapping</b>"));
 289     Gtk::Label *label_gr = manage (new Gtk::Label);
 290     label_gr->set_markup (_("<b>Grid Snapping</b>"));
 291     Gtk::Label *label_gu = manage (new Gtk::Label);
 292     label_gu->set_markup (_("<b>Guide Snapping</b>"));
 293
 294     Gtk::Widget *const array[] =
 295     {
 296         label_o,            0,
 297         0,                  _rcbsnop._button,
 298         0,                  _rcbsnon._button,
 299         0,                  _rsu_sno._vbox,
 300         0, 0,
 301         label_gr,           0,
 302         0,                  _rsu_sn._vbox,
 303         0, 0,
 304         label_gu,         0,
 305         0,                _rsu_gusn._vbox,
 306     };
 307
 308     attach_all(_page_snap.table(), array, G_N_ELEMENTS(array));
 309  }
 310
 311 /**
 312 * Called for _updating_ the dialog (e.g. when a new grid was manually added in XML)
 313 */
 314 void
 315 DocumentProperties::update_gridspage()
 316 {
 317     SPDesktop *dt = SP_ACTIVE_DESKTOP;
 318     SPNamedView *nv = sp_desktop_namedview(dt);
 319
 320     //remove all tabs
 321     while (_grids_notebook.get_current_page() != -1) {
 322         _grids_notebook.remove_page(-1);
 323     }
 324
 325     //add tabs
 326     for (GSList const * l = nv->grids; l != NULL; l = l->next) {
 327         Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
 328         _grids_notebook.append_page(grid->getWidget(), grid->repr->attribute("id"));
 329
 330     }
 331     _grids_notebook.show_all();
 332
 333     _page_grids.table().resize_children();
 334 }
 335
 336 /**
 337  * Build grid page of dialog.
 338  */
 339 void
 340 DocumentProperties::build_gridspage()
 341 {
 342     _page_grids.show();
 343
 344     /// \todo FIXME: gray out snapping when grid is off.
 345     /// Dissenting view: you want snapping without grid.
 346
 347     SPDesktop *dt = SP_ACTIVE_DESKTOP;
 348     SPNamedView *nv = sp_desktop_namedview(dt);
 349
 350     Gtk::Label* label_crea = manage (new Gtk::Label);
 351     label_crea->set_markup (_("<b>Creation</b>"));
 352     Gtk::Label* label_crea_type = manage (new Gtk::Label);
 353     label_crea_type->set_markup (_("Gridtype"));
 354
 355     for (gint t = 0; t <= GRID_MAXTYPENR; t++) {
 356         _grids_combo_gridtype.append_text( CanvasGrid::getName( (GridType) t ) );
 357     }
 358     _grids_combo_gridtype.set_active_text( CanvasGrid::getName(GRID_RECTANGULAR) );
 359
 360     Gtk::Label* label_def = manage (new Gtk::Label);
 361     label_def->set_markup (_("<b>Defined grids</b>"));
 362
 363     for (GSList const * l = nv->grids; l != NULL; l = l->next) {
 364         Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
 365         _grids_notebook.append_page(grid->getWidget(), grid->repr->attribute("id"));
 366     }
 367
 368     Gtk::Widget *const widget_array[] =
 369     {
 370         label_crea, 0,
 371         label_crea_type, (Gtk::Widget*) &_grids_combo_gridtype,
 372         (Gtk::Widget*) &_grids_button_new,         (Gtk::Widget*) &_grids_button_remove,
 373         label_def,         0
 374     };
 375     attach_all(_page_grids.table(), widget_array, G_N_ELEMENTS(widget_array));
 376     _page_grids.table().attach(_grids_notebook, 0, 3, 4, 5,
 377                                Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
 378 }
 379
 380
 381
 382 /**
 383  * Update dialog widgets from desktop. Also call updateWidget routines of the grids.
 384  */
 385 void
 386 DocumentProperties::update()
 387 {
 388     if (_wr.isUpdating()) return;
 389
 390     SPDesktop *dt = SP_ACTIVE_DESKTOP;
 391     SPNamedView *nv = sp_desktop_namedview(dt);
 392
 393     _wr.setUpdating (true);
 394     set_sensitive (true);
 395
 396     //-----------------------------------------------------------page page
 397     _rcp_bg.setRgba32 (nv->pagecolor);
 398     _rcb_canb.setActive (nv->showborder);
 399     _rcb_bord.setActive (nv->borderlayer == SP_BORDER_LAYER_TOP);
 400     _rcp_bord.setRgba32 (nv->bordercolor);
 401     _rcb_shad.setActive (nv->showpageshadow);
 402
 403     if (nv->doc_units)
 404         _rum_deflt.setUnit (nv->doc_units);
 405
 406     double const doc_w_px = sp_document_width(sp_desktop_document(dt));
 407     double const doc_h_px = sp_document_height(sp_desktop_document(dt));
 408     _page_sizer.setDim (doc_w_px, doc_h_px);
 409
 410     //-----------------------------------------------------------guide
 411     _rcb_sgui.setActive (nv->showguides);
 412     _rcp_gui.setRgba32 (nv->guidecolor);
 413     _rcp_hgui.setRgba32 (nv->guidehicolor);
 414
 415     //-----------------------------------------------------------snap
 416     _rcbsnop.setActive (nv->snap_manager.object.getSnapToPaths());
 417     _rcbsnon.setActive (nv->snap_manager.object.getSnapToNodes());
 418     _rsu_sno.setValue (nv->objecttolerance);
 419
 420     _rsu_sn.setValue (nv->gridtolerance);
 421
 422     _rsu_gusn.setValue (nv->guidetolerance);
 423
 424     //-----------------------------------------------------------grids page
 425
 426     update_gridspage();
 427
 428     _wr.setUpdating (false);
 429 }
 430
 431 //--------------------------------------------------------------------
 432
 433 void
 434 DocumentProperties::on_response (int id)
 435 {
 436     if (id == Gtk::RESPONSE_DELETE_EVENT || id == Gtk::RESPONSE_CLOSE)
 437     {
 438         _rcp_bg.closeWindow();
 439         _rcp_bord.closeWindow();
 440         _rcp_gui.closeWindow();
 441         _rcp_hgui.closeWindow();
 442     }
 443
 444     if (id == Gtk::RESPONSE_CLOSE)
 445         hide();
 446 }
 447
 448
 449
 450 static void
 451 on_child_added(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data)
 452 {
 453     if (!_instance)
 454         return;
 455
 456     _instance->update_gridspage();
 457 }
 458
 459 static void
 460 on_child_removed(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data)
 461 {
 462     if (!_instance)
 463         return;
 464
 465     _instance->update_gridspage();
 466 }
 467
 468
 469
 470 /**
 471  * Called when XML node attribute changed; updates dialog widgets.
 472  */
 473 static void
 474 on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer)
 475 {
 476     if (!_instance)
 477         return;
 478
 479     _instance->update();
 480 }
 481
 482 static void
 483 on_activate_desktop (Inkscape::Application *, SPDesktop* dt, void*)
 484 {
 485     if (!_instance)
 486         return;
 487
 488     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(SP_ACTIVE_DESKTOP));
 489     repr->addListener (&_repr_events, _instance);
 490     Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(SP_ACTIVE_DESKTOP)->root);
 491     root->addListener (&_repr_events, _instance);
 492     _instance->_doc_replaced_connection = SP_ACTIVE_DESKTOP->connectDocumentReplaced (sigc::ptr_fun (on_doc_replaced));
 493     _instance->update();
 494 }
 495
 496 static void
 497 on_deactivate_desktop (Inkscape::Application *, SPDesktop* dt, void*)
 498 {
 499     if (!_instance)
 500         return;
 501
 502     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(SP_ACTIVE_DESKTOP));
 503     repr->removeListenerByData (_instance);
 504     Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(SP_ACTIVE_DESKTOP)->root);
 505     root->removeListenerByData (_instance);
 506     _instance->_doc_replaced_connection.disconnect();
 507 }
 508
 509 static void
 510 on_doc_replaced (SPDesktop* dt, SPDocument* doc)
 511 {
 512     if (!_instance)
 513         return;
 514
 515     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(dt));
 516     repr->addListener (&_repr_events, _instance);
 517     Inkscape::XML::Node *root = SP_OBJECT_REPR(doc->root);
 518     root->addListener (&_repr_events, _instance);
 519     _instance->update();
 520 }
 521
 522
 523
 524
 525 /*########################################################################
 526 # BUTTON CLICK HANDLERS    (callbacks)
 527 ########################################################################*/
 528
 529 void
 530 DocumentProperties::onNewGrid()
 531 {
 532     SPDesktop *dt = SP_ACTIVE_DESKTOP;
 533     Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(dt));
 534     SPDocument *doc = sp_desktop_document(dt);
 535
 536     Glib::ustring typestring = _grids_combo_gridtype.get_active_text();
 537     CanvasGrid::writeNewGridToRepr(repr, doc, CanvasGrid::getGridTypeFromName(typestring.c_str()));
 538 }
 539
 540
 541 void
 542 DocumentProperties::onRemoveGrid()
 543 {
 544     gint pagenum = _grids_notebook.get_current_page();
 545     if (pagenum == -1) // no pages
 546       return;
 547
 548     Gtk::Widget *page = _grids_notebook.get_nth_page(pagenum);
 549     if (!page) return;
 550
 551     Glib::ustring tabtext = _grids_notebook.get_tab_label_text(*page);
 552
 553     // find the grid with name tabtext (it's id) and delete that one.
 554     SPDesktop *dt = SP_ACTIVE_DESKTOP;
 555     SPNamedView *nv = sp_desktop_namedview(dt);
 556     Inkscape::CanvasGrid * found_grid = NULL;
 557     for (GSList const * l = nv->grids; l != NULL; l = l->next) {
 558         Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
 559         gchar const *idtext = grid->repr->attribute("id");
 560         if ( !strcmp(tabtext.c_str(), idtext) ) {
 561             found_grid = grid;
 562             break; // break out of for-loop
 563         }
 564     }
 565     if (found_grid) {
 566         // delete the grid that corresponds with the selected tab
 567         // when the grid is deleted from SVG, the SPNamedview handler automatically deletes the object, so found_grid becomes an invalid pointer!
 568         found_grid->repr->parent()->removeChild(found_grid->repr);
 569         sp_document_done(sp_desktop_document(dt), SP_VERB_DIALOG_NAMEDVIEW, _("Remove grid"));
 570     }
 571 }
 572
 573
 574 } // namespace Dialog
 575 } // namespace UI
 576 } // namespace Inkscape
 577
 578 /*
 579   Local Variables:
 580   mode:c++
 581   c-file-style:"stroustrup"
 582   c-file-offsets:((innamespace . 0)(inline-open . 0))
 583   indent-tabs-mode:nilu
 584   fill-column:99
 585   End:
 586 */
 587 // vim: filetype=c++:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :