diff options
Diffstat (limited to 'src/document.h')
| -rw-r--r-- | src/document.h | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/src/document.h b/src/document.h new file mode 100644 index 000000000..da8b656ef --- /dev/null +++ b/src/document.h @@ -0,0 +1,218 @@ +#ifndef __SP_DOCUMENT_H__ +#define __SP_DOCUMENT_H__ + +/** \file + * SPDocument: Typed SVG document implementation + * + * Authors: + * Lauris Kaplinski <lauris@kaplinski.com> + * MenTaLguY <mental@rydia.net> + * + * Copyright (C) 2004-2005 MenTaLguY + * Copyright (C) 1999-2002 Lauris Kaplinski + * Copyright (C) 2000-2001 Ximian, Inc. + * + * Released under GNU GPL, read the file 'COPYING' for more information + */ + +#include <glib-object.h> +#include <gtk/gtksignal.h> +#include <sigc++/sigc++.h> +#include <sigc++/class_slot.h> + +#include "libcroco/cr-cascade.h" +#include "libnr/nr-forward.h" + +#include "gc-managed.h" +#include "gc-finalized.h" +#include "gc-anchored.h" + +struct SPDesktop; +struct SPItem; +struct SPObject; +struct SPGroup; + +namespace Inkscape { + struct Application; + class Selection; + class UndoStackObserver; + namespace XML { + class Document; + class Node; + } +} + +class SPDocumentPrivate; + +/// Typed SVG document implementation. +struct SPDocument : public Inkscape::GC::Managed<>, + public Inkscape::GC::Finalized, + public Inkscape::GC::Anchored +{ + typedef sigc::signal<void, SPObject *> IDChangedSignal; + typedef sigc::signal<void> ResourcesChangedSignal; + typedef sigc::signal<void, guint> ModifiedSignal; + typedef sigc::signal<void, gchar const *> URISetSignal; + typedef sigc::signal<void, double, double> ResizedSignal; + typedef sigc::signal<void> ReconstructionStart; + typedef sigc::signal<void> ReconstructionFinish; + + SPDocument(); + ~SPDocument(); + + unsigned int keepalive : 1; + unsigned int virgin : 1; ///< Has the document never been touched? + + Inkscape::XML::Document *rdoc; ///< Our Inkscape::XML::Document + Inkscape::XML::Node *rroot; ///< Root element of Inkscape::XML::Document + SPObject *root; ///< Our SPRoot + CRCascade *style_cascade; + + gchar *uri; ///< URI string or NULL + gchar *base; + gchar *name; + + SPDocumentPrivate *priv; + + /// Last action key + const gchar *actionkey; + /// Handler ID + guint modified_id; + + sigc::connection connectModified(ModifiedSignal::slot_type slot); + sigc::connection connectURISet(URISetSignal::slot_type slot); + sigc::connection connectResized(ResizedSignal::slot_type slot); + + void bindObjectToId(gchar const *id, SPObject *object); + SPObject *getObjectById(gchar const *id); + sigc::connection connectIdChanged(const gchar *id, IDChangedSignal::slot_type slot); + + void bindObjectToRepr(Inkscape::XML::Node *repr, SPObject *object); + SPObject *getObjectByRepr(Inkscape::XML::Node *repr); + + void queueForOrphanCollection(SPObject *object); + void collectOrphans(); + + void _emitModified(); + + GSList *_collection_queue; + + void addUndoObserver(Inkscape::UndoStackObserver& observer); + void removeUndoObserver(Inkscape::UndoStackObserver& observer); + +private: + SPDocument(SPDocument const &); // no copy + void operator=(SPDocument const &); // no assign + +public: + sigc::connection connectReconstructionStart(ReconstructionStart::slot_type slot); + sigc::connection connectReconstructionFinish (ReconstructionFinish::slot_type slot); + void emitReconstructionStart (void); + void emitReconstructionFinish (void); + + void reset_key (void *dummy); + sigc::connection _selection_changed_connection; + sigc::connection _desktop_activated_connection; +}; + +SPDocument *sp_document_new (const gchar *uri, unsigned int keepalive, bool make_new = false); +SPDocument *sp_document_new_from_mem (const gchar *buffer, gint length, unsigned int keepalive); +SPDocument *sp_document_new_dummy(); + +SPDocument *sp_document_ref (SPDocument *doc); +SPDocument *sp_document_unref (SPDocument *doc); + +/* + * Access methods + */ + +#define sp_document_repr_doc(d) (d->rdoc) +#define sp_document_repr_root(d) (d->rroot) +#define sp_document_root(d) (d->root) +#define SP_DOCUMENT_ROOT(d) (d->root) + +gdouble sp_document_width (SPDocument * document); +gdouble sp_document_height (SPDocument * document); + +struct SPUnit; + +void sp_document_set_width (SPDocument * document, gdouble width, const SPUnit *unit); +void sp_document_set_height (SPDocument * document, gdouble height, const SPUnit *unit); + +#define SP_DOCUMENT_URI(d) (d->uri) +#define SP_DOCUMENT_NAME(d) (d->name) +#define SP_DOCUMENT_BASE(d) (d->base) + +/* + * Dictionary + */ + +/* + * Undo & redo + */ + +void sp_document_set_undo_sensitive (SPDocument * document, gboolean sensitive); +gboolean sp_document_get_undo_sensitive (SPDocument const * document); + +void sp_document_clear_undo (SPDocument * document); +void sp_document_clear_redo (SPDocument * document); + +void sp_document_child_added (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref); +void sp_document_child_removed (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref); +void sp_document_attr_changed (SPDocument *doc, SPObject *object, const gchar *key, const gchar *oldval, const gchar *newval); +void sp_document_content_changed (SPDocument *doc, SPObject *object, const gchar *oldcontent, const gchar *newcontent); +void sp_document_order_changed (SPDocument *doc, SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *oldref, Inkscape::XML::Node *newref); + +/* Object modification root handler */ +void sp_document_request_modified (SPDocument *doc); +gint sp_document_ensure_up_to_date (SPDocument *doc); + +/* Save all previous actions to stack, as one undo step */ +void sp_document_done (SPDocument *document); +void sp_document_maybe_done (SPDocument *document, const gchar *key); +void sp_document_reset_key (Inkscape::Application *inkscape, SPDesktop *desktop, GtkObject *base); + +/* Cancel (and revert) current unsaved actions */ +void sp_document_cancel (SPDocument *document); + +/* Undo and redo */ +gboolean sp_document_undo (SPDocument * document); +gboolean sp_document_redo (SPDocument * document); + +/* Resource management */ +gboolean sp_document_add_resource (SPDocument *document, const gchar *key, SPObject *object); +gboolean sp_document_remove_resource (SPDocument *document, const gchar *key, SPObject *object); +const GSList *sp_document_get_resource_list (SPDocument *document, const gchar *key); +sigc::connection sp_document_resources_changed_connect(SPDocument *document, const gchar *key, SPDocument::ResourcesChangedSignal::slot_type slot); + + +/* + * Ideas: How to overcome style invalidation nightmare + * + * 1. There is reference request dictionary, that contains + * objects (styles) needing certain id. Object::build checks + * final id against it, and invokes necesary methods + * + * 2. Removing referenced object is simply prohibited - + * needs analyse, how we can deal with situations, where + * we simply want to ungroup etc. - probably we need + * Repr::reparent method :( [Or was it ;)] + * + */ + +/* + * Misc + */ + +GSList * sp_document_items_in_box(SPDocument *document, unsigned int dkey, NR::Rect const &box); +GSList * sp_document_partial_items_in_box(SPDocument *document, unsigned int dkey, NR::Rect const &box); +SPItem* sp_document_item_from_list_at_point_bottom (unsigned int dkey, SPGroup *group, const GSList *list, NR::Point const p, bool take_insensitive = false); +SPItem * sp_document_item_at_point (SPDocument *document, unsigned int key, NR::Point const p, gboolean into_groups, SPItem *upto = NULL); +SPItem * sp_document_group_at_point (SPDocument *document, unsigned int key, NR::Point const p); + +void sp_document_set_uri (SPDocument *document, const gchar *uri); +void sp_document_resized_signal_emit (SPDocument *doc, gdouble width, gdouble height); + +unsigned int vacuum_document (SPDocument *document); + +#endif |