Developer Documentation
VSI::Function Class Reference

#include <Plugin-VSI/parser/function.hh>

Public Member Functions

 Function (Element *_element, const QString &_name)
 Constructor. More...
 
 ~Function ()
 Destructor. More...
 
Elementelement () const
 Element that this function belongs to. More...
 
QString name () const
 Name. More...
 
const QString & shortDescription () const
 Short description. More...
 
const QString & longDescription () const
 Long description. More...
 
Elementstart () const
 Start element of this function. More...
 
Elementend () const
 End element of this function (can be NULL) More...
 

Private Attributes

Elementelement_
 
QString name_
 
QString shortDesc_
 
QString longDesc_
 
Elementstart_
 
Elementend_
 

Friends

class Context
 

Detailed Description

Class that represents a function in the visual script interface A function represents a editable script sub element that will be executed by its element (ex. loop/condition contents)

Definition at line 67 of file function.hh.

Constructor & Destructor Documentation

◆ Function()

VSI::Function::Function ( Element _element,
const QString &  _name 
)

Constructor.

Definition at line 59 of file function.cc.

◆ ~Function()

VSI::Function::~Function ( )

Destructor.

Definition at line 70 of file function.cc.

Member Function Documentation

◆ element()

Element * VSI::Function::element ( ) const
inline

Element that this function belongs to.

Definition at line 78 of file function.hh.

◆ end()

Element * VSI::Function::end ( ) const
inline

End element of this function (can be NULL)

Definition at line 93 of file function.hh.

◆ longDescription()

const QString & VSI::Function::longDescription ( ) const
inline

Long description.

Definition at line 87 of file function.hh.

◆ name()

QString VSI::Function::name ( void  ) const
inline

Name.

Definition at line 81 of file function.hh.

◆ shortDescription()

const QString & VSI::Function::shortDescription ( ) const
inline

Short description.

Definition at line 84 of file function.hh.

◆ start()

Element * VSI::Function::start ( void  ) const
inline

Start element of this function.

Definition at line 90 of file function.hh.

Friends And Related Function Documentation

◆ Context

friend class Context
friend

Definition at line 95 of file function.hh.

Member Data Documentation

◆ element_

Element* VSI::Function::element_
private

Definition at line 98 of file function.hh.

◆ end_

Element* VSI::Function::end_
private

Definition at line 105 of file function.hh.

◆ longDesc_

QString VSI::Function::longDesc_
private

Definition at line 102 of file function.hh.

◆ name_

QString VSI::Function::name_
private

Definition at line 100 of file function.hh.

◆ shortDesc_

QString VSI::Function::shortDesc_
private

Definition at line 101 of file function.hh.

◆ start_

Element* VSI::Function::start_
private

Definition at line 104 of file function.hh.


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