DesignObjectToggleWidget.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: DesignObjectToggleWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/QTDesignObject.h>
#include <NDEVR/Toggle.h>
#include <NDEVR/ManagedDesignCommand.h>
#include <NDEVR/JSONNode.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A widget allowing easy access to change the properties of a designObject by showing a toggle
        to the user.
    **/
    class NDEVR_API DesignObjectToggleWidget : public Toggle
    {
        Q_OBJECT
    public:
        DesignObjectToggleWidget(QWidget* parent = nullptr)
            : Toggle(parent)
            , m_property(DesignObject::e_design_property_size)
        {
            setFunction([this](Button*)
            {
                sendCommand();
            });
        }
        void clearTarget()
        {
            setTarget(DynamicPointer<QTDesignObject>());
        }
        void setTarget(DesignObject::DesignProperty property, const DynamicPointer<QTDesignObject>& object)
        {
            setTarget(object);
            setDesignProperty(property);
        }
        void setTarget(const DynamicPointer<QTDesignObject>& object)
        {
            if (m_target == object)
                return;
            if (!m_target.isNull())
            {
                disconnect(&m_target.get(), &QTDesignObject::updatedSignal, this, &DesignObjectToggleWidget::onObjectUpdatedSlot);
                disconnect(&m_target.get(), &QTDesignObject::deletedSignal, this, &DesignObjectToggleWidget::onObjectDeletedSlot);
            }
            m_target = object;
            if (!m_target.isNull())
            {
                connect(&m_target.get(), &QTDesignObject::updatedSignal, this, &DesignObjectToggleWidget::onObjectUpdatedSlot);
                connect(&m_target.get(), &QTDesignObject::deletedSignal, this, &DesignObjectToggleWidget::onObjectDeletedSlot);
            }
            setEnabled(!m_target.isNull());
            onObjectUpdatedSlot();
        }
        void setDesignProperty(DesignObject::DesignProperty property)
        {
            m_property = property;
            if (m_title.isEmpty())
            {
                if (property == DesignObject::DesignProperty::e_meta_data)
                    setTitle(TranslatedString(String(m_meta_data).formatAsTitleString()));
                else
                    setTitle(String::DisplayString(property));
            }
            onObjectUpdatedSlot();
        }
        void setupForMetadata(const TranslatedString& title, String meta_data)
        {
            m_title = title;
            m_meta_data = meta_data;
            setDesignProperty(DesignObject::DesignProperty::e_meta_data);
        }
        void setupForMetadata(const String& metadata)
        {
            m_meta_data = metadata;
            setDesignProperty(DesignObject::DesignProperty::e_meta_data);
        }
    protected slots:
        void onObjectDeletedSlot()
        {
            setTarget(DynamicPointer<QTDesignObject>());
        }
        void sendCommand()
        {
            bool toggle = isChecked();
            if (m_property == DesignObject::DesignProperty::e_meta_data)
            {
                m_target->postCommand(ManagedDesignCommand::SetMetadata(m_meta_data, String(toggle)));
            }
            else
            {
                if (toggle != m_target->getAs<DesignObject>().getProperty<bool>(m_property))
                    m_target->postCommand(ManagedDesignCommand::SetProperty(m_property, toggle));
            }
        }
        void onObjectUpdatedSlot()
        {
            if (!m_target.isNull() && m_property != DesignObject::e_design_property_size)
            {
                bool checked = false;
                if (m_property == DesignObject::e_meta_data)
                {
                    if (m_target->get().hasMetaData(m_meta_data))
                        checked = m_target->get().metaData(m_meta_data).getAs<bool>();
                }
                else
                {
                    checked = m_target->getProperty<bool>(m_property);
                }
                setChecked(checked);
            }
        }
    protected:
        DesignObject::DesignProperty m_property;
        DynamicPointer<QTDesignObject> m_target;
        TranslatedString m_title;
        String m_meta_data;
    };
}