juce_AudioProcessorEditor.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 AudioProcessorEditorListener;
 
//==============================================================================
class JUCE_API  AudioProcessorEditor  : public Component
{
protected:
    //==============================================================================
    AudioProcessorEditor (AudioProcessor&) noexcept;
 
    AudioProcessorEditor (AudioProcessor*) noexcept;
 
public:
    ~AudioProcessorEditor() override;
 
    //==============================================================================
    AudioProcessor& processor;
 
    AudioProcessor* getAudioProcessor() const noexcept        { return &processor; }
 
    //==============================================================================
    struct ParameterControlHighlightInfo
    {
        int parameterIndex;
        bool isHighlighted;
        Colour suggestedColour;
    };
 
    virtual void setControlHighlight (ParameterControlHighlightInfo);
 
    virtual int getControlParameterIndex (Component&);
 
    virtual bool supportsHostMIDIControllerPresence (bool hostMIDIControllerIsAvailable);
 
    virtual void hostMIDIControllerIsAvailable (bool controllerIsAvailable);
 
    virtual void setScaleFactor (float newScale);
 
    //==============================================================================
    void setResizable (bool allowHostToResize, bool useBottomRightCornerResizer);
 
    bool isResizable() const noexcept      { return resizableByHost; }
 
    void setResizeLimits (int newMinimumWidth,
                          int newMinimumHeight,
                          int newMaximumWidth,
                          int newMaximumHeight) noexcept;
 
    ComponentBoundsConstrainer* getConstrainer() noexcept           { return constrainer; }
 
    void setConstrainer (ComponentBoundsConstrainer* newConstrainer);
 
    void setBoundsConstrained (Rectangle<int> newBounds);
 
    AudioProcessorEditorHostContext* getHostContext() const noexcept          { return hostContext; }
 
    void setHostContext (AudioProcessorEditorHostContext* context) noexcept   { hostContext = context; }
 
    std::unique_ptr<ResizableCornerComponent> resizableCorner;
 
    virtual bool wantsLayerBackedView() const;
 
private:
    //==============================================================================
    struct AudioProcessorEditorListener : public ComponentListener
    {
        AudioProcessorEditorListener (AudioProcessorEditor& e) : ed (e) {}
 
        void componentMovedOrResized (Component&, bool, bool wasResized) override   { ed.editorResized (wasResized); }
        void componentParentHierarchyChanged (Component&) override                  { ed.updatePeer(); }
 
        AudioProcessorEditor& ed;
 
        JUCE_DECLARE_NON_COPYABLE (AudioProcessorEditorListener)
    };
 
    ComponentPeer* createNewPeer (int styleFlags, void*) override;
 
    //==============================================================================
    void initialise();
    void editorResized (bool wasResized);
    void updatePeer();
    void attachConstrainer (ComponentBoundsConstrainer*);
    void attachResizableCornerComponent();
 
    //==============================================================================
    std::unique_ptr<AudioProcessorEditorListener> resizeListener;
    bool resizableByHost = false;
    ComponentBoundsConstrainer defaultConstrainer;
    ComponentBoundsConstrainer* constrainer = nullptr;
    AudioProcessorEditorHostContext* hostContext = nullptr;
    Component::SafePointer<Component> splashScreen;
    AffineTransform hostScaleTransform;
 
    JUCE_DECLARE_NON_COPYABLE (AudioProcessorEditor)
};
 
} // namespace juce