geometrize::dialog::ScriptEditorWidget Class Reference

The ScriptEditorWidget class implements a widget for interactively editing a Chaiscript function. More...

#include <scripteditorwidget.h>

Inheritance diagram for geometrize::dialog::ScriptEditorWidget:

Collaboration diagram for geometrize::dialog::ScriptEditorWidget:

Classes
class	ScriptEditorWidgetImpl

Signals
void	signal_scriptChanged (ScriptEditorWidget *self, const std::string &functionName, const std::string &code)
	signal_scriptChanged Signal emitted when the user change the script code of a function. More...
void	signal_scriptReset (ScriptEditorWidget *self, const std::string &functionName, const std::string &code)
	signal_scriptReset Signal emitted when the user hits the reset button, expecting the script to be reset to some default code. More...

Public Member Functions
	ScriptEditorWidget (QObject *parent)
	ScriptEditorWidget (const std::string &title, const std::string &functionName, const std::string &defaultCode, QWidget *parent=nullptr)
virtual	~ScriptEditorWidget ()
std::string	getFunctionName () const
std::string	getDefaultCode () const
std::string	getCurrentCode () const
void	setCurrentCode (const std::string &code)
void	resetCodeToDefault ()
void	onScriptEvaluationSucceeded ()
void	onScriptEvaluationFailed (const std::string &errorMessage)

Protected Member Functions
void	changeEvent (QEvent *) override

Private Attributes
std::unique_ptr< ScriptEditorWidgetImpl >	d

Detailed Description

The ScriptEditorWidget class implements a widget for interactively editing a Chaiscript function.

Constructor & Destructor Documentation

ScriptEditorWidget() [1/2]

geometrize::dialog::ScriptEditorWidget::ScriptEditorWidget

(

QObject *

parent

)

ScriptEditorWidget() [2/2]

geometrize::dialog::ScriptEditorWidget::ScriptEditorWidget	(	const std::string &	title,
		const std::string &	functionName,
		const std::string &	defaultCode,
		QWidget *	parent = nullptr
	)

                                                                                                                                           : QGroupBox(parent), d{std::make_unique<ScriptEditorWidgetImpl>(this, title, functionName, defaultCode)}
{
}

~ScriptEditorWidget()

geometrize::dialog::ScriptEditorWidget::~ScriptEditorWidget ( )

virtual

{
}

Member Function Documentation

changeEvent()

void geometrize::dialog::ScriptEditorWidget::changeEvent ( QEvent *  event )

overrideprotected

{
    if (event->type() == QEvent::LanguageChange) {
        d->onLanguageChange();
    }
    QGroupBox::changeEvent(event);
}

getCurrentCode()

std::string geometrize::dialog::ScriptEditorWidget::getCurrentCode

(

)

const

{
    return d->getCurrentCode();
}

Here is the caller graph for this function:

getDefaultCode()

std::string geometrize::dialog::ScriptEditorWidget::getDefaultCode

(

)

const

{
    return d->getDefaultCode();
}

getFunctionName()

std::string geometrize::dialog::ScriptEditorWidget::getFunctionName

(

)

const

{
    return d->getFunctionName();
}

onScriptEvaluationFailed()

void geometrize::dialog::ScriptEditorWidget::onScriptEvaluationFailed

(

const std::string &

errorMessage

)

{
    d->onScriptEvaluationFailed(errorMessage);
}

onScriptEvaluationSucceeded()

void geometrize::dialog::ScriptEditorWidget::onScriptEvaluationSucceeded

(

)

{
    d->onScriptEvaluationSucceeded();
}

Here is the caller graph for this function:

resetCodeToDefault()

void geometrize::dialog::ScriptEditorWidget::resetCodeToDefault

(

)

{
    d->resetCodeToDefault();
}

setCurrentCode()

void geometrize::dialog::ScriptEditorWidget::setCurrentCode

(

const std::string &

code

)

{
    d->setCurrentCode(code);
}

signal_scriptChanged

void geometrize::dialog::ScriptEditorWidget::signal_scriptChanged ( ScriptEditorWidget *  self, const std::string &  functionName, const std::string &  code  )

signal

signal_scriptChanged Signal emitted when the user change the script code of a function.

Parameters

self	The widget emitting this signal.
functionName	The name of the function that was edited.
code	The new Chaiscript code.

Here is the caller graph for this function:

signal_scriptReset

void geometrize::dialog::ScriptEditorWidget::signal_scriptReset ( ScriptEditorWidget *  self, const std::string &  functionName, const std::string &  code  )

signal

signal_scriptReset Signal emitted when the user hits the reset button, expecting the script to be reset to some default code.

Parameters

self	The widget emitting this signal.
functionName	The name of the function that was reset.
code	The default Chaiscript code.

Member Data Documentation

d

std::unique_ptr<ScriptEditorWidgetImpl> geometrize::dialog::ScriptEditorWidget::d

private

---

The documentation for this class was generated from the following files:

• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/dialog/scripteditorwidget.h
• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/dialog/scripteditorwidget.cpp