CBCGPOutlineNode

Detailed Description

The CBCGPOutlineNode class is used with CBCGPEditCtrl and CBCGPOutlineParser classes.

It represents an hierarchy of outlining nodes and the data structure for collapsible node itself. It contains a list of sub nodes and a pointer to parent node.

The root of the hierarchy tree is the node that meets the following conditions: parent node is NULL, m_nStart is -1, m_nEnd is -1. The CBCGPEditCtrl class contains the root of the hierarchy tree for all collapsible nodes.

Each node has a list of sub nodes:

• Sub nodes are sorted by their offsets from the beginning of the edit control's text buffer.
• Intersection of collapsible nodes is not allowed.
• Parent node covers all sub nodes. A sub node should be inside its parent node.

All these conditions are verified while new nodes are being added. Note, that if you add a new node, which intersects some of existing nodes, then all intersected nodes are removed.

See also

CBCGPOutlineBaseNode

Inheritance diagram for CBCGPOutlineNode:

Public Member Functions
	AddBlock	Adds a new collapsible node.
	DeleteBlocksInRange	Removes all collapsible nodes within a range.
	DeleteInnermostBlock	Deletes a node, which contains the specified offset.
	GetAllBlocks	Returns all subnodes of a collapsible node.
	GetBlocksByState	Returns a list of subnodes according to their state, either collapsed or expanded.
	GetBlocksByStateInRange	Finds all collapsed or expanded nodes inside the specified range.
	GetBlocksInRange	Returns all collapsible nodes from the specified range (by offsets).
	GetCount	Returns the number of subnodes for this collapsible node.
	GetInnermostBlock	Searches for a collabsible node by offset and returns an innermost node.
	GetParentNode	Returns a pointer to parent node.
	GetValue	Returns data members of a collapsible node.
	Serialize	Serialize a collapsible node.
	ToggleAllOutlining	Expands or collapses all nodes.
	ToggleOutliningInRange	Expands or collapses blocks in range (by offset).
	UpdateBlocksForDeletedRange	Updates a collapsible node's bounds in case the text at the collapsible node is being deleted partially.
	UpdateBlocksForInsertedText	Updates the collapsible node's bounds in case the new text is being inserted at the collapsible node.
Public Member Functions inherited from CBCGPOutlineBaseNode
	IsInRangeByOffset	Called by the edit control when it needs to determine whether the collapsible is placed within some range.
	Move	Called by the framework when it needs to move a collapsible node.

Additional Inherited Members
Public Attributes inherited from CBCGPOutlineBaseNode
	m_bCollapsed	Specifies whether the node is collapsed or not.
	m_dwFlags	Used by the framework for auto-outlining.
	m_nBlockType	Specifies the type of block for this collapsible node.
	m_nEnd	Specifies the end offset of the collapsible node hidden area.
	m_nNameOffset	Keyword offset.
	m_nStart	Specifies the start offset of the collapsible node hidden area.
	m_pData	A pointer to user-defined data.
	m_rectTool	The rect bounds for the symbol that is drawing in the edit control in place of hidden text. Used by the framework.
	m_strReplace	Specifies the replace string that is shown when the node is collapsed. The default string is three dots ("...").
Static Public Attributes inherited from CBCGPOutlineBaseNode
	m_bCollapsedDefault	Specifies whether the outline node is collapsed by default, or not.