\hypertarget{a01481}{\section{Whats\+This\+Generator Class Reference}
\label{a01481}\index{Whats\+This\+Generator@{Whats\+This\+Generator}}
}


a class which provides an link generator for Whats\+This\+Messages linking to the user doc If you have an Q\+Action pointer called action, you can call\+:  




{\ttfamily \#include $<$Open\+Flipper/\+Base\+Plugin/\+Whats\+This\+Generator.\+hh$>$}

Inheritance diagram for Whats\+This\+Generator\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{a01481}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a01481_a1633ffd52a3475f728fa19096a59c463}{Whats\+This\+Generator} (const Q\+String \&\+\_\+plugin\+\_\+name)
\item 
Q\+String \hyperlink{a01481_a5a3eaa2a1ca8a717bbe98a1c3ed4414b}{generate\+Link} (const Q\+String \&\+\_\+ref=\char`\"{}\char`\"{}, const Q\+String \&\+\_\+site=\char`\"{}index.\+html\char`\"{}) const 
\begin{DoxyCompactList}\small\item\em generates a clickable link to the documentation for whats\+This Messages \end{DoxyCompactList}\item 
void \hyperlink{a01481_a219785ff7ece83215819f385385aadd1}{set\+Whats\+This} (Q\+Action $\ast$\+\_\+action, const Q\+String \&\+\_\+msg, const Q\+String \&\+\_\+ref=\char`\"{}\char`\"{}, const Q\+String \&\+\_\+site=\char`\"{}index.\+html\char`\"{}) const 
\begin{DoxyCompactList}\small\item\em sets a whats\+This Message plus link to the doc for the given Q\+Action \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a01481_a72564e7d4cefb3393b84609d914b89dc}{const Q\+String {\bfseries plugin\+\_\+name\+\_\+}}\label{a01481_a72564e7d4cefb3393b84609d914b89dc}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
a class which provides an link generator for Whats\+This\+Messages linking to the user doc If you have an Q\+Action pointer called action, you can call\+: 


\begin{DoxyCode}
action->setWhatsThis(\textcolor{stringliteral}{"Hello"});
\end{DoxyCode}
 This message \char`\"{}\+Hello\char`\"{} will be shown when somebody call this action in Whats\+This\+Mode.

\hyperlink{a01481}{Whats\+This\+Generator} provides functions linking to the user documentation. e.\+g. assume that whats\+This\+Gen is a valid \hyperlink{a01481}{Whats\+This\+Generator} object 
\begin{DoxyCode}
action->setWhatsThis(QString(tr(\textcolor{stringliteral}{"Hello"}))+whatsThisGen.generateLink()); 
\end{DoxyCode}
 The code above will change the output for Whats\+This\+Messages to\+: \char`\"{}\+Hello Click here for more information\char`\"{} where \char`\"{}\+Click here for more information\char`\"{} is a link which will call the index.\+html (default parameter) of the plugin which you have to specify in the constructor of \hyperlink{a01481}{Whats\+This\+Generator}.

You can also use the \hyperlink{a01481}{Whats\+This\+Generator} to set the Whats\+This\+Message\+: 
\begin{DoxyCode}
whatsThisGen.setWHatsThis(action,tr(\textcolor{stringliteral}{"Hello"}));
\end{DoxyCode}
 It has the same effect and options like the code above and is shorter. 

Definition at line 74 of file Whats\+This\+Generator.\+hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a01481_a1633ffd52a3475f728fa19096a59c463}{\index{Whats\+This\+Generator@{Whats\+This\+Generator}!Whats\+This\+Generator@{Whats\+This\+Generator}}
\index{Whats\+This\+Generator@{Whats\+This\+Generator}!Whats\+This\+Generator@{Whats\+This\+Generator}}
\subsubsection[{Whats\+This\+Generator}]{\setlength{\rightskip}{0pt plus 5cm}Whats\+This\+Generator\+::\+Whats\+This\+Generator (
\begin{DoxyParamCaption}
\item[{const Q\+String \&}]{\+\_\+plugin\+\_\+name}
\end{DoxyParamCaption}
)}}\label{a01481_a1633ffd52a3475f728fa19096a59c463}
Constructor for the whats\+This\+Generator initializing the plugin name.


