YItem.h

Go to the documentation of this file.

/*
  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:     YItem.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YItem_h
#define YItem_h

#include <string>
#include <vector>
#include <iosfwd>


class YItem;

// without "documenting" the file, typedefs will be dropped

typedef std::vector<YItem *>            YItemCollection;

typedef YItemCollection::iterator       YItemIterator;

typedef YItemCollection::const_iterator     YItemConstIterator;


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

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

    virtual ~YItem() {}

    virtual const char * itemClass() const { return "YItem"; }

    std::string label() const { return _label; }

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

    std::string iconName() const { return _iconName; }

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

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

    bool selected() const { return _status != 0; }

    void setSelected( bool sel = true ) { _status = sel ? 1 : 0; }

    int status() const { return _status; }

    void setStatus( int newStatus ) { _status = newStatus; }

    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; }

    virtual std::string debugLabel() const;

    std::string limitLength( const std::string & text, int limit ) const;


private:

    std::string _label;
    std::string _iconName;
    int         _status;
    int     _index;
    void *  _data;

    static YItemCollection _noChildren;
};


std::ostream & operator<<( std::ostream & stream, const YItem * item );



#endif // YItem_h