KviInputEditor.h

Go to the documentation of this file.

#ifndef _KVI_INPUT_EDITOR_H_
#define _KVI_INPUT_EDITOR_H_
//============================================================================
//
//   File : KviInputEditor.h
//   Creation date : Fri Sep 5 2008 17:26:34 by Elvio Basello
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2008 Elvio Basello (hell at hellvis69 dot netsons dot org)
//
//   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; either version 2
//   of the License, or (at your option) any later version.
//
//   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//============================================================================
//   This file was originally part of KviInput.h
//============================================================================

#include "kvi_settings.h"
#include "KviPointerList.h"
#include "KviCString.h"
#include "KviWindow.h"

#include <QMenu>
#include <QString>
#include <QWidget>

class QKeyEvent;
class QDragEnterEvent;
class QFontMetricsF;
class KviUserListView;

#define KVI_INPUT_MAX_BUFFER_SIZE 400
#define KVI_INPUT_XTRAPADDING 1
#define KVI_INPUT_MARGIN 4
#define KVI_INPUT_BLINK_TIME 800
#define KVI_INPUT_DRAG_TIMEOUT 80
#define KVI_INPUT_DEF_BACK 100
#define KVI_INPUT_DEF_FORE 101

#ifndef ACCEL_KEY
#define ACCEL_KEY(k) "\t" + QKeySequence(Qt::ControlModifier | Qt::Key_##k).toString()
#endif

class KviInputEditorSpellCheckerBlock
{
public:
        QString szText;
        int iStart;
        int iLength;
        bool bSpellCheckable;
        bool bCorrect;
};

class KviInputEditorPrivate;

class KVIRC_API KviInputEditor : public QWidget
{
        //Q_PROPERTY(int KviProperty_FocusOwner READ heightHint)
        Q_PROPERTY(int TransparencyCapable READ heightHint)
        Q_OBJECT
        friend class KviTextIconWindow; // it uses insetIconCode(const QString &)
        friend class KviTopicWidget;    // it uses home()
public:
        KviInputEditor(QWidget * pPar, KviWindow * pWnd, KviUserListView * pView = 0);

        ~KviInputEditor();

protected:
        static int g_iInputFontCharWidth[256];
        static QFontMetricsF * g_pLastFontMetrics;
        static int g_iInputInstances;
        static int g_iCachedHeight;
        QString m_szTextBuffer; // original buffer
        int m_iCursorPosition;
        int m_iSelectionBegin;
        int m_iSelectionEnd;
        int m_iMaxBufferSize;
        bool m_bSpSlowFlag; // <-- what is this ?
        int m_iCursorWidth;

        // members for supporting input methods
        QString m_szIMText;
        int m_iIMStart;
        int m_iIMLength;
        int m_iIMSelectionBegin;
        int m_iIMSelectionLength;
        bool m_bIMComposing;

        bool m_bCursorOn;

        int m_iCursorTimer;
        int m_iDragTimer;

        int m_iSelectionAnchorChar;

        // History stuff
        KviPointerList<QString> * m_pHistory;
        int m_iCurHistoryIdx;

        KviCString m_szSaveTextBuffer;

        // Nick completion
        KviUserListView * m_pUserListView;
        QString m_szLastCompletedNick;
        QString m_szLastCompletionBuffer;
        int m_iLastCompletionCursorPosition;
        bool m_bLastCompletionFinished;

        bool m_bUpdatesEnabled;
        KviCString m_szAltKeyCode;
        KviWindow * m_pKviWindow;
        QWidget * m_pInputParent;
        QMenu * m_pIconMenu;
        QMenu m_SpellCheckerPopup;
        bool m_bReadOnly;

        class EditCommand
        {
        public:
                enum Type
                {
                        InsertText, 
                        RemoveText  
                };

        private:
                Type m_eType;

                QString m_szText;

                int m_iStartPosition;

        public:
                EditCommand(Type eType, const QString & szText, int iStartPosition)
                    : m_eType(eType), m_szText(szText), m_iStartPosition(iStartPosition)
                {
                }

                void setStartPosition(int iStartPosition) { m_iStartPosition = iStartPosition; }

                int startPosition() const { return m_iStartPosition; }

                void setText(const QString & szText) { m_szText = szText; }

                const QString & text() const { return m_szText; }

                void setType(const Type & eType) { m_eType = eType; }

                const Type & type() const { return m_eType; }
        };

        KviPointerList<EditCommand> * m_pUndoStack;

        KviPointerList<EditCommand> * m_pRedoStack;

        KviInputEditorPrivate * m_p;

public:
        int heightHint() const;

        void setText(const QString szText);

        QString text() { return m_szTextBuffer; };

        QString textBeforeCursor();

        void insertChar(QChar c);

        void insertText(const QString & szTxt);

        void applyOptions(bool bRefreshCachedMetrics = true);

        void setMaxBufferSize(int iSize) { m_iMaxBufferSize = iSize; };

        void setReadOnly(bool bReadOnly) { m_bReadOnly = bReadOnly; };

