Inkscape: Inkscape::XML::Node Class Reference

Searching...

No Matches

Interface for refcounted XML nodes. More...

#include <node.h>

Inheritance diagram for Inkscape::XML::Node:

Public Member Functions
	Node ()=default

	~Node () override=default

Retrieve information about the node
virtual NodeType	type () const =0
	Get the type of the node.

virtual char const *	name () const =0
	Get the name of the element node.

virtual int	code () const =0
	Get the integer code corresponding to the node's name.

virtual unsigned	position () const =0
	Get the index of this node in parent's child order.

virtual unsigned	childCount () const =0
	Get the number of children of this node.

virtual char const *	content () const =0
	Get the content of a text or comment node.

virtual char const *	attribute (char const *key) const =0
	Get the string representation of a node's attribute.

virtual const AttributeVector &	attributeList () const =0
	Get a list of the node's attributes.

virtual bool	matchAttributeName (char const *partial_name) const =0
	Check whether this node has any attribute that matches a string.

Modify the node
virtual void	setPosition (int pos)=0
	Set the position of this node in parent's child order.

virtual void	setContent (char const *value)=0
	Set the content of a text or comment node.

void	setAttribute (Util::const_char_ptr key, Util::const_char_ptr value)
	Change an attribute of this node.

bool	copyAttribute (Util::const_char_ptr key, Node const *source_node, bool remove_if_empty=false)
	Copy attribute value from another node to this node.

bool	getAttributeBoolean (Util::const_char_ptr key, bool default_value=false) const
	Parses the boolean value of an attribute "key" in repr and sets val accordingly, or to false if the attr is not set.

int	getAttributeInt (Util::const_char_ptr key, int default_value=0) const

double	getAttributeDouble (Util::const_char_ptr key, double default_value=0.0) const

bool	setAttributeBoolean (Util::const_char_ptr key, bool val)

bool	setAttributeInt (Util::const_char_ptr key, int val)

bool	setAttributeCssDouble (Util::const_char_ptr key, double val)
	Set a property attribute to val [slightly rounded], in the format required for CSS properties: in particular, it never uses exponent notation.

bool	setAttributeSvgDouble (Util::const_char_ptr key, double val)
	For attributes where an exponent is allowed.

bool	setAttributeSvgNonDefaultDouble (Util::const_char_ptr key, double val, double default_value)

bool	setAttributeSvgLength (Util::const_char_ptr key, SVGLength const &val)

bool	setAttributePoint (Util::const_char_ptr key, Geom::Point const &val)

Geom::Point	getAttributePoint (Util::const_char_ptr key, Geom::Point default_value={}) const

void	setAttributeOrRemoveIfEmpty (Inkscape::Util::const_char_ptr key, Inkscape::Util::const_char_ptr value)
	Change an attribute of this node.

void	removeAttribute (Inkscape::Util::const_char_ptr key)
	Remove an attribute of this node.

virtual void	setCodeUnsafe (int code)=0
	Set the integer GQuark code for the name of the node.

Traverse the XML tree
virtual Document *	document ()=0
	Get the node's associated document.

virtual Document const *	document () const =0

virtual Node *	root ()=0
	Get the root node of this node's document.

virtual Node const *	root () const =0

virtual Node *	parent ()=0
	Get the parent of this node.

virtual Node const *	parent () const =0

virtual Node *	next ()=0
	Get the next sibling of this node.

virtual Node const *	next () const =0

virtual Node *	prev ()=0

virtual Node const *	prev () const =0

virtual Node *	firstChild ()=0
	Get the first child of this node.

virtual Node const *	firstChild () const =0

virtual Node *	lastChild ()=0
	Get the last child of this node.

virtual Node const *	lastChild () const =0

virtual Node *	nthChild (unsigned index)=0
	Get the child of this node with a given index.

virtual Node const *	nthChild (unsigned index) const =0

Manipulate the XML tree
virtual Node *	duplicate (Document *doc) const =0
	Create a duplicate of this node.

virtual void	addChild (Node child, Node after)=0
	Insert another node as a child of this node.

void	addChildAtPos (Node *child, unsigned pos)
	Insert another node as a child of this node.

virtual void	appendChild (Node *child)=0
	Append a node as the last child of this node.

virtual void	removeChild (Node *child)=0
	Remove a child of this node.

virtual void	changeOrder (Node child, Node after)=0
	Move a given node in this node's child order.

virtual void	cleanOriginal (Node src, char const key)=0
	Remove all elements that not in src node.

virtual bool	equal (Node const *other, bool recursive, bool skip_ids=false)=0
	Compare 2 nodes equality.

virtual void	mergeFrom (Node const src, char const key, bool extension=false, bool clean=false)=0
	Merge all children of another node with the current.

Public Member Functions inherited from Inkscape::GC::Anchored
void	anchor () const

void	release () const

unsigned	_anchored_refcount () const

	Anchored (Anchored const &)=delete

void	operator= (Anchored const &)=delete

Related Symbols
(Note that these are not member symbols.)
Node *	next_node (Node *node)
	Get the next node in sibling order.

Node *	previous_node (Node *node)
	Get the previous node in sibling order.

Node *	parent_node (Node *node)
	Get the node's parent.

Inkscape::XML::Node *	sp_repr_lookup_child (Inkscape::XML::Node repr, gchar const key, gchar const *value)
	Find an element node using an unique attribute.

Inkscape::XML::Node *	sp_repr_lookup_name (Inkscape::XML::Node repr, char const name, int maxdepth=-1)
	Find an element node with the given name.

template<typename Visitor >
void	sp_repr_visit_descendants (Inkscape::XML::Node *node, Visitor visitor)
	Visit all descendants recursively.

template<typename Visitor >
void	sp_repr_visit_descendants (Inkscape::XML::Node a, Inkscape::XML::Node b, Visitor visitor)
	Visit descendants of 2 nodes in parallel.

Notify observers about operations on the node
using	iterator = Inkscape::XML::NodeSiblingIterator

virtual void	addObserver (NodeObserver &observer)=0
	Add an object that will be notified of the changes to this node.

virtual void	removeObserver (NodeObserver &observer)=0
	Remove an object from the list of observers.

virtual void	synthesizeEvents (NodeObserver &observer)=0
	Generate a sequence of events corresponding to the state of this node.

virtual void	addSubtreeObserver (NodeObserver &observer)=0
	Add an object that will be notified of the changes to this node and its descendants.

virtual void	removeSubtreeObserver (NodeObserver &observer)=0
	Remove an object from the subtree observers list.

virtual void	recursivePrintTree (unsigned level)=0

iterator	begin ()
	Iterator over children.

iterator	end ()
	Helper to use the standard lib container functions.

bool	operator== (const std::string &name) const
	Compare a node by looking at its name to a string.

template<typename T >
Node *	findChildPath (T list)
	depth first search to find a node

template<typename iterT >
Node *	findChildPath (iterT itr, iterT end)
	template reshuffling to make the more useful findChildPath cleaner

	Node (Node const &)

virtual void	setAttributeImpl (char const key, char const value)=0

Additional Inherited Members
Protected Member Functions inherited from Inkscape::GC::Anchored
	Anchored ()

virtual	~Anchored ()=default

Detailed Description

Interface for refcounted XML nodes.

