\hypertarget{a00695}{\section{Help\+Browser Class Reference}
\label{a00695}\index{Help\+Browser@{Help\+Browser}}
}


{\ttfamily \#include $<$Open\+Flipper/widgets/help\+Widget/help\+Browser.\+hh$>$}

Inheritance diagram for Help\+Browser\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{a00695}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00695_aca831cdaf610e5d18f17b3ebb1751d39}{void {\bfseries open} (const Q\+String \&\+\_\+url)}\label{a00695_aca831cdaf610e5d18f17b3ebb1751d39}

\item 
void \hyperlink{a00695_a0ff13e67ad1452b7507a94b1f6ef8094}{open} (const Q\+Url \&\+\_\+url, bool \+\_\+skip\+Save=false)
\begin{DoxyCompactList}\small\item\em Opens a new url from the help system in the browser. \end{DoxyCompactList}\item 
void \hyperlink{a00695_ad8074508f8925cf9f626dbbb56ad1870}{backward} ()
\begin{DoxyCompactList}\small\item\em Show last page stored in the history. \end{DoxyCompactList}\item 
void \hyperlink{a00695_a14a2e0dca397a4b391470bada0177638}{forward} ()
\begin{DoxyCompactList}\small\item\em Show next page stored in the history. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Signals}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00695_a371f1c3906eee4ade9ab6acc5f54d639}{void {\bfseries history\+Changed} (const Q\+Url \&)}\label{a00695_a371f1c3906eee4ade9ab6acc5f54d639}

\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a00695_a08a3eb3be4594ed816a411b7bb606a90}{Help\+Browser} (Q\+Help\+Engine $\ast$\+\_\+help\+Engine, Q\+Widget $\ast$parent=0)
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\hypertarget{a00695_ae55865f7f5679e30aea9d6ccb3a595d9}{virtual \hyperlink{a00695_ae55865f7f5679e30aea9d6ccb3a595d9}{$\sim$\+Help\+Browser} ()}\label{a00695_ae55865f7f5679e30aea9d6ccb3a595d9}

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
Q\+Variant \hyperlink{a00695_a63892b318ec816802c37c212b9560401}{load\+Resource} (int \+\_\+type, const Q\+Url \&\+\_\+name)
\begin{DoxyCompactList}\small\item\em re implementation of the load resource function of the text browser \end{DoxyCompactList}\item 
bool \hyperlink{a00695_af68296e1706e3cd840c60ecf656f2bb7}{is\+Backward\+Available} ()
\begin{DoxyCompactList}\small\item\em Checks if we visited other pages before. \end{DoxyCompactList}\item 
bool \hyperlink{a00695_af559fc85e1a65b60534b07848a3b4208}{is\+Forward\+Available} ()
\begin{DoxyCompactList}\small\item\em Checks if the back button was pressed and we can go forward to the next page. \end{DoxyCompactList}\item 
Q\+Url \hyperlink{a00695_a5ea6f237b46785ad693365f8631bb018}{resolve\+Url} (const Q\+Url \&\+\_\+url)
\begin{DoxyCompactList}\small\item\em resolves relative urls to absolute \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Slots}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{a00695_afd1c7fbb4b36501671a9c969a7618c0e}{remember\+History} (const Q\+Url \&\+\_\+url)
\begin{DoxyCompactList}\small\item\em Adds a new page to the history. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item 
Q\+Url \hyperlink{a00695_a4b56f5dfa8e58ae1795031b2775779ee}{get\+Current\+Dir} (const Q\+Url \&\+\_\+url)
\begin{DoxyCompactList}\small\item\em Extract path from U\+R\+L. \end{DoxyCompactList}\item 
void \hyperlink{a00695_af24a428d2f61e7c38ad7b8eafc6c2e32}{update\+Name\+Space\+And\+Folder} (const Q\+Url \&\+\_\+url)
\begin{DoxyCompactList}\small\item\em update\+Name\+Space\+And\+Folder \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00695_aea18225143b717877b6b114eca4458aa}{Q\+Help\+Engine $\ast$ \hyperlink{a00695_aea18225143b717877b6b114eca4458aa}{help\+Engine\+\_\+}}\label{a00695_aea18225143b717877b6b114eca4458aa}

