\hypertarget{a00584}{\section{File\+Script\+Plugin Class Reference}
\label{a00584}\index{File\+Script\+Plugin@{File\+Script\+Plugin}}
}
Inheritance diagram for File\+Script\+Plugin\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=1.259843cm]{a00584}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00584_a26bf57489ba99f9e392a920b7ca295f7}{int {\bfseries load\+Object} (Q\+String \+\_\+filename)}\label{a00584_a26bf57489ba99f9e392a920b7ca295f7}

\item 
\hypertarget{a00584_a7d8c30e0cd74dd34c5ff08e16e0e9975}{bool \hyperlink{a00584_a7d8c30e0cd74dd34c5ff08e16e0e9975}{save\+Object} (int, Q\+String)}\label{a00584_a7d8c30e0cd74dd34c5ff08e16e0e9975}

\begin{DoxyCompactList}\small\item\em No objects are saved by this Plugin so ignore the save\+Object call. \end{DoxyCompactList}\item 
\hypertarget{a00584_ad01799cfb65923eacd9ff8454eb4d870}{Q\+String {\bfseries version} ()}\label{a00584_ad01799cfb65923eacd9ff8454eb4d870}

\end{DoxyCompactItemize}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00584_a335f7cfb558c2f7d22388c8499af131b}{void {\bfseries log} (\hyperlink{a02444_a595b2880f3ae74561ba390e3fd8c0e7c}{Logtype} \+\_\+type, Q\+String \+\_\+message)}\label{a00584_a335f7cfb558c2f7d22388c8499af131b}

\item 
\hypertarget{a00584_a3e639ca7e76187c83172cefe9edfb090}{void {\bfseries log} (Q\+String \+\_\+message)}\label{a00584_a3e639ca7e76187c83172cefe9edfb090}

\item 
\hypertarget{a00584_a9ea7dcb6a6b0e9a1b1c7a1a1c5d008a5}{void {\bfseries plugin\+Exists} (Q\+String \+\_\+plugin\+Name, bool \&\+\_\+exists)}\label{a00584_a9ea7dcb6a6b0e9a1b1c7a1a1c5d008a5}

\item 
\hypertarget{a00584_ab773d960ec06b0aeeb3f48686eadde1b}{void {\bfseries function\+Exists} (Q\+String \+\_\+plugin\+Name, Q\+String \+\_\+function\+Name, bool \&\+\_\+exists)}\label{a00584_ab773d960ec06b0aeeb3f48686eadde1b}

\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
Q\+String \hyperlink{a00584_adc2ed8559772261180528dc6237107d9}{name} ()
\begin{DoxyCompactList}\small\item\em Return a name for the plugin. \end{DoxyCompactList}\item 
Q\+String \hyperlink{a00584_aad3883c0444233783a2cc66ee1e2112a}{description} ()
\begin{DoxyCompactList}\small\item\em Return a description of what the plugin is doing. \end{DoxyCompactList}\item 
\hyperlink{a00477}{Data\+Type} \hyperlink{a00584_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\+S\+H ) \end{DoxyCompactList}\item 
Q\+String \hyperlink{a00584_a4618431152aefb6001c06c0e50e3ef37}{get\+Save\+Filters} ()
\item 
Q\+String \hyperlink{a00584_a19fb5ab9688e779dd724bd02a39cfd3a}{get\+Load\+Filters} ()
\item 
Q\+Widget $\ast$ \hyperlink{a00584_a1dd131190928afde2e49d73256e619bf}{save\+Options\+Widget} (Q\+String)
\item 
Q\+Widget $\ast$ \hyperlink{a00584_a7bd75c20a52399a248dc959f24ef5669}{load\+Options\+Widget} (Q\+String)
\end{DoxyCompactItemize}
\subsection*{Private Slots}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00584_ac7447987053291196c503820f150e612}{void {\bfseries nogui\+Supported} ()}\label{a00584_ac7447987053291196c503820f150e612}

\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}


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



\subsection{Member Function Documentation}
\hypertarget{a00584_aad3883c0444233783a2cc66ee1e2112a}{\index{File\+Script\+Plugin@{File\+Script\+Plugin}!description@{description}}
\index{description@{description}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection[{description}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String File\+Script\+Plugin\+::description (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{a00584_aad3883c0444233783a2cc66ee1e2112a}


Return a description of what the plugin is doing. 

This function has to return a basic description of the plugin 

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



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

\hypertarget{a00584_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[{get\+Load\+Filters}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String File\+Script\+Plugin\+::get\+Load\+Filters (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{a00584_a19fb5ab9688e779dd724bd02a39cfd3a}
Return the Qt Filters for File dialogs when loading files (e.\+g. \char`\"{}\+Off files ( $\ast$.\+off )\char`\"{} ) 

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



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

\hypertarget{a00584_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[{get\+Save\+Filters}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String File\+Script\+Plugin\+::get\+Save\+Filters (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{a00584_a4618431152aefb6001c06c0e50e3ef37}
Get the Qt Filters for Filedialogs when saving files (e.\+g. \char`\"{}\+Off files ( $\ast$.\+off )\char`\"{} ) 

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



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

\hypertarget{a00584_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[{load\+Options\+Widget}]{\setlength{\rightskip}{0pt plus 5cm}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]}}}\label{a00584_a7bd75c20a52399a248dc959f24ef5669}
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't need one 

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



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

\hypertarget{a00584_adc2ed8559772261180528dc6237107d9}{\index{File\+Script\+Plugin@{File\+Script\+Plugin}!name@{name}}
\index{name@{name}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection[{name}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String File\+Script\+Plugin\+::name (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{a00584_adc2ed8559772261180528dc6237107d9}


Return a name for the plugin. 

This Function has to return the name of the plugin. 

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



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

\hypertarget{a00584_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[{save\+Options\+Widget}]{\setlength{\rightskip}{0pt plus 5cm}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]}}}\label{a00584_a1dd131190928afde2e49d73256e619bf}
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't need one 

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



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

\hypertarget{a00584_a09d843ecc27c3ce97305888edf86a878}{\index{File\+Script\+Plugin@{File\+Script\+Plugin}!supported\+Type@{supported\+Type}}
\index{supported\+Type@{supported\+Type}!File\+Script\+Plugin@{File\+Script\+Plugin}}
\subsubsection[{supported\+Type}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Data\+Type} File\+Script\+Plugin\+::supported\+Type (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{a00584_a09d843ecc27c3ce97305888edf86a878}


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

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{a00570_add81abf9277dae44167763da4371fb28}{File\+Interface}.



Definition at line 67 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}
