FxUITextCursor.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
class CFxUITextCursorImpl;
class CFxUITextView;

 
class COMMONUI_API CFxUITextCursor
{
public:
    enum FxUIMoveOperation
    {
        NoMove = 0,       //Keep the cursor where it is
        Start =    1, //Move to the start of the document.
        StartOfLine = 3, //Move to the start of the current line.
        StartOfBlock = 5, //Move to the start of the current word.
        PreviousBlock = 6, //Move to the start of the previous block.
        PreviousCharacter = 7, //Move to the previous character.
        PreviousWord = 8,   //Move to the beginning of the previous word.
        Up = 2, //Move up one line.
        Left = 9, //Move left one character.
        WordLeft = 10, //Move left one word.
        End  = 11, //Move to the end of the document.
        EndOfLine = 13, //Move to the end of the current line.
        EndOfWord = 14, //Move to the end of the current word.
        EndOfBlock = 15, //Move to the end of the current block.
        NextBlock = 16,        //Move to the beginning of the next block.
        NextCharacter = 17,        //Move to the next character.
        NextWord = 18, //Move to the next word.
        Down = 12, //Move down one line.
        Right = 19,        //Move right one character.
        WordRight = 20, //Move right one word.
        NextCell = 21, //Move to the beginning of the next table cell inside the current table.If the current cell is the last cell in the row, the cursor will move to the first cell in the next row.
        PreviousCell = 22, //Move to the beginning of the previous table cell inside the current table.If the current cell is the first cell in the row, the cursor will move to the last cell in the previous row.
        NextRow = 23, //Move to the first new cell of the next row in the current table.
        PreviousRow = 24 //Move to the last cell of the previous row in the current table.
    };
 
    enum FxUIMoveMode  {
        MoveAnchor, //Moves the anchor to the same position as the cursor itself.
        KeepAnchor  //Keeps the anchor where it is.
    };
 
public:

    CFxUITextCursor( CFxUITextView* view );

    ~CFxUITextCursor();

    bool movePosition( FxUIMoveOperation moveOperation, FxUIMoveMode  moveMode, int n = 1 );

    CFxUIString selectedText();

    void removeSelectedText();

    void deletePreviousChar();

    int position() const;

    void setPosition( int pos );
 
protected:
    CFxUITextCursorImpl* m_pImpl = nullptr;
};