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

  Author:     Stefan Hundhammer <shundhammer@suse.de>

/-*/


#ifndef YQItemSelector_h
#define YQItemSelector_h

#include <QScrollArea>
#include <QMap>

#include <yui/YItemSelector.h>

class QScrollArea;
class QHBoxLayout;
class QVBoxLayout;
class QButtonGroup;
class QLabel;
class YQSelectorItemWidget;


class YQItemSelector: public QScrollArea, public YItemSelector
{
    Q_OBJECT

public:

    YQItemSelector( YWidget *    parent,
            bool     enforceSingleSelection = true );

public:

    virtual ~YQItemSelector();

    virtual void addItem( YItem * item );

    virtual void addItems( const YItemCollection & itemCollection );

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

    virtual void deselectAllItems();

    virtual void deleteAllItems();

    virtual void setEnabled( bool enabled );

    virtual int preferredWidth();

    virtual int preferredHeight();

    virtual void setSize( int newWidth, int newHeight );

    virtual bool setKeyboardFocus();

    QWidget * itemContainer() const { return _itemContainer; }

    QButtonGroup * buttonGroup() const { return _buttonGroup; }

    void addItemWidget( YQSelectorItemWidget * itemWidget );

    virtual void activateItem( YItem * item );

    virtual void shortcutChanged();

protected slots:

    void slotSelectionChanged( YQSelectorItemWidget *   itemWidget,
                               bool                     selected );



protected:

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

    void init();

    void deselectOtherItems( YItem * selectedItem );

    //
    // Data members
    //

    QWidget  * _itemContainer;
    QButtonGroup * _buttonGroup;
    QVBoxLayout  * _itemLayout;

    QMap<YItem *, YQSelectorItemWidget *> _itemWidgets;

};  // class YQItemSelector



class YQSelectorItemWidget: public QFrame
{
    Q_OBJECT

public:

    YQSelectorItemWidget( YQItemSelector        * parent,
              YItem         * item );
    virtual ~YQSelectorItemWidget();

    virtual void createWidgets();

    virtual void setSelected( bool sel = true );

    virtual bool selected() const;

    bool singleSelection() const;

    bool multiSelection() const { return ! singleSelection(); }

    void setLabel( const QString & label );

    QAbstractButton * headingToggle()   const { return _headingToggle;      }

    //
    // Getters
    //

    YQItemSelector  * parent()      const { return _parent;         }
    QLabel      * descriptionLabel()    const { return _descriptionLabel;   }
    QLabel      * iconLabel()       const { return _iconLabel;      }
    YItem       * item()        const { return _item;           }

signals:

    void selectionChanged( YQSelectorItemWidget * itemWidget, bool selected );


protected slots:

    void slotSelectionChanged( bool selected );


protected:

    virtual void createWidgets( const std::string   & label,
                                const std::string   & description,
                                const std::string   & iconName,
                                bool              selected = false );

    virtual QAbstractButton * createHeadingToggle( const std::string &  label,
                                                   QWidget *            parent );

    virtual int itemDescriptionIndent() const;

    //
    // Data members
    //

    YQItemSelector  * _parent;
    YItem       * _item;

    QHBoxLayout     * _hBox;
    QVBoxLayout     *   _vBox;
    QAbstractButton *     _headingToggle;
    QLabel      *     _descriptionLabel;
    QLabel      *   _iconLabel;

};  // class YQSelectorItemWidget



#endif  // YQItemSelector_h