ShortcutCompleter.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OpenFLUID 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 General Public License for more details.

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


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/

/**
  @file ShortcutCompleter.hpp

  @author Jean-Christophe FABRE <jean-christophe.fabre@supagro.inra.fr>
*/



#ifndef __OPENFLUID_UICOMMON_SHORTCUTCOMPLETER_HPP__
#define __OPENFLUID_UICOMMON_SHORTCUTCOMPLETER_HPP__


#include <QCompleter>
#include <QAction>
#include <QKeySequence>

#include <openfluid/dllexport.hpp>


class QLineEdit;


namespace openfluid { namespace ui { namespace common {


class OPENFLUID_API ShortcutCompleter : public QCompleter
{
  Q_OBJECT;

  private:

    QAction* mp_ShortcutAction = nullptr;

  public:

    ShortcutCompleter(QObject* Parent = nullptr);

    ShortcutCompleter(QAbstractItemModel* Model,QObject* Parent = nullptr);

    ShortcutCompleter(const QStringList& List,QObject* Parent = nullptr);

    /**
      Sets the shortcut sequence to open the completer popup
      @param[in] Shortcut the shortcut sequence
    */
    void setShortcut(const QKeySequence& Shortcut = QKeySequence(Qt::CTRL+Qt::Key_Space));

    /**
      Links the completer to a line edit
      @param[in] Widget the line edit to link to
    */
    void linkToLineEdit(QLineEdit* Widget = nullptr);

    /**
      Returns the QAction for the popup shortcut
      @return the QAction for the popup shortcut
    */
    QAction* shortcutAction() const
    { return mp_ShortcutAction; }
};


} } } // namespaces


#endif /* __OPENFLUID_UICOMMON_SHORTCUTCOMPLETER_HPP__ */