\hypertarget{classToolboxInterface}{}\section{Toolbox\+Interface Class Reference}
\label{classToolboxInterface}\index{Toolbox\+Interface@{Toolbox\+Interface}}


Plugins can add its own toolbox to the main widget\textquotesingle{}s toolbox area by using this interface.  




{\ttfamily \#include $<$Open\+Flipper/\+Base\+Plugin/\+Toolbox\+Interface.\+hh$>$}

Inheritance diagram for Toolbox\+Interface\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=12.000000cm]{classToolboxInterface}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classToolboxInterface_a34f237c4b98d624ae7895e8f3dd4ed8d}{add\+Toolbox} (Q\+String \+\_\+name, Q\+Widget $\ast$\+\_\+widget)
\begin{DoxyCompactList}\small\item\em Add a toolbox widget to the gui with the given name. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classToolboxInterface_a0f2acdcde4c317977aa2a9930e7c34d6}\label{classToolboxInterface_a0f2acdcde4c317977aa2a9930e7c34d6}} 
virtual \hyperlink{classToolboxInterface_a0f2acdcde4c317977aa2a9930e7c34d6}{$\sim$\+Toolbox\+Interface} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual void \hyperlink{classToolboxInterface_ad9401f3bc4ec8cd98205dc2cb733ec2a}{add\+Toolbox} (Q\+String \+\_\+name, Q\+Widget $\ast$\+\_\+widget, Q\+Icon $\ast$\+\_\+icon)
\begin{DoxyCompactList}\small\item\em Add a toolbox widget to the gui with the given name and an icon. \end{DoxyCompactList}\item 
virtual void \hyperlink{classToolboxInterface_a26e69292aeb9170ae81e5bedbe971ea7}{add\+Toolbox} (Q\+String \+\_\+name, Q\+Widget $\ast$\+\_\+widget, Q\+Icon $\ast$\+\_\+icon, Q\+Widget $\ast$\+\_\+header\+Area\+Widget)
\begin{DoxyCompactList}\small\item\em Add a toolbox widget to the gui with the given name, icon and header area widget. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Plugins can add its own toolbox to the main widget\textquotesingle{}s toolbox area by using this interface. 

\hyperlink{toolboxInterfacePage}{Detailed description} ~\newline
 This Interface can be used by plugins which will provide a toolbox widget. Each Plugin can create own Widgets in the toolbox area. Just create your widget and then add it with ~\newline
emit \hyperlink{classToolboxInterface_a34f237c4b98d624ae7895e8f3dd4ed8d}{add\+Toolbox( Q\+String  \+\_\+name  , Q\+Widget$\ast$ \+\_\+widget )} ~\newline
to the user interface. You can create extra signals and slots in your Plugin. These can be connected between your toolbox and your plugin.~\newline
 See our tutorials \hyperlink{ex2}{Implementing a mesh smoother plugin} and \hyperlink{ex3}{Implementing mouse and keyboard interaction} for an example of to add custom toolboxes to Open\+Flipper. 

Definition at line 68 of file Toolbox\+Interface.\+hh.



\subsection{Member Function Documentation}
\mbox{\Hypertarget{classToolboxInterface_a34f237c4b98d624ae7895e8f3dd4ed8d}\label{classToolboxInterface_a34f237c4b98d624ae7895e8f3dd4ed8d}} 
\index{Toolbox\+Interface@{Toolbox\+Interface}!add\+Toolbox@{add\+Toolbox}}
\index{add\+Toolbox@{add\+Toolbox}!Toolbox\+Interface@{Toolbox\+Interface}}
\subsubsection{\texorpdfstring{add\+Toolbox}{addToolbox}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily virtual void Toolbox\+Interface\+::add\+Toolbox (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+name,  }\item[{Q\+Widget $\ast$}]{\+\_\+widget }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [signal]}}



Add a toolbox widget to the gui with the given name. 

This signal adds a toolbox widget to the toolbox area on the right. Hint\+: Ownership of the widget is expected to be transferred with this signal. Do not delete the widget in your plugins destructor.


\begin{DoxyParams}{Parameters}
{\em \+\_\+name} & Visible name of the toolbox \\
\hline
{\em \+\_\+widget} & Pointer to the toolbox widget \\
\hline
\end{DoxyParams}


Definition at line 88 of file Toolbox\+Interface.\+hh.

\mbox{\Hypertarget{classToolboxInterface_ad9401f3bc4ec8cd98205dc2cb733ec2a}\label{classToolboxInterface_ad9401f3bc4ec8cd98205dc2cb733ec2a}} 
\index{Toolbox\+Interface@{Toolbox\+Interface}!add\+Toolbox@{add\+Toolbox}}
\index{add\+Toolbox@{add\+Toolbox}!Toolbox\+Interface@{Toolbox\+Interface}}
\subsubsection{\texorpdfstring{add\+Toolbox()}{addToolbox()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily virtual void Toolbox\+Interface\+::add\+Toolbox (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+name,  }\item[{Q\+Widget $\ast$}]{\+\_\+widget,  }\item[{Q\+Icon $\ast$}]{\+\_\+icon }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Add a toolbox widget to the gui with the given name and an icon. 

This signal adds a toolbox widget to the toolbox area on the right. And sets an icon for it Hint\+: Ownership of the widget is expected to be transferred with this signal. Do not delete the widget in your plugins destructor.


\begin{DoxyParams}{Parameters}
{\em \+\_\+name} & Visible name of the toolbox \\
\hline
{\em \+\_\+widget} & Pointer to the toolbox widget \\
\hline
{\em \+\_\+icon} & Icon for the toolbox \\
\hline
\end{DoxyParams}


Definition at line 100 of file Toolbox\+Interface.\+hh.

\mbox{\Hypertarget{classToolboxInterface_a26e69292aeb9170ae81e5bedbe971ea7}\label{classToolboxInterface_a26e69292aeb9170ae81e5bedbe971ea7}} 
\index{Toolbox\+Interface@{Toolbox\+Interface}!add\+Toolbox@{add\+Toolbox}}
\index{add\+Toolbox@{add\+Toolbox}!Toolbox\+Interface@{Toolbox\+Interface}}
\subsubsection{\texorpdfstring{add\+Toolbox()}{addToolbox()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily virtual void Toolbox\+Interface\+::add\+Toolbox (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+name,  }\item[{Q\+Widget $\ast$}]{\+\_\+widget,  }\item[{Q\+Icon $\ast$}]{\+\_\+icon,  }\item[{Q\+Widget $\ast$}]{\+\_\+header\+Area\+Widget }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Add a toolbox widget to the gui with the given name, icon and header area widget. 

This signal adds a toolbox widget to the toolbox area on the right. And sets an icon for it Hint\+: Ownership of the widget is expected to be transferred with this signal. Do not delete the widget in your plugins destructor.


\begin{DoxyParams}{Parameters}
{\em \+\_\+name} & Visible name of the toolbox \\
\hline
{\em \+\_\+widget} & Pointer to the toolbox widget \\
\hline
{\em \+\_\+icon} & Icon for the toolbox \\
\hline
{\em \+\_\+header\+Area\+Widget} & Widget displayed in the toolbox header between the title and the detach button. \\
\hline
\end{DoxyParams}


Definition at line 114 of file Toolbox\+Interface.\+hh.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
Open\+Flipper/\+Base\+Plugin/\hyperlink{ToolboxInterface_8hh}{Toolbox\+Interface.\+hh}\end{DoxyCompactItemize}
