GpgFrontend-Doxygen/docs/latex/classGpgFrontend_1_1UI_1_1PlainTextEditorPage.tex

244 lines
15 KiB
TeX

\hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage}{}\doxysection{Gpg\+Frontend\+::UI\+::Plain\+Text\+Editor\+Page Class Reference}
\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage}\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
Class for handling a single tab of the tabwidget.
{\ttfamily \#include $<$Plain\+Text\+Editor\+Page.\+h$>$}
Inheritance diagram for Gpg\+Frontend\+::UI\+::Plain\+Text\+Editor\+Page\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=232pt]{classGpgFrontend_1_1UI_1_1PlainTextEditorPage__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Gpg\+Frontend\+::UI\+::Plain\+Text\+Editor\+Page\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=550pt]{classGpgFrontend_1_1UI_1_1PlainTextEditorPage__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Signals}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_afd3749488fdd3d1c53446fb8c833f3f4}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_afd3749488fdd3d1c53446fb8c833f3f4}}
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_afd3749488fdd3d1c53446fb8c833f3f4}{Signal\+UIBytes\+Displayed}} ()
\begin{DoxyCompactList}\small\item\em this signal is emitted when the bytes has been append in texteditor. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a8759224e57d4c322933ed3df6d96e5f1}{Plain\+Text\+Editor\+Page}} (QString file\+\_\+path=\{\}, QWidget $\ast$parent=nullptr)
\item
const QString \& \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aff81f0f98a399fa55b6b0ebf2230d4cf}{Get\+File\+Path}} () const
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aa9e82690824c82e7628ba4ace9d6e2fe}{Set\+File\+Path}} (const QString \&file\+Path)
\item
QPlain\+Text\+Edit $\ast$ \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a6218e6e12bdba0228e4ab4276f7fed7a}{Get\+Text\+Page}} ()
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_af5dfdfd48ef64cc46e524ec70a22fe3a}{Show\+Notification\+Widget}} (QWidget $\ast$widget, const char $\ast$class\+Name)
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aee4f46e54f29da671838ed232e526700}{Close\+Note\+By\+Class}} (const char $\ast$class\+Name)
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ac3404f71f0f93cd7f5cb64d5d56624d7}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ac3404f71f0f93cd7f5cb64d5d56624d7}}
void {\bfseries Read\+File} ()
\item
bool \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ac1902b063decfeebe7f0908cbfe618ce}{Read\+Done}} () const
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a29b3d63ba9590e775f42c779c76102e5}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a29b3d63ba9590e775f42c779c76102e5}}
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a29b3d63ba9590e775f42c779c76102e5}{Notify\+File\+Saved}} ()
\begin{DoxyCompactList}\small\item\em notify the user that the file has been saved. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Private Slots}
\begin{DoxyCompactItemize}
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a45267bcfc8fc83851894061c0fe2a9c2}{slot\+\_\+format\+\_\+gpg\+\_\+header}} ()
\item
void \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a184985104f23da8fdf2b9aaf7b27405b}{slot\+\_\+insert\+\_\+text}} (QByte\+Array bytes\+\_\+data)
\end{DoxyCompactItemize}
\doxysubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a0e0a36396ea55f5dbe6197284cf98192}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a0e0a36396ea55f5dbe6197284cf98192}}
std\+::shared\+\_\+ptr$<$ Ui\+\_\+\+Plain\+Text\+Editor $>$ {\bfseries ui\+\_\+}
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ae867b6329fcb1978479a9d70f7b017db}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ae867b6329fcb1978479a9d70f7b017db}}
QString \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ae867b6329fcb1978479a9d70f7b017db}{full\+\_\+file\+\_\+path\+\_\+}}
\begin{DoxyCompactList}\small\item\em The path to the file handled in the tab. \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a4f94e9ef7889a169bda5a47b7f657358}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a4f94e9ef7889a169bda5a47b7f657358}}
bool \mbox{\hyperlink{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a4f94e9ef7889a169bda5a47b7f657358}{sign\+\_\+marked\+\_\+}} \{\}
\begin{DoxyCompactList}\small\item\em true, if the signed header is marked, false if not \end{DoxyCompactList}\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a5b8ce290e1b949b56734227e8d42adba}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a5b8ce290e1b949b56734227e8d42adba}}
bool {\bfseries read\+\_\+done\+\_\+} = false
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a010bae8d8d967c8cc81cd42547de5dcb}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a010bae8d8d967c8cc81cd42547de5dcb}}
size\+\_\+t {\bfseries read\+\_\+bytes\+\_\+} = 0
\item
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a0e64bcd36cf90b0eec2f05361c6c6fb3}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a0e64bcd36cf90b0eec2f05361c6c6fb3}}
bool {\bfseries is\+\_\+crlf\+\_\+} = false
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
Class for handling a single tab of the tabwidget.
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a8759224e57d4c322933ed3df6d96e5f1}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a8759224e57d4c322933ed3df6d96e5f1}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!PlainTextEditorPage@{PlainTextEditorPage}}
\index{PlainTextEditorPage@{PlainTextEditorPage}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{PlainTextEditorPage()}{PlainTextEditorPage()}}
{\footnotesize\ttfamily Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Plain\+Text\+Editor\+Page (\begin{DoxyParamCaption}\item[{QString}]{file\+\_\+path = {\ttfamily \{\}}, }\item[{QWidget $\ast$}]{parent = {\ttfamily nullptr} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}}
Add layout and add plaintextedit
\begin{DoxyParams}{Parameters}
{\em file\+\_\+path} & Path of the file handled in this tab \\
\hline
{\em parent} & Pointer to the parent widget \\
\hline
\end{DoxyParams}
References full\+\_\+file\+\_\+path\+\_\+.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aee4f46e54f29da671838ed232e526700}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aee4f46e54f29da671838ed232e526700}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!CloseNoteByClass@{CloseNoteByClass}}
\index{CloseNoteByClass@{CloseNoteByClass}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{CloseNoteByClass()}{CloseNoteByClass()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Close\+Note\+By\+Class (\begin{DoxyParamCaption}\item[{const char $\ast$}]{class\+Name }\end{DoxyParamCaption})}
Hide all widgets with the given class\+Name
\begin{DoxyParams}{Parameters}
{\em class\+Name} & The classname of the widgets to hide \\
\hline
\end{DoxyParams}
Referenced by Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+find().
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aff81f0f98a399fa55b6b0ebf2230d4cf}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aff81f0f98a399fa55b6b0ebf2230d4cf}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!GetFilePath@{GetFilePath}}
\index{GetFilePath@{GetFilePath}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{GetFilePath()}{GetFilePath()}}
{\footnotesize\ttfamily const QString \& Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Get\+File\+Path (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
Get the filepath of the currently activated tab.
References full\+\_\+file\+\_\+path\+\_\+.
Referenced by Gpg\+Frontend\+::\+UI\+::\+Text\+Edit\+::maybe\+\_\+save\+\_\+current\+\_\+tab(), and Gpg\+Frontend\+::\+UI\+::\+Text\+Edit\+::\+Slot\+Save\+As().
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a6218e6e12bdba0228e4ab4276f7fed7a}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a6218e6e12bdba0228e4ab4276f7fed7a}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!GetTextPage@{GetTextPage}}
\index{GetTextPage@{GetTextPage}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{GetTextPage()}{GetTextPage()}}
{\footnotesize\ttfamily QPlain\+Text\+Edit $\ast$ Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Get\+Text\+Page (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Return pointer tp the textedit of the currently activated tab.
Referenced by Gpg\+Frontend\+::\+UI\+::\+Text\+Edit\+::maybe\+\_\+save\+\_\+current\+\_\+tab(), Gpg\+Frontend\+::\+UI\+::\+Text\+Edit\+::save\+\_\+file(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+add\+\_\+pgp\+\_\+header(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+clean\+\_\+double\+\_\+line\+\_\+breaks(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+cut\+\_\+pgp\+\_\+header(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+import\+\_\+key\+\_\+from\+\_\+edit(), slot\+\_\+insert\+\_\+text(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::\+Slot\+Decrypt(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::\+Slot\+Decrypt\+Verify(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::\+Slot\+Encrypt(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::\+Slot\+Encrypt\+Sign(), Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::\+Slot\+Sign(), and Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::\+Slot\+Verify().
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ac1902b063decfeebe7f0908cbfe618ce}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_ac1902b063decfeebe7f0908cbfe618ce}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!ReadDone@{ReadDone}}
\index{ReadDone@{ReadDone}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{ReadDone()}{ReadDone()}}
{\footnotesize\ttfamily bool Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Read\+Done (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
\begin{DoxyReturn}{Returns}
true
false
\end{DoxyReturn}
Referenced by Gpg\+Frontend\+::\+UI\+::\+Text\+Edit\+::maybe\+\_\+save\+\_\+current\+\_\+tab().
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aa9e82690824c82e7628ba4ace9d6e2fe}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_aa9e82690824c82e7628ba4ace9d6e2fe}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!SetFilePath@{SetFilePath}}
\index{SetFilePath@{SetFilePath}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{SetFilePath()}{SetFilePath()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Set\+File\+Path (\begin{DoxyParamCaption}\item[{const QString \&}]{file\+Path }\end{DoxyParamCaption})}
Set filepath of currently activated tab.
\begin{DoxyParams}{Parameters}
{\em file\+Path} & The path to be set \\
\hline
\end{DoxyParams}
References full\+\_\+file\+\_\+path\+\_\+.
Referenced by Gpg\+Frontend\+::\+UI\+::\+Text\+Edit\+::save\+\_\+file().
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_af5dfdfd48ef64cc46e524ec70a22fe3a}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_af5dfdfd48ef64cc46e524ec70a22fe3a}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!ShowNotificationWidget@{ShowNotificationWidget}}
\index{ShowNotificationWidget@{ShowNotificationWidget}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{ShowNotificationWidget()}{ShowNotificationWidget()}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::\+Show\+Notification\+Widget (\begin{DoxyParamCaption}\item[{QWidget $\ast$}]{widget, }\item[{const char $\ast$}]{class\+Name }\end{DoxyParamCaption})}
Show additional widget at buttom of currently active tab
\begin{DoxyParams}{Parameters}
{\em widget} & The widget to be added \\
\hline
{\em class\+Name} & The name to handle the added widget \\
\hline
\end{DoxyParams}
Referenced by Gpg\+Frontend\+::\+UI\+::\+Main\+Window\+::slot\+\_\+find().
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a45267bcfc8fc83851894061c0fe2a9c2}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a45267bcfc8fc83851894061c0fe2a9c2}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!slot\_format\_gpg\_header@{slot\_format\_gpg\_header}}
\index{slot\_format\_gpg\_header@{slot\_format\_gpg\_header}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{slot\_format\_gpg\_header}{slot\_format\_gpg\_header}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::slot\+\_\+format\+\_\+gpg\+\_\+header (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}, {\ttfamily [slot]}}
Format the gpg header in another font-\/style
References sign\+\_\+marked\+\_\+.
\mbox{\Hypertarget{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a184985104f23da8fdf2b9aaf7b27405b}\label{classGpgFrontend_1_1UI_1_1PlainTextEditorPage_a184985104f23da8fdf2b9aaf7b27405b}}
\index{GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}!slot\_insert\_text@{slot\_insert\_text}}
\index{slot\_insert\_text@{slot\_insert\_text}!GpgFrontend::UI::PlainTextEditorPage@{GpgFrontend::UI::PlainTextEditorPage}}
\doxysubsubsection{\texorpdfstring{slot\_insert\_text}{slot\_insert\_text}}
{\footnotesize\ttfamily void Gpg\+Frontend\+::\+UI\+::\+Plain\+Text\+Editor\+Page\+::slot\+\_\+insert\+\_\+text (\begin{DoxyParamCaption}\item[{QByte\+Array}]{bytes\+\_\+data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}, {\ttfamily [slot]}}
\begin{DoxyParams}{Parameters}
{\em data} & \\
\hline
\end{DoxyParams}
References Get\+Text\+Page(), and Signal\+UIBytes\+Displayed().
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
src/ui/widgets/Plain\+Text\+Editor\+Page.\+h\item
src/ui/widgets/Plain\+Text\+Editor\+Page.\+cpp\end{DoxyCompactItemize}