\hypertarget{a11064}{}\section{File\+Script\+Plugin Class Reference}
\label{a11064}\index{File\+Script\+Plugin@{File\+Script\+Plugin}}
Inheritance diagram for File\+Script\+Plugin\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=1.259843cm]{a11064}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a11064_a26bf57489ba99f9e392a920b7ca295f7}\label{a11064_a26bf57489ba99f9e392a920b7ca295f7}} 
int {\bfseries load\+Object} (Q\+String \+\_\+filename)
\item 
\mbox{\Hypertarget{a11064_a7d8c30e0cd74dd34c5ff08e16e0e9975}\label{a11064_a7d8c30e0cd74dd34c5ff08e16e0e9975}} 
bool \hyperlink{a11064_a7d8c30e0cd74dd34c5ff08e16e0e9975}{save\+Object} (int, Q\+String)
\begin{DoxyCompactList}\small\item\em No objects are saved by this Plugin so ignore the save\+Object call. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{a11064_ad01799cfb65923eacd9ff8454eb4d870}\label{a11064_ad01799cfb65923eacd9ff8454eb4d870}} 
Q\+String {\bfseries version} ()
\end{DoxyCompactItemize}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a11064_a335f7cfb558c2f7d22388c8499af131b}\label{a11064_a335f7cfb558c2f7d22388c8499af131b}} 
void {\bfseries log} (\hyperlink{a00035_a595b2880f3ae74561ba390e3fd8c0e7c}{Logtype} \+\_\+type, Q\+String \+\_\+message)
\item 
\mbox{\Hypertarget{a11064_a3e639ca7e76187c83172cefe9edfb090}\label{a11064_a3e639ca7e76187c83172cefe9edfb090}} 
void {\bfseries log} (Q\+String \+\_\+message)
\item 
\mbox{\Hypertarget{a11064_a9ea7dcb6a6b0e9a1b1c7a1a1c5d008a5}\label{a11064_a9ea7dcb6a6b0e9a1b1c7a1a1c5d008a5}} 
void {\bfseries plugin\+Exists} (Q\+String \+\_\+plugin\+Name, bool \&\+\_\+exists)
\item 
\mbox{\Hypertarget{a11064_ab773d960ec06b0aeeb3f48686eadde1b}\label{a11064_ab773d960ec06b0aeeb3f48686eadde1b}} 
void {\bfseries function\+Exists} (Q\+String \+\_\+plugin\+Name, Q\+String \+\_\+function\+Name, bool \&\+\_\+exists)
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
Q\+String \hyperlink{a11064_adc2ed8559772261180528dc6237107d9}{name} ()
\begin{DoxyCompactList}\small\item\em Return a name for the plugin. \end{DoxyCompactList}\item 
Q\+String \hyperlink{a11064_aad3883c0444233783a2cc66ee1e2112a}{description} ()
\begin{DoxyCompactList}\small\item\em Return a description of what the plugin is doing. \end{DoxyCompactList}\item 
\hyperlink{a07048}{Data\+Type} \hyperlink{a11064_a09d843ecc27c3ce97305888edf86a878}{supported\+Type} ()
\begin{DoxyCompactList}\small\item\em Return your supported object type( e.\+g. D\+A\+T\+A\+\_\+\+T\+R\+I\+A\+N\+G\+L\+E\+\_\+\+M\+E\+SH ) \end{DoxyCompactList}\item 
Q\+String \hyperlink{a11064_a4618431152aefb6001c06c0e50e3ef37}{get\+Save\+Filters} ()
\item 
Q\+String \hyperlink{a11064_a19fb5ab9688e779dd724bd02a39cfd3a}{get\+Load\+Filters} ()
\item 
Q\+Widget $\ast$ \hyperlink{a11064_a1dd131190928afde2e49d73256e619bf}{save\+Options\+Widget} (Q\+String)
\item 
Q\+Widget $\ast$ \hyperlink{a11064_a7bd75c20a52399a248dc959f24ef5669}{load\+Options\+Widget} (Q\+String)
\end{DoxyCompactItemize}
\subsection*{Private Slots}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{a11064_ac7447987053291196c503820f150e612}\label{a11064_ac7447987053291196c503820f150e612}} 
void {\bfseries nogui\+Supported} ()
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}


Definition at line 57 of file File\+Script.\+hh.