This class is an abstract base type for all nodes in an XML document - this includes everything except attributes. An XML document is also a node itself. This is the main class used for interfacing with Inkscape's documents. Everything that has to be stored in the SVG has to go through this class at some point.

Each node unconditionally has to belong to a document. There are no "documentless" nodes, and it's not possible to move nodes between documents - they have to be duplicated. Each node can only refer to the nodes in the same document. Name of the node is immutable, it cannot be changed after its creation. Same goes for the type of the node. To simplify the use of this class, you can perform all operations on all nodes, but only some of them make any sense. For example, only element nodes can have attributes, only element and document nodes can have children, and all nodes except element and document nodes can have content. Although you can set content for element nodes, it won't make any difference in the XML output.

To create new nodes, use the methods of the Inkscape::XML::Document class. You can obtain the nodes' document using the document() method. To destroy a node, just unparent it by calling sp_repr_unparent() or node->parent->removeChild() and release any references to it. The garbage collector will reclaim the memory in the next pass.

In addition to regular DOM manipulations, you can register observer objects that will receive notifications about changes made to the node. See the NodeObserver class.

See also: Inkscape::XML::Document; Inkscape::XML::NodeObserver

Definition at line 80 of file node.h.

Member Typedef Documentation

◆ iterator

using Inkscape::XML::Node::iterator = Inkscape::XML::NodeSiblingIterator

Definition at line 554 of file node.h.

Constructor & Destructor Documentation

◆ Node() [1/2]

Inkscape::XML::Node::Node ( )

default

◆ ~Node()

Inkscape::XML::Node::~Node ( )

overridedefault

◆ Node() [2/2]

Inkscape::XML::Node::Node ( Node const & )

inlineprotected

Definition at line 601 of file node.h.

Member Function Documentation

◆ addChild()

virtual void Inkscape::XML::Node::addChild	(	Node *	child,
		Node *	after
	)

pure virtual

Insert another node as a child of this node.

When after is NULL, the inserted node will be placed as the first child of this node. after must be a child of this node.

Parameters

child	The node to insert
after	The node after which the inserted node should be placed, or NULL

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Tools::TextTool::_setupText(), SPObject::addChild(), addChildAtPos(), Inkscape::UI::Dialog::DocumentProperties::addEmbeddedScript(), Inkscape::UI::Dialog::DocumentProperties::addExternalScript(), Inkscape::ObjectSet::cloneOriginalPathLPE(), Inkscape::UI::Dialog::XmlTree::cmd_duplicate_node(), Inkscape::UI::Dialog::XmlTree::cmd_indent_node(), Inkscape::UI::Dialog::XmlTree::cmd_unindent_node(), Inkscape::create_layer(), create_text_with_rectangle(), Persp3D::create_xml_element(), Inkscape::LivePathEffect::Effect::createAndApply(), Inkscape::LivePathEffect::LPEMeasureSegments::createArrowMarker(), SPDocument::createDoc(), Inkscape::LivePathEffect::LPEMeasureSegments::createTextLabel(), delete_line_break(), Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), Inkscape::LivePathEffect::LPEMeasureSegments::doOnApply(), flowtext_to_text(), LivePathEffectObject::fork_private_if_necessary(), Inkscape::UI::Dialog::get_first_style_text_node(), Inkscape::ObjectSet::group(), move_child_nodes(), SPItem::moveTo(), SPTag::moveTo(), Inkscape::UI::Widget::XmlTreeView::on_drag_drop(), Inkscape::UI::Toolbar::TextToolbar::prepare_inner(), recursively_apply_style(), redundant_semi_nesting_processor(), remove_marker_auto_start_reverse(), remove_marker_context_paint(), SPGradient::repr_write_vector(), Inkscape::UI::Tools::MeasureTool::setLabelText(), Inkscape::ObjectSet::setMask(), Inkscape::UI::Tools::MeasureTool::setMeasureItem(), SPObject::setTitleOrDesc(), sp_copy_resource(), sp_document_default_gradient_vector(), sp_gradient_add_stop(), sp_gradient_fork_vector_if_necessary(), sp_gradient_load_from_svg(), sp_import_document(), sp_item_group_ungroup(), sp_marker_fork_if_necessary(), sp_marker_load_from_svg(), sp_te_insert(), sp_te_insert_line(), sp_te_set_repr_text_multiline(), sp_textpath_to_text(), sp_tref_convert_to_tspan(), sp_vector_add_stop(), split_text_object_tree_at(), Inkscape::SelTrans::stamp(), text_put_on_path(), text_unflow(), Inkscape::ObjectSet::toSymbol(), Inkscape::UI::Toolbar::TextToolbar::unindent_node(), Inkscape::ObjectSet::unsetMask(), SPSymbol::unSymbol(), verify_grad(), SPFilter::write(), SPFlowtext::write(), SPText::write(), SPTextPath::write(), SPTSpan::write(), SPDefs::write(), SPFlowdiv::write(), SPFlowtspan::write(), SPFlowpara::write(), SPFlowregion::write(), SPFlowregionExclude::write(), SPGradient::write(), SPGroup::write(), SPItem::write(), and SPObjectGroup::write().

◆ addChildAtPos()

void Inkscape::XML::Node::addChildAtPos	(	Node *	child,
		unsigned	pos
	)

inline

Insert another node as a child of this node.

This is more efficient than appendChild() + setPosition().

Parameters

child	The node to insert
pos	The position in parent's child order

Definition at line 430 of file node.h.

References addChild(), child, and nthChild().

Referenced by Inkscape::Extension::Implementation::Script::PreviewObserver::createAndSendEvent(), SPDocument::getNamedView(), item_to_paths(), Inkscape::XML::SimpleNode::mergeFrom(), Inkscape::ObjectSet::setClipGroup(), and Inkscape::ObjectSet::toSymbol().

◆ addObserver()

virtual void Inkscape::XML::Node::addObserver ( NodeObserver & observer )

pure virtual

Add an object that will be notified of the changes to this node.

observer must be an object deriving from the NodeObserver class. The virtual methods of this object will be called when a corresponding change happens to this node. You can also notify the observer of the node's current state using synthesizeEvents(NodeObserver &).

Parameters

observer The observer object

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Toolbar::SpiralToolbar::_attachRepr(), Inkscape::UI::Toolbar::StarToolbar::_attachRepr(), Inkscape::UI::Toolbar::Box3DToolbar::_attachRepr(), Inkscape::UI::Toolbar::ArcToolbar::_attachRepr(), Inkscape::UI::Toolbar::RectToolbar::_attachRepr(), Inkscape::UI::Dialog::SelectorsDialog::_getStyleTextNode(), Inkscape::UI::Dialog::StyleDialog::_getStyleTextNode(), Inkscape::Preferences::addObserver(), LivePathEffectObject::build(), Persp3D::build(), SPStyleElem::build(), Inkscape::UI::Dialog::DocumentProperties::WatchConnection::connect(), SPObject::invoke_build(), Inkscape::XML::SignalObserver::set(), Inkscape::UI::ShapeEditor::set_item(), Inkscape::UI::Toolbar::ConnectorToolbar::setDesktop(), and Inkscape::UI::Dialog::AttrDialog::setRepr().

◆ addSubtreeObserver()

virtual void Inkscape::XML::Node::addSubtreeObserver ( NodeObserver & observer )

pure virtual

Add an object that will be notified of the changes to this node and its descendants.

The difference between adding a regular observer and a subtree observer is that the subtree observer will also be notified if a change occurs to any of the node's descendants, while a regular observer will only be notified of changes to the node it was assigned to.

Parameters

observer The observer object

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Preferences::addObserver(), Inkscape::UI::Dialog::StyleDialog::documentReplaced(), and Inkscape::XML::Subtree::Subtree().

◆ appendChild()

virtual void Inkscape::XML::Node::appendChild ( Node * child )

pure virtual

Append a node as the last child of this node.

Parameters

child The node to append

Implemented in Inkscape::XML::SimpleNode.

◆ attribute()

virtual char const * Inkscape::XML::Node::attribute ( char const * key ) const

pure virtual

Get the string representation of a node's attribute.

If there is no attribute with the given name, the method will return NULL. All strings returned by this method are owned by the node and may not be freed. The returned pointer will become invalid when the attribute changes. If you need to store the return value, use g_strdup(). To parse the string, use methods in repr.h

Parameters

key	The name of the node's attribute

Implemented in Inkscape::XML::SimpleNode.

◆ attributeList()

virtual const AttributeVector & Inkscape::XML::Node::attributeList ( ) const

pure virtual

Get a list of the node's attributes.

The returned list is a functional programming style list rather than a standard one.

Returns: A list of AttributeRecord structures describing the attributes

Todo:: This method should return std::map<Glib::Quark const, char const *> or something similar with a custom allocator

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Dialog::SelectorsDialog::_addToSelector(), css_attrs_are_equal(), delete_line_break(), duplicate_node_without_children(), Inkscape::XML::SimpleNode::equal(), file_import(), Inkscape::Preferences::getAllEntries(), Inkscape::Extension::Input::Input(), insert_text_fallback(), Inkscape::UI::Dialog::Find::item_attrvalue_match(), Inkscape::Extension::Internal::Filter::merge_filters(), Inkscape::XML::SimpleNode::mergeFrom(), Inkscape::Extension::Output::Output(), Inkscape::Extension::ProcessingAction::ProcessingAction(), prune_inkscape_from_node(), SPDocument::rebase(), remove_marker_auto_start_reverse(), sp_attribute_clean_element(), sp_attribute_clean_style(), sp_attribute_sort_element(), sp_repr_write_stream(), sp_repr_write_stream_root_element(), GrDrag::styleSet(), and Inkscape::Extension::TemplatePreset::TemplatePreset().

◆ begin()

iterator Inkscape::XML::Node::begin ( )

inline

Iterator over children.

Definition at line 557 of file node.h.

References firstChild().

Referenced by Avoid::IncSolver::blockGraphIsCyclic(), vpsc::Solver::blockGraphIsCyclic(), Avoid::IncSolver::constraintGraphIsCyclic(), vpsc::Solver::constraintGraphIsCyclic(), Avoid::HyperedgeImprover::createShiftSegmentsForDimensionExcluding(), and Avoid::HyperedgeImprover::moveJunctionsAlongCommonEdges().

◆ changeOrder()

virtual void Inkscape::XML::Node::changeOrder	(	Node *	child,
		Node *	after
	)

pure virtual

Move a given node in this node's child order.

Both child and after must be children of this node for the method to work.

Parameters

child	The node to move in the order
after	The sibling node after which the moved node should be placed

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Dialog::XmlTree::cmd_lower_node(), Inkscape::UI::Dialog::XmlTree::cmd_raise_node(), Inkscape::ObjectSet::lower(), SPItem::lowerOne(), SPItem::lowerToBottom(), SPItem::moveTo(), SPTag::moveTo(), Inkscape::UI::Widget::XmlTreeView::on_drag_drop(), Inkscape::ObjectSet::raise(), SPItem::raiseOne(), SPItem::raiseToTop(), Inkscape::UI::Dialog::rename_glyph_layer(), SPPage::setPageIndex(), and XmlReprActionTest::testRollbackOfNodeReordering().

◆ childCount()

virtual unsigned Inkscape::XML::Node::childCount ( ) const

pure virtual

Get the number of children of this node.

Returns: The number of children

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Extension::Internal::SvgBuilder::applyOptionalMask(), Inkscape::LivePathEffect::LPEMeasureSegments::doOnApply(), SPFlowtext::getAsText(), insert_text_fallback(), move_child_nodes(), remove_filter_gaussian_blur(), and SPFont::sort_glyphs().

◆ cleanOriginal()

virtual void Inkscape::XML::Node::cleanOriginal	(	Node *	src,
		char const *	key
	)

pure virtual

Remove all elements that not in src node.

Parameters

src	The node to check for elements into this node
key	The attribute to use as the identity attribute

◆ code()

virtual int Inkscape::XML::Node::code ( ) const

pure virtual

Get the integer code corresponding to the node's name.

Returns: GQuark code corresponding to the name

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Dialog::get_first_style_text_node(), Inkscape::XML::id_permitted(), Inkscape::XML::rebase_hrefs(), sp_repr_lookup_name(), sp_repr_lookup_name_many(), and sp_repr_write_stream_element().

◆ content()

virtual char const * Inkscape::XML::Node::content ( ) const

pure virtual

Get the content of a text or comment node.

This method makes no sense for element nodes. To retrieve the element node's name, use the name() method.

Returns: The node's content

Implemented in Inkscape::XML::SimpleNode.

◆ copyAttribute()

bool Inkscape::XML::Node::copyAttribute	(	Util::const_char_ptr	key,
		Node const *	source_node,
		bool	remove_if_empty = `false`
	)

Copy attribute value from another node to this node.

Parameters

key	Name of the attribute to change
source_node	Node from which to take the attribute value
remove_if_empty	If true, and the source node has no such attribute, or the source node's value for the attribute is an empty string, the attribute will be removed (if present) from this node.

Returns: true if the attribute was set, false otherwise.

Definition at line 30 of file node.cpp.

References attribute(), key, removeAttribute(), and setAttribute().

◆ document() [1/2]

virtual Document const * Inkscape::XML::Node::document ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ document() [2/2]

virtual Document * Inkscape::XML::Node::document ( )

pure virtual

Get the node's associated document.

Returns: The document to which the node belongs. Never NULL.

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Preferences::_getNode(), Inkscape::XML::SimpleNode::addChild(), Inkscape::UI::Dialog::CloneTiler::apply(), Inkscape::ObjectSet::breakApart(), Inkscape::XML::SimpleNode::changeOrder(), Inkscape::Application::crash_handler(), SPBox3D::createBox3D(), delete_line_break(), Inkscape::UI::Dialog::FilterEffectsDialog::FilterModifier::duplicate_filter(), Inkscape::UI::Dialog::FilterEffectsDialog::duplicate_primitive(), Inkscape::UI::Dialog::get_first_style_text_node(), ink_copy_generic_children(), insert_hatch_polyfill(), insert_mesh_polyfill(), insert_text_fallback(), redundant_semi_nesting_processor(), remove_marker_auto_start_reverse(), remove_marker_context_paint(), Inkscape::XML::SimpleNode::removeChild(), Inkscape::AutoSave::save(), Inkscape::Extension::Implementation::XSLT::save(), Inkscape::Extension::Implementation::Script::PreviewObserver::selectionChanged(), sp_gradient_add_stop(), sp_gradient_reverse_vector(), sp_item_group_ungroup(), sp_selected_item_to_curved_repr(), sp_te_insert(), sp_te_insert_line(), sp_te_set_repr_text_multiline(), sp_textpath_to_text(), sp_vector_add_stop(), Inkscape::SelTrans::stamp(), SPObject::updateRepr(), verify_grad(), and SPMeshNodeArray::write().

◆ duplicate()

virtual Node * Inkscape::XML::Node::duplicate ( Document * doc ) const

pure virtual

Create a duplicate of this node.

The newly created node has no parent, and a refcount equal 1. You need to manually insert it into the document, using e.g. appendChild(). Afterwards, call Inkscape::GC::release on it, so that it will be automatically collected when the parent is collected.

Parameters

doc	The document in which the duplicate should be created

Returns: A pointer to the duplicated node

Implemented in Inkscape::XML::SimpleNode.

◆ end()

iterator Inkscape::XML::Node::end ( )

inline

Helper to use the standard lib container functions.

Definition at line 559 of file node.h.

Referenced by Avoid::HyperedgeImprover::createShiftSegmentsForDimensionExcluding(), and findChildPath().

◆ equal()

virtual bool Inkscape::XML::Node::equal	(	Node const *	other,
		bool	recursive,
		bool	skip_ids = `false`
	)

pure virtual

Compare 2 nodes equality.

Parameters

other	The other node to compare
recursive	Recursive mode check

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::XML::SimpleNode::mergeFrom().

◆ findChildPath() [1/2]

template<typename iterT >

Node * Inkscape::XML::Node::findChildPath	(	iterT	itr,
		iterT	end
	)

inline

template reshuffling to make the more useful findChildPath cleaner

Definition at line 582 of file node.h.

References child, end(), and findChildPath().

◆ findChildPath() [2/2]

template<typename T >

Node * Inkscape::XML::Node::findChildPath ( T list )

inline

depth first search to find a node

This function takes any list structure you want and uses that to compare Node's down the child tree. It will do depth first searching into the tree. The key part is that since it is a template you have flexibility on the container, and the comparison that is being used. Typically it will be used with something like a std::list<std::string> which will compare against the node's name but more complex searches could be imagined.

Definition at line 575 of file node.h.

References findChildPath().

Referenced by findChildPath(), and findChildPath().

◆ firstChild() [1/2]

virtual Node const * Inkscape::XML::Node::firstChild ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ firstChild() [2/2]

virtual Node * Inkscape::XML::Node::firstChild ( )

pure virtual

Get the first child of this node.

For nodes without any children, this method returns NULL.

Returns: Pointer to the first child, or NULL

Implemented in Inkscape::XML::SimpleNode.

◆ getAttributeBoolean()

bool Inkscape::XML::Node::getAttributeBoolean	(	Util::const_char_ptr	key,
		bool	default_value = `false`
	)		const

Parses the boolean value of an attribute "key" in repr and sets val accordingly, or to false if the attr is not set.

Returns: true if the attr was set, false otherwise.

Definition at line 49 of file node.cpp.

References attribute(), and Inkscape::Util::const_char_ptr::data().

Referenced by Inkscape::Extension::Internal::SvgBuilder::_createImage(), SPNamedView::getLockGuides(), and SPNamedView::getShowGuides().

◆ getAttributeDouble()

double Inkscape::XML::Node::getAttributeDouble	(	Util::const_char_ptr	key,
		double	default_value = `0.0`
	)		const

Definition at line 76 of file node.cpp.

References attribute(), and Inkscape::Util::const_char_ptr::data().

Referenced by Inkscape::UI::Toolbar::SpiralToolbar::_update(), Inkscape::Extension::Internal::PdfInput::add_builder_page(), Inkscape::UI::Dialog::CloneTiler::apply(), Inkscape::UI::Dialog::Print::draw_page(), InkFileExportCmd::get_bgcolor(), SPText::get_frame(), Inkscape::UI::Dialog::get_number(), SPObject::getExportDpi(), insert_text_fallback(), Inkscape::UI::Toolbar::StarToolbar::notifyAttributeChanged(), Inkscape::UI::Toolbar::StarToolbar::proportion_value_changed(), and Inkscape::UI::Dialog::ObjectProperties::update_entries().

◆ getAttributeInt()

int Inkscape::XML::Node::getAttributeInt	(	Util::const_char_ptr	key,
		int	default_value = `0`
	)		const

Definition at line 67 of file node.cpp.

References attribute(), and Inkscape::Util::const_char_ptr::data().

Referenced by Inkscape::Extension::Internal::PdfInput::add_builder_page(), SPObject::getIntAttribute(), and Inkscape::UI::Toolbar::StarToolbar::notifyAttributeChanged().

◆ getAttributePoint()

Geom::Point Inkscape::XML::Node::getAttributePoint	(	Util::const_char_ptr	key,
		Geom::Point	default_value = `{}`
	)		const

Definition at line 146 of file node.cpp.

References attribute(), and Inkscape::Util::const_char_ptr::data().

Referenced by sp_import_document().

◆ lastChild() [1/2]

virtual Node const * Inkscape::XML::Node::lastChild ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ lastChild() [2/2]

virtual Node * Inkscape::XML::Node::lastChild ( )

pure virtual

Get the last child of this node.

For nodes without any children, this method returns NULL.

Returns: Pointer to the last child, or NULL

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Extension::Internal::SvgBuilder::_createMask(), Inkscape::Extension::Internal::SvgBuilder::addShadedFill(), Inkscape::UI::Dialog::CPHistoryXML::CPHistoryXML(), SPMask::create(), Inkscape::Extension::Internal::Filter::Filter::effect(), Inkscape::UI::Dialog::CPHistoryXML::get_action_parameter_history(), Inkscape::UI::Dialog::CPHistoryXML::get_last_operation(), Inkscape::Extension::Internal::SvgBuilder::mergePath(), move_child_nodes(), SPDocument::rebase(), Inkscape::Extension::Internal::SvgBuilder::shouldMergePath(), sp_import_document(), sp_item_group_ungroup(), and Inkscape::ObjectSet::toLayer().

◆ matchAttributeName()

virtual bool Inkscape::XML::Node::matchAttributeName ( char const * partial_name ) const

pure virtual

Check whether this node has any attribute that matches a string.

This method checks whether this node has any attributes whose names have partial_name as their substrings. The check is done using the strstr() function of the C library. I don't know what would require that functionality, because matchAttributeName("id") matches both "identity" and "hidden".

Parameters

partial_name The string to match against all attributes

Returns: true if there is such an attribute, false otherwise

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Dialog::Find::item_attr_match(), Inkscape::UI::Dialog::SvgFontsDialog::missing_glyph_description_from_selected_path(), and Inkscape::UI::Dialog::SvgFontsDialog::set_glyph_description_from_selected_path().

◆ mergeFrom()

virtual void Inkscape::XML::Node::mergeFrom	(	Node const *	src,
		char const *	key,
		bool	extension = `false`,
		bool	clean = `false`
	)

pure virtual

Merge all children of another node with the current.

