82 lines
2.9 KiB
C
82 lines
2.9 KiB
C
|
/*
|
||
|
|
==============================================================================
|
||
|
|
|
||
|
|
This file is part of the JUCE library.
|
||
|
|
Copyright (c) 2020 - 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 6 End-User License
|
||
|
|
Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).
|
||
|
|
|
||
|
|
End User License Agreement: www.juce.com/juce-6-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
|
||
|
|
{
|
||
|
|
|
||
|
|
//==============================================================================
|
||
|
|
/**
|
||
|
|
|
||
|
|
@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
|