KisNodeDummiesGraph Class Reference

#include <kis_node_dummies_graph.h>

Public Member Functions
void	addNode (KisNodeDummy *node, KisNodeDummy *parent, KisNodeDummy *aboveThis)
bool	containsNode (KisNodeSP node) const
int	dummiesCount () const
	KisNodeDummiesGraph ()
void	moveNode (KisNodeDummy *node, KisNodeDummy *parent, KisNodeDummy *aboveThis)
KisNodeDummy *	nodeToDummy (KisNodeSP node)
void	removeNode (KisNodeDummy *node)
KisNodeDummy *	rootDummy () const

Private Types
typedef QMap< KisNodeSP, KisNodeDummy * >	NodeMap

Private Member Functions
void	unmapDummyRecursively (KisNodeDummy *dummy)

Private Attributes
NodeMap	m_dummiesMap
KisNodeDummy *	m_rootDummy

Detailed Description

KisNodeDummiesGraph manages the hierarchy of dummy objects representing nodes in the UI environment.

Definition at line 83 of file kis_node_dummies_graph.h.

Member Typedef Documentation

NodeMap

typedef QMap<KisNodeSP, KisNodeDummy*> KisNodeDummiesGraph::NodeMap

private

Definition at line 133 of file kis_node_dummies_graph.h.

Constructor & Destructor Documentation

KisNodeDummiesGraph()

KisNodeDummiesGraph::KisNodeDummiesGraph

(

)

Definition at line 106 of file kis_node_dummies_graph.cpp.

    : m_rootDummy(0)
{
}

Member Function Documentation

addNode()

void KisNodeDummiesGraph::addNode	(	KisNodeDummy *	node,
		KisNodeDummy *	parent,
		KisNodeDummy *	aboveThis )

Adds a dummy node to the position specified by parent and aboveThis.

It is not expected that you would add a dummy twice.

Definition at line 116 of file kis_node_dummies_graph.cpp.

{
    Q_ASSERT(!containsNode(node->node()));
 
    node->setParent(parent);
 
    Q_ASSERT_X(parent || !m_rootDummy, "KisNodeDummiesGraph::addNode", "Trying to add second root dummy");
    Q_ASSERT_X(!parent || m_rootDummy, "KisNodeDummiesGraph::addNode", "Trying to add non-orphan child with no root dummy set");
 
    if(!parent) {
        m_rootDummy = node;
    }
    else {
        int insertionIndex = parent->m_children.size();
 
        insertionIndex = aboveThis ?
            parent->m_children.indexOf(aboveThis) + 1: 0;
 
        Q_ASSERT(!aboveThis || parent->m_children.indexOf(aboveThis) >= 0);
 
        parent->m_children.insert(insertionIndex, node);
    }
 
    m_dummiesMap[node->node()] = node;
}

References containsNode(), m_dummiesMap, m_rootDummy, and KisNodeDummy::node().

containsNode()

bool KisNodeDummiesGraph::containsNode

(

KisNodeSP

node

)

const

Definition at line 176 of file kis_node_dummies_graph.cpp.

{
    return m_dummiesMap.contains(node);
}

References m_dummiesMap.

dummiesCount()

int KisNodeDummiesGraph::dummiesCount

(

)

const

Definition at line 181 of file kis_node_dummies_graph.cpp.

{
    return m_dummiesMap.size();
}

References m_dummiesMap.

moveNode()

void KisNodeDummiesGraph::moveNode	(	KisNodeDummy *	node,
		KisNodeDummy *	parent,
		KisNodeDummy *	aboveThis )

Moves a dummy node from its current position to the position specified by parent and aboveThis.

It is expected that the dummy node has been added to the graph with addNode() before calling this function.

Definition at line 170 of file kis_node_dummies_graph.cpp.

{
    removeNode(node);
    addNode(node, parent, aboveThis);
}

References addNode(), and removeNode().

nodeToDummy()

KisNodeDummy * KisNodeDummiesGraph::nodeToDummy

(

KisNodeSP

node

)

Definition at line 186 of file kis_node_dummies_graph.cpp.

{
    if (!m_dummiesMap.contains(node)) {
        return 0;
    }
 
    return m_dummiesMap[node];
}

References m_dummiesMap.

removeNode()

void KisNodeDummiesGraph::removeNode

(

KisNodeDummy *

node

)

Removes the dummy node from the graph.

WARNING: The dummy is only "unlinked" from the graph. Neither deletion of the node nor deletion of its children happens. The dummy keeps maintaining its children so after unlinking it from the graph you can just type to free memory recursively:

graph.removeNode(node);
delete node;

Definition at line 142 of file kis_node_dummies_graph.cpp.

{
    Q_ASSERT(containsNode(node->node()));
    unmapDummyRecursively(node);
 
    KisNodeDummy *parent = node->parent();
    Q_ASSERT_X(m_rootDummy, "KisNodeDummiesGraph::removeNode", "Trying to remove a dummy with no root dummy");
 
    if(!parent) {
        m_rootDummy = 0;
    }
    else {
        parent->m_children.removeOne(node);
    }
}

References containsNode(), m_rootDummy, KisNodeDummy::node(), KisNodeDummy::parent(), and unmapDummyRecursively().

rootDummy()

KisNodeDummy * KisNodeDummiesGraph::rootDummy

(

)

const

Returns the root dummy of the graph. Take it into account that root may be null, while the image is being switched.

Definition at line 111 of file kis_node_dummies_graph.cpp.

{
    return m_rootDummy;
}

References m_rootDummy.

unmapDummyRecursively()

void KisNodeDummiesGraph::unmapDummyRecursively ( KisNodeDummy * dummy )

private

Definition at line 158 of file kis_node_dummies_graph.cpp.

{
    m_dummiesMap.remove(dummy->node());
 
    KisNodeDummy *child = dummy->firstChild();
    while(child) {
        unmapDummyRecursively(child);
        child = child->nextSibling();
    }
}

References KisNodeDummy::firstChild(), m_dummiesMap, KisNodeDummy::nextSibling(), KisNodeDummy::node(), and unmapDummyRecursively().

Member Data Documentation

m_dummiesMap

NodeMap KisNodeDummiesGraph::m_dummiesMap

private

Definition at line 137 of file kis_node_dummies_graph.h.

m_rootDummy

KisNodeDummy* KisNodeDummiesGraph::m_rootDummy

private

Definition at line 136 of file kis_node_dummies_graph.h.

---

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

• libs/ui/flake/kis_node_dummies_graph.h
• libs/ui/flake/kis_node_dummies_graph.cpp