document-properties.cpp revision de19d0a8c684298be714d18c991965b370707ed8
/** \file
*
* Document properties dialog, Gtkmm-style
*
* Authors:
* bulia byak <buliabyak@users.sf.net>
* Bryce W. Harrington <bryce@bryceharrington.org>
* Lauris Kaplinski <lauris@kaplinski.com>
* Jon Phillips <jon@rejon.org>
* Ralf Stephan <ralf@ark.in-berlin.de> (Gtkmm)
*
* Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
* Copyright (C) 2000 - 2005 Authors
*
* Released under GNU GPL. Read the file 'COPYING' for more information
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <gtkmm.h>
#include "ui/widget/color-picker.h"
#include "ui/widget/scalar-unit.h"
#include "xml/node-event-vector.h"
#include "helper/units.h"
#include "prefs-utils.h"
#include "inkscape.h"
#include "verbs.h"
#include "document.h"
#include "desktop-handles.h"
#include "desktop.h"
#include "sp-namedview.h"
#include "widgets/icon.h"
#include "document-properties.h"
#include "display/canvas-grid.h"
using std::pair;
namespace Inkscape {
namespace UI {
namespace Dialog {
#define SPACE_SIZE_X 15
#define SPACE_SIZE_Y 10
#define INKSCAPE_ICON_GRID_XY "grid_xy"
#define INKSCAPE_ICON_GRID_AXONOM "grid_axonom"
//===================================================
//---------------------------------------------------
static void on_child_added(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data);
static void on_child_removed(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void * data);
static void on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer);
static Inkscape::XML::NodeEventVector const _repr_events = {
on_child_added, /* child_added */
on_child_removed, /* child_removed */
on_repr_attr_changed,
NULL, /* content_changed */
NULL /* order_changed */
};
DocumentProperties &
DocumentProperties::getInstance()
{
DocumentProperties &instance = *new DocumentProperties();
instance.init();
return instance;
}
DocumentProperties::DocumentProperties()
: UI::Widget::Panel ("", "dialogs.documentoptions", SP_VERB_DIALOG_NAMEDVIEW),
_page_page(1, 1), _page_guides(1, 1),
_page_snap(1, 1), _page_snap_dtls(1, 1),
_grids_label_crea("", Gtk::ALIGN_LEFT),
_grids_button_new(_("_New"), _("Create new grid.")),
_grids_button_remove(_("_Remove"), _("Remove selected grid.")),
_grids_label_def("", Gtk::ALIGN_LEFT),
_prefs_path("dialogs.documentoptions")
{
_tt.enable();
_getContents()->set_spacing (4);
_getContents()->pack_start(_notebook, true, true);
_notebook.append_page(_page_page, _("Page"));
_notebook.append_page(_page_guides, _("Guides"));
_notebook.append_page(_grids_vbox, _("Grids"));
_notebook.append_page(_page_snap, _("Snap"));
_notebook.append_page(_page_snap_dtls, _("Snap points"));
build_page();
build_guides();
build_gridspage();
build_snap();
build_snap_dtls();
_grids_button_new.signal_clicked().connect(sigc::mem_fun(*this, &DocumentProperties::onNewGrid));
_grids_button_remove.signal_clicked().connect(sigc::mem_fun(*this, &DocumentProperties::onRemoveGrid));
signalDocumentReplaced().connect(sigc::mem_fun(*this, &DocumentProperties::_handleDocumentReplaced));
signalActivateDesktop().connect(sigc::mem_fun(*this, &DocumentProperties::_handleActivateDesktop));
signalDeactiveDesktop().connect(sigc::mem_fun(*this, &DocumentProperties::_handleDeactivateDesktop));
}
void
DocumentProperties::init()
{
update();
Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(getDesktop()));
repr->addListener (&_repr_events, this);
Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(getDesktop())->root);
root->addListener (&_repr_events, this);
show_all_children();
_grids_button_remove.hide();
}
DocumentProperties::~DocumentProperties()
{
Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(getDesktop()));
repr->removeListenerByData (this);
Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(getDesktop())->root);
root->removeListenerByData (this);
}
//========================================================================
/**
* Helper function that attaches widgets in a 3xn table. The widgets come in an
* array that has two entries per table row. The two entries code for four
* possible cases: (0,0) means insert space in first column; (0, non-0) means
* widget in columns 2-3; (non-0, 0) means label in columns 1-3; and
* (non-0, non-0) means two widgets in columns 2 and 3.
**/
inline void
attach_all(Gtk::Table &table, Gtk::Widget *const arr[], unsigned const n, int start = 0)
{
for (unsigned i = 0, r = start; i < n; i += 2)
{
if (arr[i] && arr[i+1])
{
table.attach(*arr[i], 1, 2, r, r+1,
Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
table.attach(*arr[i+1], 2, 3, r, r+1,
Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
}
else
{
if (arr[i+1])
table.attach(*arr[i+1], 1, 3, r, r+1,
Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
else if (arr[i])
{
Gtk::Label& label = reinterpret_cast<Gtk::Label&>(*arr[i]);
label.set_alignment (0.0);
table.attach (label, 0, 3, r, r+1,
Gtk::FILL|Gtk::EXPAND, (Gtk::AttachOptions)0,0,0);
}
else
{
Gtk::HBox *space = manage (new Gtk::HBox);
space->set_size_request (SPACE_SIZE_X, SPACE_SIZE_Y);
table.attach (*space, 0, 1, r, r+1,
(Gtk::AttachOptions)0, (Gtk::AttachOptions)0,0,0);
}
}
++r;
}
}
void
DocumentProperties::build_page()
{
_page_page.show();
_rcp_bg.init (_("Back_ground:"), _("Background color"), _("Color and transparency of the page background (also used for bitmap export)"),
"pagecolor", "inkscape:pageopacity", _wr);
_rcb_canb.init (_("Show page _border"), _("If set, rectangular page border is shown"), "showborder", _wr, false);
_rcb_bord.init (_("Border on _top of drawing"), _("If set, border is always on top of the drawing"), "borderlayer", _wr, false);
_rcp_bord.init (_("Border _color:"), _("Page border color"),
_("Color of the page border"),
"bordercolor", "borderopacity", _wr);
_rcb_shad.init (_("_Show border shadow"), _("If set, page border shows a shadow on its right and lower side"), "inkscape:showpageshadow", _wr, false);
_rum_deflt.init (_("Default _units:"), "inkscape:document-units", _wr);
Gtk::Label* label_gen = manage (new Gtk::Label);
label_gen->set_markup (_("<b>General</b>"));
Gtk::Label* label_bor = manage (new Gtk::Label);
label_bor->set_markup (_("<b>Border</b>"));
Gtk::Label *label_for = manage (new Gtk::Label);
label_for->set_markup (_("<b>Format</b>"));
_page_sizer.init (_wr);
Gtk::Widget *const widget_array[] =
{
label_gen, 0,
_rum_deflt._label, _rum_deflt._sel,
_rcp_bg._label, _rcp_bg._cp,
0, 0,
label_for, 0,
0, &_page_sizer,
0, 0,
label_bor, 0,
0, _rcb_canb._button,
0, _rcb_bord._button,
0, _rcb_shad._button,
_rcp_bord._label, _rcp_bord._cp,
};
attach_all(_page_page.table(), widget_array, G_N_ELEMENTS(widget_array));
}
void
DocumentProperties::build_guides()
{
_page_guides.show();
_rcb_sgui.init (_("Show _guides"), _("Show or hide guides"), "showguides", _wr);
_rcp_gui.init (_("Guide co_lor:"), _("Guideline color"),
_("Color of guidelines"), "guidecolor", "guideopacity", _wr);
_rcp_hgui.init (_("_Highlight color:"), _("Highlighted guideline color"),
_("Color of a guideline when it is under mouse"),
"guidehicolor", "guidehiopacity", _wr);
_rcbsng.init (_("_Snap guides while dragging"),
_("While dragging a guide, snap to object nodes or bounding box corners ('Snap to nodes' or 'snap to bounding box corners' must be enabled in the 'Snap' tab; only a small part of the guide near the cursor will snap)"),
"inkscape:snap-guide", _wr);
Gtk::Label *label_gui = manage (new Gtk::Label);
label_gui->set_markup (_("<b>Guides</b>"));
Gtk::Widget *const widget_array[] =
{
label_gui, 0,
0, _rcb_sgui._button,
_rcp_gui._label, _rcp_gui._cp,
_rcp_hgui._label, _rcp_hgui._cp,
0, _rcbsng._button,
};
attach_all(_page_guides.table(), widget_array, G_N_ELEMENTS(widget_array));
}
void
DocumentProperties::build_snap()
{
_page_snap.show();
//General options
_rcbsg.init (_("Enable snapping"),
_("Toggle snapping on or off"),
"inkscape:snap-global", _wr);
_rcbsnbb.init (_("_Bounding box corners"),
_("Snap bounding box corners to grid lines, to guides, and to other bounding boxes (Snapping of bounding boxes is only available in the selector tool)"),
"inkscape:snap-bbox", _wr);
_rcbsnn.init (_("_Nodes"),
_("Snap nodes to grid lines, to guides, to paths, and to other nodes"),
"inkscape:snap-nodes", _wr);
//Options for snapping to objects
_rcbsnop.init (_("Snap to pat_hs"),
_("Snap nodes to object paths"),
"inkscape:object-paths", _wr);
_rcbsnon.init (_("Snap to n_odes"),
_("Snap nodes and guides to object nodes"),
"inkscape:object-nodes", _wr);
_rcbsnbbn.init (_("Snap to bounding box co_rners"),
_("Snap bounding box corners to other bounding box corners"),
"inkscape:bbox-nodes", _wr);
_rcbsnbbp.init (_("Snap to bounding box _edges"),
_("Snap bounding box corners and guides to bounding box edges"),
"inkscape:bbox-paths", _wr);
_rsu_sno.init (_("Snap _distance"), _("Snap at specified d_istance"),
_("Snapping distance, in screen pixels, for snapping to objects"),
_("If set, objects only snap to another object when it's within the range specified below"),
"objecttolerance", _wr);
//Options for snapping to grids
_rsu_sn.init (_("Snap di_stance"), _("Snap at specified dis_tance"),
_("Snapping distance, in screen pixels, for snapping to grid"),
_("If set, objects only snap to a grid line when it's within the range specified below"),
"gridtolerance", _wr);
//Options for snapping to guides
_rsu_gusn.init (_("Snap dist_ance"), _("Snap at specified distan_ce"),
_("Snapping distance, in screen pixels, for snapping to guides"),
_("If set, objects only snap to a guide when it's within the range specified below"),
"guidetolerance", _wr);
//Other options to locate here: e.g. visual snapping indicators on/off
std::list<Gtk::ToggleButton*> slaves;
slaves.push_back(_rcbsnop._button);
slaves.push_back(_rcbsnon._button);
_rcbsnn.setSlaveButton(slaves);
slaves.clear();
slaves.push_back(_rcbsnbbp._button);
slaves.push_back(_rcbsnbbn._button);
_rcbsnbb.setSlaveButton(slaves);
slaves.clear();
slaves.push_back(_rcbsnn._button);
slaves.push_back(_rcbsnbb._button);
_rcbsg.setSlaveButton(slaves);
Gtk::Label *label_g = manage (new Gtk::Label);
label_g->set_markup (_("<b>Snapping</b>"));
Gtk::Label *label_w = manage (new Gtk::Label);
label_w->set_markup (_("<b>What snaps</b>"));
Gtk::Label *label_o = manage (new Gtk::Label);
label_o->set_markup (_("<b>Snap to objects</b>"));
Gtk::Label *label_gr = manage (new Gtk::Label);
label_gr->set_markup (_("<b>Snap to grids</b>"));
Gtk::Label *label_gu = manage (new Gtk::Label);
label_gu->set_markup (_("<b>Snap to guides</b>"));
Gtk::Widget *const array[] =
{
label_g, 0,
0, _rcbsg._button,
0, 0,
label_w, 0,
0, _rcbsnn._button,
0, _rcbsnbb._button,
0, 0,
label_o, 0,
0, _rcbsnop._button,
0, _rcbsnon._button,
0, _rcbsnbbp._button,
0, _rcbsnbbn._button,
0, _rsu_sno._vbox,
0, 0,
label_gr, 0,
0, _rsu_sn._vbox,
0, 0,
label_gu, 0,
0, _rsu_gusn._vbox
};
attach_all(_page_snap.table(), array, G_N_ELEMENTS(array));
}
void
DocumentProperties::build_snap_dtls()
{
_page_snap_dtls.show();
_rcbsigg.init (_("_Grid with guides"),
_("Snap to grid-guide intersections"),
"inkscape:snap-intersection-grid-guide", _wr);
_rcbsils.init (_("_Line segments"),
_("Snap to intersections of line segments ('snap to paths' must be enabled, see the previous tab)"),
"inkscape:snap-intersection-line-segments", _wr);
//Applies to both nodes and guides, but not to bboxes, that's why its located here
_rcbic.init (_("_Include the object's rotation center"),
_("Also snap the rotation center of an object when snapping nodes or guides"),
"inkscape:snap-center", _wr);
//Other options to locate here: e.g. visual snapping indicators on/off
Gtk::Label *label_i= manage (new Gtk::Label);
label_i->set_markup (_("<b>Snapping to intersections of</b>"));
Gtk::Label *label_m = manage (new Gtk::Label);
label_m->set_markup (_("<b>Miscellaneous</b>"));
Gtk::Widget *const array[] =
{
label_i, 0,
0, _rcbsigg._button,
0, _rcbsils._button,
0, 0,
label_m, 0,
0, _rcbic._button,
};
attach_all(_page_snap_dtls.table(), array, G_N_ELEMENTS(array));
}
/**
* Called for _updating_ the dialog (e.g. when a new grid was manually added in XML)
*/
void
DocumentProperties::update_gridspage()
{
SPDesktop *dt = getDesktop();
SPNamedView *nv = sp_desktop_namedview(dt);
//remove all tabs
while (_grids_notebook.get_current_page() != -1) {
_grids_notebook.remove_page(-1);
}
//add tabs
bool grids_present = false;
for (GSList const * l = nv->grids; l != NULL; l = l->next) {
Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
if (!grid->repr->attribute("id")) continue; // update_gridspage is called again when "id" is added
Glib::ustring name(grid->repr->attribute("id"));
const char *icon = NULL;
switch (grid->getGridType()) {
case GRID_RECTANGULAR:
icon = INKSCAPE_ICON_GRID_XY;
break;
case GRID_AXONOMETRIC:
icon = INKSCAPE_ICON_GRID_AXONOM;
break;
default:
break;
}
_grids_notebook.append_page(grid->getWidget(), _createPageTabLabel(name, icon));
grids_present = true;
}
_grids_notebook.show_all();
if (grids_present)
_grids_button_remove.show();
else
_grids_button_remove.hide();
}
/**
* Build grid page of dialog.
*/
void
DocumentProperties::build_gridspage()
{
/// \todo FIXME: gray out snapping when grid is off.
/// Dissenting view: you want snapping without grid.
SPDesktop *dt = getDesktop();
SPNamedView *nv = sp_desktop_namedview(dt);
_grids_label_crea.set_markup(_("<b>Creation</b>"));
_grids_label_def.set_markup(_("<b>Defined grids</b>"));
_grids_hbox_crea.pack_start(_grids_combo_gridtype, true, true);
_grids_hbox_crea.pack_start(_grids_button_new, true, true);
for (gint t = 0; t <= GRID_MAXTYPENR; t++) {
_grids_combo_gridtype.append_text( CanvasGrid::getName( (GridType) t ) );
}
_grids_combo_gridtype.set_active_text( CanvasGrid::getName(GRID_RECTANGULAR) );
_grids_space.set_size_request (SPACE_SIZE_X, SPACE_SIZE_Y);
_grids_vbox.set_spacing(4);
_grids_vbox.pack_start(_grids_label_crea, false, false);
_grids_vbox.pack_start(_grids_hbox_crea, false, false);
_grids_vbox.pack_start(_grids_space, false, false);
_grids_vbox.pack_start(_grids_label_def, false, false);
_grids_vbox.pack_start(_grids_notebook, false, false);
_grids_vbox.pack_start(_grids_button_remove, false, false);
_grids_button_remove.hide();
update_gridspage();
}
/**
* Update dialog widgets from desktop. Also call updateWidget routines of the grids.
*/
void
DocumentProperties::update()
{
if (_wr.isUpdating()) return;
SPDesktop *dt = getDesktop();
SPNamedView *nv = sp_desktop_namedview(dt);
_wr.setUpdating (true);
set_sensitive (true);
//-----------------------------------------------------------page page
_rcp_bg.setRgba32 (nv->pagecolor);
_rcb_canb.setActive (nv->showborder);
_rcb_bord.setActive (nv->borderlayer == SP_BORDER_LAYER_TOP);
_rcp_bord.setRgba32 (nv->bordercolor);
_rcb_shad.setActive (nv->showpageshadow);
if (nv->doc_units)
_rum_deflt.setUnit (nv->doc_units);
double const doc_w_px = sp_document_width(sp_desktop_document(dt));
double const doc_h_px = sp_document_height(sp_desktop_document(dt));
_page_sizer.setDim (doc_w_px, doc_h_px);
//-----------------------------------------------------------guide
_rcb_sgui.setActive (nv->showguides);
_rcp_gui.setRgba32 (nv->guidecolor);
_rcp_hgui.setRgba32 (nv->guidehicolor);
//-----------------------------------------------------------snap
_rcbsnbb.setActive (nv->snap_manager.getSnapModeBBox());
_rcbsnn.setActive (nv->snap_manager.getSnapModeNode());
_rcbsng.setActive (nv->snap_manager.getSnapModeGuide());
_rcbic.setActive (nv->snap_manager.getIncludeItemCenter());
_rcbsigg.setActive (nv->snap_manager.getSnapIntersectionGG());
_rcbsils.setActive (nv->snap_manager.getSnapIntersectionLS());
_rcbsnop.setActive(nv->snap_manager.object.getSnapToItemPath());
_rcbsnon.setActive(nv->snap_manager.object.getSnapToItemNode());
_rcbsnbbp.setActive(nv->snap_manager.object.getSnapToBBoxPath());
_rcbsnbbn.setActive(nv->snap_manager.object.getSnapToBBoxNode());
_rsu_sno.setValue (nv->objecttolerance);
_rsu_sn.setValue (nv->gridtolerance);
_rsu_gusn.setValue (nv->guidetolerance);
_rcbsg.setActive (nv->snap_manager.getSnapEnabledGlobally());
//-----------------------------------------------------------grids page
update_gridspage();
_wr.setUpdating (false);
}
// TODO: copied from fill-and-stroke.cpp factor out into new ui/widget file?
Gtk::HBox&
DocumentProperties::_createPageTabLabel(const Glib::ustring& label, const char *label_image)
{
Gtk::HBox *_tab_label_box = manage(new Gtk::HBox(false, 0));
_tab_label_box->set_spacing(4);
_tab_label_box->pack_start(*Glib::wrap(sp_icon_new(Inkscape::ICON_SIZE_DECORATION,
label_image)));
Gtk::Label *_tab_label = manage(new Gtk::Label(label, true));
_tab_label_box->pack_start(*_tab_label);
_tab_label_box->show_all();
return *_tab_label_box;
}
//--------------------------------------------------------------------
void
DocumentProperties::on_response (int id)
{
if (id == Gtk::RESPONSE_DELETE_EVENT || id == Gtk::RESPONSE_CLOSE)
{
_rcp_bg.closeWindow();
_rcp_bord.closeWindow();
_rcp_gui.closeWindow();
_rcp_hgui.closeWindow();
}
if (id == Gtk::RESPONSE_CLOSE)
hide();
}
void
DocumentProperties::_handleDocumentReplaced(SPDesktop* desktop, SPDocument *document)
{
Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(desktop));
repr->addListener(&_repr_events, this);
Inkscape::XML::Node *root = SP_OBJECT_REPR(document->root);
root->addListener(&_repr_events, this);
update();
}
void
DocumentProperties::_handleActivateDesktop(Inkscape::Application *, SPDesktop *desktop)
{
Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(desktop));
repr->addListener(&_repr_events, this);
Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(desktop)->root);
root->addListener(&_repr_events, this);
update();
}
void
DocumentProperties::_handleDeactivateDesktop(Inkscape::Application *, SPDesktop *desktop)
{
Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(desktop));
repr->removeListenerByData(this);
Inkscape::XML::Node *root = SP_OBJECT_REPR(sp_desktop_document(desktop)->root);
root->removeListenerByData(this);
}
static void
on_child_added(Inkscape::XML::Node */*repr*/, Inkscape::XML::Node */*child*/, Inkscape::XML::Node */*ref*/, void *data)
{
if (DocumentProperties *dialog = static_cast<DocumentProperties *>(data))
dialog->update_gridspage();
}
static void
on_child_removed(Inkscape::XML::Node */*repr*/, Inkscape::XML::Node */*child*/, Inkscape::XML::Node */*ref*/, void *data)
{
if (DocumentProperties *dialog = static_cast<DocumentProperties *>(data))
dialog->update_gridspage();
}
/**
* Called when XML node attribute changed; updates dialog widgets.
*/
static void
on_repr_attr_changed (Inkscape::XML::Node *, gchar const *, gchar const *, gchar const *, bool, gpointer data)
{
if (DocumentProperties *dialog = static_cast<DocumentProperties *>(data))
dialog->update();
}
/*########################################################################
# BUTTON CLICK HANDLERS (callbacks)
########################################################################*/
void
DocumentProperties::onNewGrid()
{
SPDesktop *dt = getDesktop();
Inkscape::XML::Node *repr = SP_OBJECT_REPR(sp_desktop_namedview(dt));
SPDocument *doc = sp_desktop_document(dt);
Glib::ustring typestring = _grids_combo_gridtype.get_active_text();
CanvasGrid::writeNewGridToRepr(repr, doc, CanvasGrid::getGridTypeFromName(typestring.c_str()));
// toggle grid showing to ON:
dt->showGrids(true);
}
void
DocumentProperties::onRemoveGrid()
{
gint pagenum = _grids_notebook.get_current_page();
if (pagenum == -1) // no pages
return;
SPDesktop *dt = getDesktop();
SPNamedView *nv = sp_desktop_namedview(dt);
Inkscape::CanvasGrid * found_grid = NULL;
int i = 0;
for (GSList const * l = nv->grids; l != NULL; l = l->next, i++) { // not a very nice fix, but works.
Inkscape::CanvasGrid * grid = (Inkscape::CanvasGrid*) l->data;
if (pagenum == i) {
found_grid = grid;
break; // break out of for-loop
}
}
if (found_grid) {
// delete the grid that corresponds with the selected tab
// when the grid is deleted from SVG, the SPNamedview handler automatically deletes the object, so found_grid becomes an invalid pointer!
found_grid->repr->parent()->removeChild(found_grid->repr);
sp_document_done(sp_desktop_document(dt), SP_VERB_DIALOG_NAMEDVIEW, _("Remove grid"));
}
}
} // namespace Dialog
} // namespace UI
} // namespace Inkscape
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0))
indent-tabs-mode:nilu
fill-column:99
End:
*/
// vim: filetype=c++:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :