GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1UI_1_1HelpPage.tex

137 lines
6.2 KiB
TeX
Raw Normal View History

2022-05-08 19:59:26 +00:00
\hypertarget{classGpgFrontend_1_1UI_1_1HelpPage}{}\doxysection{Gpg\+Frontend\+::UI\+::Help\+Page Class Reference}
\label{classGpgFrontend_1_1UI_1_1HelpPage}\index{GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}}
Inheritance diagram for Gpg\+Frontend\+::UI\+::Help\+Page\+:
2022-05-08 22:01:23 +00:00
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=227pt]{classGpgFrontend_1_1UI_1_1HelpPage__inherit__graph}
\end{center}
\end{figure}
2022-05-08 19:59:26 +00:00
Collaboration diagram for Gpg\+Frontend\+::UI\+::Help\+Page\+:
2022-05-08 22:01:23 +00:00
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=227pt]{classGpgFrontend_1_1UI_1_1HelpPage__coll__graph}
\end{center}
\end{figure}
2022-05-08 19:59:26 +00:00
\doxysubsection*{Public Slots}
\begin{DoxyCompactItemize}
\item
2022-05-08 22:01:23 +00:00
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_a51ff99077a75507365307f5dd783df99}{slot\+\_\+open\+\_\+url}} (const Q\+Url \&url)
2022-05-08 19:59:26 +00:00
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
2022-05-08 22:01:23 +00:00
\mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_a1be8f5b79fef3d1d62ff4620b8535006}{Help\+Page}} (const Q\+String \&path, Q\+Widget $\ast$parent=nullptr)
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em Construct a new Help Page object. \end{DoxyCompactList}\item
2022-05-08 22:01:23 +00:00
Q\+Text\+Browser $\ast$ \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_a92c31eea47b42be28c86431384b27846}{Get\+Browser}} ()
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em Get the Browser object. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item
2022-05-08 22:01:23 +00:00
Q\+Url \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_a49fbde87f2ef385b44225acd6ffbc84f}{localized\+\_\+help}} (const Q\+Url \&path)
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_a49fbde87f2ef385b44225acd6ffbc84f}{Help\+Page\+::localized\+\_\+help}} check if the requested file is also available with the locale, e.\+g. return index.\+de.\+html if index.\+html was requested but the locale is de and index.\+de.\+html is available. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1HelpPage_af4f61342fae06a49c95d8d20ca51ca2c}\label{classGpgFrontend_1_1UI_1_1HelpPage_af4f61342fae06a49c95d8d20ca51ca2c}}
2022-05-08 22:01:23 +00:00
Q\+Text\+Browser $\ast$ \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_af4f61342fae06a49c95d8d20ca51ca2c}{browser\+\_\+}}
2022-05-08 19:59:26 +00:00
\begin{DoxyCompactList}\small\item\em The textbrowser of the tab. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1HelpPage_a1be8f5b79fef3d1d62ff4620b8535006}\label{classGpgFrontend_1_1UI_1_1HelpPage_a1be8f5b79fef3d1d62ff4620b8535006}}
\index{GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}!HelpPage@{HelpPage}}
\index{HelpPage@{HelpPage}!GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}}
\doxysubsubsection{\texorpdfstring{HelpPage()}{HelpPage()}}
2022-05-08 22:01:23 +00:00
{\footnotesize\ttfamily Gpg\+Frontend\+::\+U\+I\+::\+Help\+Page\+::\+Help\+Page (\begin{DoxyParamCaption}\item[{const Q\+String \&}]{path, }\item[{Q\+Widget $\ast$}]{parent = {\ttfamily nullptr} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}}
2022-05-08 19:59:26 +00:00
Construct a new Help Page object.
\begin{DoxyParams}{Parameters}
{\em path} & \\
\hline
{\em parent} & \\
\hline
\end{DoxyParams}
2022-05-08 22:01:23 +00:00
References browser\+\_\+, localized\+\_\+help(), and slot\+\_\+open\+\_\+url().
2022-05-08 19:59:26 +00:00
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1HelpPage_a92c31eea47b42be28c86431384b27846}\label{classGpgFrontend_1_1UI_1_1HelpPage_a92c31eea47b42be28c86431384b27846}}
\index{GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}!GetBrowser@{GetBrowser}}
\index{GetBrowser@{GetBrowser}!GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}}
\doxysubsubsection{\texorpdfstring{GetBrowser()}{GetBrowser()}}
2022-05-08 22:01:23 +00:00
{\footnotesize\ttfamily Q\+Text\+Browser $\ast$ Gpg\+Frontend\+::\+U\+I\+::\+Help\+Page\+::\+Get\+Browser (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
2022-05-08 19:59:26 +00:00
Get the Browser object.
\begin{DoxyReturn}{Returns}
2022-05-08 22:01:23 +00:00
Q\+Text\+Browser$\ast$
2022-05-08 19:59:26 +00:00
\end{DoxyReturn}
2022-05-08 22:01:23 +00:00
References browser\+\_\+.
2022-05-08 19:59:26 +00:00
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1HelpPage_a49fbde87f2ef385b44225acd6ffbc84f}\label{classGpgFrontend_1_1UI_1_1HelpPage_a49fbde87f2ef385b44225acd6ffbc84f}}
\index{GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}!localized\_help@{localized\_help}}
\index{localized\_help@{localized\_help}!GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}}
\doxysubsubsection{\texorpdfstring{localized\_help()}{localized\_help()}}
2022-05-08 22:01:23 +00:00
{\footnotesize\ttfamily Q\+Url Gpg\+Frontend\+::\+U\+I\+::\+Help\+Page\+::localized\+\_\+help (\begin{DoxyParamCaption}\item[{const Q\+Url \&}]{url }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
2022-05-08 19:59:26 +00:00
\mbox{\hyperlink{classGpgFrontend_1_1UI_1_1HelpPage_a49fbde87f2ef385b44225acd6ffbc84f}{Help\+Page\+::localized\+\_\+help}} check if the requested file is also available with the locale, e.\+g. return index.\+de.\+html if index.\+html was requested but the locale is de and index.\+de.\+html is available.
\begin{DoxyParams}{Parameters}
{\em url} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\end{DoxyReturn}
2022-05-08 22:01:23 +00:00
Referenced by Help\+Page(), and slot\+\_\+open\+\_\+url().
2022-05-08 19:59:26 +00:00
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1HelpPage_a51ff99077a75507365307f5dd783df99}\label{classGpgFrontend_1_1UI_1_1HelpPage_a51ff99077a75507365307f5dd783df99}}
\index{GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}!slot\_open\_url@{slot\_open\_url}}
\index{slot\_open\_url@{slot\_open\_url}!GpgFrontend::UI::HelpPage@{GpgFrontend::UI::HelpPage}}
\doxysubsubsection{\texorpdfstring{slot\_open\_url}{slot\_open\_url}}
2022-05-08 22:01:23 +00:00
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+U\+I\+::\+Help\+Page\+::slot\+\_\+open\+\_\+url (\begin{DoxyParamCaption}\item[{const Q\+Url \&}]{url }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [slot]}}
2022-05-08 19:59:26 +00:00
\begin{DoxyParams}{Parameters}
{\em url} & \\
\hline
\end{DoxyParams}
2022-05-08 22:01:23 +00:00
References browser\+\_\+, and localized\+\_\+help().
2022-05-08 19:59:26 +00:00
2022-05-08 22:01:23 +00:00
Referenced by Help\+Page().
2022-05-08 19:59:26 +00:00
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/ui/widgets/Help\+Page.\+h\item
src/ui/widgets/Help\+Page.\+cpp\end{DoxyCompactItemize}