GpgFrontend-Doxygen/docs/html/PlainTextEditorPage_8h_source.html

164 lines
19 KiB
HTML
Raw Permalink Normal View History

2022-05-08 19:59:26 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
2022-05-08 22:01:23 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
2022-05-08 19:59:26 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: src/ui/widgets/PlainTextEditorPage.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
2022-05-08 22:01:23 +00:00
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
2022-05-08 19:59:26 +00:00
<div id="projectname">GpgFrontend Project
</div>
<div id="projectbrief">A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
2022-05-08 19:59:26 +00:00
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2022-05-08 19:59:26 +00:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-05-08 22:01:23 +00:00
/* @license-end */</script>
2022-05-08 19:59:26 +00:00
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(document).ready(function(){initNavTree('PlainTextEditorPage_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
2022-05-08 22:01:23 +00:00
<div class="headertitle">
<div class="title">PlainTextEditorPage.h</div> </div>
2022-05-08 19:59:26 +00:00
</div><!--header-->
<div class="contents">
2022-05-08 22:01:23 +00:00
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">class </span>Ui_PlainTextEditor;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceGpgFrontend_1_1UI.html">GpgFrontend::UI</a> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html"> 39</a></span>&#160;<span class="keyword">class </span><a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html">PlainTextEditorPage</a> : <span class="keyword">public</span> QWidget {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; Q_OBJECT</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a8759224e57d4c322933ed3df6d96e5f1">PlainTextEditorPage</a>(QString file_path = {},</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; QWidget* parent = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; [[nodiscard]] <span class="keyword">const</span> QString&amp; <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#aff81f0f98a399fa55b6b0ebf2230d4cf">GetFilePath</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#aa9e82690824c82e7628ba4ace9d6e2fe">SetFilePath</a>(<span class="keyword">const</span> QString&amp; filePath);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; QPlainTextEdit* <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a6218e6e12bdba0228e4ab4276f7fed7a">GetTextPage</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#af5dfdfd48ef64cc46e524ec70a22fe3a">ShowNotificationWidget</a>(QWidget* widget, <span class="keyword">const</span> <span class="keywordtype">char</span>* className);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#aee4f46e54f29da671838ed232e526700">CloseNoteByClass</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* className);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> ReadFile();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#ac1902b063decfeebe7f0908cbfe618ce"> 95</a></span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#ac1902b063decfeebe7f0908cbfe618ce">ReadDone</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> this-&gt;read_done_; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a29b3d63ba9590e775f42c779c76102e5">NotifyFileSaved</a>();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; signals:</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#afd3749488fdd3d1c53446fb8c833f3f4"> 109</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#afd3749488fdd3d1c53446fb8c833f3f4">SignalUIBytesDisplayed</a>();</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; std::shared_ptr&lt;Ui_PlainTextEditor&gt; ui_; </div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#ae867b6329fcb1978479a9d70f7b017db"> 113</a></span>&#160; QString <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#ae867b6329fcb1978479a9d70f7b017db">full_file_path_</a>; </div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a4f94e9ef7889a169bda5a47b7f657358"> 114</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a4f94e9ef7889a169bda5a47b7f657358">sign_marked_</a>{}; </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordtype">bool</span> read_done_ = <span class="keyword">false</span>; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">size_t</span> read_bytes_ = 0; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordtype">bool</span> is_crlf_ = <span class="keyword">false</span>; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">private</span> slots:</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a45267bcfc8fc83851894061c0fe2a9c2">slot_format_gpg_header</a>();</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a184985104f23da8fdf2b9aaf7b27405b">slot_insert_text</a>(QByteArray bytes_data);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;};</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;} <span class="comment">// namespace GpgFrontend::UI</span></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html">GpgFrontend::UI::PlainTextEditorPage</a></div><div class="ttdoc">Class for handling a single tab of the tabwidget.</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.h:39</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_a184985104f23da8fdf2b9aaf7b27405b"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a184985104f23da8fdf2b9aaf7b27405b">GpgFrontend::UI::PlainTextEditorPage::slot_insert_text</a></div><div class="ttdeci">void slot_insert_text(QByteArray bytes_data)</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:188</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_a29b3d63ba9590e775f42c779c76102e5"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a29b3d63ba9590e775f42c779c76102e5">GpgFrontend::UI::PlainTextEditorPage::NotifyFileSaved</a></div><div class="ttdeci">void NotifyFileSaved()</div><div class="ttdoc">notify the user that the file has been saved.</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:83</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_a45267bcfc8fc83851894061c0fe2a9c2"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a45267bcfc8fc83851894061c0fe2a9c2">GpgFrontend::UI::PlainTextEditorPage::slot_format_gpg_header</a></div><div class="ttdeci">void slot_format_gpg_header()</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:109</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_a4f94e9ef7889a169bda5a47b7f657358"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a4f94e9ef7889a169bda5a47b7f657358">GpgFrontend::UI::PlainTextEditorPage::sign_marked_</a></div><div class="ttdeci">bool sign_marked_</div><div class="ttdoc">true, if the signed header is marked, false if not</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.h:114</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_a6218e6e12bdba0228e4ab4276f7fed7a"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a6218e6e12bdba0228e4ab4276f7fed7a">GpgFrontend::UI::PlainTextEditorPage::GetTextPage</a></div><div class="ttdeci">QPlainTextEdit * GetTextPage()</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:81</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_a8759224e57d4c322933ed3df6d96e5f1"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#a8759224e57d4c322933ed3df6d96e5f1">GpgFrontend::UI::PlainTextEditorPage::PlainTextEditorPage</a></div><div class="ttdeci">PlainTextEditorPage(QString file_path={}, QWidget *parent=nullptr)</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:39</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_aa9e82690824c82e7628ba4ace9d6e2fe"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#aa9e82690824c82e7628ba4ace9d6e2fe">GpgFrontend::UI::PlainTextEditorPage::SetFilePath</a></div><div class="ttdeci">void SetFilePath(const QString &amp;filePath)</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:90</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_ac1902b063decfeebe7f0908cbfe618ce"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#ac1902b063decfeebe7f0908cbfe618ce">GpgFrontend::UI::PlainTextEditorPage::ReadDone</a></div><div class="ttdeci">bool ReadDone() const</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.h:95</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_ae867b6329fcb1978479a9d70f7b017db"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#ae867b6329fcb1978479a9d70f7b017db">GpgFrontend::UI::PlainTextEditorPage::full_file_path_</a></div><div class="ttdeci">QString full_file_path_</div><div class="ttdoc">The path to the file handled in the tab.</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.h:113</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_aee4f46e54f29da671838ed232e526700"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#aee4f46e54f29da671838ed232e526700">GpgFrontend::UI::PlainTextEditorPage::CloseNoteByClass</a></div><div class="ttdeci">void CloseNoteByClass(const char *className)</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:100</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_af5dfdfd48ef64cc46e524ec70a22fe3a"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#af5dfdfd48ef64cc46e524ec70a22fe3a">GpgFrontend::UI::PlainTextEditorPage::ShowNotificationWidget</a></div><div class="ttdeci">void ShowNotificationWidget(QWidget *widget, const char *className)</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:94</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_afd3749488fdd3d1c53446fb8c833f3f4"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#afd3749488fdd3d1c53446fb8c833f3f4">GpgFrontend::UI::PlainTextEditorPage::SignalUIBytesDisplayed</a></div><div class="ttdeci">void SignalUIBytesDisplayed()</div><div class="ttdoc">this signal is emitted when the bytes has been append in texteditor.</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1UI_1_1PlainTextEditorPage_html_aff81f0f98a399fa55b6b0ebf2230d4cf"><div class="ttname"><a href="classGpgFrontend_1_1UI_1_1PlainTextEditorPage.html#aff81f0f98a399fa55b6b0ebf2230d4cf">GpgFrontend::UI::PlainTextEditorPage::GetFilePath</a></div><div class="ttdeci">const QString &amp; GetFilePath() const</div><div class="ttdef"><b>Definition:</b> PlainTextEditorPage.cpp:77</div></div>
<div class="ttc" id="anamespaceGpgFrontend_1_1UI_html"><div class="ttname"><a href="namespaceGpgFrontend_1_1UI.html">GpgFrontend::UI</a></div><div class="ttdef"><b>Definition:</b> FileReadTask.cpp:31</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
2022-05-08 19:59:26 +00:00
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_da5c6b39c0a2f54e57df6799511cd3ab.html">ui</a></li><li class="navelem"><a class="el" href="dir_f3911b9629b0e27ea480d06d47573cbf.html">widgets</a></li><li class="navelem"><b>PlainTextEditorPage.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
2022-05-08 19:59:26 +00:00
</ul>
</div>
</body>
</html>