YTableItem.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:         YTableItem.h

  Author:       Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YTableItem_h
#define YTableItem_h

#include "YTreeItem.h"


class YTableCell;

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

typedef std::vector<YTableCell *>       YTableCellCollection;

typedef YTableCellCollection::iterator      YTableCellIterator;

typedef YTableCellCollection::const_iterator    YTableCellConstIterator;



class YTableItem: public YTreeItem
{
public:

    YTableItem();

    YTableItem( YTableItem * parent,
                bool         isOpen = false );

    YTableItem( const std::string & label_0,
                const std::string & label_1 = std::string(),
                const std::string & label_2 = std::string(),
                const std::string & label_3 = std::string(),
                const std::string & label_4 = std::string(),
                const std::string & label_5 = std::string(),
                const std::string & label_6 = std::string(),
                const std::string & label_7 = std::string(),
                const std::string & label_8 = std::string(),
                const std::string & label_9 = std::string() );

    YTableItem( YTableItem *        parent,
                const std::string & label_0,
                const std::string & label_1 = std::string(),
                const std::string & label_2 = std::string(),
                const std::string & label_3 = std::string(),
                const std::string & label_4 = std::string(),
                const std::string & label_5 = std::string(),
                const std::string & label_6 = std::string(),
                const std::string & label_7 = std::string(),
                const std::string & label_8 = std::string(),
                const std::string & label_9 = std::string() );

    virtual ~YTableItem();

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

    void addCell( YTableCell * cell_disown );

    void addCell( const std::string & label,
                  const std::string & iconName = std::string(),
          const std::string & sortKey  = std::string() );

    void addCells( const std::string & label_0,
                   const std::string & label_1,
                   const std::string & label_2 = std::string(),
                   const std::string & label_3 = std::string(),
                   const std::string & label_4 = std::string(),
                   const std::string & label_5 = std::string(),
                   const std::string & label_6 = std::string(),
                   const std::string & label_7 = std::string(),
                   const std::string & label_8 = std::string(),
                   const std::string & label_9 = std::string() );

    void deleteCells();

    YTableCellIterator          cellsBegin()            { return _cells.begin(); }
    YTableCellConstIterator     cellsBegin() const      { return _cells.begin(); }

    YTableCellIterator          cellsEnd()              { return _cells.end(); }
    YTableCellConstIterator     cellsEnd() const        { return _cells.end(); }

    const YTableCell * cell( int index ) const;
    YTableCell *       cell( int index );

    int cellCount() const { return _cells.size(); }

    bool hasCell( int index ) const;

    std::string label( int index ) const;

    std::string iconName( int index ) const;

    bool hasIconName( int index ) const;

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

    virtual std::string debugLabel() const;


private:

    // Disable unwanted base class methods. They don't make sense in this
    // context since there is not just one single label or icon name, but one
    // for each cell.

    std::string iconName()  const           { return ""; }
    bool    hasIconName()   const           { return false; }
    void    setLabel    ( const std::string & ) {}
    void    setIconName ( const std::string & ) {}


    //
    // Data members
    //

    YTableCellCollection _cells;
};



class YTableCell
{
public:
    YTableCell( const std::string & label, const std::string & iconName = "",
        const std::string & sortKey = "" )
        : _label( label )
        , _iconName( iconName )
    , _sortKey( sortKey )
    , _parent( 0 )
    , _column ( -1 )
        {}

    YTableCell( YTableItem *        parent,
        int         column,
        const std::string & label,
        const std::string & iconName = "",
        const std::string &     sortKey = "" )
        : _label( label )
        , _iconName( iconName )
    , _sortKey( sortKey )
    , _parent( parent )
    , _column ( column )
        {}

    virtual ~YTableCell() {}

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

    std::string sortKey() const { return _sortKey; }

    bool hasSortKey() const { return ! _sortKey.empty(); }

    void setSortKey( const std::string & newSortKey ) { _sortKey = newSortKey; }

    YTableItem * parent() const { return _parent; }

    int column() const { return _column; }

    int itemIndex() const { return _parent ? _parent->index() : -1; }

    void reparent( YTableItem * parent, int column );


private:

    std::string     _label;
    std::string     _iconName;
    std::string         _sortKey;
    YTableItem *    _parent;
    int         _column;
};


#endif // YTableItem_h