juce_CaretComponent.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_CARETCOMPONENT_H_INCLUDED
#define JUCE_CARETCOMPONENT_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  CaretComponent   : public Component,
                                   private Timer
{
public:
    //==============================================================================
    CaretComponent (Component* keyFocusOwner);
 
    ~CaretComponent();
 
    //==============================================================================
    virtual void setCaretPosition (const Rectangle<int>& characterArea);
 
    enum ColourIds
    {
        caretColourId    = 0x1000204, 
    };
 
    //==============================================================================
    void paint (Graphics&) override;
 
private:
    Component* owner;
 
    bool shouldBeShown() const;
    void timerCallback() override;
 
    JUCE_DECLARE_NON_COPYABLE (CaretComponent)
};
 
 
#endif   // JUCE_CARETCOMPONENT_H_INCLUDED