\hypertarget{a10916}{}\section{Vsi\+Plugin Class Reference}
\label{a10916}\index{Vsi\+Plugin@{Vsi\+Plugin}}


{\ttfamily \#include $<$Plugin-\/\+V\+S\+I/vsi\+Plugin.\+hh$>$}

Inheritance diagram for Vsi\+Plugin\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{a10916}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{DoxyCompactItemize}
\item 
Q\+Script\+Value \hyperlink{a10916_a1d80b4d7ddf9057e7b74ea645f85d8a4}{ask\+For\+Inputs} (Q\+String \+\_\+element, Q\+String \+\_\+inputs)
\begin{DoxyCompactList}\small\item\em Scripting function, that allows to ask the user for inputs during script execution. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_a028ebd2d76ad9172f6e8ba413231d625}\label{a10916_a028ebd2d76ad9172f6e8ba413231d625}} 
void \hyperlink{a10916_a028ebd2d76ad9172f6e8ba413231d625}{message\+Box} (Q\+String \+\_\+message)
\begin{DoxyCompactList}\small\item\em Scripting function, that displays a message box. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_a52f0209977b97b72025eeaa30b2a84f9}\label{a10916_a52f0209977b97b72025eeaa30b2a84f9}} 
bool \hyperlink{a10916_a52f0209977b97b72025eeaa30b2a84f9}{question\+Box} (Q\+String \+\_\+message)
\begin{DoxyCompactList}\small\item\em Scripting function, that displays a Yes/\+No message box. \end{DoxyCompactList}\item 
bool \hyperlink{a10916_a094c47e1e0b0105eb473268e968827ee}{continue\+Box} (Q\+String \+\_\+message)
\begin{DoxyCompactList}\small\item\em Shows a non blocking stop box for use inside loops. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_af0a5077a9843d2b46cad2cce6c3614d3}\label{a10916_af0a5077a9843d2b46cad2cce6c3614d3}} 
Q\+String {\bfseries version} ()
\end{DoxyCompactItemize}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a10916_a30d8316d8ae72ffff4b1454e9c0be6f2}\label{a10916_a30d8316d8ae72ffff4b1454e9c0be6f2}} 
void {\bfseries get\+Menubar\+Menu} (Q\+String \+\_\+name, Q\+Menu $\ast$\&\+\_\+menu, bool \+\_\+create)
\item 
\mbox{\Hypertarget{a10916_a96ae61b26f67b1ec5824bfe8d5bb2649}\label{a10916_a96ae61b26f67b1ec5824bfe8d5bb2649}} 
void {\bfseries get\+Scripting\+Engine} (Q\+Script\+Engine $\ast$\&\+\_\+engine)
\item 
\mbox{\Hypertarget{a10916_a82aa223936e50b739d4962944b1dd3f2}\label{a10916_a82aa223936e50b739d4962944b1dd3f2}} 
void {\bfseries plugin\+Exists} (Q\+String \+\_\+plugin\+Name, bool \&\+\_\+exists)
\item 
\mbox{\Hypertarget{a10916_a18a41ef850cda735416efb982c6d1ccf}\label{a10916_a18a41ef850cda735416efb982c6d1ccf}} 
void {\bfseries function\+Exists} (Q\+String \+\_\+plugin\+Name, Q\+String \+\_\+function\+Name, bool \&\+\_\+exists)
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a10916_a2535a7b331d5e993dd35e26863c13db0}\label{a10916_a2535a7b331d5e993dd35e26863c13db0}} 
\hyperlink{a10916_a2535a7b331d5e993dd35e26863c13db0}{Vsi\+Plugin} ()
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_ad60904d287843ae7a6b945f705c62906}\label{a10916_ad60904d287843ae7a6b945f705c62906}} 
\hyperlink{a10916_ad60904d287843ae7a6b945f705c62906}{$\sim$\+Vsi\+Plugin} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_afeafde7cf993d4460d25abba9ce9a953}\label{a10916_afeafde7cf993d4460d25abba9ce9a953}} 
Q\+String \hyperlink{a10916_afeafde7cf993d4460d25abba9ce9a953}{name} ()
\begin{DoxyCompactList}\small\item\em Name of the Plugin. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_ac31695cf715a1244b9f0a73fe513c42b}\label{a10916_ac31695cf715a1244b9f0a73fe513c42b}} 
Q\+String \hyperlink{a10916_ac31695cf715a1244b9f0a73fe513c42b}{description} ()
\begin{DoxyCompactList}\small\item\em Description of the Plugin. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Slots}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a10916_aef616f91010334f67152e025016ebc70}\label{a10916_aef616f91010334f67152e025016ebc70}} 
void \hyperlink{a10916_aef616f91010334f67152e025016ebc70}{plugins\+Initialized} ()
\begin{DoxyCompactList}\small\item\em Register in menubar. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a10916_aed46c090e936bcbac0367b606267dcf5}\label{a10916_aed46c090e936bcbac0367b606267dcf5}} 
void {\bfseries nogui\+Supported} ()
\end{DoxyCompactItemize}
\subsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{a10916_a1ee969a36023c68d0c86057f36ae27a2}{show\+Script\+Editor} ()
\begin{DoxyCompactList}\small\item\em Shows visual script editor. \end{DoxyCompactList}\item 
void \hyperlink{a10916_aef7983c63e692db85c435e040378bfe0}{show\+In\+Script\+Editor} (Q\+String \+\_\+script)
\begin{DoxyCompactList}\small\item\em Opens the text based script editor with the given script. \end{DoxyCompactList}\item 
void \hyperlink{a10916_ad3a9d0a429d6e0375c96426af3a4691f}{init\+Context} ()
\begin{DoxyCompactList}\small\item\em initalisation \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a10916_ad32f7e01dd4089ec0c73c9138b81868c}\label{a10916_ad32f7e01dd4089ec0c73c9138b81868c}} 
\hyperlink{a10724}{V\+S\+I\+::\+Context} $\ast$ {\bfseries context\+\_\+}
\item 
\mbox{\Hypertarget{a10916_a3829b088fa415ef14bfa606b64f21649}\label{a10916_a3829b088fa415ef14bfa606b64f21649}} 
\hyperlink{a10704}{V\+S\+I\+::\+Base\+Widget} $\ast$ {\bfseries base\+Widget\+\_\+}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Plugin that provides a visual scripting interface 