\begin{DoxyCompactList}\small\item\em The help engine the widget is working on. \end{DoxyCompactList}\item 
\hypertarget{a00695_a8f19f038573b467772eddb32844d1b51}{Q\+List$<$ Q\+Url $>$ \hyperlink{a00695_a8f19f038573b467772eddb32844d1b51}{visited\+Pages\+\_\+}}\label{a00695_a8f19f038573b467772eddb32844d1b51}

\begin{DoxyCompactList}\small\item\em History of the visited pages. \end{DoxyCompactList}\item 
\hypertarget{a00695_aa099652cc7a4cc56be4d0af3ec174f89}{int \hyperlink{a00695_aa099652cc7a4cc56be4d0af3ec174f89}{current\+Page\+\_\+}}\label{a00695_aa099652cc7a4cc56be4d0af3ec174f89}

\begin{DoxyCompactList}\small\item\em Current position in the history. \end{DoxyCompactList}\item 
Q\+String \hyperlink{a00695_aa029c005d321b021fcfa77c688e240dd}{current\+Virtual\+Folder\+\_\+}
\begin{DoxyCompactList}\small\item\em The currently active virtual folder. \end{DoxyCompactList}\item 
Q\+String \hyperlink{a00695_a3c394d1472e59f8d8e11f4d239fb70cd}{current\+Name\+Space\+\_\+}
\begin{DoxyCompactList}\small\item\em The currently active namespace. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
This class implements Open\+Flippers help browser. The Qt\+Help files are loaded at startup into the help engine which is passed to this widget. 

Definition at line 77 of file help\+Browser.\+hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00695_a08a3eb3be4594ed816a411b7bb606a90}{\index{Help\+Browser@{Help\+Browser}!Help\+Browser@{Help\+Browser}}
\index{Help\+Browser@{Help\+Browser}!Help\+Browser@{Help\+Browser}}
\subsubsection[{Help\+Browser}]{\setlength{\rightskip}{0pt plus 5cm}Help\+Browser\+::\+Help\+Browser (
\begin{DoxyParamCaption}
\item[{Q\+Help\+Engine $\ast$}]{\+\_\+help\+Engine, }
\item[{Q\+Widget $\ast$}]{parent = {\ttfamily 0}}
\end{DoxyParamCaption}
)}}\label{a00695_a08a3eb3be4594ed816a411b7bb606a90}


Constructor. 

Sets up a new help widget which works on the given help engine


\begin{DoxyParams}{Parameters}
{\em \+\_\+help\+Engine} & Q\+Help\+Engine \\
\hline
{\em parent} & Parent widget \\
\hline
\end{DoxyParams}


Definition at line 61 of file help\+Browser.\+cc.



\subsection{Member Function Documentation}
\hypertarget{a00695_ad8074508f8925cf9f626dbbb56ad1870}{\index{Help\+Browser@{Help\+Browser}!backward@{backward}}
\index{backward@{backward}!Help\+Browser@{Help\+Browser}}
\subsubsection[{backward}]{\setlength{\rightskip}{0pt plus 5cm}void Help\+Browser\+::backward (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [slot]}}}\label{a00695_ad8074508f8925cf9f626dbbb56ad1870}


Show last page stored in the history. 



Definition at line 213 of file help\+Browser.\+cc.

\hypertarget{a00695_a14a2e0dca397a4b391470bada0177638}{\index{Help\+Browser@{Help\+Browser}!forward@{forward}}
\index{forward@{forward}!Help\+Browser@{Help\+Browser}}
\subsubsection[{forward}]{\setlength{\rightskip}{0pt plus 5cm}void Help\+Browser\+::forward (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [slot]}}}\label{a00695_a14a2e0dca397a4b391470bada0177638}


Show next page stored in the history. 



Definition at line 222 of file help\+Browser.\+cc.

\hypertarget{a00695_a4b56f5dfa8e58ae1795031b2775779ee}{\index{Help\+Browser@{Help\+Browser}!get\+Current\+Dir@{get\+Current\+Dir}}
\index{get\+Current\+Dir@{get\+Current\+Dir}!Help\+Browser@{Help\+Browser}}
\subsubsection[{get\+Current\+Dir}]{\setlength{\rightskip}{0pt plus 5cm}Q\+Url Help\+Browser\+::get\+Current\+Dir (
\begin{DoxyParamCaption}
\item[{const Q\+Url \&}]{\+\_\+url}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [private]}}}\label{a00695_a4b56f5dfa8e58ae1795031b2775779ee}


Extract path from U\+R\+L. 