This method merges two node hierarchies, where src takes precedence. key is the name of the attribute that determines whether two nodes are corresponding (it must be the same for both, and all of their ancestors). If there is a corresponding node in src hierarchy, their attributes and content override the ones already present in this node's hierarchy. If there is no corresponding node, it is copied from src to this node. This method is used when merging the user's preferences file with the defaults, and has little use beyond that.

Parameters

src	The node to merge into this node
key	The attribute to use as the identity attribute
noid	If true process noid items
key	If clean callback to cleanOriginal

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Preferences::_load(), Inkscape::XML::SimpleNode::mergeFrom(), Inkscape::migrateDetails(), SPDocument::rebase(), sp_repr_css_merge(), SPMetadata::write(), SPLine::write(), SPNamedView::write(), and SPPolyLine::write().

◆ name()

virtual char const * Inkscape::XML::Node::name ( ) const

pure virtual

Get the name of the element node.

This method only makes sense for element nodes. Names are stored as GQuarks to accelerate conversions.

Returns: Name for element nodes, NULL for others

Implemented in Inkscape::XML::SimpleNode.

◆ next() [1/2]

virtual Node const * Inkscape::XML::Node::next ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ next() [2/2]

virtual Node * Inkscape::XML::Node::next ( )

pure virtual

Get the next sibling of this node.

This method will return NULL if the node is the last sibling element of the parent. The nodes form a singly-linked list, so there is no "prev()" method. Use the provided external function for that.

Returns: Pointer to the next sibling, or NULL

See also: Inkscape::XML::previous_node()

Implemented in Inkscape::XML::SimpleNode.

◆ nthChild() [1/2]

