ITreeNode.h

Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef _VT_ITREENODE_H_
25#define _VT_ITREENODE_H_
26
27//-----------------------------------------------------------------------------
28
29class ITreeNode
30{
31public:
32
33    ITreeNode   *mParentNode;
34    ITreeNode   *mChildNode;
35
36    ITreeNode   *mSiblingPrevNode;
37    ITreeNode   *mSiblingNextNode;
38
39public:
40
41    ITreeNode( void ) :
42            mParentNode( 0 ),
43            mChildNode( 0 ),
44            mSiblingPrevNode( 0 ),
45            mSiblingNextNode( 0 )
46    {
47        // Void.
48    };
49
50    virtual ~ITreeNode( void )
51    {
52        // Void.
53    };
54
55    virtual void               clear( void ) = 0;                              // Clear the Node.
56
57    virtual ITreeNode         *getRoot( void ) = 0;                            // Get Root Node.
58    virtual ITreeNode         *getParent( void ) = 0;                          // Get Parent Node.
59    virtual ITreeNode         *getChild( void ) = 0;                           // Get Child Node.
60    virtual ITreeNode         *getLastChild( void ) = 0;                       // Get Last Child Node.
61
62    virtual ITreeNode         *getPrevSibling( void ) = 0;                     // Get Previous Sibling Node.
63    virtual ITreeNode         *getNextSibling( void ) = 0;                     // Get Next Sibling Node.
64
65    virtual void               addTo( ITreeNode *pNode ) = 0;                  // Add Node to target node.
66    virtual void               remove( void ) = 0;                             // Remove this Node from the tree.
67    virtual void               moveTo( ITreeNode* node ) = 0;                  // Move to specified Node.
68
69    virtual void               onAttach( void ) = 0;                           // Attach Callback.
70    virtual void               onDetach( void ) = 0;                           // Detach Callback.
71
72    virtual bool               inTree( void ) = 0;                             // Is Node in a tree?
73};
74
75//-----------------------------------------------------------------------------
76
77#endif // _VT_ITREENODE_H_
78