File indexing completed on 2024-05-12 16:35:02

 /* This file is part of the KDE project
  * Copyright (C) 2006-2009 Thomas Zander <zander@kde.org>
  * Copyright (C) 2008 Thorsten Zachmann <zachmann@kde.org>
  * Copyright (C) 2009 KO GmbH <cbo@kogmbh.com>
  * Copyright (C) 2011 Mojtaba Shahi Senobari <mojtaba.shahi3000@gmail.com>
  * Copyright (C) 2008, 2012 Pierre Stirnweiss <pstirnweiss@googlemail.org>
  * Copyright (C) 2014 Denis Kuplyakov <dener.kup@gmail.com>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library 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 License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, write to
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
 
 #ifndef KOTEXTTOOL_H
 #define KOTEXTTOOL_H
 
 #include "TextShape.h"
 #include "KoPointedAt.h"
 
 #include <KoToolBase.h>
 #include <KoTextCommandBase.h>
 #include <KoUnit.h>
 #include <KoBorder.h>
 #include <KoTextEditor.h>
 
 #include <QClipboard>
 #include <QHash>
 #include <QTextBlock>
 #include <QTextCursor>
 #include <QTimer>
 #include <QPointer>
 #include <QRectF>
 
 #include <TextEditingPluginContainer.h>
 
 class InsertCharacter;
 class KoChangeTracker;
 class KoCharacterStyle;
 class KoColor;
 class KoColorPopupAction;
 class KoParagraphStyle;
 class KoStyleManager;
 class KoTextEditor;
 class UndoTextCommand;
 
 class QAction;
 class KActionMenu;
 class KoFontFamilyAction;
 class FontSizeAction;
 
 class KUndo2Command;
 
 class QDrag;
 class QMimeData;
 
 class MockCanvas;
 class TextToolSelection;
 
 /**
  * This is the tool for the text-shape (which is a flake-based plugin).
  */
 class TextTool : public KoToolBase, public KoUndoableTool
 {
     Q_OBJECT
 public:
     explicit TextTool(KoCanvasBase *canvas);
 #ifndef NDEBUG
     explicit TextTool(MockCanvas *canvas);
 #endif
     ~TextTool() override;
 
     /// reimplemented from superclass
     void paint(QPainter &painter, const KoViewConverter &converter) override;
 
     /// reimplemented from superclass
     void mousePressEvent(KoPointerEvent *event) override;
     /// reimplemented from superclass
     void mouseDoubleClickEvent(KoPointerEvent *event) override;
     /// reimplemented from superclass
     void mouseTripleClickEvent(KoPointerEvent *event) override;
     /// reimplemented from superclass
     void mouseMoveEvent(KoPointerEvent *event) override;
     /// reimplemented from superclass
     void mouseReleaseEvent(KoPointerEvent *event) override;
     /// reimplemented from superclass
     void shortcutOverrideEvent(QKeyEvent *event) override;
     /// reimplemented from superclass
     void keyPressEvent(QKeyEvent *event) override;
     /// reimplemented from superclass
     void keyReleaseEvent(QKeyEvent *event) override;
 
     /// reimplemented from superclass
     void activate(ToolActivation toolActivation, const QSet<KoShape*> &shapes) override;
     /// reimplemented from superclass
     void deactivate() override;
     /// reimplemented from superclass
     void copy() const override;
 
     /// reimplemented from KoUndoableTool
     void setAddUndoCommandAllowed(bool allowed) override { m_allowAddUndoCommand = allowed; }
 
     ///reimplemented
     void deleteSelection() override;
     /// reimplemented from superclass
     void cut() override;
     /// reimplemented from superclass
     bool paste() override;
     /// reimplemented from superclass
     QStringList supportedPasteMimeTypes() const override;
     /// reimplemented from superclass
     void dragMoveEvent(QDragMoveEvent *event, const QPointF &point) override;
     /// reimplemented from superclass
     void dragLeaveEvent(QDragLeaveEvent *event) override;
     /// reimplemented from superclass
     void dropEvent(QDropEvent *event, const QPointF &point) override;
 
     /// reimplemented from superclass
     void repaintDecorations() override;
 
     /// reimplemented from superclass
     KoToolSelection* selection() override;
     /// reimplemented from superclass
     QList<QPointer<QWidget> > createOptionWidgets() override;
 
     /// reimplemented from superclass
     QVariant inputMethodQuery(Qt::InputMethodQuery query, const KoViewConverter &converter) const override;
     /// reimplemented from superclass
     void inputMethodEvent(QInputMethodEvent * event) override;
 
 
     /// The following two methods allow an undo/redo command to tell the tool, it will modify the QTextDocument and wants to be parent of the undo/redo commands resulting from these changes.
 
     void startEditing(KUndo2Command* command);
 
     void stopEditing();
 
     void setShapeData(KoTextShapeData *data);
 
     QRectF caretRect(QTextCursor *cursor, bool *upToDate=0) const;
 
     QRectF textRect(QTextCursor &cursor) const;
 
 protected:
     virtual void createActions();
     TextShape *textShape() {return m_textShape;}
 
     friend class SimpleParagraphWidget;
     friend class ParagraphSettingsDialog;
 
     KoTextEditor *textEditor() { return m_textEditor.data(); }
 
 public Q_SLOTS:
     /// Insert comment to document.
      void insertAnnotation();
     /// start the textedit-plugin.
     void startTextEditingPlugin(const QString &pluginId);
     /// reimplemented from KoToolBase
     void canvasResourceChanged(int key, const QVariant &res) override;
 
 Q_SIGNALS:
     /// emitted every time a different styleManager is set.
     void styleManagerChanged(KoStyleManager *manager);
     /// emitted every time a caret move leads to a different character format being under the caret
     void charFormatChanged(const QTextCharFormat &format, const QTextCharFormat& refBlockCharFormat);
     /// emitted every time a caret move leads to a different paragraph format being under the caret
     void blockFormatChanged(const QTextBlockFormat &format);
     /// emitted every time a caret move leads to a different paragraph format being under the caret
     void blockChanged(const QTextBlock &block);
 
 private Q_SLOTS:
     /// inserts new paragraph and includes it into the new section
     void insertNewSection();
     /// configures params of the current section
     void configureSection();
     /// inserts paragraph between sections bounds
     void splitSections();
     /// paste text from the clipboard without formatting
     void pasteAsText();
     /// make the selected text bold or not
     void bold(bool);
     /// make the selected text italic or not
     void italic(bool);
     /// underline of the selected text
     void underline(bool underline);
     /// strikethrough of the selected text
     void strikeOut(bool strikeOut);
     /// insert a non breaking space at the caret position
     void nonbreakingSpace();
     /// insert a non breaking hyphen at the caret position
     void nonbreakingHyphen();
     /// insert a soft hyphen at the caret position
     void softHyphen();
     /// insert a linebreak at the caret position
     void lineBreak();
     /// force the remainder of the text into the next page
     void insertFrameBreak();
     /// align all of the selected text left
     void alignLeft();
     /// align all of the selected text right
     void alignRight();
     /// align all of the selected text centered
     void alignCenter();
     /// align all of the selected text block-justified
     void alignBlock();
     /// make the selected text switch to be super-script
     void superScript(bool);
     /// make the selected text switch to be sub-script
     void subScript(bool);
     /// move the paragraph indent of the selected text to be less (left on LtR text)
     void decreaseIndent();
     /// move the paragraph indent of the selected text to be more (right on LtR text)
     void increaseIndent();
     /// Increase the font size. This will preserve eventual difference in font size within the selection.
     void increaseFontSize();
     /// Decrease font size. See above.
     void decreaseFontSize();
     /// Set font family
     void setFontFamily(const QString &);
     /// Set Font size
     void setFontSize(qreal size);
     /// see KoTextEditor::insertIndexMarker
     void insertIndexMarker();
     /// shows a dialog to insert a table
     void insertTable();
     /// insert a table of given dimensions
     void insertTableQuick(int rows, int columns);
     /// insert a row above
     void insertTableRowAbove();
     /// insert a row below
     void insertTableRowBelow();
     /// insert a column left
     void insertTableColumnLeft();
     /// insert a column right
     void insertTableColumnRight();
     /// delete a column
     void deleteTableColumn();
     /// delete a row
     void deleteTableRow();
     /// merge table cells
     void mergeTableCells();
     /// split previous merged table cells
     void splitTableCells();
     /// format the table border (enter table pen mode)
     void setTableBorderData(const KoBorder::BorderData &data);
     /// shows a dialog to alter the paragraph properties
     void formatParagraph();
     /// select all text in the current document.
     void selectAll();
     /// show the style manager
     void showStyleManager(int styleId = -1);
     /// change color of a selected text
     void setTextColor(const KoColor &color);
     /// change background color of a selected text
     void setBackgroundColor(const KoColor &color);
     /// Enable or disable auto-resize
     void setAutoResize(bool enabled);
     /// Enable or disable grow-width-to-fit-text.
     void setGrowWidthToFit(bool enabled);
     /// Enable or disable grow-height-to-fit-text.
     void setGrowHeightToFit(bool enabled);
     /// Enable or disable shrink-to-fit-text.
     void setShrinkToFit(bool enabled);
     /// set Paragraph style of current selection. Existing style will be completely overridden.
     void setStyle(KoParagraphStyle *syle);
     /// set the characterStyle of the current selection. see above.
     void setStyle(KoCharacterStyle *style);
     /// set the level of current selected list
     void setListLevel(int level);
 
     /// slot to call when a series of commands is started that together need to become 1 undo action.
     void startMacro(const QString &title);
     /// slot to call when a series of commands has ended that together should be 1 undo action.
     void stopMacro();
 
     /// show the insert special character docker.
     void insertSpecialCharacter();
     /// insert string
     void insertString(const QString &string);
 
     /// returns the focus to canvas when styles are selected in the optionDocker
     void returnFocusToCanvas();
 
     void selectFont();
     void shapeAddedToCanvas();
 
     void blinkCaret();
     void relayoutContent();
 
     // called when the m_textShapeData has been deleted.
     void shapeDataRemoved();
 
     //Show tooltip with editing info
     void showEditTip();
 
     /// print debug about the details of the text document
     void debugTextDocument();
     /// print debug about the details of the styles on the current text document
     void debugTextStyles();
 
     void ensureCursorVisible(bool moveView = true);
 
     void createStyleFromCurrentBlockFormat(const QString &name);
     void createStyleFromCurrentCharFormat(const QString &name);
 
     void testSlot(bool);
 
     /// change block text direction
     void textDirectionChanged();
 
     void updateActions();
 
 private:
     void repaintCaret();
     void repaintSelection();
     KoPointedAt hitTest(const QPointF & point) const;
     void updateStyleManager();
     void updateSelectedShape(const QPointF &point, bool noDocumentChange);
     void updateSelectionHandler();
     void editingPluginEvents();
     void finishedWord();
     void finishedParagraph();
     void startingSimpleEdit();
     void runUrl(KoPointerEvent *event, QString &url);
     void useTableBorderCursor();
 
     QMimeData *generateMimeData() const;
 
     TextEditingPluginContainer *textEditingPluginContainer();
 
 private:
     friend class UndoTextCommand;
     friend class ChangeTracker;
     friend class TextCutCommand;
     friend class ShowChangesCommand;
 
     TextShape *m_textShape; // where caret of m_textEditor currently is
     KoTextShapeData *m_textShapeData; // where caret of m_textEditor currently is
     QPointer<KoTextEditor> m_textEditor;
     QPointer<KoTextEditor> m_oldTextEditor;
     KoChangeTracker *m_changeTracker;
     KoUnit m_unit;
     bool m_allowActions;
     bool m_allowAddUndoCommand;
     bool m_allowResourceManagerUpdates;
     int m_prevCursorPosition; /// used by editingPluginEvents
     int m_prevMouseSelectionStart, m_prevMouseSelectionEnd;
 
     QTimer m_caretTimer;
     bool m_caretTimerState;
     QAction *m_actionPasteAsText;
     QAction *m_actionFormatBold;
     QAction *m_actionFormatItalic;
     QAction *m_actionFormatUnderline;
     QAction *m_actionFormatStrikeOut;
     QAction *m_actionAlignLeft;
     QAction *m_actionAlignRight;
     QAction *m_actionAlignCenter;
     QAction *m_actionAlignBlock;
     QAction *m_actionFormatSuper;
     QAction *m_actionFormatSub;
     QAction *m_actionFormatIncreaseIndent;
     QAction *m_actionFormatDecreaseIndent;
     QAction *m_autoResizeAction;
     QAction *m_growWidthAction;
     QAction *m_growHeightAction;
     QAction *m_shrinkToFitAction;
     QAction *m_actionChangeDirection;
     QAction *m_actionInsertSection;
     QAction *m_actionConfigureSection;
     QAction *m_actionSplitSections;
     KActionMenu *m_variableMenu;
 
     FontSizeAction *m_actionFormatFontSize;
     KoFontFamilyAction *m_actionFormatFontFamily;
     KoColorPopupAction *m_actionFormatTextColor;
     KoColorPopupAction *m_actionFormatBackgroundColor;
 
     KUndo2Command *m_currentCommand; //this command will be the direct parent of undoCommands generated as the result of QTextDocument changes
 
     bool m_currentCommandHasChildren;
 
     InsertCharacter *m_specialCharacterDocker;
 
     QPointer<TextEditingPluginContainer> m_textEditingPlugins;
 
     bool m_textTyping;
     bool m_textDeleting;
 
     QTimer m_editTipTimer;
     KoPointedAt m_editTipPointedAt;
     QPoint m_editTipPos;
 
     bool m_delayedEnsureVisible;
     TextToolSelection *m_toolSelection;
 
     KoPointedAt m_tableDragInfo;
     bool m_tableDraggedOnce;
     bool m_tableDragWithShift;
     QPointF m_draggingOrigin;
     qreal m_dx;
     qreal m_dy;
     bool m_tablePenMode;
     KoBorder::BorderData m_tablePenBorderData;
     mutable QRectF m_lastImMicroFocus;
 
     bool m_clickWithinSelection;
     QDrag *m_drag;
     QAbstractTextDocumentLayout::Selection m_preDragSelection;
 };
 
 #endif