completer.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 COMPLETER_H
#define COMPLETER_H

// Qt includes
#include <QCompleter>
#include <QMetaType>

#include "commonWidgets.h"

// CTK includes
class CompleterPrivate;

class ITOMWIDGETS_EXPORT Completer: public QCompleter
{
  Q_OBJECT
  Q_ENUMS(ModelFiltering)
  Q_PROPERTY(ModelFiltering modelFiltering READ modelFiltering WRITE setModelFiltering)

public:
  Completer(QObject* parent = 0);
  Completer(QAbstractItemModel* model, QObject* parent = 0);
  Completer(const QStringList& list, QObject* parent = 0 );
  virtual ~Completer();

  enum ModelFiltering
    {
    FilterStartsWith=0,
    FilterContains,
    FilterWordStartsWith
    };

  ModelFiltering modelFiltering()const;
  void setModelFiltering(ModelFiltering filter);

  virtual QStringList splitPath(const QString& s)const;

  QAbstractItemModel* sourceModel()const;
  void setSourceModel(QAbstractItemModel* model);

protected:
  QScopedPointer<CompleterPrivate> d_ptr;

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

Q_DECLARE_METATYPE(Completer::ModelFiltering)

#endif // __Completer_h