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

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

/-*/

#ifndef NCTree_h
#define NCTree_h

#include <iosfwd>

#include <yui/YTree.h>
#include "NCPadWidget.h"
#include "NCTreePad.h"
#include "NCTablePad.h"

class NCTreeLine;

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

public:

    NCTree( YWidget *           parent,
            const std::string & label,
            bool                multiselection     = false,
            bool                recursiveselection = false );

    virtual ~NCTree();

    virtual void rebuildTree();

    virtual YTreeItem * getCurrentItem() const;

    virtual YTreeItem * currentItem();

    virtual void deselectAllItems();

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

    virtual void selectItem( int index );

    virtual void deleteAllItems();

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

    virtual void activate();

    virtual NCursesEvent wHandleInput( wint_t key );


protected:

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

    virtual NCPad * CreatePad();

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

    virtual void DrawPad();


    const NCTreeLine * getTreeLine( unsigned idx ) const;

    NCTreeLine * modifyTreeLine( unsigned idx );

    virtual void startMultipleChanges() { startMultidraw(); }

    virtual void doneMultipleChanges()  { stopMultidraw(); }

    void CreateTreeLines( NCTreeLine * parentLine,
                          NCTreePad  * pad,
                          YItem      * item );

private:

    // Disable unwanted assignment operator and copy constructor

    NCTree & operator=( const NCTree & );
    NCTree( const NCTree & );


    //
    // Data members
    //

    bool _multiSelect;
    int  _nextItemIndex; // Only used in CreateTreeLines()
};


class NCTreeLine : public NCTableLine
{
public:

    NCTreeLine( NCTreeLine * parentLine,
                YTreeItem  * origItem,
                bool         multiSelection );

    virtual ~NCTreeLine();

public:

    YTreeItem * YItem() const { return dynamic_cast<YTreeItem *>( _yitem ); }

    virtual bool ChangeToVisible();

    virtual unsigned Hotspot( unsigned & at ) const;

    virtual bool handleInput( wint_t key );


    //
    // Some covariants of the tree operations returning this derived class
    //

    virtual NCTreeLine * parent()      const { return dynamic_cast<NCTreeLine *>( _parent      ); }
    virtual NCTreeLine * firstChild()  const { return dynamic_cast<NCTreeLine *>( _firstChild  ); }
    virtual NCTreeLine * nextSibling() const { return dynamic_cast<NCTreeLine *>( _nextSibling ); }


private:

    //
    // Data members
    //

    bool _multiSelect;
};


#endif // NCTree_h