PropertyEditorDelegateUtils.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_PROPERTYEDITORDELEGATEUTILS_H_
#define _MIRA_PROPERTYEDITORDELEGATEUTILS_H_

#include <QStyle>
#include <QWidget>

#include <serialization/PropertySerializer.h>

#include <widgets/PropertyEditor.h>

class QRadioButton;
class QPushButton;

namespace mira {


// Return an icon containing a true/false indicator
QIcon drawBinaryIndicator(bool value, QStyle::PrimitiveElement element);

// Compose 2 icons next to each other
QIcon composeIcon(const QIcon& left, const QIcon& right);


// Interface for editor widgets used by PropertyEditor delegates
class IPropertyDelegate_Edit
{
public:
    IPropertyDelegate_Edit(PropertyNode* p) : property(p) {}
    virtual ~IPropertyDelegate_Edit() = default;
public:
    // (re-)init widget from property value
    // must be called after constructor, allowing use of virtual methods
    virtual void initFromProperty() = 0;

    // in a derived widget, this shall be overridden by a signal and
    // emitted when the widget changes the property value
    virtual void propertyEdited() = 0;

protected:
    const PropertyNode* propertyNode() const { return property; }

    // encapsulate non-const access to the PropertyNode,
    // to do the exception handling (and potentially also define
    // specific timeout) in a single place

    void setPropertyFromString(const std::string& s);
    void setPropertyFromJSON(const JSONValue& v);

    // note: avoid using this method, prefer setting through string/JSON (above)!
    // e.g. to make a delegate for T applicable to a property of type boost::optional<T>
    template <typename T>
    void setPropertyFromValue(TypedPropertyNode<T>* p, const T& v)
    {
        try {
            p->set(v);
        }
        catch(XIO& ex) {
            MIRA_LOG(WARNING) << "Failed setting property: " << ex.message();
        }
    }

private:
    PropertyNode* property;
};


// Interface for PropertyEditor delegates wrapping around other delegates
class IPropertyDelegateWrapper
{
public:
    virtual ~IPropertyDelegateWrapper() = default;
public:
    // create a copy, which can then be used to attach a specific other delegate
    virtual PropertyEditor::DelegatePtr clone() const = 0;

    // attach another delegate
    virtual void wrap(PropertyEditor::DelegatePtr d) = 0;
};


class PropertyNode;

// An editor for properties of type boost::optional<...>
class PropertyDelegate_OptionalEditor : public QWidget, IPropertyDelegate_Edit
{
    Q_OBJECT;
public:
    PropertyDelegate_OptionalEditor(PropertyNode* p, QWidget* wrapped, QWidget* parent);

    void initFromProperty() override;
public slots:
    void setNone();
    void valueSet();
signals:
    void propertyEdited() override;
protected:
    QRadioButton* hasValueIndicator;
    QPushButton* setNoneButton;
    IPropertyDelegate_Edit* edit = nullptr;
    QWidget* wrappedWidget;
};

}

#endif