\subsection{Member Function Documentation}
\mbox{\Hypertarget{a11064_aad3883c0444233783a2cc66ee1e2112a}\label{a11064_aad3883c0444233783a2cc66ee1e2112a}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!description@{description}}
\index{description@{description}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{description()}{description()}}
{\footnotesize\ttfamily Q\+String File\+Script\+Plugin\+::description (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Return a description of what the plugin is doing. 

This function has to return a basic description of the plugin 

Implements \hyperlink{a06872_a43f0d3612695b53c848c14f48fea9a7a}{Base\+Interface}.



Definition at line 87 of file File\+Script.\+hh.

\mbox{\Hypertarget{a11064_a19fb5ab9688e779dd724bd02a39cfd3a}\label{a11064_a19fb5ab9688e779dd724bd02a39cfd3a}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!get\+Load\+Filters@{get\+Load\+Filters}}
\index{get\+Load\+Filters@{get\+Load\+Filters}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{get\+Load\+Filters()}{getLoadFilters()}}
{\footnotesize\ttfamily Q\+String File\+Script\+Plugin\+::get\+Load\+Filters (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Return the Qt Filters for File dialogs when loading files (e.\+g. \char`\"{}\+Off files ( $\ast$.\+off )\char`\"{} ) 

Implements \hyperlink{a06880_a804009a394ded7436b43c624af9cc44d}{File\+Interface}.



Definition at line 49 of file File\+Script.\+cc.

\mbox{\Hypertarget{a11064_a4618431152aefb6001c06c0e50e3ef37}\label{a11064_a4618431152aefb6001c06c0e50e3ef37}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!get\+Save\+Filters@{get\+Save\+Filters}}
\index{get\+Save\+Filters@{get\+Save\+Filters}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{get\+Save\+Filters()}{getSaveFilters()}}
{\footnotesize\ttfamily Q\+String File\+Script\+Plugin\+::get\+Save\+Filters (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}

Get the Qt Filters for Filedialogs when saving files (e.\+g. \char`\"{}\+Off files ( $\ast$.\+off )\char`\"{} ) 

Implements \hyperlink{a06880_a86b79f14fef9913720c6456df43de7df}{File\+Interface}.



Definition at line 53 of file File\+Script.\+cc.

\mbox{\Hypertarget{a11064_a7bd75c20a52399a248dc959f24ef5669}\label{a11064_a7bd75c20a52399a248dc959f24ef5669}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!load\+Options\+Widget@{load\+Options\+Widget}}
\index{load\+Options\+Widget@{load\+Options\+Widget}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{load\+Options\+Widget()}{loadOptionsWidget()}}
{\footnotesize\ttfamily Q\+Widget$\ast$ File\+Script\+Plugin\+::load\+Options\+Widget (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+current\+Filter }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}

You can provide a special widget showing options for loading your file types depending on the current filter

\+\_\+current\+Filter\+: one filter from load\+Filters

Return 0 when you don\textquotesingle{}t need one 

Implements \hyperlink{a06880_a69ddbb8db7fd5b9257f35bc0148ef7c0}{File\+Interface}.



Definition at line 97 of file File\+Script.\+hh.

\mbox{\Hypertarget{a11064_adc2ed8559772261180528dc6237107d9}\label{a11064_adc2ed8559772261180528dc6237107d9}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!name@{name}}
\index{name@{name}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{name()}{name()}}
{\footnotesize\ttfamily Q\+String File\+Script\+Plugin\+::name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Return a name for the plugin. 

This Function has to return the name of the plugin. 

Implements \hyperlink{a06872_a2b351aa6ef0eb368bce735e243235958}{Base\+Interface}.



Definition at line 86 of file File\+Script.\+hh.

\mbox{\Hypertarget{a11064_a1dd131190928afde2e49d73256e619bf}\label{a11064_a1dd131190928afde2e49d73256e619bf}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!save\+Options\+Widget@{save\+Options\+Widget}}
\index{save\+Options\+Widget@{save\+Options\+Widget}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{save\+Options\+Widget()}{saveOptionsWidget()}}
{\footnotesize\ttfamily Q\+Widget$\ast$ File\+Script\+Plugin\+::save\+Options\+Widget (\begin{DoxyParamCaption}\item[{Q\+String}]{\+\_\+current\+Filter }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}

You can provide a special widget showing options for saving your file types depending on the current filter

\+\_\+current\+Filter\+: one filter from save\+Filters

Return 0 when you don\textquotesingle{}t need one 

Implements \hyperlink{a06880_a5cfabe9faa5b3e9f107766a6b670626b}{File\+Interface}.



Definition at line 96 of file File\+Script.\+hh.

\mbox{\Hypertarget{a11064_a09d843ecc27c3ce97305888edf86a878}\label{a11064_a09d843ecc27c3ce97305888edf86a878}} 
\index{File\+Script\+Plugin@{File\+Script\+Plugin}!supported\+Type@{supported\+Type}}
\index{supported\+Type@{supported\+Type}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection{\texorpdfstring{supported\+Type()}{supportedType()}}
{\footnotesize\ttfamily \hyperlink{a07048}{Data\+Type} File\+Script\+Plugin\+::supported\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Return your supported object type( e.\+g. D\+A\+T\+A\+\_\+\+T\+R\+I\+A\+N\+G\+L\+E\+\_\+\+M\+E\+SH ) 

If you support multiple Data\+Types you can combine them bitwise here. The function is used from the load and save code to check if your plugin can handle an object of a given data\+Type. 

Implements \hyperlink{a06880_add81abf9277dae44167763da4371fb28}{File\+Interface}.



Definition at line 57 of file File\+Script.\+cc.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Plugin\+Collection-\/\+File\+Plugins/\+Plugin-\/\+File\+Script/File\+Script.\+hh\item 
Plugin\+Collection-\/\+File\+Plugins/\+Plugin-\/\+File\+Script/File\+Script.\+cc\end{DoxyCompactItemize}