virtual Node const * Inkscape::XML::Node::nthChild ( unsigned index ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ nthChild() [2/2]

virtual Node * Inkscape::XML::Node::nthChild ( unsigned index )

pure virtual

Get the child of this node with a given index.

If there is no child with the specified index number, this method will return NULL.

Parameters

index The zero-based index of the child to retrieve

Returns: Pointer to the appropriate child, or NULL

Implemented in Inkscape::XML::SimpleNode.

Referenced by addChildAtPos(), and Inkscape::LivePathEffect::LPEMeasureSegments::doOnApply().

◆ operator==()

bool Inkscape::XML::Node::operator== ( const std::string & name ) const

inline

Compare a node by looking at its name to a string.

Definition at line 562 of file node.h.

References name().

◆ parent() [1/2]

virtual Node const * Inkscape::XML::Node::parent ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ parent() [2/2]

virtual Node * Inkscape::XML::Node::parent ( )

pure virtual

Get the parent of this node.

This method will return NULL for detached nodes.

Returns: Pointer to the parent, or NULL

Implemented in Inkscape::XML::SimpleNode.

◆ position()

virtual unsigned Inkscape::XML::Node::position ( ) const

pure virtual

Get the index of this node in parent's child order.

If this method is used on a node that doesn't have a parent, the method will return 0, and a warning will be printed on the console.

Returns: The node's index, or 0 if the node does not have a parent

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::PathManipulator::_bsplineHandlePosition(), Inkscape::UI::PathManipulator::_bsplineHandleReposition(), Inkscape::ObjectSet::_pathBoolOp(), Inkscape::ObjectSet::breakApart(), Inkscape::ObjectSet::combine(), Inkscape::UI::PathManipulator::copySelectedPath(), SPObject::getPosition(), Inkscape::ObjectSet::group(), item_to_paths(), Inkscape::XML::SimpleNode::mergeFrom(), Inkscape::UI::NodeList::reverse(), sp_item_list_to_curves(), sp_repr_compare_position(), sp_selected_path_create_offset_object(), sp_selected_path_do_offset(), and Inkscape::UI::Tools::sp_tweak_dilate_recursive().

◆ prev() [1/2]

virtual Node const * Inkscape::XML::Node::prev ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ prev() [2/2]

virtual Node * Inkscape::XML::Node::prev ( )

pure virtual

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Dialog::CPHistoryXML::get_action_parameter_history(), Inkscape::UI::Widget::XmlTreeView::on_drag_drop(), previous_node(), SPDocument::rebase(), sp_item_group_ungroup(), Inkscape::SelTrans::stamp(), and Inkscape::ObjectSet::toLayer().

◆ recursivePrintTree()

virtual void Inkscape::XML::Node::recursivePrintTree ( unsigned level )

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ removeAttribute()

void Inkscape::XML::Node::removeAttribute ( Inkscape::Util::const_char_ptr key )

inline

Remove an attribute of this node.

Parameters

key	Name of the attribute to delete

Definition at line 280 of file node.h.

References Inkscape::Util::const_char_ptr::data(), and setAttributeImpl().

Referenced by SPGrid::_checkOldGrid(), Inkscape::UI::Dialog::SelectorsDialog::_removeClass(), Inkscape::UI::Dialog::StyleDialog::_writeStyleElement(), Inkscape::UI::Widget::GradientSelector::add_vector_clicked(), Inkscape::Extension::Internal::SvgBuilder::addImageMask(), Inkscape::Extension::Internal::SvgBuilder::addMaskedImage(), Inkscape::Extension::Internal::SvgBuilder::addSoftMaskedImage(), SPGradient::build(), copyAttribute(), Inkscape::LivePathEffect::LPEMeasureSegments::createArrowMarker(), SPDocument::createDoc(), Inkscape::LivePathEffect::LPEMeasureSegments::createLine(), Inkscape::LivePathEffect::LPEMeasureSegments::createTextLabel(), Inkscape::UI::Dialog::AttrDialog::deleteAttribute(), Inkscape::LivePathEffect::Effect::doOnBeforeCommit(), file_import(), Inkscape::fixBrokenLinks(), item_to_paths(), Inkscape::LivePathEffect::LPECopyRotate::LPECopyRotate(), Inkscape::LivePathEffect::LPEPowerClip::LPEPowerClip(), Inkscape::UI::Dialog::AttrDialog::nameEdited(), Inkscape::LivePathEffect::LPEMeasureSegments::processObjects(), prune_inkscape_from_node(), rebase_image_href(), Inkscape::Preferences::remove(), SPObject::removeAttribute(), Inkscape::Extension::save(), SPGenericEllipse::set_elliptical_path_attribute(), SPRect::set_rect_path_attribute(), setAttributeSvgNonDefaultDouble(), SPObject::setExportDpi(), sp_attribute_clean_element(), sp_attribute_sort_element(), sp_gradient_repr_set_link(), sp_lpe_item_cleanup_original_path_recursive(), sp_selected_path_create_offset_object(), Inkscape::UI::Tools::spdc_apply_powerstroke_shape(), SPFeComposite::write(), SPTag::write(), SPFeDiffuseLighting::write(), SPFeTurbulence::write(), SPFilter::write(), SPObject::write(), SPMarker::write(), SPGenericEllipse::write(), SPGradient::write(), SPItem::write(), SPLPEItem::write(), SPPath::write(), SPStar::write(), TextTagAttributes::writeSingleAttributeLength(), and TextTagAttributes::writeSingleAttributeVector().

◆ removeChild()

virtual void Inkscape::XML::Node::removeChild ( Node * child )

pure virtual

Remove a child of this node.

Once the pointer to the removed node disappears from the stack, the removed node will be collected in the next GC pass, but only as long as its refcount is zero. You should keep a refcount of zero for all nodes in the document except for the document node itself, because they will be held in memory by the parent.

Parameters

child The child to remove

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Extension::Internal::SvgBuilder::applyOptionalMask(), Inkscape::UI::Dialog::XmlTree::cmd_indent_node(), delete_line_break(), GrDrag::deleteSelected(), gr_knot_clicked_handler(), insert_text_fallback(), item_to_paths(), move_child_nodes(), SPItem::moveTo(), SPTag::moveTo(), Inkscape::UI::Widget::XmlTreeView::on_drag_drop(), Inkscape::UI::Toolbar::TextToolbar::prepare_inner(), prune_inkscape_from_node(), prune_proprietary_from_node(), SPDocument::rebase(), recursively_apply_style(), Inkscape::Preferences::remove(), Inkscape::LivePathEffect::LPEPowerMask::setMask(), SPFont::sort_glyphs(), sp_gradient_delete_stop(), sp_lpe_item_cleanup_original_path_recursive(), sp_repr_unparent(), sp_te_set_repr_text_multiline(), sp_textpath_to_text(), Inkscape::UI::Tools::spdc_flush_white(), split_text_object_tree_at(), text_put_on_path(), tidy_operator_repeated_spans(), Inkscape::ObjectSet::toSymbol(), Inkscape::UI::Toolbar::TextToolbar::unindent_node(), SPSymbol::unSymbol(), and Inkscape::Extension::Effect::~Effect().

◆ removeObserver()

virtual void Inkscape::XML::Node::removeObserver ( NodeObserver & observer )

pure virtual

Remove an object from the list of observers.

Parameters

observer The object to be removed

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Toolbar::ArcToolbar::_detachRepr(), Inkscape::UI::Toolbar::Box3DToolbar::_detachRepr(), Inkscape::UI::Toolbar::RectToolbar::_detachRepr(), Inkscape::UI::Toolbar::SpiralToolbar::_detachRepr(), Inkscape::UI::Toolbar::StarToolbar::_detachRepr(), Inkscape::UI::Dialog::SelectorsDialog::_getStyleTextNode(), Inkscape::UI::Dialog::StyleDialog::_getStyleTextNode(), Inkscape::UI::Tools::ConnectorTool::cc_clear_active_conn(), Inkscape::UI::Tools::ConnectorTool::cc_clear_active_shape(), LivePathEffectObject::release(), Persp3D::release(), SPStyleElem::release(), SPObject::releaseReferences(), Inkscape::Preferences::removeObserver(), Inkscape::UI::Dialog::StyleDialog::removeObservers(), Inkscape::XML::SignalObserver::set(), Inkscape::UI::Toolbar::ConnectorToolbar::setDesktop(), Inkscape::UI::Dialog::AttrDialog::setRepr(), Inkscape::UI::ShapeEditor::unset_item(), and Inkscape::UI::PathManipulator::writeXML().

◆ removeSubtreeObserver()

virtual void Inkscape::XML::Node::removeSubtreeObserver ( NodeObserver & observer )

pure virtual

Remove an object from the subtree observers list.

Parameters

observer The object to be removed

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::Preferences::removeObserver(), Inkscape::UI::Dialog::StyleDialog::removeObservers(), and Inkscape::XML::Subtree::~Subtree().

◆ root() [1/2]

virtual Node const * Inkscape::XML::Node::root ( ) const

pure virtual

Implemented in Inkscape::XML::SimpleNode.

◆ root() [2/2]

virtual Node * Inkscape::XML::Node::root ( )

pure virtual

Get the root node of this node's document.

This method works on any node that is part of an XML document, and returns the root node of the document in which it resides. For detached node hierarchies (i.e. nodes that are not descendants of a document node) this method returns the highest-level element node. For detached non-element nodes this method returns NULL.

Returns: A pointer to the root element node, or NULL if the node is detached

Implemented in Inkscape::XML::SimpleNode.

◆ setAttribute()

void Inkscape::XML::Node::setAttribute	(	Util::const_char_ptr	key,
		Util::const_char_ptr	value
	)

Change an attribute of this node.

The strings passed to this method are copied, so you can free them after use.

Parameters

key	Name of the attribute to change
value	The new value of the attribute

Definition at line 25 of file node.cpp.

References Inkscape::Util::const_char_ptr::data(), and setAttributeImpl().

◆ setAttributeBoolean()

bool Inkscape::XML::Node::setAttributeBoolean	(	Util::const_char_ptr	key,
		bool	val
	)

Definition at line 86 of file node.cpp.

References setAttribute().

Referenced by Inkscape::Extension::Internal::PdfImportDialog::getImportSettings(), SPNamedView::set_origin_follows_page(), SPNamedView::set_y_axis_down(), SPGrid::setDotted(), SPGrid::setEnabled(), SPNamedView::setLockGuides(), SPNamedView::setShowGrids(), SPNamedView::setShowGuides(), SPGrid::setSnapToVisibleOnly(), SPGrid::setVisible(), and SPStar::write().

◆ setAttributeCssDouble()

bool Inkscape::XML::Node::setAttributeCssDouble	(	Util::const_char_ptr	key,
		double	val
	)

Set a property attribute to val [slightly rounded], in the format required for CSS properties: in particular, it never uses exponent notation.

Definition at line 102 of file node.cpp.

References setAttribute(), and Inkscape::CSSOStringStream::str().

Referenced by Inkscape::Extension::Internal::SvgBuilder::_addStopToGradient(), SPNamedView::change_color(), GrDrag::deleteSelected(), gr_knot_clicked_handler(), Inkscape::UI::Widget::RegisteredColorPicker::on_changed(), Inkscape::Colors::paint_to_xml(), SPGradient::repr_write_vector(), sp_repr_set_css_double(), sp_vector_add_stop(), SPFeDiffuseLighting::write(), SPFeDistantLight::write(), SPFePointLight::write(), SPFeSpecularLighting::write(), SPFeSpotLight::write(), SPStop::write(), and SPMarker::write().

◆ setAttributeImpl()

virtual void Inkscape::XML::Node::setAttributeImpl	(	char const *	key,
		char const *	value
	)

protectedpure virtual

Implemented in Inkscape::XML::SimpleNode.

Referenced by removeAttribute(), setAttribute(), and setAttributeOrRemoveIfEmpty().

◆ setAttributeInt()

bool Inkscape::XML::Node::setAttributeInt	(	Util::const_char_ptr	key,
		int	val
	)

Definition at line 92 of file node.cpp.

References c, and setAttribute().

Referenced by Inkscape::UI::Toolbar::StarToolbar::magnitude_value_changed(), SPGrid::setMajorLineInterval(), sp_namedview_document_from_window(), Box3DSide::write(), and SPStar::write().

◆ setAttributeOrRemoveIfEmpty()

void Inkscape::XML::Node::setAttributeOrRemoveIfEmpty	(	Inkscape::Util::const_char_ptr	key,
		Inkscape::Util::const_char_ptr	value
	)

Change an attribute of this node.

Empty string deletes the attribute.

Parameters

key	Name of the attribute to change
value	The new value of the attribute

Definition at line 167 of file node.cpp.

References Inkscape::Util::const_char_ptr::data(), and setAttributeImpl().

Referenced by Inkscape::Extension::Internal::SvgBuilder::_createGradient(), Inkscape::Extension::Internal::SvgBuilder::_createImage(), Inkscape::Extension::Internal::SvgBuilder::_createTilingPattern(), Inkscape::Extension::Internal::SvgBuilder::_getColorProfile(), Inkscape::ObjectSet::_pathBoolOp(), Inkscape::Extension::Internal::SvgBuilder::_setBlendMode(), Inkscape::UI::Dialog::DocumentProperties::addExternalScript(), Inkscape::Extension::Internal::SvgBuilder::addMaskedImage(), Inkscape::ObjectSet::breakApart(), Inkscape::ObjectSet::cloneOriginalPathLPE(), SPBox3D::convert_to_group(), create_flowtext_with_internal_frame(), create_text_with_rectangle(), Inkscape::LivePathEffect::LPEMeasureSegments::createArrowMarker(), Inkscape::ObjectSet::createBitmapCopy(), Inkscape::ColorProfile::createFromProfile(), Inkscape::LivePathEffect::LPEMeasureSegments::createLine(), Inkscape::LivePathEffect::LPEMeasureSegments::createTextLabel(), delete_line_break(), Inkscape::UI::Tools::do_trace(), Inkscape::LivePathEffect::Effect::doOnBeforeCommit(), Inkscape::fixBrokenLinks(), SPFlowtext::getAsText(), insert_text_fallback(), Inkscape::UI::Dialog::AttrDialog::nameEdited(), Inkscape::UI::Dialog::FilterEffectsDialog::PrimitiveList::on_click_released(), Inkscape::Colors::paint_to_xml(), Inkscape::LivePathEffect::LPEMeasureSegments::processObjects(), SPPattern::produce(), rebase_image_href(), SPTSpan::set(), SPNamedView::setDisplayUnit(), SPObject::setExportFilename(), sp_attribute_clean_style(), sp_attribute_sort_style(), sp_import_document(), sp_repr_css_set(), sp_selected_item_to_curved_repr(), Inkscape::UI::Tools::spdc_apply_simplify(), Inkscape::Extension::Internal::svgSetTransform(), text_to_glyphs(), Inkscape::ObjectSet::tile(), Inkscape::LivePathEffect::LPEMirrorSymmetry::toMirror(), Inkscape::UI::Dialog::AttrDialog::valueEdited(), SPFeComposite::write(), SPFeBlend::write(), SPFeDiffuseLighting::write(), SPFeDisplacementMap::write(), SPFilterPrimitive::write(), SPFeSpecularLighting::write(), SPFilter::write(), SPTagUse::write(), SPObject::write(), LivePathEffectObject::write(), Inkscape::ColorProfile::write(), SPPage::write(), SPBox3D::write(), SPGradient::write(), SPItem::write(), SPLPEItem::write(), SPUse::write(), and TextTagAttributes::writeSingleAttributeVector().

◆ setAttributePoint()

bool Inkscape::XML::Node::setAttributePoint	(	Util::const_char_ptr	key,
		Geom::Point const &	val
	)

Definition at line 137 of file node.cpp.

References setAttribute(), Inkscape::SVGOStringStream::str(), Geom::X, and Geom::Y.

Referenced by SPGuide::createSPGuide(), SPGuide::moveto(), and SPGuide::set_normal().

◆ setAttributeSvgDouble()

bool Inkscape::XML::Node::setAttributeSvgDouble	(	Util::const_char_ptr	key,
		double	val
	)

For attributes where an exponent is allowed.

Not suitable for property attributes (fill-opacity, font-size etc.).

Definition at line 111 of file node.cpp.

References setAttribute(), and Inkscape::SVGOStringStream::str().

◆ setAttributeSvgLength()

bool Inkscape::XML::Node::setAttributeSvgLength	(	Util::const_char_ptr	key,
		SVGLength const &	val
	)

Definition at line 131 of file node.cpp.

References setAttribute(), and SVGLength::write().

Referenced by SPGenericEllipse::write(), and SPRect::write().

◆ setAttributeSvgNonDefaultDouble()

bool Inkscape::XML::Node::setAttributeSvgNonDefaultDouble	(	Util::const_char_ptr	key,
		double	val,
		double	default_value
	)

Definition at line 122 of file node.cpp.

References removeAttribute(), and setAttributeSvgDouble().

Referenced by sp_namedview_document_from_window().

◆ setCodeUnsafe()

virtual void Inkscape::XML::Node::setCodeUnsafe ( int code )

pure virtual

Set the integer GQuark code for the name of the node.

Do not use this function unless you really have a good reason.

Parameters

code	The integer value corresponding to the string to be set as the name of this node

Implemented in Inkscape::XML::SimpleNode.

Referenced by SPGenericEllipse::write(), and SPRect::write().

◆ setContent()

virtual void Inkscape::XML::Node::setContent ( char const * value )

pure virtual

Set the content of a text or comment node.

This method doesn't make sense for element nodes.

Parameters

value The node's new content

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Dialog::SelectorsDialog::_writeStyleElement(), Inkscape::UI::Dialog::StyleDialog::_writeStyleElement(), Inkscape::UI::Dialog::CPHistoryXML::add_operation(), Inkscape::UI::Dialog::AttrDialog::AttrDialog(), Inkscape::LivePathEffect::LPEMeasureSegments::createTextLabel(), Inkscape::LivePathEffect::LPEMeasureSegments::doOnApply(), erase_from_spstring(), sp_repr_svg_read_node(), sp_te_insert_line(), sp_te_set_repr_text_multiline(), tidy_operator_repeated_spans(), and tidy_operator_styled_whitespace().

◆ setPosition()

virtual void Inkscape::XML::Node::setPosition ( int pos )

pure virtual

Set the position of this node in parent's child order.

To move the node to the end of the parent's child order, pass a negative argument.

Parameters

pos	The new position in parent's child order

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::PathManipulator::_createControlPointsFromGeometry(), SPBox3D::convert_to_group(), Inkscape::UI::Tools::do_trace(), item_to_paths(), Inkscape::UI::Dialog::FilterEffectsDialog::PrimitiveList::on_drag_end(), Inkscape::UI::NodeList::reverse(), Inkscape::LivePathEffect::LPEPowerMask::setMask(), and sp_lpe_item_cleanup_original_path_recursive().

◆ synthesizeEvents()

virtual void Inkscape::XML::Node::synthesizeEvents ( NodeObserver & observer )

pure virtual

Generate a sequence of events corresponding to the state of this node.

This function notifies the specified observer of all the events that would recreate the current state of this node; e.g. the observer is notified of all the attributes, children and content like they were just created. This function can greatly simplify observer logic.

Parameters

observer The node observer to notify of the events

Implemented in Inkscape::XML::SimpleNode.

Referenced by Inkscape::UI::Toolbar::SpiralToolbar::_selectionChanged(), Inkscape::UI::Toolbar::StarToolbar::_selectionChanged(), and Inkscape::UI::Dialog::AttrDialog::setRepr().

◆ type()

virtual NodeType Inkscape::XML::Node::type ( ) const

pure virtual

Get the type of the node.

Returns: NodeType enumeration member corresponding to the type of the node.

Implemented in Inkscape::XML::CommentNode, Inkscape::XML::ElementNode, Inkscape::XML::PINode, Inkscape::XML::SimpleDocument, and Inkscape::XML::TextNode.

Referenced by Inkscape::UI::Dialog::XmlTree::cmd_indent_node(), Inkscape::LivePathEffect::LPEMeasureSegments::doOnApply(), duplicate_node_without_children(), find_references(), Inkscape::Extension::Internal::gatherText(), Inkscape::UI::Dialog::get_first_style_text_node(), NodeTraits::get_type_string(), Inkscape::XML::id_permitted(), is_text_or_comment_node(), Inkscape::UI::Dialog::XmlTree::on_tree_select_row_enable(), Inkscape::Extension::ParamNotebook::ParamNotebook(), Inkscape::Extension::ParamNotebook::ParamNotebookPage::ParamNotebookPage(), Inkscape::Extension::ParamOptionGroup::ParamOptionGroup(), Inkscape::UI::Dialog::XmlTree::propagate_tree_select(), prune_inkscape_from_node(), Inkscape::XML::SimpleNode::root(), SPObject::set(), Inkscape::UI::Dialog::XmlTree::set_dt_select(), Inkscape::UI::MultiPathManipulator::setNodeType(), sp_attribute_clean_element(), sp_attribute_clean_recursive(), sp_attribute_clean_style(), sp_attribute_clean_style(), sp_attribute_sort_element(), sp_attribute_sort_recursive(), sp_attribute_sort_style(), sp_repr_do_read(), sp_repr_is_meta_element(), sp_repr_save_writer(), sp_repr_svg_read_node(), sp_repr_write_stream(), SPObject::textualContent(), tidy_operator_repeated_spans(), Inkscape::FontLister::update_font_data_recursive(), Inkscape::Extension::WidgetBox::WidgetBox(), Inkscape::Extension::WidgetLabel::WidgetLabel(), and SPObject::write().

Friends And Related Symbol Documentation

◆ next_node()

Node * next_node ( Node * node )

Get the next node in sibling order.

Parameters

node	The origin node

Returns: The next node in sibling order

Definition at line 31 of file node-fns.h.

References next(), and node.

◆ parent_node()

Node * parent_node ( Node * node )

Get the node's parent.

Parameters

node	The origin node

Returns: The node's parent

Definition at line 63 of file node-fns.h.

References node, and parent().

◆ previous_node()

Node * previous_node ( Node * node )

Get the previous node in sibling order.

This method, unlike Node::next(), is a linear search over the children of node's parent. The return value is NULL when the node has no parent or is first in the sibling order.

Parameters

node	The origin node

Returns: The previous node in sibling order, or NULL

Definition at line 69 of file node-fns.cpp.

References node, and prev().

◆ sp_repr_lookup_child()

Inkscape::XML::Node * sp_repr_lookup_child	(	Inkscape::XML::Node *	repr,
		gchar const *	key,
		gchar const *	value
	)

Find an element node using an unique attribute.

This function returns the first child of the specified node that has the attribute key equal to value. Note that this function does not recurse.

Parameters

repr	The node to start from
key	The name of the attribute to use for comparisons
value	The value of the attribute to look for

Definition at line 315 of file repr-util.cpp.

References child, firstChild(), and key.

Referenced by Inkscape::XML::SimpleNode::cleanOriginal(), and Inkscape::XML::SimpleNode::mergeFrom().

◆ sp_repr_lookup_name()

Inkscape::XML::Node * sp_repr_lookup_name	(	Inkscape::XML::Node *	repr,
		char const *	name,
		int	maxdepth = `-1`
	)

Find an element node with the given name.

This function searches the descendants of the specified node depth-first for the first XML node with the specified name.

Parameters

repr	The node to start from
name	The name of the element node to find
maxdepth	Maximum search depth, or -1 for an unlimited depth

Returns: A pointer to the matching Inkscape::XML::Node

◆ sp_repr_visit_descendants() [1/2]

template<typename Visitor >

void sp_repr_visit_descendants	(	Inkscape::XML::Node *	a,
		Inkscape::XML::Node *	b,
		Visitor	visitor
	)

Visit descendants of 2 nodes in parallel.

The assumption is that one a and b trees are the same in terms of structure (like one is a duplicate of the other).

Parameters

a	first node tree root
b	second node tree root
visitor	The visitor lambda (Node , Node ) -> bool If visitor returns false child nodes are not visited.

Definition at line 219 of file repr.h.

References firstChild(), and sp_repr_visit_descendants().

◆ sp_repr_visit_descendants() [2/2]

template<typename Visitor >

void sp_repr_visit_descendants	(	Inkscape::XML::Node *	node,
		Visitor	visitor
	)

Visit all descendants recursively.

Traverse all descendants of node and call visitor on it. Stop descending when visitor returns false

Parameters

node	The root node to start visiting
visitor	The visitor lambda (Node *) -> bool If visitor returns false child nodes of current node are not visited.

Definition at line 196 of file repr.h.

References child, firstChild(), node, and sp_repr_visit_descendants().

The documentation for this class was generated from the following files:

/builds/inkscape/inkscape/src/xml/node.h
/builds/inkscape/inkscape/src/xml/node-fns.h
/builds/inkscape/inkscape/src/xml/node.cpp
/builds/inkscape/inkscape/src/xml/repr-util.cpp
/builds/inkscape/inkscape/src/xml/repr.h

Public Member Functions

Related Symbols

Notify observers about operations on the node

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ iterator

Constructor & Destructor Documentation

◆ Node() [1/2]

◆ ~Node()

◆ Node() [2/2]

Member Function Documentation

◆ addChild()

◆ addChildAtPos()

◆ addObserver()

◆ addSubtreeObserver()

◆ appendChild()

◆ attribute()

◆ attributeList()

◆ begin()

◆ changeOrder()

◆ childCount()

◆ cleanOriginal()

◆ code()

◆ content()

◆ copyAttribute()

◆ document() [1/2]

◆ document() [2/2]

◆ duplicate()

◆ end()

◆ equal()

◆ findChildPath() [1/2]

◆ findChildPath() [2/2]

◆ firstChild() [1/2]

◆ firstChild() [2/2]

◆ getAttributeBoolean()

◆ getAttributeDouble()

◆ getAttributeInt()

◆ getAttributePoint()

◆ lastChild() [1/2]

◆ lastChild() [2/2]

◆ matchAttributeName()

◆ mergeFrom()

◆ name()

◆ next() [1/2]

◆ next() [2/2]

◆ nthChild() [1/2]

◆ nthChild() [2/2]

◆ operator==()

◆ parent() [1/2]

◆ parent() [2/2]

◆ position()

◆ prev() [1/2]

◆ prev() [2/2]

◆ recursivePrintTree()

◆ removeAttribute()

◆ removeChild()

◆ removeObserver()

◆ removeSubtreeObserver()

◆ root() [1/2]

◆ root() [2/2]

◆ setAttribute()

◆ setAttributeBoolean()

◆ setAttributeCssDouble()

◆ setAttributeImpl()

◆ setAttributeInt()

◆ setAttributeOrRemoveIfEmpty()

◆ setAttributePoint()

◆ setAttributeSvgDouble()

◆ setAttributeSvgLength()

◆ setAttributeSvgNonDefaultDouble()

◆ setCodeUnsafe()

◆ setContent()

◆ setPosition()

◆ synthesizeEvents()

◆ type()

Friends And Related Symbol Documentation

◆ next_node()

◆ parent_node()

◆ previous_node()