juce_TextInputTarget.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
class JUCE_API  TextInputTarget
{
public:
    //==============================================================================
    TextInputTarget() = default;
 
    virtual ~TextInputTarget() = default;
 
    virtual bool isTextInputActive() const = 0;
 
    virtual Range<int> getHighlightedRegion() const = 0;
 
    virtual void setHighlightedRegion (const Range<int>& newRange) = 0;
 
    virtual void setTemporaryUnderlining (const Array<Range<int>>& underlinedRegions) = 0;
 
    virtual String getTextInRange (const Range<int>& range) const = 0;
 
    virtual void insertTextAtCaret (const String& textToInsert) = 0;
 
    virtual int getCaretPosition() const = 0;
 
    Rectangle<int> getCaretRectangle() const        { return getCaretRectangleForCharIndex (getCaretPosition()); }
 
    virtual Rectangle<int> getCaretRectangleForCharIndex (int characterIndex) const = 0;
 
    virtual int getTotalNumChars() const = 0;
 
    virtual int getCharIndexForPoint (Point<int> point) const = 0;
 
    virtual RectangleList<int> getTextBounds (Range<int> textRange) const = 0;
 
    enum VirtualKeyboardType
    {
        textKeyboard = 0,
        numericKeyboard,
        decimalKeyboard,
        urlKeyboard,
        emailAddressKeyboard,
        phoneNumberKeyboard,
        passwordKeyboard
    };
 
    virtual VirtualKeyboardType getKeyboardType()       { return textKeyboard; }
};
 
} // namespace juce