GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1UI_1_1InfoBoardWidget.tex

251 lines
15 KiB
TeX
Raw Normal View History

2022-05-08 19:59:26 +00:00
\hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget}{}\doxysection{Gpg\+Frontend\+::UI\+::Info\+Board\+Widget Class Reference}
\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget}\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
Class for handling the verify label shown at bottom of a textedit-\/page.
{\ttfamily \#include $<$Info\+Board\+Widget.\+h$>$}
Inheritance diagram for Gpg\+Frontend\+::UI\+::Info\+Board\+Widget\+:
% FIG 0
Collaboration diagram for Gpg\+Frontend\+::UI\+::Info\+Board\+Widget\+:
% FIG 1
\doxysubsection*{Public Slots}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ac576ad298acc83cc313b6753e3715441}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ac576ad298acc83cc313b6753e3715441}}
void {\bfseries Slot\+Reset} ()
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a68f984815100f4ce281b9794f193e516}{Slot\+Refresh}} (const QString \&text, \mbox{\hyperlink{namespaceGpgFrontend_1_1UI_acbaebd342a317b1f067942e5144bb00d}{Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Status}} status)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adeef521a8838bf2a1692c25d9b108010}{Info\+Board\+Widget}} (QWidget $\ast$parent)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a4fd6f91eb435feb41ae93e44485646ab}{Associate\+Text\+Edit}} (QText\+Edit $\ast$edit)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adfa4acd435d2ec29f951f4e7e6a43f38}{Associate\+Tab\+Widget}} (QTab\+Widget $\ast$tab)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a456f15315a03107f7757d84362c1af71}{Add\+Optional\+Action}} (const QString \&name, const std\+::function$<$ void()$>$ \&action)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a7d7504339221bd680fb18698dd829b32}{Reset\+Option\+Actions\+Menu}} ()
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ac936cfc8e1b3af65d0d71b74fb3f0b02}{Set\+Info\+Board}} (const QString \&text, \mbox{\hyperlink{namespaceGpgFrontend_1_1UI_acbaebd342a317b1f067942e5144bb00d}{Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Status}} verify\+\_\+label\+\_\+status)
\end{DoxyCompactItemize}
\doxysubsection*{Private Slots}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a83a4ec326911b8b112bc471e7ca14925}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a83a4ec326911b8b112bc471e7ca14925}}
void {\bfseries slot\+\_\+copy} ()
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a2c23091fa2fd5b97a045ac6c492caaca}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a2c23091fa2fd5b97a045ac6c492caaca}}
void {\bfseries slot\+\_\+save} ()
\end{DoxyCompactItemize}
\doxysubsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a852c1fe10c7d3153a2146bcea4dbe9ad}{delete\+\_\+widgets\+\_\+in\+\_\+layout}} (QLayout $\ast$layout, int start\+\_\+index=0)
\end{DoxyCompactItemize}
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a4d18a72ae1c460a12b8902d426d9d395}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a4d18a72ae1c460a12b8902d426d9d395}}
std\+::shared\+\_\+ptr$<$ Ui\+\_\+\+Info\+Board $>$ {\bfseries ui\+\_\+}
\item
QText\+Edit $\ast$ \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a6380776ea1bf9a020370589e1e20efd3}{m\+\_\+text\+\_\+page\+\_\+}}
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1TextEdit}{Text\+Edit}} associated to the notification. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ad30591c31d19936cfd256e1a3c35d08f}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ad30591c31d19936cfd256e1a3c35d08f}}
QTab\+Widget $\ast$ {\bfseries m\+\_\+tab\+\_\+widget\+\_\+} \{nullptr\}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Class for handling the verify label shown at bottom of a textedit-\/page.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adeef521a8838bf2a1692c25d9b108010}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adeef521a8838bf2a1692c25d9b108010}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!InfoBoardWidget@{InfoBoardWidget}}
\index{InfoBoardWidget@{InfoBoardWidget}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{InfoBoardWidget()}{InfoBoardWidget()}}
{\footnotesize\ttfamily Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Info\+Board\+Widget (\begin{DoxyParamCaption}\item[{QWidget $\ast$}]{parent }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}}
\begin{DoxyParams}{Parameters}
{\em ctx} & The GPGme-\/\+Context \\
\hline
{\em parent} & The parent widget \\
\hline
\end{DoxyParams}
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1SignalStation_abe381ce56a7b157a3760b2fd9c3b7419}{Gpg\+Frontend\+::\+UI\+::\+Signal\+Station\+::\+Get\+Instance()}}, \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1SignalStation_a94d4c7d79e0deb7026083689bc5dc2ad}{Gpg\+Frontend\+::\+UI\+::\+Signal\+Station\+::\+Signal\+Refresh\+Info\+Board()}}, and \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a68f984815100f4ce281b9794f193e516}{Slot\+Refresh()}}.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a456f15315a03107f7757d84362c1af71}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a456f15315a03107f7757d84362c1af71}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!AddOptionalAction@{AddOptionalAction}}
\index{AddOptionalAction@{AddOptionalAction}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{AddOptionalAction()}{AddOptionalAction()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Add\+Optional\+Action (\begin{DoxyParamCaption}\item[{const QString \&}]{name, }\item[{const std\+::function$<$ void()$>$ \&}]{action }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em name} & \\
\hline
{\em action} & \\
\hline
\end{DoxyParams}
Referenced by \mbox{\hyperlink{namespaceGpgFrontend_1_1UI_a590a26051105940a6d6e0743b147e281}{Gpg\+Frontend\+::\+UI\+::show\+\_\+verify\+\_\+details()}}.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adfa4acd435d2ec29f951f4e7e6a43f38}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adfa4acd435d2ec29f951f4e7e6a43f38}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!AssociateTabWidget@{AssociateTabWidget}}
\index{AssociateTabWidget@{AssociateTabWidget}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{AssociateTabWidget()}{AssociateTabWidget()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Associate\+Tab\+Widget (\begin{DoxyParamCaption}\item[{QTab\+Widget $\ast$}]{tab }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em tab} & \\
\hline
\end{DoxyParams}
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a6380776ea1bf9a020370589e1e20efd3}{m\+\_\+text\+\_\+page\+\_\+}}.
Referenced by \mbox{\hyperlink{namespaceGpgFrontend_1_1UI_abd3c7c636954390d52150b4e6d38e1b3}{Gpg\+Frontend\+::\+UI\+::process\+\_\+result\+\_\+analyse()}}.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a4fd6f91eb435feb41ae93e44485646ab}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a4fd6f91eb435feb41ae93e44485646ab}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!AssociateTextEdit@{AssociateTextEdit}}
\index{AssociateTextEdit@{AssociateTextEdit}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{AssociateTextEdit()}{AssociateTextEdit()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Associate\+Text\+Edit (\begin{DoxyParamCaption}\item[{QText\+Edit $\ast$}]{edit }\end{DoxyParamCaption})}
\begin{DoxyParams}{Parameters}
{\em edit} & \\
\hline
\end{DoxyParams}
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a6380776ea1bf9a020370589e1e20efd3}{m\+\_\+text\+\_\+page\+\_\+}}.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a852c1fe10c7d3153a2146bcea4dbe9ad}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a852c1fe10c7d3153a2146bcea4dbe9ad}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!delete\_widgets\_in\_layout@{delete\_widgets\_in\_layout}}
\index{delete\_widgets\_in\_layout@{delete\_widgets\_in\_layout}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{delete\_widgets\_in\_layout()}{delete\_widgets\_in\_layout()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::delete\+\_\+widgets\+\_\+in\+\_\+layout (\begin{DoxyParamCaption}\item[{QLayout $\ast$}]{layout, }\item[{int}]{start\+\_\+index = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
\begin{DoxyParams}{Parameters}
{\em layout} & \\
\hline
{\em start\+\_\+index} & \\
\hline
\end{DoxyParams}
Try Delete all widget from target layout
\begin{DoxyParams}{Parameters}
{\em layout} & target layout \\
\hline
\end{DoxyParams}
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a852c1fe10c7d3153a2146bcea4dbe9ad}{delete\+\_\+widgets\+\_\+in\+\_\+layout()}}.
Referenced by \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a852c1fe10c7d3153a2146bcea4dbe9ad}{delete\+\_\+widgets\+\_\+in\+\_\+layout()}}, and \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a7d7504339221bd680fb18698dd829b32}{Reset\+Option\+Actions\+Menu()}}.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a7d7504339221bd680fb18698dd829b32}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a7d7504339221bd680fb18698dd829b32}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!ResetOptionActionsMenu@{ResetOptionActionsMenu}}
\index{ResetOptionActionsMenu@{ResetOptionActionsMenu}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{ResetOptionActionsMenu()}{ResetOptionActionsMenu()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Reset\+Option\+Actions\+Menu (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Delete All item in action\+Button\+Layout
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a852c1fe10c7d3153a2146bcea4dbe9ad}{delete\+\_\+widgets\+\_\+in\+\_\+layout()}}.
Referenced by \mbox{\hyperlink{namespaceGpgFrontend_1_1UI_a590a26051105940a6d6e0743b147e281}{Gpg\+Frontend\+::\+UI\+::show\+\_\+verify\+\_\+details()}}, \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1MainWindow_ae11d01211c2914ecc148e13dd7de506e}{Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+encrypt()}}, and \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1MainWindow_a304efe91afa31b32725caa00c27475a4}{Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+encrypt\+\_\+sign()}}.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ac936cfc8e1b3af65d0d71b74fb3f0b02}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ac936cfc8e1b3af65d0d71b74fb3f0b02}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!SetInfoBoard@{SetInfoBoard}}
\index{SetInfoBoard@{SetInfoBoard}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{SetInfoBoard()}{SetInfoBoard()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Set\+Info\+Board (\begin{DoxyParamCaption}\item[{const QString \&}]{text, }\item[{\mbox{\hyperlink{namespaceGpgFrontend_1_1UI_acbaebd342a317b1f067942e5144bb00d}{Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Status}}}]{verify\+\_\+label\+\_\+status }\end{DoxyParamCaption})}
Set the text and background-\/color of verify notification.
\begin{DoxyParams}{Parameters}
{\em text} & The text to be set. \\
\hline
{\em verify\+\_\+label\+\_\+status} & The status of label to set the specified color. \\
\hline
\end{DoxyParams}
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1SettingsObject_a5ddcc2e0bc6d4c2f88e6e00371d4792e}{Gpg\+Frontend\+::\+UI\+::\+Settings\+Object\+::\+Check()}}.
Referenced by \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a68f984815100f4ce281b9794f193e516}{Slot\+Refresh()}}.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a68f984815100f4ce281b9794f193e516}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a68f984815100f4ce281b9794f193e516}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!SlotRefresh@{SlotRefresh}}
\index{SlotRefresh@{SlotRefresh}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{SlotRefresh}{SlotRefresh}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::\+Slot\+Refresh (\begin{DoxyParamCaption}\item[{const QString \&}]{text, }\item[{\mbox{\hyperlink{namespaceGpgFrontend_1_1UI_acbaebd342a317b1f067942e5144bb00d}{Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Status}}}]{status }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [slot]}}
Refresh the contents of dialog.
References \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_ac936cfc8e1b3af65d0d71b74fb3f0b02}{Set\+Info\+Board()}}.
Referenced by \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adeef521a8838bf2a1692c25d9b108010}{Info\+Board\+Widget()}}, and \mbox{\hyperlink{namespaceGpgFrontend_1_1UI_a204156a333cde4f705f0ace91cd3d333}{Gpg\+Frontend\+::\+UI\+::refresh\+\_\+info\+\_\+board()}}.
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a6380776ea1bf9a020370589e1e20efd3}\label{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a6380776ea1bf9a020370589e1e20efd3}}
\index{GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}!m\_text\_page\_@{m\_text\_page\_}}
\index{m\_text\_page\_@{m\_text\_page\_}!GpgFrontend::UI::InfoBoardWidget@{GpgFrontend::UI::InfoBoardWidget}}
\doxysubsubsection{\texorpdfstring{m\_text\_page\_}{m\_text\_page\_}}
{\footnotesize\ttfamily QText\+Edit$\ast$ Gpg\+Frontend\+::\+UI\+::\+Info\+Board\+Widget\+::m\+\_\+text\+\_\+page\+\_\+\hspace{0.3cm}{\ttfamily [private]}}
{\bfseries Initial value\+:}
\begin{DoxyCode}{0}
\DoxyCodeLine{\{}
\DoxyCodeLine{ \textcolor{keyword}{nullptr}\}}
\end{DoxyCode}
\mbox{\hyperlink{classGpgFrontend_1_1UI_1_1TextEdit}{Text\+Edit}} associated to the notification.
Referenced by \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_adfa4acd435d2ec29f951f4e7e6a43f38}{Associate\+Tab\+Widget()}}, and \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1InfoBoardWidget_a4fd6f91eb435feb41ae93e44485646ab}{Associate\+Text\+Edit()}}.
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/ui/widgets/Info\+Board\+Widget.\+h\item
src/ui/widgets/Info\+Board\+Widget.\+cpp\end{DoxyCompactItemize}