juce_CallOutBox.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  CallOutBox    : public Component,
                                private Timer
{
public:
    //==============================================================================
    CallOutBox (Component& contentComponent,
                Rectangle<int> areaToPointTo,
                Component* parentComponent);
 
    //==============================================================================
    void setArrowSize (float newSize);

    void updatePosition (const Rectangle<int>& newAreaToPointTo,
                         const Rectangle<int>& newAreaToFitIn);
 

    static CallOutBox& launchAsynchronously (std::unique_ptr<Component> contentComponent,
                                             Rectangle<int> areaToPointTo,
                                             Component* parentComponent);

    void dismiss();

    void setDismissalMouseClicksAreAlwaysConsumed (bool shouldAlwaysBeConsumed) noexcept;
 
    //==============================================================================
    struct JUCE_API  LookAndFeelMethods
    {
        virtual ~LookAndFeelMethods() = default;
 
        virtual void drawCallOutBoxBackground (CallOutBox&, Graphics&, const Path&, Image&) = 0;
        virtual int getCallOutBoxBorderSize (const CallOutBox&) = 0;
        virtual float getCallOutBoxCornerSize (const CallOutBox&) = 0;
    };
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void moved() override;
    void childBoundsChanged (Component*) override;
    bool hitTest (int x, int y) override;
    void inputAttemptWhenModal() override;
    bool keyPressed (const KeyPress&) override;
    void handleCommandMessage (int) override;
    int getBorderSize() const noexcept;
    void lookAndFeelChanged() override;
 
private:
    //==============================================================================
    Component& content;
    Path outline;
    Point<float> targetPoint;
    Rectangle<int> availableArea, targetArea;
    Image background;
    float arrowSize = 16.0f;
    bool dismissalMouseClicksAreAlwaysConsumed = false;
 
    Time creationTime;
 
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void refreshPath();
    void timerCallback() override;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (CallOutBox)
};
 
} // namespace juce