File indexing completed on 2024-12-22 04:16:42

 /*
  *  SPDX-FileCopyrightText: 2023 Wolthera van Hövell tot Westerflier <griffinvalley@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef SVGTEXTCURSOR_H
 #define SVGTEXTCURSOR_H
 
 #include <KoSvgTextShape.h>
 #include <KoToolSelection.h>
 #include <QPainter>
 #include <KoShape.h>
 #include "kritatoolsvgtext_export.h"
 
 class KoCanvasBase;
 class SvgTextInsertCommand;
 class SvgTextRemoveCommand;
 class KUndo2Command;
 class QKeyEvent;
 class QInputMethodEvent;
 
 /**
  * @brief The SvgTextCursor class
  *
  * This class handles cursor movement and text editing operations.
  *
  * It acts as the KoToolSelection for SvgTextTool, allowing it to
  * integrate with the basic KoToolBase functionality for copy, cut
  * paste and clear.
  *
  * A selection is defined as the anchor being different from the cursor
  * position, with the move operation accepting whether you want to shift
  * the cursor position.
  *
  * It is also a shape listener to allow the textcursor to update itself
  * whenever the corresponding text shape changes.
  */
 
 class KRITATOOLSVGTEXT_EXPORT SvgTextCursor : public KoToolSelection, public KoSvgTextShape::TextCursorChangeListener
 {
     Q_OBJECT
 public:
     explicit SvgTextCursor(KoCanvasBase *canvas);
 
     enum MoveMode {
         MoveNone,
         MoveLeft,
         MoveRight,
         MoveUp,
         MoveDown,
         MoveNextChar,
         MovePreviousChar,
         MoveNextLine,
         MovePreviousLine,
         MoveWordLeft,
         MoveWordRight,
         MoveWordEnd,
         MoveWordStart,
         MoveLineStart,
         MoveLineEnd,
         ParagraphStart,
         ParagraphEnd,
     };
 
     ~SvgTextCursor();
 
     /**
      * @brief Get the current text shape
      * @return KoSvgTextShape *
      */
     KoSvgTextShape *shape() const;
 
     /**
      * @brief setShape
      * @param textShape KoSvgTextShape to set, is allowed to be a nullptr, the cursor just won't do anything.
      */
     void setShape(KoSvgTextShape *textShape);
 
     /**
      * @brief setCaretSetting
      * Set the caret settings for the cursor. Qt has some standard functionality associated, which we pass via this.
      * @param cursorWidth - Cursor width from the style.
      * @param cursorFlash - the total time it takes for a cursor to hide reapear.
      * @param cursorFlashLimit - maximum amount of time a cursor is allowed to flash.
      */
     void setCaretSetting(int cursorWidth = 1, int cursorFlash = 1000, int cursorFlashLimit = 5000);
 
     /**
      * @brief setVisualMode
      * set whether the navigation mode is visual or logical.
      * This right now primarily affects Bidirectional text.
      * @param mode whether to turn off visual mode.
      */
     void setVisualMode(bool visualMode = true);
 
     /// Get the current position.
     int getPos();
 
     /// Get the current selection anchor. This is the same as position, unless there's a selection.
     int getAnchor();
 
     /// Set the pos and the anchor.
     void setPos(int pos, int anchor);
 
     /// Set the pos from a point. This currently does a search inside the text shape.
     void setPosToPoint(QPointF point, bool moveAnchor = true);
 
     /// Move the cursor, and, if you don't want a selection, move the anchor.
     void moveCursor(MoveMode mode, bool moveAnchor = true);
 
     /// Insert text at getPos()
     void insertText(QString text);
 
     /**
      * @brief removeText
      * remove text relative to the current position.
      * This will move the cursor according to the move modes and then
      * remove the text between the two positions.
      * @param first how the cursor should move to get to the start position.
      * @param second how the cursor should move to get to the end position.
      */
     void removeText(MoveMode first, MoveMode second);
 
     void removeLastCodePoint();
 
     /**
      * @brief removeSelection
      * if there's a selection, creates a text-removal command.
      * @param parent
      * @return the text-removal command, if possible, if there's no selection or shape, it'll return 0;
      */
     void removeSelection();
 
     /**
      * @brief copy
      * copies plain text into the clipboard between anchor and pos.
      */
     void copy() const;
     /**
      * @brief paste
      * @return pastes plain text in the clipboard at pos.
      */
     bool paste();
 
     void deselectText();
 
     void paintDecorations(QPainter &gc, QColor selectionColor, int decorationThickness = 1);
 
     QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
     void inputMethodEvent(QInputMethodEvent *event);
 
     // Reimplemented.
     bool hasSelection() override;
 
     /// ShapeChangeListener reimplementation. This will update the cursor position
     /// when the shape was updated.
     void notifyShapeChanged(KoShape::ChangeType type, KoShape *shape) override;
 
     /// TextCursorChangeListener reimplementation, this allows undo commands
     /// to update the cursor without having the cursor owned by the command.
     void notifyCursorPosChanged(int pos, int anchor) override;
 
     /// Handle the cursor-related key events.
     void keyPressEvent(QKeyEvent *event);
 
     /// the cursor is currently adding a command
     bool isAddingCommand() const;
 
     /// Turns on blinking cursor.
     void focusIn();
 
     /// Stops blinking cursor.
     void focusOut();
 
 Q_SIGNALS:
 
     void updateCursorDecoration(QRectF updateRect);
 private Q_SLOTS:
     void blinkCursor();
     void stopBlinkCursor();
 
     void updateInputMethodItemTransform();
 
 private:
 
     /**
      * @brief removeSelection
      * if there's a selection, creates a text-removal command.
      * @param parent
      * @return the text-removal command, if possible, if there's no selection or shape, it'll return 0;
      */
     SvgTextRemoveCommand *removeSelectionImpl(KUndo2Command *parent = 0);
 
 
     /// update the cursor shape. First update will block ensuring the canvas is visible so setShape won't cause this.
     void updateCursor(bool firstUpdate = false);
     void updateSelection();
     void updateIMEDecoration();
     void addCommandToUndoAdapter(KUndo2Command *cmd);
 
     int moveModeResult(MoveMode &mode, int &pos, bool visual = false) const;
     bool acceptableInput(const QKeyEvent *event) const;
 
     void commitIMEPreEdit();
 
     struct Private;
     const QScopedPointer<Private> d;
 };
 
 Q_DECLARE_METATYPE(SvgTextCursor::MoveMode)
 
 
 #endif // SVGTEXTCURSOR_H