Definition at line 71 of file vsi\+Plugin.\+hh.



\subsection{Member Function Documentation}
\mbox{\Hypertarget{a10916_a1d80b4d7ddf9057e7b74ea645f85d8a4}\label{a10916_a1d80b4d7ddf9057e7b74ea645f85d8a4}} 
\index{Vsi\+Plugin@{Vsi\+Plugin}!ask\+For\+Inputs@{ask\+For\+Inputs}}
\index{ask\+For\+Inputs@{ask\+For\+Inputs}!Vsi\+Plugin@{Vsi\+Plugin}}
\subsubsection{\texorpdfstring{ask\+For\+Inputs}{askForInputs}}
{\footnotesize\ttfamily Q\+Script\+Value Vsi\+Plugin\+::ask\+For\+Inputs (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+element,  }\item[{Q\+String}]{\+\_\+inputs }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [slot]}}



Scripting function, that allows to ask the user for inputs during script execution. 

Gererates a dialog for the given element inputs. 

Definition at line 169 of file vsi\+Plugin.\+cc.

\mbox{\Hypertarget{a10916_a094c47e1e0b0105eb473268e968827ee}\label{a10916_a094c47e1e0b0105eb473268e968827ee}} 
\index{Vsi\+Plugin@{Vsi\+Plugin}!continue\+Box@{continue\+Box}}
\index{continue\+Box@{continue\+Box}!Vsi\+Plugin@{Vsi\+Plugin}}
\subsubsection{\texorpdfstring{continue\+Box}{continueBox}}
{\footnotesize\ttfamily bool Vsi\+Plugin\+::continue\+Box (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+message }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [slot]}}



Shows a non blocking stop box for use inside loops. 

Non blocking box which can be used inside scripting loops to stop on clicks. 

Definition at line 258 of file vsi\+Plugin.\+cc.

\mbox{\Hypertarget{a10916_ad3a9d0a429d6e0375c96426af3a4691f}\label{a10916_ad3a9d0a429d6e0375c96426af3a4691f}} 
\index{Vsi\+Plugin@{Vsi\+Plugin}!init\+Context@{init\+Context}}
\index{init\+Context@{init\+Context}!Vsi\+Plugin@{Vsi\+Plugin}}
\subsubsection{\texorpdfstring{init\+Context()}{initContext()}}
{\footnotesize\ttfamily void Vsi\+Plugin\+::init\+Context (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



initalisation 

initalize context 

Definition at line 126 of file vsi\+Plugin.\+cc.

\mbox{\Hypertarget{a10916_aef7983c63e692db85c435e040378bfe0}\label{a10916_aef7983c63e692db85c435e040378bfe0}} 
\index{Vsi\+Plugin@{Vsi\+Plugin}!show\+In\+Script\+Editor@{show\+In\+Script\+Editor}}
\index{show\+In\+Script\+Editor@{show\+In\+Script\+Editor}!Vsi\+Plugin@{Vsi\+Plugin}}
\subsubsection{\texorpdfstring{show\+In\+Script\+Editor()}{showInScriptEditor()}}
{\footnotesize\ttfamily void Vsi\+Plugin\+::show\+In\+Script\+Editor (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+script }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



Opens the text based script editor with the given script. 

shows the given script in the textual script editor 

Definition at line 220 of file vsi\+Plugin.\+cc.

\mbox{\Hypertarget{a10916_a1ee969a36023c68d0c86057f36ae27a2}\label{a10916_a1ee969a36023c68d0c86057f36ae27a2}} 
\index{Vsi\+Plugin@{Vsi\+Plugin}!show\+Script\+Editor@{show\+Script\+Editor}}
\index{show\+Script\+Editor@{show\+Script\+Editor}!Vsi\+Plugin@{Vsi\+Plugin}}
\subsubsection{\texorpdfstring{show\+Script\+Editor()}{showScriptEditor()}}
{\footnotesize\ttfamily void Vsi\+Plugin\+::show\+Script\+Editor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}



Shows visual script editor. 

Show visual script editor. 

Definition at line 112 of file vsi\+Plugin.\+cc.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Plugin-\/\+V\+S\+I/vsi\+Plugin.\+hh\item 
Plugin-\/\+V\+S\+I/vsi\+Plugin.\+cc\end{DoxyCompactItemize}
