QTfrontend/ui/widget/SmartLineEdit.h
changeset 6147 b4d7d8d62feb
child 6149 0b92341adb6a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/QTfrontend/ui/widget/SmartLineEdit.h	Tue Oct 18 14:28:50 2011 +0200
@@ -0,0 +1,129 @@
+/*
+ * Hedgewars, a free turn based strategy game
+ * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
+ * Copyright (c) 2007-2011 Andrey Korotaev <unC0Rr@gmail.com>
+ *
+ * This program 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; version 2 of the License
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ */
+
+#ifndef HEDGEWARS_SMARTLINEDIT
+#define HEDGEWARS_SMARTLINEDIT
+
+#include <QLineEdit>
+#include <QStringList>
+#include <QString>
+
+#include <QEvent>
+#include <QKeyEvent>
+
+#include <QMutex>
+#include <QRegExp>
+
+class QLineEdit;
+
+/**
+ * A modification of QLineEdit that will attempt to auto-complete the current
+ * word with cursor when the TAB key is pressed.
+ * Additionally it will delete its contents when ESC is pressed.
+ * A Keyword can either be a command (if first word) or
+ * a nickname (completed if any word)
+ * @author sheepluva
+ * @since 0.9.17
+ */
+class SmartLineEdit : public QLineEdit
+{
+ Q_OBJECT
+
+public:
+    /**
+    * Class constructor.
+    */
+    SmartLineEdit(QWidget * parent = 0);
+
+    /**
+     * Adds commands to the auto-completion feature.
+     * @param commands list of commands to be added.
+     */
+    void addCommands(const QStringList & commands);
+
+    /**
+     * Adds a single nickname to the auto-completion feature.
+     * @param nickname name to be added.
+     */
+    void addNickname(const QString & nickname);
+
+    /**
+     * Removes commands from the auto-completion feature.
+     * @param commands list of commands to be removed.
+     */
+    void removeCommands(const QStringList & commands);
+
+    /**
+     * Removes a single nickname from the auto-completion feature.
+     * @param nickname name to be removed.
+     */
+    void removeNickname(const QString & nickname);
+
+
+protected:
+    /**
+     * Overrides method of parent class.
+     * Forward pressed TAB to parent class' method (for focus handling etc)
+     * only if line is empty.
+     * @param event the key event.
+     * @return returns true if the event was recognized.
+     */
+    virtual bool event(QEvent * event);
+
+    /**
+     * Overrides method of parent class.
+     * Autocompletes if TAB is reported as pressed key in the key event,
+     * otherwise keys except for ESC (with no modifiers)
+     * are forwarded to parent method.
+     * ESC leads to the contents being cleared.
+     * @param event the key event.
+     */
+    virtual void keyPressEvent(QKeyEvent * event);
+
+
+private:
+    QRegExp m_whitespace; // regexp that matches a whitespace
+
+    QStringList * m_cmds;  // list of recognized commands
+    QStringList * m_nicks; // list of recognized nicknames
+
+    // these variables contain information about the last replacement
+    // they get reset whenever cursor is moved or text is changed
+
+    QString m_beforeMatch; // the string that was just matched
+    bool m_hasJustMatched; // whether this widget just did an auto-completion
+    QString m_prefix; // prefix of the text replacement this widget just did
+    QString m_postfix; // postfix of the text replacement this widget just did
+
+    QMutex m_mutex; // make all the QStringList action thread-safe
+
+    /**
+     * Autocompletes the contents based on the known commands and/or names
+     */
+    void autoComplete();
+
+
+private slots:
+    // resets the information about the last match and text replacement
+    void reset();
+};
+
+
+
+#endif // HEDGEWARS_SMARTLINEDIT