\begin{DoxyParams}{Parameters}
{\em \+\_\+plugin\+\_\+name} & the name of the plugin which is used \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
use only the name and N\+O\+T the prefix Plugin-\/ (e.\+g. Skeleton\+Editing for Plugin-\/\+Skeleton\+Editing). If you want to reference in the core user plugin, then \+\_\+plugin = \char`\"{}user\char`\"{} 
\end{DoxyNote}


Definition at line 57 of file Whats\+This\+Generator.\+cc.



\subsection{Member Function Documentation}
\hypertarget{a01481_a5a3eaa2a1ca8a717bbe98a1c3ed4414b}{\index{Whats\+This\+Generator@{Whats\+This\+Generator}!generate\+Link@{generate\+Link}}
\index{generate\+Link@{generate\+Link}!Whats\+This\+Generator@{Whats\+This\+Generator}}
\subsubsection[{generate\+Link}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String Whats\+This\+Generator\+::generate\+Link (
\begin{DoxyParamCaption}
\item[{const Q\+String \&}]{\+\_\+ref = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{const Q\+String \&}]{\+\_\+site = {\ttfamily \char`\"{}index.html\char`\"{}}}
\end{DoxyParamCaption}
) const}}\label{a01481_a5a3eaa2a1ca8a717bbe98a1c3ed4414b}


generates a clickable link to the documentation for whats\+This Messages 


\begin{DoxyParams}{Parameters}
{\em \+\_\+ref} & gives the section in the documentation for the action. The help-\/browser will jump into the section. An example\+: \+\_\+jump = \char`\"{}\+Cube\char`\"{} in Primitive\+Generator refs to the section \char`\"{}\+Cube\char`\"{} in the Documentation and the help Browser. \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
use the doxygen reference name (always one word), not the section name
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em \+\_\+site} & gives the documentation site (html-\/site) which you want to open. Default is the site \char`\"{}index.\+html\char`\"{}. You need this parameter if you have more than one site in your plugin documentation and want to refer on one of this. \\
\hline
\end{DoxyParams}


Definition at line 72 of file Whats\+This\+Generator.\+cc.

\hypertarget{a01481_a219785ff7ece83215819f385385aadd1}{\index{Whats\+This\+Generator@{Whats\+This\+Generator}!set\+Whats\+This@{set\+Whats\+This}}
\index{set\+Whats\+This@{set\+Whats\+This}!Whats\+This\+Generator@{Whats\+This\+Generator}}
\subsubsection[{set\+Whats\+This}]{\setlength{\rightskip}{0pt plus 5cm}void Whats\+This\+Generator\+::set\+Whats\+This (
\begin{DoxyParamCaption}
\item[{Q\+Action $\ast$}]{\+\_\+action, }
\item[{const Q\+String \&}]{\+\_\+msg, }
\item[{const Q\+String \&}]{\+\_\+ref = {\ttfamily \char`\"{}\char`\"{}}, }
\item[{const Q\+String \&}]{\+\_\+site = {\ttfamily \char`\"{}index.html\char`\"{}}}
\end{DoxyParamCaption}
) const}}\label{a01481_a219785ff7ece83215819f385385aadd1}


sets a whats\+This Message plus link to the doc for the given Q\+Action 


\begin{DoxyParams}{Parameters}
{\em \+\_\+action} & action where the message should appear. \\
\hline
{\em \+\_\+msg} & help message for the user. This is the default Whatsthis Text which you set with Q\+Action\+::set\+Whats\+This\\
\hline
{\em \+\_\+ref} & gives the section in the documentation for the action. The help-\/browser will jump into the section. An example\+: \+\_\+jump = \char`\"{}\+Cube\char`\"{} in Primitive\+Generator refs to the section \char`\"{}\+Cube\char`\"{} in the Documentation and the help Browser. \\
\hline
\end{DoxyParams}
\begin{DoxyNote}{Note}
use the doxygen reference name (always one word), not the section name
\end{DoxyNote}

\begin{DoxyParams}{Parameters}
{\em \+\_\+site} & gives the documentation site (html-\/site) which you want to open. Default is the site \char`\"{}index.\+html\char`\"{}. You need this parameter if you have more than one site in your plugin documentation and want to refer on one of this. \\
\hline
\end{DoxyParams}


Definition at line 96 of file Whats\+This\+Generator.\+cc.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Open\+Flipper/\+Base\+Plugin/Whats\+This\+Generator.\+hh\item 
Open\+Flipper/\+Base\+Plugin/Whats\+This\+Generator.\+cc\end{DoxyCompactItemize}
