YTree.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:       YTree.h

  Author:     Stefan Hundhammer <sh@suse.de>
  Maintainer: Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YTree_h
#define YTree_h

#include "YWidget.h"
#include <ycp/YCPString.h>
#include <ycp/YCPList.h>


class YMacroRecorder;
class YTreeItem;

typedef vector<YTreeItem *>                 YTreeItemList;
typedef vector<YTreeItem *>::iterator       YTreeItemListIterator;
typedef vector<YTreeItem *>::const_iterator YTreeItemListConstIterator;


class YTree : public YWidget
{
    friend class YTreeItem;

public:

    YTree( const YWidgetOpt & opt, YCPString label );


    virtual ~YTree();


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


    virtual void rebuildTree();

    YTreeItem * addItem ( YTreeItem *           parentItem,
                          const YCPValue &      id,
                          const YCPString &     text,
                          const YCPString &     iconName,
                          bool                  open );

    YTreeItem * addItem ( YTreeItem *           parentItem,
                          const YCPString &     text,
                          const YCPString &     iconName,
                          void *                data,
                          bool                  open );

    YCPValue changeWidget( const YCPSymbol & property, const YCPValue & newvalue );

    YCPValue queryWidget( const YCPSymbol & property );

    virtual void setLabel( const YCPString & label );

    YCPString getLabel();

    const char *shortcutProperty() { return YUIProperty_Label; }

    bool parseItemList( const YCPList & itemList, YTreeItem *parentItem = 0);

    bool hasIcons() const { return _hasIcons; }


protected:

    virtual const YTreeItem * getCurrentItem() const = 0;

    virtual void setCurrentItem ( YTreeItem * it ) = 0;

    YTreeItem *findItemWithId   ( const YCPValue & id );

    YTreeItem *findItemWithText ( const YCPString & text );

    YCPList itemsTermList( YTreeItemList items );

    void findOpenItems( YCPMap & openItems, YTreeItemList items );

    virtual void deleteAllItems();


    //
    // Data members
    //
    
    YTreeItemList items;


private:

    virtual void saveUserInput( YMacroRecorder *macroRecorder );


    //
    // Data members
    //

    YCPString label;
    bool _hasIcons;
};


class YTreeItem
{
    friend class YTree;

public:

    YTreeItem ( YTree *                 parent,
                const YCPValue  &       id,
                const YCPString &       text,
                const YCPString &       iconName,
                bool                    open = false );

    YTreeItem ( YTreeItem *             parent,
                const YCPValue &        id,
                const YCPString &       text,
                const YCPString &       iconName,
                bool                    open = false );


    YTreeItem ( YTree *                 parent,
                const YCPString &       text,
                const YCPString &       iconName,
                void *                  data,
                bool                    open = false );


    YTreeItem ( YTreeItem *             parent,
                const YCPString &       text,
                const YCPString &       iconName,
                void *                  data,
                bool                    open = false );


    virtual ~YTreeItem();

    const YCPString &           getText()               const { return _text;   }
    const YCPValue &            getId()                 const { return _id;     }
    const YTreeItemList &       itemList()              const { return _items;  }
    bool                        isOpenByDefault()       const { return _openByDefault; }

    YTreeItem *findItemWithId   ( const YCPValue & id );

    YTreeItem *findItemWithText ( const YCPString & text );

    void setOpen( bool open ) { _open = open; }

    bool isOpen() const { return _open; }

    void * data() const { return _data; }

    void setData( void * data ) { _data = data; }

    YCPString iconName() const;

    void setIconName( const YCPString & icon ) { _iconName = icon; }


protected:

    YCPValue            _id;
    void *              _data;
    YCPString           _text;
    YCPString           _iconName;
    YTree *             _parentTree;
    YTreeItem *         _parentItem;
    bool                _openByDefault;
    bool                _open;

    YTreeItemList       _items;
};



#endif // YTree_h

---