YTree.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  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 Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YTree.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YTree_h
#define YTree_h

#include "YSelectionWidget.h"

class YTreeItem;
class YTreePrivate;


class YTree : public YSelectionWidget
{
protected:

    YTree( YWidget *           parent,
           const std::string & label,
           bool                multiSelection,
           bool                recursiveSelection);

public:

    virtual ~YTree();

    virtual const char * widgetClass() const { return "YTree"; }

    virtual void rebuildTree() = 0;

    virtual void addItems( const YItemCollection & itemCollection );

    bool immediateMode() const;

    void setImmediateMode( bool on = true );

    virtual bool setProperty( const std::string    & propertyName,
                  const YPropertyValue & val );

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();

    const char * userInputProperty() { return YUIProperty_CurrentItem; }


    bool hasMultiSelection() const;

    virtual YTreeItem * currentItem() = 0;

    virtual void activate() = 0;

    YTreeItem * findItem( const std::vector<std::string> & path ) const;


protected:

    YTreeItem * findItem( std::vector<std::string>::const_iterator path_begin,
                          std::vector<std::string>::const_iterator path_end,
                          YItemConstIterator                       begin,
                          YItemConstIterator                       end ) const;

private:

    ImplPtr<YTreePrivate> priv;
};


#endif // YTree_h