/usr/share/doc/libjuce/apiref/classLogger.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: Logger 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classLogger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Logger Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Acts as an application-wide logging class.
<a href="classLogger.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Logger:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classLogger.png" usemap="#Logger_map" alt=""/>
<map id="Logger_map" name="Logger_map">
<area href="classFileLogger.html" title="A simple implementation of a Logger that writes to a file. " alt="FileLogger" shape="rect" coords="0,56,73,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae93f62ca3e47716b7120acb032a260f3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#ae93f62ca3e47716b7120acb032a260f3">~Logger</a> ()</td></tr>
<tr class="memdesc:ae93f62ca3e47716b7120acb032a260f3"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae93f62ca3e47716b7120acb032a260f3">More...</a><br /></td></tr>
<tr class="separator:ae93f62ca3e47716b7120acb032a260f3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5855a0341fc4f6ceb5418879fd685277"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a5855a0341fc4f6ceb5418879fd685277">setCurrentLogger</a> (<a class="el" href="classLogger.html">Logger</a> *newLogger) noexcept</td></tr>
<tr class="memdesc:a5855a0341fc4f6ceb5418879fd685277"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current logging class to use. <a href="#a5855a0341fc4f6ceb5418879fd685277">More...</a><br /></td></tr>
<tr class="separator:a5855a0341fc4f6ceb5418879fd685277"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4646bc85614d9cfe225f1f89bca50c74"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classLogger.html">Logger</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a4646bc85614d9cfe225f1f89bca50c74">getCurrentLogger</a> () noexcept</td></tr>
<tr class="memdesc:a4646bc85614d9cfe225f1f89bca50c74"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current logger, or nullptr if none has been set. <a href="#a4646bc85614d9cfe225f1f89bca50c74">More...</a><br /></td></tr>
<tr class="separator:a4646bc85614d9cfe225f1f89bca50c74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a037cd16034c0663805f301b0e95c0be6"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a037cd16034c0663805f301b0e95c0be6">writeToLog</a> (const <a class="el" href="classString.html">String</a> &message)</td></tr>
<tr class="memdesc:a037cd16034c0663805f301b0e95c0be6"><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to the current logger. <a href="#a037cd16034c0663805f301b0e95c0be6">More...</a><br /></td></tr>
<tr class="separator:a037cd16034c0663805f301b0e95c0be6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54273b4faf398b4da464d21bb6abac59"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#a54273b4faf398b4da464d21bb6abac59">outputDebugString</a> (const <a class="el" href="classString.html">String</a> &text)</td></tr>
<tr class="memdesc:a54273b4faf398b4da464d21bb6abac59"><td class="mdescLeft"> </td><td class="mdescRight">Writes a message to the standard error stream. <a href="#a54273b4faf398b4da464d21bb6abac59">More...</a><br /></td></tr>
<tr class="separator:a54273b4faf398b4da464d21bb6abac59"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:abc41bfb031d896170c7675fa96a6b30c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#abc41bfb031d896170c7675fa96a6b30c">Logger</a> ()</td></tr>
<tr class="separator:abc41bfb031d896170c7675fa96a6b30c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2ef7f6552d425bf729b7d1a7ed5160f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLogger.html#ab2ef7f6552d425bf729b7d1a7ed5160f">logMessage</a> (const <a class="el" href="classString.html">String</a> &message)=0</td></tr>
<tr class="memdesc:ab2ef7f6552d425bf729b7d1a7ed5160f"><td class="mdescLeft"> </td><td class="mdescRight">This is overloaded by subclasses to implement custom logging behaviour. <a href="#ab2ef7f6552d425bf729b7d1a7ed5160f">More...</a><br /></td></tr>
<tr class="separator:ab2ef7f6552d425bf729b7d1a7ed5160f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Acts as an application-wide logging class. </p>
<p>A subclass of <a class="el" href="classLogger.html" title="Acts as an application-wide logging class. ">Logger</a> can be created and passed into the <a class="el" href="classLogger.html#a5855a0341fc4f6ceb5418879fd685277" title="Sets the current logging class to use. ">Logger::setCurrentLogger</a> method and this will then be used by all calls to writeToLog.</p>
<p>The logger class also contains methods for writing messages to the debugger's output stream.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFileLogger.html" title="A simple implementation of a Logger that writes to a file. ">FileLogger</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ae93f62ca3e47716b7120acb032a260f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae93f62ca3e47716b7120acb032a260f3">§ </a></span>~Logger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Logger::~Logger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<a id="abc41bfb031d896170c7675fa96a6b30c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc41bfb031d896170c7675fa96a6b30c">§ </a></span>Logger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Logger::Logger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5855a0341fc4f6ceb5418879fd685277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5855a0341fc4f6ceb5418879fd685277">§ </a></span>setCurrentLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> Logger::setCurrentLogger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLogger.html">Logger</a> * </td>
<td class="paramname"><em>newLogger</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current logging class to use. </p>
<p>Note that the object passed in will not be owned or deleted by the logger, so the caller must make sure that it is not deleted while still being used. A null pointer can be passed-in to disable any logging. </p>
</div>
</div>
<a id="a4646bc85614d9cfe225f1f89bca50c74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4646bc85614d9cfe225f1f89bca50c74">§ </a></span>getCurrentLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classLogger.html">Logger</a>* Logger::getCurrentLogger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current logger, or nullptr if none has been set. </p>
</div>
</div>
<a id="a037cd16034c0663805f301b0e95c0be6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a037cd16034c0663805f301b0e95c0be6">§ </a></span>writeToLog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> Logger::writeToLog </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a string to the current logger. </p>
<p>This will pass the string to the logger's <a class="el" href="classLogger.html#ab2ef7f6552d425bf729b7d1a7ed5160f" title="This is overloaded by subclasses to implement custom logging behaviour. ">logMessage()</a> method if a logger has been set.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classLogger.html#ab2ef7f6552d425bf729b7d1a7ed5160f" title="This is overloaded by subclasses to implement custom logging behaviour. ">logMessage</a> </dd></dl>
</div>
</div>
<a id="a54273b4faf398b4da464d21bb6abac59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54273b4faf398b4da464d21bb6abac59">§ </a></span>outputDebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> Logger::outputDebugString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a message to the standard error stream. </p>
<p>This can be called directly, or by using the <a class="el" href="juce__PlatformDefs_8h.html#a679635952a5d2eb25f3b31398f0fcc25" title="Writes a string to the standard error stream. ">DBG()</a> macro in <a class="el" href="juce__PlatformDefs_8h.html">juce_PlatformDefs.h</a> (which will avoid calling the method in non-debug builds). </p>
</div>
</div>
<a id="ab2ef7f6552d425bf729b7d1a7ed5160f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2ef7f6552d425bf729b7d1a7ed5160f">§ </a></span>logMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Logger::logMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is overloaded by subclasses to implement custom logging behaviour. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classLogger.html#a5855a0341fc4f6ceb5418879fd685277" title="Sets the current logging class to use. ">setCurrentLogger</a> </dd></dl>
<p>Implemented in <a class="el" href="classFileLogger.html#aaf1bc4062f89bc56c9926bb1af268bb4">FileLogger</a>.</p>
<p>Referenced by <a class="el" href="classFileLogger.html#aa2dae5bcd0746287b8c5076019ea741c">FileLogger::getLogFile()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__Logger_8h.html">juce_Logger.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|