kworship/songdb/KwSongDatabaseNode.h

   1 #ifndef _KwSongDatabaseNode_h_
   2 #define _KwSongDatabaseNode_h_
   3
   4 /**
   5  * @file KwSongDatabaseNode.h
   6  * @brief A node on a song database tree.
   7  * @author James Hogan <james@albanarts.com>
   8  */
   9
  10 #include <QVariant>
  11 #include <QVector>
  12
  13 class KwDisplayManager;
  14
  15 /// A node on a playlist tree.
  16 /**
  17  * Inherit from this class for each playlist node type.
  18  */
  19 class KwSongDatabaseNode
  20 {
  21   public:
  22
  23     /*
  24      * Constructors + destructor.
  25      */
  26
  27     /// Primary constructor.
  28     KwSongDatabaseNode(KwSongDatabaseNode* parent);
  29
  30     /// Destructor.
  31     virtual ~KwSongDatabaseNode();
  32
  33     /*
  34      * Main interface
  35      */
  36
  37     /// Get the parent.
  38     KwSongDatabaseNode* getParent();
  39
  40     /// Get a child node by index.
  41     KwSongDatabaseNode* getChild(int index);
  42
  43     /// Get the index of a certain child.
  44     int getChildIndex(KwSongDatabaseNode* node) const;
  45
  46     /// Get data associated with the node.
  47     virtual QVariant getData(int role, int column);
  48
  49     /// Get the number of children.
  50     virtual int getChildCount() const;
  51
  52     /// Activate the node using a display manager.
  53     virtual void activate(KwDisplayManager* manager);
  54
  55   protected:
  56
  57     /// Get a child node by index.
  58     virtual KwSongDatabaseNode* _getChild(int index);
  59
  60   private:
  61
  62     /*
  63      * Variables
  64      */
  65
  66     /// Parent node.
  67     KwSongDatabaseNode* m_parent;
  68
  69     /// Child nodes.
  70     QVector<KwSongDatabaseNode*> m_children;
  71 };
  72
  73 #endif // _KwSongDatabaseNode_h_
  74