Inkscape::XML::Node Class Reference

List of all members.

Detailed Description

Note:

NB! Unless explicitly stated all methods are noref/nostrcpy

Todo:

Though Inkscape::XML::Node provides "signals" for notification when individual nodes change, there is no mechanism to receive notification for overall document changes. However, with the addition of the transactions code, it would not be very hard to implement if you wanted it.

Note:

Inkscape::XML::Node itself doesn't use GObject signals at present -- Inkscape::XML::Nodes maintain lists of Inkscape::XML::NodeEventVectors (added via sp_repr_add_listener), which are used to specify callbacks when something changes.

void (* child_added)(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void *data); Called once a child has been added.

void (* child_removed)(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, void *data); Called after a child is removed; ref is the child that used to precede the removed child.

void (* attr_changed)(Inkscape::XML::Node *repr, gchar const *key, gchar const *oldval, gchar const *newval, void *data); Called after an attribute has been changed.

void (* content_changed)(Inkscape::XML::Node *repr, gchar const *oldcontent, gchar const *newcontent, void *data); Called after an element's content has been changed.

void (* order_changed)(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *oldref, Inkscape::XML::Node *newref, void *data); Called once the child has been moved to its new position in the child order.

Inkscape::XML::Node mini-FAQ

Since I'm not very familiar with this section of code but I need to use it heavily for the RDF work, I'm going to answer various questions I run into with my best-guess answers so others can follow along too.

• Q: How do I find the root Inkscape::XML::Node?
  A: If you have an SPDocument, use doc->rroot. For example:

 SP_ACTIVE_DOCUMENT->rroot       

(but it's better to arrange for your caller to pass in the relevent document rather than assuming it's necessarily the active one and using SP_ACTIVE_DOCUMENT)

• Q: How do I find an Inkscape::XML::Node by unique key/value?
  A: Use sp_repr_lookup_child

• Q: How do I find an Inkscape::XML::Node by unique namespace name?
  A: Use sp_repr_lookup_name

• Q: How do I make an Inkscape::XML::Node namespace prefix constant in the application?
  A: Add the XML namespace URL as a define to repr.h at the top with the other SP_<NAMESPACE>_NS_URI define's, and then in repr-util.cpp, in sp_xml_ns_register_defaults, bump "defaults" up in size one, and add another section. Don't forget to increment the array offset and keep ".next" pointed to the next (if any) array entry.

• Q: How do I create a new Inkscape::XML::Node?
  A: Use "sp_repr_new*". Then attach it to a parent somewhere with parent->appendChild(child), and then use Inkscape::GC::release(child) to let go of it (the parent will hold it in memory).

• Q: How do I destroy an Inkscape::XML::Node? A: Just call "sp_repr_unparent" on it and release any references you may be retaining to it. Any attached SPObjects will clean themselves up automatically, as will any children.

• Q: What about listeners?
  A: I have no idea yet...

• Q: How do I add a namespace to a newly created document?
  A: The current hack is in document.cpp:sp_document_create

Definition at line 41 of file node.h.

• inkscape-0.45.1/src/xml/node.h