NCItemSelector.h

/*
  Copyright (C) 2019 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:       NCItemSelector.h

   Author:     Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef NCItemSelector_h
#define NCItemSelector_h

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

#include <yui/YItemSelector.h>
#include "NCPadWidget.h"
#include "NCTablePad.h"


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

protected:

    NCItemSelectorBase( YWidget * parent, bool enforceSingleSelection );

    NCItemSelectorBase( YWidget *           parent,
            const YItemCustomStatusVector & customStates );

public:

    virtual ~NCItemSelectorBase();

    virtual NCursesEvent wHandleInput( wint_t key );

    virtual int preferredWidth();

    virtual int preferredHeight();

    virtual void setSize( int newWidth, int newHeight );

    virtual YItem * currentItem() const;

    virtual void setCurrentItem( YItem * item );

    virtual void setEnabled( bool do_bv );

    virtual bool setKeyboardFocus();

    virtual void setVisibleItems( int newVal );

    int linesCount() const { return (int) myPad()->Lines(); }

    int currentLine() const { return myPad()->CurPos().L; }

    virtual void addItem( YItem * item );

    virtual void deleteAllItems();

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

    virtual void deselectAllItems();

    const NCTableLine * getLine( int lineNo ) { return myPad()->GetLine( lineNo ); }


    virtual void startMultipleChanges() { startMultidraw(); }

    virtual void doneMultipleChanges()  { stopMultidraw(); }

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

    virtual void activateItem( YItem * item );

    virtual void shortcutChanged();

    virtual bool HasHotkey( int key ) ;

protected:

    void createItemWidget( YItem * item );

    virtual NCTableTag * createTagCell( YItem * item ) = 0;

    virtual void cycleCurrentItemStatus() = 0;

    virtual bool statusChangeAllowed( int fromStatus, int toStatus )
        { return false; }

    virtual NCursesEvent valueChangedNotify( YItem * item ) = 0;

    std::string description( YItem * item ) const;

    std::vector<std::string> descriptionLines( YItem * item ) const;

    YItem * scrollDownToNextItem();

    YItem * scrollUpToPreviousItem();

    virtual wsze preferredSize();

    virtual NCTableTag * tagCell( int index ) const;

    int findItemLine( YItem * item ) const;

    virtual NCPad * CreatePad();

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

    virtual void wRecoded() { NCPadWidget::wRecoded(); }

private:

    // Disable assignment operator and copy constructor

    NCItemSelectorBase & operator=( const NCItemSelectorBase & );
    NCItemSelectorBase( const NCItemSelectorBase & );

    YItem* findItemWithHotkey( int key ) const;

protected:

    // Data members

    wsze _prefSize;
    bool _prefSizeDirty;
    int _selectorWidth;
    int _hotKey;


};  // class NCItemSelectorBase



class NCItemSelector: public NCItemSelectorBase
{
public:
    NCItemSelector( YWidget * parent, bool enforceSingleSelection );

    virtual ~NCItemSelector();

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

protected:

    virtual NCTableTag * createTagCell( YItem * item );

    virtual NCursesEvent valueChangedNotify( YItem * item );

    virtual void cycleCurrentItemStatus();

    virtual bool statusChangeAllowed( int fromStatus, int toStatus );

    void deselectAllItemsExcept( YItem * exceptItem );


private:

    // Disable assignment operator and copy constructor

    NCItemSelector & operator=( const NCItemSelector & );
    NCItemSelector( const NCItemSelector & );

};      // class NCItemSelector


#endif // NCItemSelector_h