elB4RTO/LogDoctor
elB4RTO
/
LogDoctor
2
2
Fork 0
Code Issues 6 Pull Requests Projects 1 Releases 8 Wiki Activity
LogDoctor/docs/html/classCraphelp.html

204 lines
8.5 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LogDoctor: Craphelp Class Reference</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="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>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="dox_logo.png"/></td>
<td id="projectalign">
<div id="projectname">LogDoctor<span id="projectnumber">&#160;2.04</span>
</div>
<div id="projectbrief">Parse Apache2/Nginx/IIS logs and view dinamically generated statistics</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classCraphelp-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Craphelp Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classCraphelp.html" title="Craphelp.">Craphelp</a>.
<a href="classCraphelp.html#details">More...</a></p>
<p><code>#include &lt;craphelp.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Craphelp:</div>
<div class="dyncontent">
<div class="center">
<img src="classCraphelp.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a311257a3a833ec2fa8fe262fbd0646cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCraphelp.html#a311257a3a833ec2fa8fe262fbd0646cb">helpLogsFormat</a> (const std::string &amp;path, const QFont &amp;font, const int color_scheme_id) const</td></tr>
<tr class="memdesc:a311257a3a833ec2fa8fe262fbd0646cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides help about log formats. <br /></td></tr>
<tr class="separator:a311257a3a833ec2fa8fe262fbd0646cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf0dd64949a11297fb23aa97971e241a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCraphelp.html#acf0dd64949a11297fb23aa97971e241a">helpLogsFormatDefault</a> (std::string_view file_name, const QFont &amp;font, const int color_scheme_id) const</td></tr>
<tr class="memdesc:acf0dd64949a11297fb23aa97971e241a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides help about log formats. <br /></td></tr>
<tr class="separator:acf0dd64949a11297fb23aa97971e241a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCraphelp.html" title="Craphelp.">Craphelp</a>. </p>
<p>Displays an help window </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a311257a3a833ec2fa8fe262fbd0646cb" name="a311257a3a833ec2fa8fe262fbd0646cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a311257a3a833ec2fa8fe262fbd0646cb">&#9670;&#160;</a></span>helpLogsFormat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Craphelp::helpLogsFormat </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QFont &amp;&#160;</td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>color_scheme_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides help about log formats. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path of the file resource to be displayed </td></tr>
<tr><td class="paramname">font</td><td>The font to be used </td></tr>
<tr><td class="paramname">color_scheme_id</td><td>The ID of the color-scheme to be used </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acf0dd64949a11297fb23aa97971e241a" name="acf0dd64949a11297fb23aa97971e241a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf0dd64949a11297fb23aa97971e241a">&#9670;&#160;</a></span>helpLogsFormatDefault()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Craphelp::helpLogsFormatDefault </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QFont &amp;&#160;</td>
<td class="paramname"><em>font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>color_scheme_id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides help about log formats. </p>
<p>Shows the built-in default version in case the file for the currently selected locale was not found or unreadable </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_name</td><td>The file that was supposed to be shown </td></tr>
<tr><td class="paramname">font</td><td>The font to be used </td></tr>
<tr><td class="paramname">color_scheme_id</td><td>The ID of the color-scheme to be used </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>logdoctor/modules/craphelp/craphelp.h</li>
<li>logdoctor/modules/craphelp/craphelp.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink