/data/gitorious.org/libyui/libyui-master/src/YItem.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

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.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


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

  File:         YItem.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YItem_h
#define YItem_h

#include <string>
#include <vector>

using std::string;
using std::vector;

class YItem;

typedef vector<YItem *>                         YItemCollection;
typedef YItemCollection::iterator               YItemIterator;
typedef YItemCollection::const_iterator         YItemConstIterator;


class YItem
{
public:
    YItem( const string & label, bool selected = false )
        : _label( label )
        , _selected( selected )
        , _index( -1 )
        , _data( 0 )
        {}

    YItem( const string & label, const string & iconName, bool selected = false )
        : _label( label )
        , _iconName( iconName )
        , _selected( selected )
        , _index( -1 )
        , _data( 0 )
        {}

    virtual ~YItem() {}

    string label() const { return _label; }

    void setLabel( const string & newLabel ) { _label = newLabel; }

    string iconName() const { return _iconName; }

    bool hasIconName() const { return ! _iconName.empty(); }

    void setIconName( const string & newIconName ) { _iconName = newIconName; }

    bool selected() const { return _selected; }

    void setSelected( bool sel = true ) { _selected = sel; }

    void setIndex( int index ) { _index = index; }

    int index() const { return _index; }

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

    void * data() const { return _data; }

    //
    // Children management stubs.
    //
    // Derived classes that can handle child items should reimplement those
    // functions.  
    // The following default implementations don't do anything with children;
    // they act as if this item didn't have any children.
    //

    virtual bool hasChildren() const { return false; }

    virtual YItemIterator       childrenBegin()         { return _noChildren.end(); }
    virtual YItemConstIterator  childrenBegin() const   { return _noChildren.end(); }

    virtual YItemIterator       childrenEnd()           { return _noChildren.end(); }
    virtual YItemConstIterator  childrenEnd() const     { return _noChildren.end(); }

    virtual YItem * parent() const { return 0; }


private:

    string      _label;
    string      _iconName;
    bool        _selected;
    int         _index;
    void *      _data;

    static YItemCollection _noChildren;
};



#endif // YItem_h