juce_ComponentBuilder.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_COMPONENTBUILDER_H_INCLUDED
#define JUCE_COMPONENTBUILDER_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  ComponentBuilder  : private ValueTree::Listener
{
public:
    explicit ComponentBuilder (const ValueTree& state);
 
    ComponentBuilder();
 
    ~ComponentBuilder();
 
    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() {}
        virtual ~ImageProvider() {}
 
        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;
    ScopedPointer<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)
};
 
#endif   // JUCE_COMPONENTBUILDER_H_INCLUDED