Removes the filename part from the url and returns only the directory component


\begin{DoxyParams}{Parameters}
{\em \+\_\+url} & Input url \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Path 
\end{DoxyReturn}


Definition at line 189 of file help\+Browser.\+cc.

\hypertarget{a00695_af68296e1706e3cd840c60ecf656f2bb7}{\index{Help\+Browser@{Help\+Browser}!is\+Backward\+Available@{is\+Backward\+Available}}
\index{is\+Backward\+Available@{is\+Backward\+Available}!Help\+Browser@{Help\+Browser}}
\subsubsection[{is\+Backward\+Available}]{\setlength{\rightskip}{0pt plus 5cm}bool Help\+Browser\+::is\+Backward\+Available (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{a00695_af68296e1706e3cd840c60ecf656f2bb7}


Checks if we visited other pages before. 

\begin{DoxyReturn}{Returns}
Did we visit pages before to which we can jump back? (History) 
\end{DoxyReturn}


Definition at line 208 of file help\+Browser.\+cc.

\hypertarget{a00695_af559fc85e1a65b60534b07848a3b4208}{\index{Help\+Browser@{Help\+Browser}!is\+Forward\+Available@{is\+Forward\+Available}}
\index{is\+Forward\+Available@{is\+Forward\+Available}!Help\+Browser@{Help\+Browser}}
\subsubsection[{is\+Forward\+Available}]{\setlength{\rightskip}{0pt plus 5cm}bool Help\+Browser\+::is\+Forward\+Available (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{a00695_af559fc85e1a65b60534b07848a3b4208}


Checks if the back button was pressed and we can go forward to the next page. 

\begin{DoxyReturn}{Returns}
is a page stored in the forward list? 
\end{DoxyReturn}


Definition at line 203 of file help\+Browser.\+cc.

\hypertarget{a00695_a63892b318ec816802c37c212b9560401}{\index{Help\+Browser@{Help\+Browser}!load\+Resource@{load\+Resource}}
\index{load\+Resource@{load\+Resource}!Help\+Browser@{Help\+Browser}}
\subsubsection[{load\+Resource}]{\setlength{\rightskip}{0pt plus 5cm}Q\+Variant Help\+Browser\+::load\+Resource (
\begin{DoxyParamCaption}
\item[{int}]{\+\_\+type, }
\item[{const Q\+Url \&}]{\+\_\+name}
\end{DoxyParamCaption}
)}}\label{a00695_a63892b318ec816802c37c212b9560401}


re implementation of the load resource function of the text browser 

This function loads a resource from the help system. It also handles jumping to another namespace via relative links in the url


\begin{DoxyParams}{Parameters}
{\em \+\_\+type} & Ignored \\
\hline
{\em \+\_\+name} & A filename in the help system that should be loaded (image, html document) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The loaded resource 
\end{DoxyReturn}


Definition at line 143 of file help\+Browser.\+cc.

\hypertarget{a00695_a0ff13e67ad1452b7507a94b1f6ef8094}{\index{Help\+Browser@{Help\+Browser}!open@{open}}
\index{open@{open}!Help\+Browser@{Help\+Browser}}
\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}void Help\+Browser\+::open (
\begin{DoxyParamCaption}
\item[{const Q\+Url \&}]{\+\_\+url, }
\item[{bool}]{\+\_\+skip\+Save = {\ttfamily false}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [slot]}}}\label{a00695_a0ff13e67ad1452b7507a94b1f6ef8094}


Opens a new url from the help system in the browser. 


\begin{DoxyParams}{Parameters}
{\em \+\_\+url} & U\+R\+L that should be opened \\
\hline
{\em \+\_\+skip\+Save} & Flag if the U\+R\+L should be saved in the history \\
\hline
\end{DoxyParams}


Definition at line 162 of file help\+Browser.\+cc.

\hypertarget{a00695_afd1c7fbb4b36501671a9c969a7618c0e}{\index{Help\+Browser@{Help\+Browser}!remember\+History@{remember\+History}}
\index{remember\+History@{remember\+History}!Help\+Browser@{Help\+Browser}}
\subsubsection[{remember\+History}]{\setlength{\rightskip}{0pt plus 5cm}void Help\+Browser\+::remember\+History (
\begin{DoxyParamCaption}
\item[{const Q\+Url \&}]{\+\_\+url}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [private]}, {\ttfamily [slot]}}}\label{a00695_afd1c7fbb4b36501671a9c969a7618c0e}


Adds a new page to the history. 


\begin{DoxyParams}{Parameters}
{\em \+\_\+url} & U\+R\+L of the new page \\
\hline
\end{DoxyParams}


Definition at line 93 of file help\+Browser.\+cc.

\hypertarget{a00695_a5ea6f237b46785ad693365f8631bb018}{\index{Help\+Browser@{Help\+Browser}!resolve\+Url@{resolve\+Url}}
\index{resolve\+Url@{resolve\+Url}!Help\+Browser@{Help\+Browser}}
\subsubsection[{resolve\+Url}]{\setlength{\rightskip}{0pt plus 5cm}Q\+Url Help\+Browser\+::resolve\+Url (
\begin{DoxyParamCaption}
\item[{const Q\+Url \&}]{\+\_\+url}
\end{DoxyParamCaption}
)}}\label{a00695_a5ea6f237b46785ad693365f8631bb018}


resolves relative urls to absolute 


\begin{DoxyParams}{Parameters}
{\em \+\_\+url} & relative U\+R\+L which will be resolved \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
absolute url 
\end{DoxyReturn}


Definition at line 112 of file help\+Browser.\+cc.

\hypertarget{a00695_af24a428d2f61e7c38ad7b8eafc6c2e32}{\index{Help\+Browser@{Help\+Browser}!update\+Name\+Space\+And\+Folder@{update\+Name\+Space\+And\+Folder}}
\index{update\+Name\+Space\+And\+Folder@{update\+Name\+Space\+And\+Folder}!Help\+Browser@{Help\+Browser}}
\subsubsection[{update\+Name\+Space\+And\+Folder}]{\setlength{\rightskip}{0pt plus 5cm}void Help\+Browser\+::update\+Name\+Space\+And\+Folder (
\begin{DoxyParamCaption}
\item[{const Q\+Url \&}]{\+\_\+url}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [private]}}}\label{a00695_af24a428d2f61e7c38ad7b8eafc6c2e32}


update\+Name\+Space\+And\+Folder 

This function takes the url and extracts the virtual namespace and folder information which are stored in the variables. These variables are used to find the corresponding images.


\begin{DoxyParams}{Parameters}
{\em \+\_\+url} & The url that should be analyzed \\
\hline
\end{DoxyParams}


Definition at line 77 of file help\+Browser.\+cc.



\subsection{Member Data Documentation}
\hypertarget{a00695_a3c394d1472e59f8d8e11f4d239fb70cd}{\index{Help\+Browser@{Help\+Browser}!current\+Name\+Space\+\_\+@{current\+Name\+Space\+\_\+}}
\index{current\+Name\+Space\+\_\+@{current\+Name\+Space\+\_\+}!Help\+Browser@{Help\+Browser}}
\subsubsection[{current\+Name\+Space\+\_\+}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String Help\+Browser\+::current\+Name\+Space\+\_\+\hspace{0.3cm}{\ttfamily [private]}}}\label{a00695_a3c394d1472e59f8d8e11f4d239fb70cd}


The currently active namespace. 

Q\+T manages the different help files for the plugins with different name spaces. This variable will always hold the currently active one. 

Definition at line 203 of file help\+Browser.\+hh.

\hypertarget{a00695_aa029c005d321b021fcfa77c688e240dd}{\index{Help\+Browser@{Help\+Browser}!current\+Virtual\+Folder\+\_\+@{current\+Virtual\+Folder\+\_\+}}
\index{current\+Virtual\+Folder\+\_\+@{current\+Virtual\+Folder\+\_\+}!Help\+Browser@{Help\+Browser}}
\subsubsection[{current\+Virtual\+Folder\+\_\+}]{\setlength{\rightskip}{0pt plus 5cm}Q\+String Help\+Browser\+::current\+Virtual\+Folder\+\_\+\hspace{0.3cm}{\ttfamily [private]}}}\label{a00695_aa029c005d321b021fcfa77c688e240dd}


The currently active virtual folder. 

Q\+T manages the different help files for the plugins in different virtual folders. This variable will always hold the currently active one. 

Definition at line 196 of file help\+Browser.\+hh.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Open\+Flipper/widgets/help\+Widget/help\+Browser.\+hh\item 
Open\+Flipper/widgets/help\+Widget/help\+Browser.\+cc\end{DoxyCompactItemize}
