menuComboBox.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

    This file is part of itom and its software development toolkit (SDK).

    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
   
    In addition, as a special exception, the Institut fuer Technische
    Optik (ITO) gives you certain additional rights.
    These rights are described in the ITO LGPL Exception version 1.0,
    which can be found in the file LGPL_EXCEPTION.txt in this package.

    itom 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 Library
    General Public Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.

    This file is a port and modified version of the 
    Common framework (http://www.commontk.org)
*********************************************************************** */

#ifndef MENUCOMBOBOX_H
#define MENUCOMBOBOX_H

// Qt includes
#include <QMenu>
#include <QMetaType>
#include <QWidget>
class QComboBox;
class QToolButton;

// CTK includes
#include "commonWidgets.h"
class Completer;
class MenuComboBoxPrivate;



class ITOMWIDGETS_EXPORT MenuComboBox : public QWidget
{
  Q_OBJECT

  Q_PROPERTY(QString defaultText READ defaultText WRITE setDefaultText)
  Q_PROPERTY(QIcon defaultIcon READ defaultIcon WRITE setDefaultIcon)
  Q_PROPERTY(EditableBehavior editBehavior READ editableBehavior WRITE setEditableBehavior)
  Q_PROPERTY(bool searchIconVisible READ isSearchIconVisible WRITE setSearchIconVisible)
  Q_PROPERTY(Qt::ToolButtonStyle toolButtonStyle READ toolButtonStyle WRITE setToolButtonStyle)
public:
  enum EditableBehavior{
    NotEditable = 0,
    Editable,
    EditableOnFocus,
    EditableOnPopup
  };

  //Q_ENUM exposes a meta object to the enumeration types, such that the key names for the enumeration
  //values are always accessible.
  Q_ENUM(EditableBehavior)

    
    typedef QWidget Superclass;

  MenuComboBox(QWidget* parent = 0);
  virtual ~MenuComboBox();

  Q_INVOKABLE void setMenu(QMenu* menu);
  Q_INVOKABLE QMenu* menu()const;

  Q_INVOKABLE void setCompleterMenu(QMenu* menu);
  Q_INVOKABLE QMenu* completerMenu()const;

  void setDefaultText(const QString&);
  QString defaultText()const;

  void setDefaultIcon(const QIcon&);
  QIcon defaultIcon()const;

  void setEditableBehavior(EditableBehavior editBehavior);
  EditableBehavior editableBehavior()const;

  void setSearchIconVisible(bool state);
  bool isSearchIconVisible() const;

  Qt::ToolButtonStyle toolButtonStyle() const;

  void setMinimumContentsLength(int characters);

  QComboBox* menuComboBoxInternal() const;

  QToolButton* toolButtonInternal() const;

  Completer* searchCompleter() const;

protected:
    virtual bool eventFilter(QObject* target, QEvent* event);

public Q_SLOTS:
    void clearActiveAction();
    void setToolButtonStyle(Qt::ToolButtonStyle style);

Q_SIGNALS:
    void actionChanged(QAction* action);
    void popupShown();

protected Q_SLOTS:
    void onActionSelected(QAction* action);
    void onEditingFinished();

protected:
    QScopedPointer<MenuComboBoxPrivate> d_ptr;

private:
    Q_DECLARE_PRIVATE(MenuComboBox);
    Q_DISABLE_COPY(MenuComboBox);
};

Q_DECLARE_METATYPE(MenuComboBox::EditableBehavior)

#endif