juce_TextInputTarget.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE 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.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_TEXTINPUTTARGET_H_INCLUDED
#define JUCE_TEXTINPUTTARGET_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  TextInputTarget
{
public:
    //==============================================================================
    TextInputTarget() {}
 
    virtual ~TextInputTarget() {}
 
    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 Rectangle<int> getCaretRectangle() = 0;
 
    enum VirtualKeyboardType
    {
        textKeyboard = 0,
        numericKeyboard,
        decimalKeyboard,
        urlKeyboard,
        emailAddressKeyboard,
        phoneNumberKeyboard
    };
 
    virtual VirtualKeyboardType getKeyboardType()       { return textKeyboard; }
};
 
 
#endif   // JUCE_TEXTINPUTTARGET_H_INCLUDED