NCTable.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  Copyright (C) 2020 SUSE LLC
  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:       NCTable.h

   Authors:    Michael Andres <ma@suse.de>
               Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef NCTable_h
#define NCTable_h

#include <yui/YTable.h>
#include "NCPadWidget.h"
#include "NCTablePad.h"
#include "NCTableSort.h"


class NCTable : public YTable, public NCPadWidget
{
    friend std::ostream & operator<<( std::ostream & str, const NCTable & obj );

public:

    NCTable( YWidget *      parent,
             YTableHeader * tableHeader,
             bool           multiSelection = false );

    virtual ~NCTable();

    void setHeader( const std::vector<std::string>& head );

    std::vector<std::string> getHeader() const;

    virtual void addItems( const YItemCollection & itemCollection );

    virtual void addItem( YItem *yitem )
        { addItem( yitem, NCTableLine::S_NORMAL ); }

    virtual void addItem( YItem *            yitem,
                          NCTableLine::STATE state );

    virtual void deleteAllItems();

    virtual int getCurrentIndex() const;

    virtual int getCurrentItem() const;

    YItem * getCurrentItemPointer();

    virtual void setCurrentItem( int index );

    virtual void scrollToFirstItem();

    virtual void selectItem( YItem *yitem, bool selected );

    void selectCurrentItem();

    virtual void deselectAllItems();

    virtual NCursesEvent wHandleInput( wint_t key );

    virtual int preferredWidth();

    virtual int preferredHeight();

    virtual void setSize( int newWidth, int newHeight );

    virtual void setLabel( const std::string & nlabel );

    virtual void setEnabled( bool do_bv );

    virtual bool setKeyboardFocus()
    {
    if ( !grabFocus() )
        return YWidget::setKeyboardFocus();

    return true;
    }

    bool setItemByKey( int key );

    void SetSepChar( const chtype colSepchar )
        { myPad()->SetSepChar( colSepchar ); }

    void SetSepWidth( const unsigned sepwidth )
        { myPad()->SetSepWidth( sepwidth ); }

    void SetHotCol( int hcol )
        { myPad()->SetHotCol( hcol ); }

    bool bigList() const { return _bigList; }

    void setBigList( bool big ) { _bigList = big; }

    void stripHotkeys() { myPad()->stripHotkeys(); }

    void setSortStrategy( NCTableSortStrategyBase * newStrategy );

    NCTableSortStrategyBase * sortStrategy() const { return _sortStrategy; }


protected:

    virtual const char * location() const { return "NCTable"; }

    virtual NCPad * CreatePad();

    virtual NCTablePad * myPad() const
    { return dynamic_cast<NCTablePad*>( NCPadWidget::myPad() ); }

    virtual void addItem( YItem *            yitem,
                          bool               preventRedraw,
                          NCTableLine::STATE state = NCTableLine::S_NORMAL );

    virtual void addPadLine( NCTableLine *      parentLine,
                             YItem *            yitem,
                             bool               preventRedraw,
                             NCTableLine::STATE state = NCTableLine::S_NORMAL );


    void rebuildPadLines();

    void rebuildHeaderLine();

    NCstring alignmentStr( int col );

    bool hasNestedItems( const YItemCollection & itemCollection ) const;

    bool hasNestedItems( YItemConstIterator begin,
                         YItemConstIterator end ) const;

    virtual void startMultipleChanges() { startMultidraw(); }

    virtual void doneMultipleChanges()  { stopMultidraw(); }

    void toggleCurrentItem();

    void cellChanged( const YTableCell * cell );

    void setCell( int index, int col, const std::string & newText );

    void assignIndex( YItemConstIterator begin,
                      YItemConstIterator end );

    void assignIndex( YItem * item );

    void interactiveSort();

    void sortItems( int sortCol, bool reverse = false );

    void sortYItems( YItemIterator begin,
                     YItemIterator end   );

private:

    // Disable unwanted assignment opearator and copy constructor

    NCTable & operator=( const NCTable & );
    NCTable( const NCTable & );


    //
    // Data members
    //

    // Number of non-data prefix columns for things like the multi-selection
    // indicator ("[ ]" / "[x]")
    int  _prefixCols;

    bool _nestedItems;
    bool _bigList;
    bool _multiSelect;

    int  _lastSortCol;
    bool _sortReverse;
    NCTableSortStrategyBase * _sortStrategy;    //< owned
};


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


#endif // NCTable_h