juce_ComponentBuilder.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  ComponentBuilder  : private ValueTree::Listener
{
public:
    explicit ComponentBuilder (const ValueTree& state);

    ComponentBuilder();

    ~ComponentBuilder() override;

    ValueTree state;
 
    //==============================================================================
    Component* getManagedComponent();

    Component* createComponent();
 
    //==============================================================================
    class JUCE_API  TypeHandler
    {
    public:
        //==============================================================================
        explicit TypeHandler (const Identifier& valueTreeType);

        virtual ~TypeHandler();

        const Identifier type;

        ComponentBuilder* getBuilder() const noexcept;
 
        //==============================================================================
        virtual Component* addNewComponentFromState (const ValueTree& state, Component* parent) = 0;

        virtual void updateComponentFromState (Component* component, const ValueTree& state) = 0;
 
    private:
        //==============================================================================
        friend class ComponentBuilder;
        ComponentBuilder* builder;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (TypeHandler)
    };
 
    //==============================================================================
    void registerTypeHandler (TypeHandler* type);

    TypeHandler* getHandlerForState (const ValueTree& state) const;

    int getNumHandlers() const noexcept;

    TypeHandler* getHandler (int index) const noexcept;

    void registerStandardComponentTypes();
 
    //==============================================================================
    class JUCE_API  ImageProvider
    {
    public:
        ImageProvider() = default;
        virtual ~ImageProvider() = default;

        virtual Image getImageForIdentifier (const var& imageIdentifier) = 0;

        virtual var getIdentifierForImage (const Image& image) = 0;
    };
 
    //==============================================================================
    void setImageProvider (ImageProvider* newImageProvider) noexcept;

    ImageProvider* getImageProvider() const noexcept;
 
    //==============================================================================
    void updateChildComponents (Component& parent, const ValueTree& children);

    static const Identifier idProperty;
 
private:
    //==============================================================================
    OwnedArray<TypeHandler> types;
    std::unique_ptr<Component> component;
    ImageProvider* imageProvider;
   #if JUCE_DEBUG
    WeakReference<Component> componentRef;
   #endif
 
    void valueTreePropertyChanged (ValueTree&, const Identifier&) override;
    void valueTreeChildAdded (ValueTree&, ValueTree&) override;
    void valueTreeChildRemoved (ValueTree&, ValueTree&, int) override;
    void valueTreeChildOrderChanged (ValueTree&, int, int) override;
    void valueTreeParentChanged (ValueTree&) override;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ComponentBuilder)
};
 
} // namespace juce