var_tree.hpp

/*****************************************************************************
 * var_tree.hpp
 *****************************************************************************
 * Copyright (C) 2005 VideoLAN
 * $Id: var_bool.hpp 9934 2005-02-15 13:55:08Z courmisch $
 *
 * Authors: Antoine Cellerier <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

#ifndef VAR_TREE_HPP
#define VAR_TREE_HPP

#include <list>

#include "variable.hpp"
#include "observer.hpp"
#include "ustring.hpp"
#include "var_percent.hpp"

class VarTree: public Variable, public Subject<VarTree>
{
    public:
        VarTree( intf_thread_t *pIntf );

        VarTree( intf_thread_t *pIntf, VarTree *pParent, int id,
                 const UStringPtr &rcString, bool selected, bool playing,
                 bool expanded, void *pData );

        virtual ~VarTree();

        virtual const string &getType() const { return m_type; }

        virtual void add( int id, const UStringPtr &rcString, bool selected,
                          bool playing, bool expanded, void *pData );

        virtual void delSelected();

        virtual void clear();

        int m_id;
        UStringPtr m_cString;
        bool m_selected;
        bool m_playing;
        bool m_expanded;
        void *m_pData;

        int size() const { return m_children.size(); }

        typedef list<VarTree>::iterator Iterator;
        typedef list<VarTree>::const_iterator ConstIterator;

        Iterator begin() { return m_children.begin(); }
        ConstIterator begin() const { return m_children.begin(); }

        Iterator end() { return m_children.end(); }
        ConstIterator end() const { return m_children.end(); }

        VarTree &back() { return m_children.back(); }

        Iterator operator[]( int n );
        ConstIterator operator[]( int n ) const;

        VarTree *parent() { return m_pParent; }
        void VarTree::checkParents( VarTree *pParent );

        Iterator uncle();

        VarTree *root()
        {
            VarTree *parent = this;
            while( parent->parent() != NULL )
                parent = parent->parent();
            return parent;
        }

        int depth()
        {
            VarTree *parent = this;
            int depth = 0;
            while( ( parent = parent->parent() ) != NULL )
                depth++;
            return depth;
        }

        virtual void action( VarTree *pItem ) {}

        VarPercent &getPositionVar() const
        { return *((VarPercent*)m_cPosition.get()); }

        const VariablePtr &getPositionVarPtr() const { return m_cPosition; }

        int visibleItems();

        Iterator getVisibleItem( int n );

        Iterator getNextVisibleItem( Iterator it );

        Iterator findById( int id );

    private:
        list<VarTree> m_children;

        VarTree *m_pParent;

        static const string m_type;

        VariablePtr m_cPosition;
};

#endif

---