        bool isReadOnly() const { return m_bReadOnly; };

        void clearUndoStack();

private:
        void replaceWordBeforeCursor(const QString & szWord, const QString & szReplacement, bool bRepaint = true);

        int replaceSegment(int iStart, int iLength, const QString & szString);

        void getWordBeforeCursor(QString & szBuffer, bool * bIsFirstWordInLine);

        static QChar getSubstituteChar(unsigned short uControlCode);

        void ensureCursorVisible();

        void repaintWithCursorOn();

        void clearSelection();

        int charIndexFromXPosition(qreal fXPos);

        qreal xPositionFromCharIndex(int iChIdx);

        void killDragTimer();

        void handleDragSelection();

        void end();

        void home();

        bool hasSelection();

        void moveCursorTo(int iIdx, bool bRepaint = true);

        void returnPressed(bool bRepaint = true);

        void completion(bool bShift);

        void standardNickCompletion(bool bAddMask, QString & szWord, bool bFirstWordInLine, bool bInCommand);

        void standardNickCompletionInsertCompletedText(const QString & szReplacedWord, const QString & szCompletedText, bool bFirstWordInLine, bool bInCommand);

        void internalCursorRight(bool bShift);

        void internalCursorLeft(bool bShift);

        inline bool isUndoAvailable() const { return !m_bReadOnly && m_pUndoStack; }

        inline bool isRedoAvailable() const { return !m_bReadOnly && m_pRedoStack; }

        void addUndo(EditCommand * pCommand);

        QFontMetricsF * getLastFontMetrics(const QFont & font);

public slots:
        void iconPopupActivated(QAction * pAction);

        void copyToSelection(bool bDonNotCopyToClipboard = true);

        void copyToClipboard();

        void removeSelected();

        void cut();

        void undo();

        void redo();

        void pasteClipboardWithConfirmation();

        void pasteSelectionWithConfirmation();

        void pasteSlow();

        void stopPasteSlow();

        void pasteFile();

        void selectAll();

        void clear();
private slots:
        void openHistory();

        void toggleMultiLineEditor();

        void previousChar();

        void nextChar();

        void previousCharSelection();

        void nextCharSelection();

        void previousWord();

        void nextWord();

        void previousWordSelection();

        void nextWordSelection();

        void insertBold();

        void insertReset();

        void insertUnderline();

        void insertReverse();

        void insertPlainText();

        void insertIcon();

        void insertColor();

        void copyInternal();

        void cutInternal();

        void pasteInternal();

        void undoInternal();

        void redoInternal();

        void selectAllInternal();

        void deletePreviousWord();

        void deleteNextWord();

        void previousLine();

        void nextLine();

        void previousPage();

        void nextPage();

        void search();

        void scrollToLastReadLine();

        void sendPlain();

        void sendKvs();

        void homeInternal();

        void endInternal();

        void homeInternalSelection();

        void endInternalSelection();

        void historyPrev();

        void historyNext();

        void returnHit();

        void backspaceHit();

        void deleteHit();

        void escapeHit();

        void toggleCommandMode();

        void dummy();

        void zoomIn();

        void zoomOut();

        void zoomDefault();

        void popupTextIconWindow();

        void showContextPopup(const QPoint & pos);

        void showContextPopupHere();

        void showSpellCheckerCorrectionsPopup();

        void spellCheckerPopupCorrectionActionTriggered();

protected:
        void insertIconCode(const QString & szCode);
        void completionEscapeUnsafeToken(QString & szToken);
        void installShortcuts();
        virtual void drawContents(QPainter *);
        //virtual void resizeEvent(QResizeEvent * e);
        virtual void timerEvent(QTimerEvent * e);
        virtual void focusInEvent(QFocusEvent * e);
        virtual void focusOutEvent(QFocusEvent * e);
        virtual void keyPressEvent(QKeyEvent * e);
        virtual void keyReleaseEvent(QKeyEvent * e);
        virtual void mousePressEvent(QMouseEvent * e);
        virtual void mouseReleaseEvent(QMouseEvent * e);
        virtual void mouseDoubleClickEvent(QMouseEvent * e);
        virtual void dragEnterEvent(QDragEnterEvent * e);
        virtual void dropEvent(QDropEvent * e);
        virtual void inputMethodEvent(QInputMethodEvent * e);
        virtual QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
        virtual void paintEvent(QPaintEvent * e);
        bool checkWordSpelling(const QString & szWord);
        void splitTextIntoSpellCheckerBlocks(const QString & szText, KviPointerList<KviInputEditorSpellCheckerBlock> & lBuffer);
        KviInputEditorSpellCheckerBlock * findSpellCheckerBlockAtCursor(KviPointerList<KviInputEditorSpellCheckerBlock> & lBlocks);
        void fillSpellCheckerCorrectionsPopup();

        void rebuildTextBlocks();

signals:
        void escapePressed();

        void enterPressed();
};

#endif //_KVI_INPUT_EDITOR_H_