PythonEditor.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 *  and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Redistribution and modification of this code is strictly prohibited.
 *
 * 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_TOOLBOXES_PYTHON_PYTHONEDITOR_H_
#define _MIRA_TOOLBOXES_PYTHON_PYTHONEDITOR_H_

#include <QEvent>

#include <fw/Framework.h>
#include <rcp/EditorPart.h>

class QTextEdit;

namespace mira { namespace python {


class PythonEditorUI : public QWidget
{
    Q_OBJECT;

    friend class PythonEditor;

public:
    PythonEditorUI(QWidget* parent) :
                   QWidget(parent)
    {
        setupUi();
    }

public slots:
    void onExecuteScript();
    void clearHighlight();

protected:
    void setupUi();
    void highlightLine(int line, const QColor& background, const QColor& underline);
    void backgroundHighlightLine(int line, const QColor& color);
    void underlineHighlightLine(int line, const QColor& color);

    QTextEdit* mLEExecuteScript;
    QTextEdit* mLEMessage;
};


class PythonEditor : public EditorPart
{
Q_OBJECT

MIRA_META_OBJECT(PythonEditor,
                ("Name", "Python editor view")
                ("Category", "Script")
                ("Description", "Python console"))

protected:
    const static std::string sDefaultPythonProgram;

public:
    PythonEditor();
    virtual ~PythonEditor() {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("EditorText",
                 getter(&PythonEditor::getEditorText, this),
                 setter(&PythonEditor::setEditorText, this),
                 "Editor's program", sDefaultPythonProgram);
        r.property("ShowWhitespace", mShowWhitespace,
                   setter(&PythonEditor::onShowWhitespace, this),
                   "Show tabs and spaces", false);
        r.property("ShowSeparators", mShowSeparators,
                   setter<bool>(&PythonEditor::onShowSeparators, this),
                   "Show line and paragraph separators", false);
    }

    virtual QWidget* createPartControl();

    void setEditorText(const std::string& text);
    std::string getEditorText() const;

protected slots:
    void onShowWhitespace(bool show);
    void onShowSeparators(bool show);

protected:
    void updateTextDisplay();

protected:
    Authority mAuthority;

    PythonEditorUI* mUI;
    std::string mEditorText;

    bool mShowWhitespace;
    bool mShowSeparators;
};


}} // namespace

#endif