mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
90 lines
3.5 KiB
C++
90 lines
3.5 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE framework.
|
|
Copyright (c) Raw Material Software Limited
|
|
|
|
JUCE is an open source framework subject to commercial or open source
|
|
licensing.
|
|
|
|
By downloading, installing, or using the JUCE framework, or combining the
|
|
JUCE framework with any other source code, object code, content or any other
|
|
copyrightable work, you agree to the terms of the JUCE End User Licence
|
|
Agreement, and all incorporated terms including the JUCE Privacy Policy and
|
|
the JUCE Website Terms of Service, as applicable, which will bind you. If you
|
|
do not agree to the terms of these agreements, we will not license the JUCE
|
|
framework to you, and you must discontinue the installation or download
|
|
process and cease use of the JUCE framework.
|
|
|
|
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
|
|
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
|
|
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
|
|
|
|
Or:
|
|
|
|
You may also use this code under the terms of the AGPLv3:
|
|
https://www.gnu.org/licenses/agpl-3.0.en.html
|
|
|
|
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
|
|
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API CaretComponent : public Component,
|
|
private Timer
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates the caret component.
|
|
The keyFocusOwner is an optional component which the caret will check, making
|
|
itself visible only when the keyFocusOwner has keyboard focus.
|
|
*/
|
|
CaretComponent (Component* keyFocusOwner);
|
|
|
|
/** Destructor. */
|
|
~CaretComponent() override;
|
|
|
|
//==============================================================================
|
|
/** Sets the caret's position to place it next to the given character.
|
|
The area is the rectangle containing the entire character that the caret is
|
|
positioned on, so by default a vertical-line caret may choose to just show itself
|
|
at the left of this area. You can override this method to customise its size.
|
|
This method will also force the caret to reset its timer and become visible (if
|
|
appropriate), so that as it moves, you can see where it is.
|
|
*/
|
|
virtual void setCaretPosition (const Rectangle<int>& characterArea);
|
|
|
|
/** A set of colour IDs to use to change the colour of various aspects of the caret.
|
|
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour()
|
|
methods.
|
|
@see Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
|
|
*/
|
|
enum ColourIds
|
|
{
|
|
caretColourId = 0x1000204, /**< The colour with which to draw the caret. */
|
|
};
|
|
|
|
//==============================================================================
|
|
/** @internal */
|
|
void paint (Graphics&) override;
|
|
|
|
private:
|
|
Component* owner;
|
|
|
|
bool shouldBeShown() const;
|
|
void timerCallback() override;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE (CaretComponent)
|
|
};
|
|
|
|
} // namespace juce
|