comboBox.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 COMBOBOX_H
#define COMBOBOX_H

// Qt includes
#include <QComboBox>

// CTK includes
//#include "ctkPimpl.h"
#include "commonWidgets.h"
class ComboBoxPrivate;

class ITOMWIDGETS_EXPORT ComboBox : public QComboBox
{
  Q_OBJECT
  Q_PROPERTY(QString defaultText READ defaultText WRITE setDefaultText)
  Q_PROPERTY(QIcon defaultIcon READ defaultIcon WRITE setDefaultIcon)
  Q_PROPERTY(bool forceDefault READ isDefaultForced WRITE forceDefault)
  Q_PROPERTY(Qt::TextElideMode elideMode READ elideMode WRITE setElideMode)
  Q_PROPERTY(ScrollEffect scrollWheelEffect READ scrollWheelEffect WRITE setScrollWheelEffect)
  Q_PROPERTY(QString currentUserDataAsString READ currentUserDataAsString WRITE setCurrentUserDataAsString)

public:
  explicit ComboBox(QWidget* parent = 0);
  virtual ~ComboBox();

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

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

  void forceDefault(bool forceDefault);
  bool isDefaultForced()const;

  void setElideMode(const Qt::TextElideMode& newMode);
  Qt::TextElideMode elideMode()const;

  enum ScrollEffect
  {
    NeverScroll,
    AlwaysScroll,
    ScrollWithFocus,
    ScrollWithNoVScrollBar
  };

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

  ScrollEffect scrollWheelEffect()const;
  void setScrollWheelEffect(ScrollEffect scroll);

  virtual QSize minimumSizeHint()const;
  virtual QSize sizeHint()const;

  QString currentUserDataAsString()const;

public slots:
  void setCurrentUserDataAsString(QString userData);

protected:
  virtual void paintEvent(QPaintEvent* event);
  virtual void changeEvent(QEvent* event);
  virtual void wheelEvent(QWheelEvent* event);

protected:
  QScopedPointer<ComboBoxPrivate> d_ptr;

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

#endif