Update pages 🚀
This commit is contained in:
commit
6cb49b3353
15 changed files with 6218 additions and 0 deletions
118
annotated.html
Normal file
118
annotated.html
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html" id="m-navbar-current">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>Classes</h1>
|
||||
<ul class="m-doc">
|
||||
<li>class <a href="classScStw.html" class="m-doc">ScStw</a> <span class="m-doc">The <a href="classScStw.html" class="m-doc">ScStw</a> class provides some shared functions and enums for use in the <a href="classScStw.html" class="m-doc">ScStw</a> project.</span></li>
|
||||
<li>class <a href="classScStwRace.html" class="m-doc">ScStwRace</a> <span class="m-doc">The <a href="classScStwRace.html" class="m-doc">ScStwRace</a> class can be used to measure timings of climbing races with multiple lanes at once.</span></li>
|
||||
<li>class <a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> <span class="m-doc">The <a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> class is used for ultra low latency sound playback of the speed clibing start tones and commands.</span></li>
|
||||
<li>class <a href="classScStwTimer.html" class="m-doc">ScStwTimer</a> <span class="m-doc">The <a href="classScStwTimer.html" class="m-doc">ScStwTimer</a> class is used for advanced time measurement.</span></li>
|
||||
</ul>
|
||||
<script>
|
||||
function toggle(e) {
|
||||
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
|
||||
'm-doc-expansible' : 'm-doc-collapsible';
|
||||
return false;
|
||||
}
|
||||
/* Collapse all nodes marked as such. Doing it via JS instead of
|
||||
directly in markup so disabling it doesn't harm usability. The list
|
||||
is somehow regenerated on every iteration and shrinks as I change
|
||||
the classes. It's not documented anywhere and I'm not sure if this
|
||||
is the same across browsers, so I am going backwards in that list to
|
||||
be sure. */
|
||||
var collapsed = document.getElementsByClassName("collapsed");
|
||||
for(var i = collapsed.length - 1; i >= 0; --i)
|
||||
collapsed[i].className = 'm-doc-expansible';
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
492
classScStw.html
Normal file
492
classScStw.html
Normal file
|
|
@ -0,0 +1,492 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw class | ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>
|
||||
ScStw <span class="m-thin">class</span>
|
||||
</h1>
|
||||
<p>The <a href="classScStw.html" class="m-doc">ScStw</a> class provides some shared functions and enums for use in the <a href="classScStw.html" class="m-doc">ScStw</a> project.</p>
|
||||
<nav class="m-block m-default">
|
||||
<h3>Contents</h3>
|
||||
<ul>
|
||||
<li>
|
||||
Reference
|
||||
<ul>
|
||||
<li><a href="#pub-types">Public types</a></li>
|
||||
<li><a href="#pub-static-attribs">Public static variables</a></li>
|
||||
<li><a href="#pub-static-methods">Public static functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="pub-types">
|
||||
<h2><a href="#pub-types">Public types</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#ae1e6a4063ef25e60b06a96be66ae98f5" class="m-doc">SignalKey</a> { </span><span class="m-doc-wrap"><a href="#ae1e6a4063ef25e60b06a96be66ae98f5af668e8ab065c88986e8d4834f2665a8c" class="m-doc">InvalidSignal</a> = -1,
|
||||
<a href="#ae1e6a4063ef25e60b06a96be66ae98f5aa80ebf1833d97d5832995b1ce5a1da58" class="m-doc">RaceStateChanged</a> = 9000,
|
||||
<a href="#ae1e6a4063ef25e60b06a96be66ae98f5a47d5c3b737a67c16a5a3b3838b1c8c78" class="m-doc">TimersChanged</a> = 9001,
|
||||
<a href="#ae1e6a4063ef25e60b06a96be66ae98f5a0a0771bdd0619fc4295043b9d434a05a" class="m-doc">ExtensionsChanged</a> = 9002,
|
||||
<a href="#ae1e6a4063ef25e60b06a96be66ae98f5a58605207be6190ba18724d7ba9eb9b0f" class="m-doc">CurrentStartDelayChanged</a> = 9003,
|
||||
<a href="#ae1e6a4063ef25e60b06a96be66ae98f5a8e3e0a2a19fce2e083db110623a1328a" class="m-doc">SettingChanged</a> = 9004,
|
||||
<a href="#ae1e6a4063ef25e60b06a96be66ae98f5ac63926de40b326c3bbdc7d2769095238" class="m-doc">RaceDetailsChanged</a> = 9005 }</span>
|
||||
</dt>
|
||||
<dd>The SignalKey enum contains all signal keys a client can subscribe to.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#a5423a0a57d880d1f3869b81c2c31435d" class="m-doc">SocketCommand</a> { </span><span class="m-doc-wrap"><a href="#a5423a0a57d880d1f3869b81c2c31435daa8175df1ad5271c45ceb9728c78b4781" class="m-doc">InvalidCommand</a> = -1,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da89eca4261bb918b66c86aac4cd54b974" class="m-doc">InitializeSessionCommand</a> = 1,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da2e9071f19d6c4323c3e63c230f181915" class="m-doc">StartRaceCommand</a> = 1000,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435daa610e783673fe122b0d2aa475e2a59eb" class="m-doc">StopRaceCommand</a> = 1001,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da54bb9a3f594fc242fb13f67cdd959ecc" class="m-doc">ResetRaceCommand</a> = 1002,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da56ceaf707e56ed71d5ad76d2a006d699" class="m-doc">CancelRaceCommand</a> = 1003,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435dabbb46bc1d8a0da3def761bbe0b3a6a8b" class="m-doc">SetTimerDisabledCommand</a> = 1004,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da4feff580b736bf76918a1679b20ef09b" class="m-doc">GetRaceStateCommand</a> = 2000,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da0b0811d7d9da70db64c721e0428e1ed8" class="m-doc">GetRaceDetailsCommand</a> = 2001,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435dacc68f94afda8dd51d214ea72de8f35d9" class="m-doc">GetExtensionsCommand</a> = 2006,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435dad2ebce11c93924f366c3db2fba4a70eb" class="m-doc">GetTimersCommand</a> = 2007,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435dac2fc21420cf257d4ee8544ee7ff2c5da" class="m-doc">GetCurrentStartDelayCommand</a> = 2009,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da7dfdefe46bb07e4f61a109071cd514f0" class="m-doc">WriteSettingCommand</a> = 3000,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da9b21491ad5679551564117fdd8037dfa" class="m-doc">ReadSettingCommand</a> = 3001,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da0cd9075af5093deb2440ae88153b8710" class="m-doc">LoginAthleteCommand</a> = 4000,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435dad8ee0cacc4af2fca0fed7df86cdb9d7b" class="m-doc">CreateAthleteCommand</a> = 4001,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435daefd2ac3fd192ce7301aa92ec9bfffd91" class="m-doc">DeleteAthleteCommand</a> = 4002,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da1e70a71892186a0fdf75776a3436830a" class="m-doc">GetAtheletesCommand</a> = 4003,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da7d41c99c0143ba83183d4d125c026937" class="m-doc">GetAthleteResultsCommand</a> = 4004,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da7baee66c53c8db6428cfe9b920db0068" class="m-doc">UpdateFirmwareCommand</a> = 5000,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435dab569d653ad233358e01a5a9feffe992d" class="m-doc">UpdateSystemTimeCommand</a> = 5001,
|
||||
<a href="#a5423a0a57d880d1f3869b81c2c31435da694deb2480537d40ad462b150f14b367" class="m-doc">PairExtensionsCommand</a> = 5002 }</span>
|
||||
</dt>
|
||||
<dd>The SocketCommand enum contains all commands the base station can handle.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc">StatusCode</a> { </span><span class="m-doc-wrap"><a href="#ad0a329ddc142cab81bc98e0d40d32068ac90bc44b984e9b18f2a0502aaeadbc70" class="m-doc">Success</a> = 200,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a8c5d88049fa4b6772f45334aaaea7ed8" class="m-doc">FirmwareAlreadyUpToDateInfo</a> = 304,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a1402c3028428a1014af069ce5a1b5e5a" class="m-doc">AccessDeniedError</a> = 401,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a38ceb962d98837024c73f7c1ff892650" class="m-doc">UpdateSignatureInvalidError</a> = 402,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068ae66e653e8758f291409a03a2e594fb66" class="m-doc">CurrentStateNotVaildForOperationError</a> = 403,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a88cd97a3c92c7827347d838c290a1d1a" class="m-doc">CommandNotFoundError</a> = 404,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068afc606bfc04e661c0f3322918d5971b8e" class="m-doc">RequiredParameterNotGivenError</a> = 405,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a3dbfdee6e7375265d4d368da015fff6a" class="m-doc">TimestampTooSmallError</a> = 406,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a4adf2bcdb8d85a40dfa6186b2dc636d8" class="m-doc">ClientSessionAlreadyActiveError</a> = 407,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a295c2b1f44a6f1791df9e62c5e4f09b6" class="m-doc">NoSessionActiveError</a> = 408,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068ad8022967fadac3af0477abeb94eefba6" class="m-doc">ItemNotFoundError</a> = 409,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a67a867bdb5323675c8971d506f322dd9" class="m-doc">LastTimerCannotBeDisabledError</a> = 410,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a9856621699e04ac7e336411c34769ef2" class="m-doc">UpdateFailedError</a> = 500,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068ad0bcc0ff858abd7ebcf6842662fdad28" class="m-doc">Error</a> = 900,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a8b76f1bc500981c49d4bf1880b02e7cd" class="m-doc">NotConnectedError</a> = 910,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a5f7d9a63e9b48a1f4ca4f212de3998e5" class="m-doc">TimeoutError</a> = 911,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a18b1139de766f9ae6aab6fddb5f2e3f4" class="m-doc">SettingNotAccessibleError</a> = 901,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a4238fbecbd83ec9d9d88503274a4fc55" class="m-doc">InternalError</a> = 950,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a98e06a2ac920230686410995bfb52071" class="m-doc">InternalErrorTimerOperationFailed</a> = 951,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a6983d437713d173257ac8ba9e59a21a1" class="m-doc">ApiVersionNotSupportedError</a> = 952,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068aa09b339c976ac6155e57482213b0dacc" class="m-doc">CompetitionModeProhibitsThisError</a> = 953,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068afe579c343439c557042b405213c0a767" class="m-doc">FirmwareUpdateFormatInvalidError</a> = 954,
|
||||
<a href="#ad0a329ddc142cab81bc98e0d40d32068a98d7b4970249f97e6063e98894310fe3" class="m-doc">TimersNotReadyError</a> = 501 }</span>
|
||||
</dt>
|
||||
<dd>The ErrorCode enum contains all error codes that can occur when sending a command to the basestation.</dd>
|
||||
<dt id="afb007a099c165449761afaed23a54c45">
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#afb007a099c165449761afaed23a54c45" class="m-doc-self">ExtensionType</a> { </span><span class="m-doc-wrap"><a href="#afb007a099c165449761afaed23a54c45a11143192831b8c7c1561b7a5fe49c73b" class="m-doc">StartPad</a>,
|
||||
<a href="#afb007a099c165449761afaed23a54c45af805ee1d649fb700b311d78a539de5d0" class="m-doc">TopPad</a> }</span>
|
||||
</dt>
|
||||
<dd>The ExtensionType enum contains all types of extensions.</dd>
|
||||
<dt id="a45d2f89b38509f9249c62fcf8615a5e4">
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#a45d2f89b38509f9249c62fcf8615a5e4" class="m-doc-self">ExtensionState</a> { </span><span class="m-doc-wrap"><a href="#a45d2f89b38509f9249c62fcf8615a5e4ad4bc7e3ba3f8b4bb17565f5c09d0e923" class="m-doc">ExtensionDisconnected</a> = 0,
|
||||
<a href="#a45d2f89b38509f9249c62fcf8615a5e4ac5e22f94e3075e4f2b42079acee12af0" class="m-doc">ExtensionConnecting</a> = 1,
|
||||
<a href="#a45d2f89b38509f9249c62fcf8615a5e4a33849788f83325582fed003b0c5cdd53" class="m-doc">ExtensionInitialising</a> = 2,
|
||||
<a href="#a45d2f89b38509f9249c62fcf8615a5e4a61b99a659b183161287cc5871dacd49c" class="m-doc">ExtensionConnected</a> = 3 }</span>
|
||||
</dt>
|
||||
<dd>The ExtensionState enum contains all possible states of an extension.</dd>
|
||||
<dt id="a834ac2b3f360fa60c7c4ff595901872b">
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#a834ac2b3f360fa60c7c4ff595901872b" class="m-doc-self">ExtensionBatteryState</a> { </span><span class="m-doc-wrap"><a href="#a834ac2b3f360fa60c7c4ff595901872ba52242d1e8319f37044fc08462c833dab" class="m-doc">BatteryUnknown</a> = -1,
|
||||
<a href="#a834ac2b3f360fa60c7c4ff595901872ba97904f100f4fe2ced6aad97c28b7e19e" class="m-doc">BatteryCritical</a> = 0,
|
||||
<a href="#a834ac2b3f360fa60c7c4ff595901872ba80c048b281765407456f0d95134b033f" class="m-doc">BatteryWarning</a> = 1,
|
||||
<a href="#a834ac2b3f360fa60c7c4ff595901872ba24ae0b56e578f11fb248920033b319c5" class="m-doc">BatteryFine</a> = 2,
|
||||
<a href="#a834ac2b3f360fa60c7c4ff595901872ba0852dfdec85e155f5def253a26ce9264" class="m-doc">BatteryCharging</a> = 3,
|
||||
<a href="#a834ac2b3f360fa60c7c4ff595901872ba5d94a347cddac0a18dd2e017ffd903ed" class="m-doc">BatteryNotCharging</a> = 4 }</span>
|
||||
</dt>
|
||||
<dd>The ExtensionBatteryState enum contains all possible battery states of an extension.</dd>
|
||||
<dt id="a7311db682ac8e761198339dd5ba53d44">
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#a7311db682ac8e761198339dd5ba53d44" class="m-doc-self">PadState</a> { </span><span class="m-doc-wrap"><a href="#a7311db682ac8e761198339dd5ba53d44acb5fd37b5f8d10eb23270d8c346e9c77" class="m-doc">PadNotPressed</a> = 0,
|
||||
<a href="#a7311db682ac8e761198339dd5ba53d44a251d1dab4490f91a2e42fa54d1fb71b8" class="m-doc">PadPressed</a> = 1 }</span>
|
||||
</dt>
|
||||
<dd>The PadState enum contains whether a pad is currently pressed or not.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="pub-static-attribs">
|
||||
<h2><a href="#pub-static-attribs">Public static variables</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt id="a55de84e3e91a8e3834a629ed7eb805a7">
|
||||
static const char* <a href="#a55de84e3e91a8e3834a629ed7eb805a7" class="m-doc-self">SOCKET_MESSAGE_START_KEY</a>
|
||||
</dt>
|
||||
<dd>SOCKET_MESSAGE_START_KEY contains the key, a message is supposed to start with.</dd>
|
||||
<dt id="a8c677bb34fc8286af58b4ace13cf8c89">
|
||||
static const char* <a href="#a8c677bb34fc8286af58b4ace13cf8c89" class="m-doc-self">SOCKET_MESSAGE_END_KEY</a>
|
||||
</dt>
|
||||
<dd>SOCKET_MESSAGE_END_KEY contains the key, a message is supposed to end with.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="pub-static-methods">
|
||||
<h2><a href="#pub-static-methods">Public static functions</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">static auto <a href="#a781770df5498946a23e1d91613c6c5e7" class="m-doc">signalKeyFromInt</a>(</span><span class="m-doc-wrap">int i) -> <a href="classScStw.html#ae1e6a4063ef25e60b06a96be66ae98f5" class="m-doc">SignalKey</a></span>
|
||||
</dt>
|
||||
<dd>Function to convert an int to a SignalKey.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">static auto <a href="#a8102a6fee01f43144d8bf3ebe054b753" class="m-doc">socketCommandFromInt</a>(</span><span class="m-doc-wrap">int i) -> <a href="classScStw.html#a5423a0a57d880d1f3869b81c2c31435d" class="m-doc">SocketCommand</a></span>
|
||||
</dt>
|
||||
<dd>Function to convert an int to a SocketCommand.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">static auto <a href="#ad40564b2338ba1cf01ccacedfd1525ca" class="m-doc">extensionTypeToString</a>(</span><span class="m-doc-wrap"><a href="classScStw.html#afb007a099c165449761afaed23a54c45" class="m-doc">ExtensionType</a> t) -> QString</span>
|
||||
</dt>
|
||||
<dd>Function to convert an ExtensionType to a string.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">static auto <a href="#a4732d5c78f05a171b492efbf1d8e4820" class="m-doc">firmwareCompare</a>(</span><span class="m-doc-wrap">QString a,
|
||||
QString b) -> int</span>
|
||||
</dt>
|
||||
<dd>Function to compare to string firmware versions in <major>.<minor>.<patch> formar.</dd>
|
||||
<dt id="ad93a64f89f0bec0903e5b78d714b1cb3">
|
||||
<div class="m-doc-template">template<typename Enum></div>
|
||||
<span class="m-doc-wrap-bumper">static auto <a href="#ad93a64f89f0bec0903e5b78d714b1cb3" class="m-doc-self">toEnumValue</a>(</span><span class="m-doc-wrap">const int& value,
|
||||
bool* ok) -> Enum</span>
|
||||
</dt>
|
||||
<dd>Function to convert a value to an enum.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<h2>Enum documentation</h2>
|
||||
<section class="m-doc-details" id="ae1e6a4063ef25e60b06a96be66ae98f5"><div>
|
||||
<h3>
|
||||
enum ScStw::<wbr /><a href="#ae1e6a4063ef25e60b06a96be66ae98f5" class="m-doc-self">SignalKey</a>
|
||||
</h3>
|
||||
<p>The SignalKey enum contains all signal keys a client can subscribe to.</p>
|
||||
<aside class="m-note m-default"><h4>See also</h4><p><a href="classScStw.html#a781770df5498946a23e1d91613c6c5e7" class="m-doc">ScStw::<wbr />signalKeyFromInt()</a></p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a5423a0a57d880d1f3869b81c2c31435d"><div>
|
||||
<h3>
|
||||
enum ScStw::<wbr /><a href="#a5423a0a57d880d1f3869b81c2c31435d" class="m-doc-self">SocketCommand</a>
|
||||
</h3>
|
||||
<p>The SocketCommand enum contains all commands the base station can handle.</p>
|
||||
<aside class="m-note m-default"><h4>See also</h4><p><a href="classScStw.html#a8102a6fee01f43144d8bf3ebe054b753" class="m-doc">ScStw::<wbr />socketCommandFromInt()</a></p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ad0a329ddc142cab81bc98e0d40d32068"><div>
|
||||
<h3>
|
||||
enum ScStw::<wbr /><a href="#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc-self">StatusCode</a>
|
||||
</h3>
|
||||
<p>The ErrorCode enum contains all error codes that can occur when sending a command to the basestation.</p>
|
||||
<table class="m-table m-fullwidth m-flat m-doc">
|
||||
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068ac90bc44b984e9b18f2a0502aaeadbc70" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068ac90bc44b984e9b18f2a0502aaeadbc70">Success</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a8c5d88049fa4b6772f45334aaaea7ed8" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a8c5d88049fa4b6772f45334aaaea7ed8">FirmwareAlreadyUpToDateInfo</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a1402c3028428a1014af069ce5a1b5e5a" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a1402c3028428a1014af069ce5a1b5e5a">AccessDeniedError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a38ceb962d98837024c73f7c1ff892650" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a38ceb962d98837024c73f7c1ff892650">UpdateSignatureInvalidError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068ae66e653e8758f291409a03a2e594fb66" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068ae66e653e8758f291409a03a2e594fb66">CurrentStateNotVaildForOperationError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a88cd97a3c92c7827347d838c290a1d1a" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a88cd97a3c92c7827347d838c290a1d1a">CommandNotFoundError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068afc606bfc04e661c0f3322918d5971b8e" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068afc606bfc04e661c0f3322918d5971b8e">RequiredParameterNotGivenError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a3dbfdee6e7375265d4d368da015fff6a" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a3dbfdee6e7375265d4d368da015fff6a">TimestampTooSmallError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a4adf2bcdb8d85a40dfa6186b2dc636d8" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a4adf2bcdb8d85a40dfa6186b2dc636d8">ClientSessionAlreadyActiveError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a295c2b1f44a6f1791df9e62c5e4f09b6" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a295c2b1f44a6f1791df9e62c5e4f09b6">NoSessionActiveError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068ad8022967fadac3af0477abeb94eefba6" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068ad8022967fadac3af0477abeb94eefba6">ItemNotFoundError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a67a867bdb5323675c8971d506f322dd9" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a67a867bdb5323675c8971d506f322dd9">LastTimerCannotBeDisabledError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a9856621699e04ac7e336411c34769ef2" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a9856621699e04ac7e336411c34769ef2">UpdateFailedError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068ad0bcc0ff858abd7ebcf6842662fdad28" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068ad0bcc0ff858abd7ebcf6842662fdad28">Error</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a8b76f1bc500981c49d4bf1880b02e7cd" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a8b76f1bc500981c49d4bf1880b02e7cd">NotConnectedError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a5f7d9a63e9b48a1f4ca4f212de3998e5" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a5f7d9a63e9b48a1f4ca4f212de3998e5">TimeoutError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a18b1139de766f9ae6aab6fddb5f2e3f4" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a18b1139de766f9ae6aab6fddb5f2e3f4">SettingNotAccessibleError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a4238fbecbd83ec9d9d88503274a4fc55" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a4238fbecbd83ec9d9d88503274a4fc55">InternalError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a98e06a2ac920230686410995bfb52071" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a98e06a2ac920230686410995bfb52071">InternalErrorTimerOperationFailed</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a6983d437713d173257ac8ba9e59a21a1" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a6983d437713d173257ac8ba9e59a21a1">ApiVersionNotSupportedError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068aa09b339c976ac6155e57482213b0dacc" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068aa09b339c976ac6155e57482213b0dacc">CompetitionModeProhibitsThisError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068afe579c343439c557042b405213c0a767" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068afe579c343439c557042b405213c0a767">FirmwareUpdateFormatInvalidError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ad0a329ddc142cab81bc98e0d40d32068a98d7b4970249f97e6063e98894310fe3" class="m-doc-self" id="ad0a329ddc142cab81bc98e0d40d32068a98d7b4970249f97e6063e98894310fe3">TimersNotReadyError</a></td>
|
||||
<td>
|
||||
<p>One or more timer is not ready</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
</section>
|
||||
<section>
|
||||
<h2>Function documentation</h2>
|
||||
<section class="m-doc-details" id="a781770df5498946a23e1d91613c6c5e7"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">static <a href="classScStw.html#ae1e6a4063ef25e60b06a96be66ae98f5" class="m-doc">SignalKey</a> ScStw::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a781770df5498946a23e1d91613c6c5e7" class="m-doc-self">signalKeyFromInt</a>(</span><span class="m-doc-wrap">int i)</span></span>
|
||||
</h3>
|
||||
<p>Function to convert an int to a SignalKey.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">i</td>
|
||||
<td>the int to convert</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>a SignalKey</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<aside class="m-note m-default"><h4>See also</h4><p><a href="classScStw.html#ae1e6a4063ef25e60b06a96be66ae98f5" class="m-doc">ScStw::<wbr />SignalKey</a></p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a8102a6fee01f43144d8bf3ebe054b753"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">static <a href="classScStw.html#a5423a0a57d880d1f3869b81c2c31435d" class="m-doc">SocketCommand</a> ScStw::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8102a6fee01f43144d8bf3ebe054b753" class="m-doc-self">socketCommandFromInt</a>(</span><span class="m-doc-wrap">int i)</span></span>
|
||||
</h3>
|
||||
<p>Function to convert an int to a SocketCommand.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">i</td>
|
||||
<td>the int to convert</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>a SocketCommand</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<aside class="m-note m-default"><h4>See also</h4><p><a href="classScStw.html#a5423a0a57d880d1f3869b81c2c31435d" class="m-doc">ScStw::<wbr />SocketCommand</a></p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ad40564b2338ba1cf01ccacedfd1525ca"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">static QString ScStw::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad40564b2338ba1cf01ccacedfd1525ca" class="m-doc-self">extensionTypeToString</a>(</span><span class="m-doc-wrap"><a href="classScStw.html#afb007a099c165449761afaed23a54c45" class="m-doc">ExtensionType</a> t)</span></span>
|
||||
</h3>
|
||||
<p>Function to convert an ExtensionType to a string.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">t</td>
|
||||
<td>the ExtensionType to convert</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>String</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<aside class="m-note m-default"><h4>See also</h4><p>ScStwExtensionType</p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a4732d5c78f05a171b492efbf1d8e4820"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">static int ScStw::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4732d5c78f05a171b492efbf1d8e4820" class="m-doc-self">firmwareCompare</a>(</span><span class="m-doc-wrap">QString a,
|
||||
QString b)</span></span>
|
||||
</h3>
|
||||
<p>Function to compare to string firmware versions in <major>.<minor>.<patch> formar.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">a</td>
|
||||
<td>version a</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>b</td>
|
||||
<td>version b</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>-4: a is of invalid format -3: major of a is lower than b -2: minor of a is lower than b -1: patch of a is lower than b 0: a and b are identical 1: patch b is lower than a 2: minor of b is lower than a 3: major of b is lower than a 4: b is of invalid format</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
175
classScStwRace.html
Normal file
175
classScStwRace.html
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStwRace class | ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>
|
||||
ScStwRace <span class="m-thin">class</span>
|
||||
</h1>
|
||||
<p>The <a href="classScStwRace.html" class="m-doc">ScStwRace</a> class can be used to measure timings of climbing races with multiple lanes at once.</p>
|
||||
<nav class="m-block m-default">
|
||||
<h3>Contents</h3>
|
||||
<ul>
|
||||
<li>
|
||||
Reference
|
||||
<ul>
|
||||
<li><a href="#pub-slots">Public slots</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p>The <a href="classScStwRace.html" class="m-doc">ScStwRace</a> is a container to manage multiple timers at a time and introduces a propper start sequence with start commands ('At your Marks' and 'Ready') and the official IFSC start signal.</p><h3>Basic usage:</h3><pre class="m-code"><span class="n">ScStwRace</span><span class="w"> </span><span class="n">race</span><span class="p">;</span><span class="w"></span>
|
||||
|
||||
<span class="c1">// add two timers</span>
|
||||
<span class="n">race</span><span class="p">.</span><span class="n">addTimer</span><span class="p">(</span><span class="k">new</span><span class="w"> </span><span class="n">ScStwTimer</span><span class="p">());</span><span class="w"></span>
|
||||
<span class="n">race</span><span class="p">.</span><span class="n">addTimer</span><span class="p">(</span><span class="k">new</span><span class="w"> </span><span class="n">ScStwTimer</span><span class="p">());</span><span class="w"></span>
|
||||
|
||||
<span class="c1">// start a race</span>
|
||||
<span class="n">race</span><span class="p">.</span><span class="n">start</span><span class="p">();</span><span class="w"></span></pre>
|
||||
<section id="pub-slots">
|
||||
<h2><a href="#pub-slots">Public slots</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#ad0ce866fd86b91d7b1faf52533ab3c79" class="m-doc">start</a>(</span><span class="m-doc-wrap">bool asyncronous = true) -> <a href="classScStw.html#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc">ScStw::<wbr />StatusCode</a> <span class="m-label m-flat m-warning">virtual</span></span>
|
||||
</dt>
|
||||
<dd>Function to start the race.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a86c82494a5c75b0a5abd701c3417d8a9" class="m-doc">stop</a>(</span><span class="m-doc-wrap">) -> <a href="classScStw.html#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc">ScStw::<wbr />StatusCode</a> <span class="m-label m-flat m-warning">virtual</span></span>
|
||||
</dt>
|
||||
<dd>Function to stop the currently running race.</dd>
|
||||
<dt id="ad36060393dcd989bced314a5077f4ea8">
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#ad36060393dcd989bced314a5077f4ea8" class="m-doc-self">reset</a>(</span><span class="m-doc-wrap">) -> <a href="classScStw.html#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc">ScStw::<wbr />StatusCode</a> <span class="m-label m-flat m-warning">virtual</span></span>
|
||||
</dt>
|
||||
<dd>Function to reset a stopped race.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<h2>Function documentation</h2>
|
||||
<section class="m-doc-details" id="ad0ce866fd86b91d7b1faf52533ab3c79"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper"><a href="classScStw.html#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc">ScStw::<wbr />StatusCode</a> ScStwRace::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad0ce866fd86b91d7b1faf52533ab3c79" class="m-doc-self">start</a>(</span><span class="m-doc-wrap">bool asyncronous = true) <span class="m-label m-warning">virtual</span> <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to start the race.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">asyncronous</td>
|
||||
<td>if the function should just start the start sequence and then quit (true) or if if should wait until the start sequence is over and quit after that (false)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>200: OK; 904: state not matching</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a86c82494a5c75b0a5abd701c3417d8a9"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper"><a href="classScStw.html#ad0a329ddc142cab81bc98e0d40d32068" class="m-doc">ScStw::<wbr />StatusCode</a> ScStwRace::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a86c82494a5c75b0a5abd701c3417d8a9" class="m-doc-self">stop</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">virtual</span> <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to stop the currently running race.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>200: OK; 904: state not matching</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
240
classScStwSoundPlayer.html
Normal file
240
classScStwSoundPlayer.html
Normal file
|
|
@ -0,0 +1,240 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStwSoundPlayer class | ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>
|
||||
ScStwSoundPlayer <span class="m-thin">class</span>
|
||||
</h1>
|
||||
<p>The <a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> class is used for ultra low latency sound playback of the speed clibing start tones and commands.</p>
|
||||
<nav class="m-block m-default">
|
||||
<h3>Contents</h3>
|
||||
<ul>
|
||||
<li>
|
||||
Reference
|
||||
<ul>
|
||||
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
|
||||
<li><a href="#signals">Signals</a></li>
|
||||
<li><a href="#pub-slots">Public slots</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<section id="typeless-methods">
|
||||
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper"><a href="#a8fb670ba6b752464f7a2f729803dfc45" class="m-doc">ScStwSoundPlayer</a>(</span><span class="m-doc-wrap">QObject* parent = nullptr) <span class="m-label m-flat m-info">explicit</span> </span>
|
||||
</dt>
|
||||
<dd><a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> constructor.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="signals">
|
||||
<h2><a href="#signals">Signals</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt id="aa2fee0a62891c8375659ec24adc8f15c">
|
||||
<span class="m-doc-wrap-bumper">void <a href="#aa2fee0a62891c8375659ec24adc8f15c" class="m-doc-self">playbackStarted</a>(</span><span class="m-doc-wrap">)</span>
|
||||
</dt>
|
||||
<dd>Emitted whenever a playback started.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="pub-slots">
|
||||
<h2><a href="#pub-slots">Public slots</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a8406a6f6877a700a6872980ca1497b0e" class="m-doc">play</a>(</span><span class="m-doc-wrap">StartSound sound,
|
||||
double volume,
|
||||
double* timeOfStart = nullptr) -> ScStwSoundPlayer::PlayResult</span>
|
||||
</dt>
|
||||
<dd>Function to begin playing the sound of a certain state.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a027f45d562b787bfe94872b5fb797575" class="m-doc">waitForSoundFinish</a>(</span><span class="m-doc-wrap">double* timeOfStop = nullptr) -> ScStwSoundPlayer::PlayResult</span>
|
||||
</dt>
|
||||
<dd>Function to wait for the playback to finish.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a3e09578b2da014e3a2324e7f3c5549f1" class="m-doc">cancel</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to cancel the current playback.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<h2>Function documentation</h2>
|
||||
<section class="m-doc-details" id="a8fb670ba6b752464f7a2f729803dfc45"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper"> ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8fb670ba6b752464f7a2f729803dfc45" class="m-doc-self">ScStwSoundPlayer</a>(</span><span class="m-doc-wrap">QObject* parent = nullptr) <span class="m-label m-info">explicit</span> </span></span>
|
||||
</h3>
|
||||
<p><a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> constructor.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">parent</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a8406a6f6877a700a6872980ca1497b0e"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">ScStwSoundPlayer::PlayResult ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8406a6f6877a700a6872980ca1497b0e" class="m-doc-self">play</a>(</span><span class="m-doc-wrap">StartSound sound,
|
||||
double volume,
|
||||
double* timeOfStart = nullptr) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to begin playing the sound of a certain state.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">sound</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>volume</td>
|
||||
<td>The volume to play at</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>timeOfStart</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>TODO true if the playback was successfully started, false otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a027f45d562b787bfe94872b5fb797575"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">ScStwSoundPlayer::PlayResult ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a027f45d562b787bfe94872b5fb797575" class="m-doc-self">waitForSoundFinish</a>(</span><span class="m-doc-wrap">double* timeOfStop = nullptr) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to wait for the playback to finish.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">timeOfStop</td>
|
||||
<td>the point in time when the plyback actually stopped (msecs since epoch)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>false if there was any error (eg. there was no playback currently), true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a3e09578b2da014e3a2324e7f3c5549f1"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3e09578b2da014e3a2324e7f3c5549f1" class="m-doc-self">cancel</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to cancel the current playback.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>true if the playback was successfully stopped, false otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>Note that this function will automatically play the false start tone if the currently playing action is 2</p>
|
||||
</div></section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
814
classScStwTimer.html
Normal file
814
classScStwTimer.html
Normal file
|
|
@ -0,0 +1,814 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStwTimer class | ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>
|
||||
ScStwTimer <span class="m-thin">class</span>
|
||||
</h1>
|
||||
<p>The <a href="classScStwTimer.html" class="m-doc">ScStwTimer</a> class is used for advanced time measurement.</p>
|
||||
<nav class="m-block m-default">
|
||||
<h3>Contents</h3>
|
||||
<ul>
|
||||
<li>
|
||||
Reference
|
||||
<ul>
|
||||
<li><a href="#pub-types">Public types</a></li>
|
||||
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
|
||||
<li><a href="#signals">Signals</a></li>
|
||||
<li><a href="#pub-slots">Public slots</a></li>
|
||||
<li><a href="#pro-slots">Protected slots</a></li>
|
||||
<li><a href="#pro-attribs">Protected variables</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<p>It does not work on its own though. It is recommended to use it in combination with the <a href="classScStwRace.html" class="m-doc">ScStwRace</a> class.</p><h3>When using standalone:</h3><pre class="m-code"><span class="n">ScStwTimer</span><span class="w"> </span><span class="n">timer</span><span class="p">;</span><span class="w"></span>
|
||||
<span class="c1">// start the timer</span>
|
||||
<span class="n">timer</span><span class="p">.</span><span class="n">start</span><span class="p">();</span><span class="w"></span>
|
||||
<span class="c1">// stop the timer</span>
|
||||
<span class="n">timer</span><span class="p">.</span><span class="n">stop</span><span class="p">();</span><span class="w"></span></pre><p>The timer will now go into ScStw::WAITING state. That indicates that the timer has stopped and the final result has to be assigned by an external handler.</p><pre class="m-code"><span class="c1">// assign result 'won'</span>
|
||||
<span class="n">timer</span><span class="p">.</span><span class="n">setResult</span><span class="p">(</span><span class="n">ScStwTimer</span><span class="o">::</span><span class="n">WON</span><span class="p">);</span><span class="w"></span></pre><p>The timer is now in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4ab3c3d8af8f1690d61dcb5ea0f93bfbeb" class="m-doc">ScStwTimer::<wbr />WON</a> state.</p><pre class="m-code"><span class="c1">// reset the timer</span>
|
||||
<span class="n">timer</span><span class="p">.</span><span class="n">reset</span><span class="p">();</span><span class="w"></span></pre><p>The timer is not in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4a89a624261a53da443c950e23f18b5893" class="m-doc">ScStwTimer::<wbr />IDLE</a> state again.</p>
|
||||
<section id="pub-types">
|
||||
<h2><a href="#pub-types">Public types</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a> { </span><span class="m-doc-wrap"><a href="#ada0d42f8cac92807271e3811899691d4a89a624261a53da443c950e23f18b5893" class="m-doc">IDLE</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4acb0051986bc92cfc3f596268b5d72a20" class="m-doc">STARTING</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0" class="m-doc">RUNNING</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4aa34537cc3504afbce041e685452f9a25" class="m-doc">WAITING</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4ab3c3d8af8f1690d61dcb5ea0f93bfbeb" class="m-doc">WON</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a85e5d2220b78dddd93b3b1cb57021007" class="m-doc">LOST</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a7e39397d2ef7dfa99d24bf4edd504f99" class="m-doc">FAILING</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a573d0be22ab41b235152d135a8a744f6" class="m-doc">WILDCARD</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a2f45c51629a91757794ba7bbc5adb9bf" class="m-doc">FAILED</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a5979f37506744b5559ce744ed8904ad3" class="m-doc">CANCELLED</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4a8f000f496058711a293671ab5c9d32ba" class="m-doc">INCIDENT</a>,
|
||||
<a href="#ada0d42f8cac92807271e3811899691d4aa392d2f5e98c5b1c426981c1ab1b27d8" class="m-doc">DISABLED</a> }</span>
|
||||
</dt>
|
||||
<dd>The TimerState enum contains all state the timer can be in.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">enum <a href="#a185f832ed38e2e555af7e74d339c023f" class="m-doc">ReadyState</a> { </span><span class="m-doc-wrap"><a href="#a185f832ed38e2e555af7e74d339c023fad3c2fa7df4332280eff3c365f9a4b894" class="m-doc">IsReady</a> = 0,
|
||||
<a href="#a185f832ed38e2e555af7e74d339c023fa014a3289e24b7e37fe840ccb0f039197" class="m-doc">NotInIdleState</a>,
|
||||
<a href="#a185f832ed38e2e555af7e74d339c023faec170fb0f373a61f319994345e68faee" class="m-doc">IsDisabled</a>,
|
||||
<a href="#a185f832ed38e2e555af7e74d339c023faab1621429f64ecaffe935191a02e975d" class="m-doc">ExtensionIsNotConnected</a>,
|
||||
<a href="#a185f832ed38e2e555af7e74d339c023fa6974cd0c4b77dfa673a5e1dfe0c3c884" class="m-doc">ExtensionBatteryIsCritical</a>,
|
||||
<a href="#a185f832ed38e2e555af7e74d339c023faf705a3ca10429a13af06f0a59f7f1ddf" class="m-doc">ClimberIsNotReady</a> }</span>
|
||||
</dt>
|
||||
<dd>The ReadyStatus enum contains all possible reasons for a timer not to be ready (>0) and the case that it is ready (0)</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="typeless-methods">
|
||||
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper"><a href="#a389e15b515cb54db5168c5efcb5f05e4" class="m-doc">ScStwTimer</a>(</span><span class="m-doc-wrap">QString letter,
|
||||
QObject* parent = nullptr) <span class="m-label m-flat m-info">explicit</span> </span>
|
||||
</dt>
|
||||
<dd><a href="classScStwTimer.html" class="m-doc">ScStwTimer</a> constructor.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="signals">
|
||||
<h2><a href="#signals">Signals</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt id="a2b99b88e926d1b8cda3e1b3ef87d209b">
|
||||
<span class="m-doc-wrap-bumper">void <a href="#a2b99b88e926d1b8cda3e1b3ef87d209b" class="m-doc-self">stateChanged</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a> state)</span>
|
||||
</dt>
|
||||
<dd>Emitted when the state of the timer changed.</dd>
|
||||
<dt id="a013826923879fee7f35a542b58f75754">
|
||||
<span class="m-doc-wrap-bumper">void <a href="#a013826923879fee7f35a542b58f75754" class="m-doc-self">reactionTimeChanged</a>(</span><span class="m-doc-wrap">)</span>
|
||||
</dt>
|
||||
<dd>Emitted when the reaction time changed.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#af67db37af63f6c999a55b2f76a3e8cda" class="m-doc">wantsToBeDisabledChanged</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html" class="m-doc">ScStwTimer</a>* timer,
|
||||
bool wantsToBeDisabled)</span>
|
||||
</dt>
|
||||
<dd>Emitted when the timer wants its state to be changed by the external handler.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#aafb8547777f4211ef5eddf19637d14c3" class="m-doc">readyStateChanged</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#a185f832ed38e2e555af7e74d339c023f" class="m-doc">ReadyState</a> readyState)</span>
|
||||
</dt>
|
||||
<dd>Emitted when the ready state of the timer changes.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="pub-slots">
|
||||
<h2><a href="#pub-slots">Public slots</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a144ef4f6608e5a05e63dacdc581f0210" class="m-doc">start</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to start the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a6868b437f85a7ebf6cc059e102c9bcb9" class="m-doc">start</a>(</span><span class="m-doc-wrap">double timeOfStart) -> bool <span class="m-label m-flat m-warning">virtual</span></span>
|
||||
</dt>
|
||||
<dd>Function to start the timer at a given point in time (present or future)</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a7409fb5ffe4d1f2e2a46b9f503a36b7c" class="m-doc">cancel</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to cancel the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#ab7bc9250d1db3046b3832f048bdfff26" class="m-doc">stop</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to stop the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a55766788bb86f36db8940c3c50149ec0" class="m-doc">stop</a>(</span><span class="m-doc-wrap">double timeOfStop) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to stop the timer at a given point in time (past or future)</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a94c8f03ad0fb44c38c515d77ef810d47" class="m-doc">setResult</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a>) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to assing the result of the race to the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a1576aaf8ebedd8ed26bc4bbce96b81a8" class="m-doc">reset</a>(</span><span class="m-doc-wrap">) -> bool <span class="m-label m-flat m-warning">virtual</span></span>
|
||||
</dt>
|
||||
<dd>Function to reset the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#ab5ab3874a241f57c58b4e5e7ac83d63b" class="m-doc">getState</a>(</span><span class="m-doc-wrap">) -> <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a></span>
|
||||
</dt>
|
||||
<dd>Function to get the current state of the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a702bed98a3905c901aefdaefbbd4a5a6" class="m-doc">getCurrentTime</a>(</span><span class="m-doc-wrap">) -> double</span>
|
||||
</dt>
|
||||
<dd>Function to get the current time of the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a819e94b9abe6d1073b97008bd7997a60" class="m-doc">getReactionTime</a>(</span><span class="m-doc-wrap">) -> double</span>
|
||||
</dt>
|
||||
<dd>Function to get the reaction time of the climber.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#af558c8104846a09ed5f71499544954a3" class="m-doc">getText</a>(</span><span class="m-doc-wrap">) -> QString</span>
|
||||
</dt>
|
||||
<dd>Function to get the text, a timer display is supposed to show.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#aab757a3e2b3de1d7da584f9adf17cde3" class="m-doc">getLetter</a>(</span><span class="m-doc-wrap">) -> QString</span>
|
||||
</dt>
|
||||
<dd>Function to get the letter of the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#a40bc97d7842cc65ec7b08d03c022741e" class="m-doc">setDisabled</a>(</span><span class="m-doc-wrap">bool disabled)</span>
|
||||
</dt>
|
||||
<dd>Function to set if the timer is supposed to be disabled.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#ae553fde747622fbfc2eb3bf26dafd08a" class="m-doc">getWantsToBeDisabled</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to check if the timer currently wants to be disabled.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#a1d9b182d983a2f6ab03b8e3877376bff" class="m-doc">getReadyState</a>(</span><span class="m-doc-wrap">) -> <a href="classScStwTimer.html#a185f832ed38e2e555af7e74d339c023f" class="m-doc">ScStwTimer::<wbr />ReadyState</a> <span class="m-label m-flat m-warning">virtual</span></span>
|
||||
</dt>
|
||||
<dd>Function to get the current ready status of a timer.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="pro-slots">
|
||||
<h2><a href="#pro-slots">Protected slots</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#a89dcba328bf66c1d86ebffb086bea18b" class="m-doc">handleClimberStart</a>(</span><span class="m-doc-wrap">double timeOfStart)</span>
|
||||
</dt>
|
||||
<dd>slot to call when the climber has started</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#a10ee4d196dcf71a8a5b1a1770578d367" class="m-doc">setState</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a> newState)</span>
|
||||
</dt>
|
||||
<dd>Function to change the state of the timer.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#ab1a4c10718873ff80d395a4697ad8e6a" class="m-doc">setWantsToBeDisabled</a>(</span><span class="m-doc-wrap">bool wantsToBeDisabled)</span>
|
||||
</dt>
|
||||
<dd>Function to set whether the timer currently wants to be disabled.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">void <a href="#ab8a2f017d02f979e13282a10ac9c25ab" class="m-doc">technicalIncident</a>(</span><span class="m-doc-wrap">)</span>
|
||||
</dt>
|
||||
<dd>Function to set the timer into INCIDENT state immidieately.</dd>
|
||||
<dt>
|
||||
<span class="m-doc-wrap-bumper">auto <a href="#aaaf67aa1c25ed318404a9236fa56f732" class="m-doc">wildcard</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
||||
</dt>
|
||||
<dd>Function to set the timer into WILDCARD state.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="pro-attribs">
|
||||
<h2><a href="#pro-attribs">Protected variables</a></h2>
|
||||
<dl class="m-doc">
|
||||
<dt id="a47a2e907433f2fe1da321ce018d5e16f">
|
||||
<a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a> <a href="#a47a2e907433f2fe1da321ce018d5e16f" class="m-doc-self">state</a>
|
||||
</dt>
|
||||
<dd>The current state of the timer.</dd>
|
||||
<dt id="a0a0d9c0888889777a537b08800431550">
|
||||
double <a href="#a0a0d9c0888889777a537b08800431550" class="m-doc-self">startTime</a>
|
||||
</dt>
|
||||
<dd>The time the timer was started at.</dd>
|
||||
<dt id="ae59f354e85585ff9d642258135345538">
|
||||
double <a href="#ae59f354e85585ff9d642258135345538" class="m-doc-self">stopTime</a>
|
||||
</dt>
|
||||
<dd>The time the timer was stopped at.</dd>
|
||||
<dt id="a019e8b5dc595e637dd3717f3d235e266">
|
||||
double <a href="#a019e8b5dc595e637dd3717f3d235e266" class="m-doc-self">reactionTime</a>
|
||||
</dt>
|
||||
<dd>the reaction time of the climber</dd>
|
||||
<dt id="a9a37c93552fa1f4e3d47bca99db14a9a">
|
||||
QString <a href="#a9a37c93552fa1f4e3d47bca99db14a9a" class="m-doc-self">letter</a>
|
||||
</dt>
|
||||
<dd>The letter (eg. "A" or "B") of the Timer (only one char)</dd>
|
||||
<dt id="aea0fb34cb9b98d12ffa6dec38c60f998">
|
||||
bool <a href="#aea0fb34cb9b98d12ffa6dec38c60f998" class="m-doc-self">wantsToBeDisabled</a>
|
||||
</dt>
|
||||
<dd>Defines if the timer currently wants to be disabled or not.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section>
|
||||
<h2>Enum documentation</h2>
|
||||
<section class="m-doc-details" id="ada0d42f8cac92807271e3811899691d4"><div>
|
||||
<h3>
|
||||
enum ScStwTimer::<wbr /><a href="#ada0d42f8cac92807271e3811899691d4" class="m-doc-self">TimerState</a>
|
||||
</h3>
|
||||
<p>The TimerState enum contains all state the timer can be in.</p>
|
||||
<table class="m-table m-fullwidth m-flat m-doc">
|
||||
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a89a624261a53da443c950e23f18b5893" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a89a624261a53da443c950e23f18b5893">IDLE</a></td>
|
||||
<td>
|
||||
<p>Timer is waiting to be started</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4acb0051986bc92cfc3f596268b5d72a20" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4acb0051986bc92cfc3f596268b5d72a20">STARTING</a></td>
|
||||
<td>
|
||||
<p>Timer is starting and will react with a false start if the climber starts</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0">RUNNING</a></td>
|
||||
<td>
|
||||
<p>Timer is running</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4aa34537cc3504afbce041e685452f9a25" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4aa34537cc3504afbce041e685452f9a25">WAITING</a></td>
|
||||
<td>
|
||||
<p>Timer was stopped and is waiting to be set to either WON or LOST</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4ab3c3d8af8f1690d61dcb5ea0f93bfbeb" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4ab3c3d8af8f1690d61dcb5ea0f93bfbeb">WON</a></td>
|
||||
<td>
|
||||
<p>Timer has won</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a85e5d2220b78dddd93b3b1cb57021007" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a85e5d2220b78dddd93b3b1cb57021007">LOST</a></td>
|
||||
<td>
|
||||
<p>Timer has lost</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a7e39397d2ef7dfa99d24bf4edd504f99" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a7e39397d2ef7dfa99d24bf4edd504f99">FAILING</a></td>
|
||||
<td>
|
||||
<p>Timer encountered a false start and is waiting to be set to either FAILED or WILDCARD</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a573d0be22ab41b235152d135a8a744f6" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a573d0be22ab41b235152d135a8a744f6">WILDCARD</a></td>
|
||||
<td>
|
||||
<p>The opponent has done a false start</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a2f45c51629a91757794ba7bbc5adb9bf" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a2f45c51629a91757794ba7bbc5adb9bf">FAILED</a></td>
|
||||
<td>
|
||||
<p>A false start occured</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a5979f37506744b5559ce744ed8904ad3" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a5979f37506744b5559ce744ed8904ad3">CANCELLED</a></td>
|
||||
<td>
|
||||
<p>Timer was cancelled</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4a8f000f496058711a293671ab5c9d32ba" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4a8f000f496058711a293671ab5c9d32ba">INCIDENT</a></td>
|
||||
<td>
|
||||
<p>There was a technical incident (most likely a disconnected extension)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#ada0d42f8cac92807271e3811899691d4aa392d2f5e98c5b1c426981c1ab1b27d8" class="m-doc-self" id="ada0d42f8cac92807271e3811899691d4aa392d2f5e98c5b1c426981c1ab1b27d8">DISABLED</a></td>
|
||||
<td>
|
||||
<p>Timer is disabled</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a185f832ed38e2e555af7e74d339c023f"><div>
|
||||
<h3>
|
||||
enum ScStwTimer::<wbr /><a href="#a185f832ed38e2e555af7e74d339c023f" class="m-doc-self">ReadyState</a>
|
||||
</h3>
|
||||
<p>The ReadyStatus enum contains all possible reasons for a timer not to be ready (>0) and the case that it is ready (0)</p>
|
||||
<table class="m-table m-fullwidth m-flat m-doc">
|
||||
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a href="#a185f832ed38e2e555af7e74d339c023fad3c2fa7df4332280eff3c365f9a4b894" class="m-doc-self" id="a185f832ed38e2e555af7e74d339c023fad3c2fa7df4332280eff3c365f9a4b894">IsReady</a></td>
|
||||
<td>
|
||||
<p>Timer is ready for start</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#a185f832ed38e2e555af7e74d339c023fa014a3289e24b7e37fe840ccb0f039197" class="m-doc-self" id="a185f832ed38e2e555af7e74d339c023fa014a3289e24b7e37fe840ccb0f039197">NotInIdleState</a></td>
|
||||
<td>
|
||||
<p>Timer is not in IDLE state</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#a185f832ed38e2e555af7e74d339c023faec170fb0f373a61f319994345e68faee" class="m-doc-self" id="a185f832ed38e2e555af7e74d339c023faec170fb0f373a61f319994345e68faee">IsDisabled</a></td>
|
||||
<td>
|
||||
<p>Timer is disabled</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#a185f832ed38e2e555af7e74d339c023faab1621429f64ecaffe935191a02e975d" class="m-doc-self" id="a185f832ed38e2e555af7e74d339c023faab1621429f64ecaffe935191a02e975d">ExtensionIsNotConnected</a></td>
|
||||
<td>
|
||||
<p>Not all extension of the timer are conneted</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#a185f832ed38e2e555af7e74d339c023fa6974cd0c4b77dfa673a5e1dfe0c3c884" class="m-doc-self" id="a185f832ed38e2e555af7e74d339c023fa6974cd0c4b77dfa673a5e1dfe0c3c884">ExtensionBatteryIsCritical</a></td>
|
||||
<td>
|
||||
<p>The battery level of one or more extension is critical or unknown</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#a185f832ed38e2e555af7e74d339c023faf705a3ca10429a13af06f0a59f7f1ddf" class="m-doc-self" id="a185f832ed38e2e555af7e74d339c023faf705a3ca10429a13af06f0a59f7f1ddf">ClimberIsNotReady</a></td>
|
||||
<td>
|
||||
<p>The startpad of the timer is not triggered</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
</section>
|
||||
<section>
|
||||
<h2>Function documentation</h2>
|
||||
<section class="m-doc-details" id="a389e15b515cb54db5168c5efcb5f05e4"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper"> ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a389e15b515cb54db5168c5efcb5f05e4" class="m-doc-self">ScStwTimer</a>(</span><span class="m-doc-wrap">QString letter,
|
||||
QObject* parent = nullptr) <span class="m-label m-info">explicit</span> </span></span>
|
||||
</h3>
|
||||
<p><a href="classScStwTimer.html" class="m-doc">ScStwTimer</a> constructor.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">letter</td>
|
||||
<td>the letter of the timer (only first char will be used!)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>parent</td>
|
||||
<td>the parent object</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="af67db37af63f6c999a55b2f76a3e8cda"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af67db37af63f6c999a55b2f76a3e8cda" class="m-doc-self">wantsToBeDisabledChanged</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html" class="m-doc">ScStwTimer</a>* timer,
|
||||
bool wantsToBeDisabled) <span class="m-label m-success">signal</span></span></span>
|
||||
</h3>
|
||||
<p>Emitted when the timer wants its state to be changed by the external handler.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">timer</td>
|
||||
<td>the timer object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wantsToBeDisabled</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="aafb8547777f4211ef5eddf19637d14c3"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aafb8547777f4211ef5eddf19637d14c3" class="m-doc-self">readyStateChanged</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#a185f832ed38e2e555af7e74d339c023f" class="m-doc">ReadyState</a> readyState) <span class="m-label m-success">signal</span></span></span>
|
||||
</h3>
|
||||
<p>Emitted when the ready state of the timer changes.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">readyState</td>
|
||||
<td>the new ReadyState</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a144ef4f6608e5a05e63dacdc581f0210"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a144ef4f6608e5a05e63dacdc581f0210" class="m-doc-self">start</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to start the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>false if the timer was not in the required state and therefore not started, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4acb0051986bc92cfc3f596268b5d72a20" class="m-doc">ScStwTimer::<wbr />STARTING</a> state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a6868b437f85a7ebf6cc059e102c9bcb9"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6868b437f85a7ebf6cc059e102c9bcb9" class="m-doc-self">start</a>(</span><span class="m-doc-wrap">double timeOfStart) <span class="m-label m-warning">virtual</span> <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to start the timer at a given point in time (present or future)</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">timeOfStart</td>
|
||||
<td>the point in time (msecs since epoch) when the timer is supposted to be started</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>false if the timer was not in the required state and therefore not started, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4acb0051986bc92cfc3f596268b5d72a20" class="m-doc">ScStwTimer::<wbr />STARTING</a> state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a7409fb5ffe4d1f2e2a46b9f503a36b7c"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a7409fb5ffe4d1f2e2a46b9f503a36b7c" class="m-doc-self">cancel</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to cancel the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>false if the timer was not in the required state and therefore not cancelled, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4a89a624261a53da443c950e23f18b5893" class="m-doc">ScStwTimer::<wbr />IDLE</a>, <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4acb0051986bc92cfc3f596268b5d72a20" class="m-doc">ScStwTimer::<wbr />STARTING</a> or <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0" class="m-doc">ScStwTimer::<wbr />RUNNING</a> state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ab7bc9250d1db3046b3832f048bdfff26"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab7bc9250d1db3046b3832f048bdfff26" class="m-doc-self">stop</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to stop the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>false if the timer was not in the required state and therefore not stopped, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0" class="m-doc">ScStwTimer::<wbr />RUNNING</a> state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a55766788bb86f36db8940c3c50149ec0"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a55766788bb86f36db8940c3c50149ec0" class="m-doc-self">stop</a>(</span><span class="m-doc-wrap">double timeOfStop) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to stop the timer at a given point in time (past or future)</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">timeOfStop</td>
|
||||
<td>the point in time (msecs since epoch) when the timer is supposted to be stopped</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th>Returns</th>
|
||||
<td>false if the timer was not in the required state and therefore not stopped, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0" class="m-doc">ScStwTimer::<wbr />RUNNING</a> state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a94c8f03ad0fb44c38c515d77ef810d47"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a94c8f03ad0fb44c38c515d77ef810d47" class="m-doc-self">setResult</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a>) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to assing the result of the race to the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>false if the timer was not in the required state and the result therefore not set, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4aa34537cc3504afbce041e685452f9a25" class="m-doc">ScStwTimer::<wbr />WAITING</a> state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a1576aaf8ebedd8ed26bc4bbce96b81a8"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a1576aaf8ebedd8ed26bc4bbce96b81a8" class="m-doc-self">reset</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">virtual</span> <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to reset the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>false if the timer was not in the required state and therefore not reset, true otherwise</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4ab3c3d8af8f1690d61dcb5ea0f93bfbeb" class="m-doc">ScStwTimer::<wbr />WON</a> or ScSTw::LOST state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ab5ab3874a241f57c58b4e5e7ac83d63b"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper"><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a> ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab5ab3874a241f57c58b4e5e7ac83d63b" class="m-doc-self">getState</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to get the current state of the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>current state of the timer</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<aside class="m-note m-default"><h4>See also</h4><p><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">ScStwTimer::<wbr />TimerState</a></p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a702bed98a3905c901aefdaefbbd4a5a6"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">double ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a702bed98a3905c901aefdaefbbd4a5a6" class="m-doc-self">getCurrentTime</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to get the current time of the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>The current / final time of the timer or -1 if it is not in the required state</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>To do this, the timer has to be in <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4a8dd9e579e1c43be3f5736b93e093bea0" class="m-doc">ScStwTimer::<wbr />RUNNING</a>, <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4aa34537cc3504afbce041e685452f9a25" class="m-doc">ScStwTimer::<wbr />WAITING</a>, <a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4ab3c3d8af8f1690d61dcb5ea0f93bfbeb" class="m-doc">ScStwTimer::<wbr />WON</a> or ScSTw::LOST state!</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a819e94b9abe6d1073b97008bd7997a60"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">double ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a819e94b9abe6d1073b97008bd7997a60" class="m-doc-self">getReactionTime</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to get the reaction time of the climber.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>The climbers reaction time</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="af558c8104846a09ed5f71499544954a3"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">QString ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af558c8104846a09ed5f71499544954a3" class="m-doc-self">getText</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to get the text, a timer display is supposed to show.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>The text to show</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="aab757a3e2b3de1d7da584f9adf17cde3"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">QString ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aab757a3e2b3de1d7da584f9adf17cde3" class="m-doc-self">getLetter</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to get the letter of the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>The letter of the timer or ""</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a40bc97d7842cc65ec7b08d03c022741e"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a40bc97d7842cc65ec7b08d03c022741e" class="m-doc-self">setDisabled</a>(</span><span class="m-doc-wrap">bool disabled) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to set if the timer is supposed to be disabled.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">disabled</td>
|
||||
<td>if the timer is supposed to be diabled</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>!!! CAUTION use this function with care, it immidiately changes the state of the timer !!! It is recommended to only use this function to change the timers state after the ScStwTimer::requestTimerEnableChange() signal was called, during the race, the timer is used in, is in IDLE state.</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ae553fde747622fbfc2eb3bf26dafd08a"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae553fde747622fbfc2eb3bf26dafd08a" class="m-doc-self">getWantsToBeDisabled</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to check if the timer currently wants to be disabled.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>true or false</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a1d9b182d983a2f6ab03b8e3877376bff"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper"><a href="classScStwTimer.html#a185f832ed38e2e555af7e74d339c023f" class="m-doc">ScStwTimer::<wbr />ReadyState</a> ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a1d9b182d983a2f6ab03b8e3877376bff" class="m-doc-self">getReadyState</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">virtual</span> <span class="m-label m-success">public slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to get the current ready status of a timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>The current ready status</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a89dcba328bf66c1d86ebffb086bea18b"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a89dcba328bf66c1d86ebffb086bea18b" class="m-doc-self">handleClimberStart</a>(</span><span class="m-doc-wrap">double timeOfStart) <span class="m-label m-warning">protected slot</span></span></span>
|
||||
</h3>
|
||||
<p>slot to call when the climber has started</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">timeOfStart</td>
|
||||
<td>time (msecs since epoch) when the climber started</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="a10ee4d196dcf71a8a5b1a1770578d367"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a10ee4d196dcf71a8a5b1a1770578d367" class="m-doc-self">setState</a>(</span><span class="m-doc-wrap"><a href="classScStwTimer.html#ada0d42f8cac92807271e3811899691d4" class="m-doc">TimerState</a> newState) <span class="m-label m-warning">protected slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to change the state of the timer.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">newState</td>
|
||||
<td>The new state</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Doing this will emit the <a href="classScStwTimer.html#a2b99b88e926d1b8cda3e1b3ef87d209b" class="m-doc">ScStwTimer::<wbr />stateChanged()</a> signal (only if the new state differs from the current one)</p>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ab1a4c10718873ff80d395a4697ad8e6a"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab1a4c10718873ff80d395a4697ad8e6a" class="m-doc-self">setWantsToBeDisabled</a>(</span><span class="m-doc-wrap">bool wantsToBeDisabled) <span class="m-label m-warning">protected slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to set whether the timer currently wants to be disabled.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<thead>
|
||||
<tr><th colspan="2">Parameters</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 1%">wantsToBeDisabled</td>
|
||||
<td>true or false</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="ab8a2f017d02f979e13282a10ac9c25ab"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">void ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab8a2f017d02f979e13282a10ac9c25ab" class="m-doc-self">technicalIncident</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">protected slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to set the timer into INCIDENT state immidieately.</p>
|
||||
<p>The current state of the timer will be ignored! It can only get out of this state by calling <a href="classScStwTimer.html#a1576aaf8ebedd8ed26bc4bbce96b81a8" class="m-doc">ScStwTimer::<wbr />reset</a></p><aside class="m-note m-default"><h4>See also</h4><p><a href="classScStwTimer.html#a1576aaf8ebedd8ed26bc4bbce96b81a8" class="m-doc">reset</a></p></aside>
|
||||
</div></section>
|
||||
<section class="m-doc-details" id="aaaf67aa1c25ed318404a9236fa56f732"><div>
|
||||
<h3>
|
||||
<span class="m-doc-wrap-bumper">bool ScStwTimer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aaaf67aa1c25ed318404a9236fa56f732" class="m-doc-self">wildcard</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">protected slot</span></span></span>
|
||||
</h3>
|
||||
<p>Function to set the timer into WILDCARD state.</p>
|
||||
<table class="m-table m-fullwidth m-flat">
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th style="width: 1%">Returns</th>
|
||||
<td>false if not in STARTING state</td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
<p>Only works when the timer is in STARTING state.</p>
|
||||
</div></section>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
BIN
favicon.png
Normal file
BIN
favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
114
files.html
Normal file
114
files.html
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>Files</h1>
|
||||
<ul class="m-doc">
|
||||
</ul>
|
||||
<script>
|
||||
function toggle(e) {
|
||||
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
|
||||
'm-doc-expansible' : 'm-doc-collapsible';
|
||||
return false;
|
||||
}
|
||||
/* Collapse all nodes marked as such. Doing it via JS instead of
|
||||
directly in markup so disabling it doesn't harm usability. The list
|
||||
is somehow regenerated on every iteration and shrinks as I change
|
||||
the classes. It's not documented anywhere and I'm not sure if this
|
||||
is the same across browsers, so I am going backwards in that list to
|
||||
be sure. */
|
||||
var collapsed = document.getElementsByClassName("collapsed");
|
||||
for(var i = collapsed.length - 1; i >= 0; --i)
|
||||
collapsed[i].className = 'm-doc-expansible';
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
101
index.html
Normal file
101
index.html
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw Libraries documentation | ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>
|
||||
ScStw Libraries documentation
|
||||
</h1>
|
||||
<section id="intro_sec"><h2><a href="#intro_sec">Introduction</a></h2><p>This library is meant for usage with the Speed climbing stopwatch project. It contains some helper classes to build a client application for the <a href="classScStw.html" class="m-doc">ScStw</a> basestation with Qt.</p></section><section id="section"><h2><a href="#section">Installation</a></h2><pre class="m-code"><span class="nb">cd</span> yourRepo
|
||||
git submodule add https://git.itsblue.de/ScStw/shared-libraries/
|
||||
git submodule update --init --recursive</pre><p>And in your MyProject.pro include the .pri file: <code class="m-code"><span class="nf">include</span><span class="p">(</span><span class="err">$$</span><span class="nv">PWD</span><span class="o">/</span><span class="s s-Atom">shared</span><span class="o">-</span><span class="s s-Atom">libraries</span><span class="o">/</span><span class="nv">ScStwLibraries</span><span class="o">/</span><span class="nv">ScStwLibraries</span><span class="p">.</span><span class="s s-Atom">pri</span><span class="p">)</span></code></p></section>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
2923
m-dark+documentation.compiled.css
Normal file
2923
m-dark+documentation.compiled.css
Normal file
File diff suppressed because it is too large
Load diff
114
modules.html
Normal file
114
modules.html
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>Modules</h1>
|
||||
<ul class="m-doc">
|
||||
</ul>
|
||||
<script>
|
||||
function toggle(e) {
|
||||
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
|
||||
'm-doc-expansible' : 'm-doc-collapsible';
|
||||
return false;
|
||||
}
|
||||
/* Collapse all nodes marked as such. Doing it via JS instead of
|
||||
directly in markup so disabling it doesn't harm usability. The list
|
||||
is somehow regenerated on every iteration and shrinks as I change
|
||||
the classes. It's not documented anywhere and I'm not sure if this
|
||||
is the same across browsers, so I am going backwards in that list to
|
||||
be sure. */
|
||||
var collapsed = document.getElementsByClassName("collapsed");
|
||||
for(var i = collapsed.length - 1; i >= 0; --i)
|
||||
collapsed[i].className = 'm-doc-expansible';
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
114
namespaces.html
Normal file
114
namespaces.html
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>Namespaces</h1>
|
||||
<ul class="m-doc">
|
||||
</ul>
|
||||
<script>
|
||||
function toggle(e) {
|
||||
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
|
||||
'm-doc-expansible' : 'm-doc-collapsible';
|
||||
return false;
|
||||
}
|
||||
/* Collapse all nodes marked as such. Doing it via JS instead of
|
||||
directly in markup so disabling it doesn't harm usability. The list
|
||||
is somehow regenerated on every iteration and shrinks as I change
|
||||
the classes. It's not documented anywhere and I'm not sure if this
|
||||
is the same across browsers, so I am going backwards in that list to
|
||||
be sure. */
|
||||
var collapsed = document.getElementsByClassName("collapsed");
|
||||
for(var i = collapsed.length - 1; i >= 0; --i)
|
||||
collapsed[i].className = 'm-doc-expansible';
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
114
pages.html
Normal file
114
pages.html
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>ScStw shared libraries</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
||||
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
||||
<link rel="icon" href="favicon.png" type="image/png" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="theme-color" content="#0094ff" />
|
||||
</head>
|
||||
<body>
|
||||
<header><nav id="navigation">
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
||||
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
||||
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
||||
</svg></a>
|
||||
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
||||
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
||||
</div>
|
||||
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
||||
<div class="m-row">
|
||||
<ol class="m-col-t-6 m-col-m-none">
|
||||
</ol>
|
||||
<ol class="m-col-t-6 m-col-m-none" start="1">
|
||||
<li><a href="index.html">Introduction</a></li>
|
||||
<li><a href="annotated.html">Classes</a></li>
|
||||
<li><a href="refman.pdf">Download</a></li>
|
||||
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
||||
<use href="#m-doc-search-icon-path" />
|
||||
</svg></a></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></header>
|
||||
<main><article>
|
||||
<div class="m-container m-container-inflatable">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<h1>Pages</h1>
|
||||
<ul class="m-doc">
|
||||
</ul>
|
||||
<script>
|
||||
function toggle(e) {
|
||||
e.parentElement.className = e.parentElement.className == 'm-doc-collapsible' ?
|
||||
'm-doc-expansible' : 'm-doc-collapsible';
|
||||
return false;
|
||||
}
|
||||
/* Collapse all nodes marked as such. Doing it via JS instead of
|
||||
directly in markup so disabling it doesn't harm usability. The list
|
||||
is somehow regenerated on every iteration and shrinks as I change
|
||||
the classes. It's not documented anywhere and I'm not sure if this
|
||||
is the same across browsers, so I am going backwards in that list to
|
||||
be sure. */
|
||||
var collapsed = document.getElementsByClassName("collapsed");
|
||||
for(var i = collapsed.length - 1; i >= 0; --i)
|
||||
collapsed[i].className = 'm-doc-expansible';
|
||||
</script>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</article></main>
|
||||
<div class="m-doc-search" id="search">
|
||||
<a href="#!" onclick="return hideSearch()"></a>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-m-8 m-push-m-2">
|
||||
<div class="m-doc-search-header m-text m-small">
|
||||
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
||||
<div id="search-symbolcount">…</div>
|
||||
</div>
|
||||
<div class="m-doc-search-content">
|
||||
<form>
|
||||
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
||||
</form>
|
||||
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
||||
<div id="search-help" class="m-text m-dim m-text-center">
|
||||
<p class="m-noindent">Search for symbols, directories, files, pages or
|
||||
modules. You can omit any prefix from the symbol or file path; adding a
|
||||
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
||||
directory.</p>
|
||||
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
||||
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
||||
<span class="m-label m-dim">Enter</span> to go.
|
||||
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
||||
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
||||
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
||||
</div>
|
||||
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
||||
<ul id="search-results"></ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="search-v2.js"></script>
|
||||
<script src="searchdata-v2.js" async="async"></script>
|
||||
<footer><nav>
|
||||
<div class="m-container">
|
||||
<div class="m-row">
|
||||
<div class="m-col-l-10 m-push-l-1">
|
||||
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav></footer>
|
||||
</body>
|
||||
</html>
|
||||
BIN
refman.pdf
Normal file
BIN
refman.pdf
Normal file
Binary file not shown.
897
search-v2.js
Normal file
897
search-v2.js
Normal file
|
|
@ -0,0 +1,897 @@
|
|||
/*
|
||||
This file is part of m.css.
|
||||
|
||||
Copyright © 2017, 2018, 2019, 2020, 2021, 2022
|
||||
Vladimír Vondruš <mosra@centrum.cz>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and associated documentation files (the "Software"),
|
||||
to deal in the Software without restriction, including without limitation
|
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
and/or sell copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included
|
||||
in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
||||
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
|
||||
"use strict"; /* it summons the Cthulhu in a proper way, they say */
|
||||
|
||||
var Search = {
|
||||
formatVersion: 2, /* the data filename contains this number too */
|
||||
|
||||
dataSize: 0, /* used mainly by tests, not here */
|
||||
symbolCount: '…',
|
||||
trie: null,
|
||||
map: null,
|
||||
mapFlagsOffset: null,
|
||||
typeMap: null,
|
||||
maxResults: 0,
|
||||
|
||||
/* Type sizes and masks. The data is always fetched as 16/32bit number and
|
||||
then masked to 1, 2, 3 or 4 bytes. Fortunately on LE a mask is enough,
|
||||
on BE we'd have to read N bytes before and then mask. */
|
||||
nameSizeBytes: null,
|
||||
nameSizeMask: null,
|
||||
resultIdBytes: null,
|
||||
resultIdMask: null,
|
||||
fileOffsetBytes: null,
|
||||
fileOffsetMask: null,
|
||||
lookaheadBarrierMask: null,
|
||||
|
||||
/* Always contains at least the root node offset and then one node offset
|
||||
per entered character */
|
||||
searchString: '',
|
||||
searchStack: [],
|
||||
|
||||
/* So items don't get selected right away when a cursor is over results but
|
||||
only after mouse moves */
|
||||
mouseMovedSinceLastRender: false,
|
||||
|
||||
/* Whether we can go back in history in order to hide the search box or
|
||||
not. We can't do that if we arrived directly on #search from outside. */
|
||||
canGoBackToHideSearch: false,
|
||||
|
||||
/* Autocompletion in the input field is whitelisted only for character
|
||||
input (so not deletion, cut, or anything else). This is flipped in the
|
||||
onkeypress event and reset after each oninput event. */
|
||||
autocompleteNextInputEvent: false,
|
||||
|
||||
init: function(buffer, maxResults) {
|
||||
let view = new DataView(buffer);
|
||||
|
||||
/* The file is too short to contain at least the headers and empty
|
||||
sections */
|
||||
if(view.byteLength < 31) {
|
||||
console.error("Search data too short");
|
||||
return false;
|
||||
}
|
||||
|
||||
if(view.getUint8(0) != 'M'.charCodeAt(0) ||
|
||||
view.getUint8(1) != 'C'.charCodeAt(0) ||
|
||||
view.getUint8(2) != 'S'.charCodeAt(0)) {
|
||||
console.error("Invalid search data signature");
|
||||
return false;
|
||||
}
|
||||
|
||||
if(view.getUint8(3) != this.formatVersion) {
|
||||
console.error("Invalid search data version");
|
||||
return false;
|
||||
}
|
||||
|
||||
/* Fetch type sizes. The only value that can fail is result ID byte
|
||||
count, where value of 3 has no assigned meaning. */
|
||||
let typeSizes = view.getUint8(4, true);
|
||||
if((typeSizes & 0x01) >> 0 == 0) {
|
||||
this.fileOffsetBytes = 3;
|
||||
this.fileOffsetMask = 0x00ffffff;
|
||||
this.lookaheadBarrierMask = 0x00800000;
|
||||
} else /* (typeSizes & 0x01) >> 0 == 1 */ {
|
||||
this.fileOffsetBytes = 4;
|
||||
this.fileOffsetMask = 0xffffffff;
|
||||
this.lookaheadBarrierMask = 0x80000000;
|
||||
}
|
||||
if((typeSizes & 0x06) >> 1 == 0) {
|
||||
this.resultIdBytes = 2;
|
||||
this.resultIdMask = 0x0000ffff;
|
||||
} else if((typeSizes & 0x06) >> 1 == 1) {
|
||||
this.resultIdBytes = 3;
|
||||
this.resultIdMask = 0x00ffffff;
|
||||
} else if((typeSizes & 0x06) >> 1 == 2) {
|
||||
this.resultIdBytes = 4;
|
||||
this.resultIdMask = 0xffffffff;
|
||||
} else /* (typeSizes & 0x06) >> 1 == 3 */ {
|
||||
console.error("Invalid search data result ID byte value");
|
||||
return false;
|
||||
}
|
||||
if((typeSizes & 0x08) >> 3 == 0) {
|
||||
this.nameSizeBytes = 1;
|
||||
this.nameSizeMask = 0x00ff;
|
||||
} else /* (typeSizes & 0x08) >> 3 == 1 */ {
|
||||
this.nameSizeBytes = 2;
|
||||
this.nameSizeMask = 0xffff;
|
||||
}
|
||||
|
||||
/* Separate the data into the trie and the result / type map. Because
|
||||
we're reading larger values than there might be and then masking out
|
||||
the high bytes, keep extra 1/2 byte padding at the end to avoid
|
||||
OOB errors. */
|
||||
let mapOffset = view.getUint32(12, true);
|
||||
let typeMapOffset = view.getUint32(16, true);
|
||||
/* There may be a 3-byte file offset at the end of the trie which we'll
|
||||
read as 32-bit, add one safety byte in that case */
|
||||
this.trie = new DataView(buffer, 20, mapOffset - 20 + (4 - this.fileOffsetBytes));
|
||||
/* There may be a 3-byte file size (for zero results) which we'll read
|
||||
as 32-bit, add one safety byte in that case */
|
||||
this.map = new DataView(buffer, mapOffset, typeMapOffset - mapOffset + (4 - this.fileOffsetBytes));
|
||||
/* No variable-size types in the type map at the moment */
|
||||
this.typeMap = new DataView(buffer, typeMapOffset);
|
||||
|
||||
/* Offset of the first result map item is after N + 1 offsets and N
|
||||
flags, calculate flag offset from that */
|
||||
this.mapFlagsOffset = this.fileOffsetBytes*(((this.map.getUint32(0, true) & this.fileOffsetMask) - this.fileOffsetBytes)/(this.fileOffsetBytes + 1) + 1);
|
||||
|
||||
/* Set initial properties */
|
||||
this.dataSize = buffer.byteLength;
|
||||
this.symbolCount = view.getUint32(8, true) + " symbols (" + Math.round(this.dataSize/102.4)/10 + " kB)";
|
||||
this.maxResults = maxResults ? maxResults : 100;
|
||||
this.searchString = '';
|
||||
this.searchStack = [this.trie.getUint32(0, true)];
|
||||
|
||||
/* istanbul ignore if */
|
||||
if(typeof document !== 'undefined') {
|
||||
document.getElementById('search-symbolcount').innerHTML = this.symbolCount;
|
||||
document.getElementById('search-input').disabled = false;
|
||||
document.getElementById('search-input').placeholder = "Type something here …";
|
||||
document.getElementById('search-input').focus();
|
||||
|
||||
/* Search for the input value (there might be something already,
|
||||
for example when going back in the browser) */
|
||||
let value = document.getElementById('search-input').value;
|
||||
|
||||
/* Otherwise check the GET parameters for `q` and fill the input
|
||||
with that */
|
||||
if(!value.length) {
|
||||
var args = decodeURIComponent(window.location.search.substr(1)).trim().split('&');
|
||||
for(var i = 0; i != args.length; ++i) {
|
||||
if(args[i].substring(0, 2) != 'q=') continue;
|
||||
|
||||
value = document.getElementById('search-input').value = args[i].substring(2);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if(value.length) Search.searchAndRender(value);
|
||||
}
|
||||
|
||||
return true;
|
||||
},
|
||||
|
||||
download: /* istanbul ignore next */ function(url) {
|
||||
var req = window.XDomainRequest ? new XDomainRequest() : new XMLHttpRequest();
|
||||
if(!req) return;
|
||||
|
||||
req.open("GET", url, true);
|
||||
req.responseType = 'arraybuffer';
|
||||
req.onreadystatechange = function() {
|
||||
if(req.readyState != 4) return;
|
||||
|
||||
Search.init(req.response);
|
||||
}
|
||||
req.send();
|
||||
},
|
||||
|
||||
base85decode: function(base85string) {
|
||||
function charValue(char) {
|
||||
if(char >= 48 && char < 58) /* 0-9 -> 0-9 */
|
||||
return char - 48 + 0;
|
||||
if(char >= 65 && char < 91) /* A-Z -> 10-35 */
|
||||
return char - 65 + 10;
|
||||
if(char >= 97 && char < 123) /* a-z -> 36-61 */
|
||||
return char - 97 + 36;
|
||||
if(char == 33) /* ! -> 62 */
|
||||
return 62;
|
||||
/* skipping 34 (') */
|
||||
if(char >= 35 && char < 39) /* #-& -> 63-66 */
|
||||
return char - 35 + 63;
|
||||
/* skipping 39 (") */
|
||||
if(char >= 40 && char < 44) /* (-+ -> 67-70 */
|
||||
return char - 40 + 67;
|
||||
/* skipping 44 (,) */
|
||||
if(char == 45) /* - -> 71 */
|
||||
return 71;
|
||||
if(char >= 59 && char < 65) /* ;-@ -> 72-77 */
|
||||
return char - 59 + 72;
|
||||
if(char >= 94 && char < 97) /* ^-` -> 78-80 */
|
||||
return char - 94 + 78;
|
||||
if(char >= 123 && char < 127) /* {-~ -> 81-84 */
|
||||
return char - 123 + 81;
|
||||
|
||||
return 0; /* Interpret padding values as zeros */
|
||||
}
|
||||
|
||||
/* Pad the string for easier decode later. We don't read past the file
|
||||
end, so it doesn't matter what garbage is there. */
|
||||
if(base85string.length % 5) {
|
||||
console.log("Expected properly padded base85 data");
|
||||
return;
|
||||
}
|
||||
|
||||
let buffer = new ArrayBuffer(base85string.length*4/5);
|
||||
let data8 = new DataView(buffer);
|
||||
for(let i = 0; i < base85string.length; i += 5) {
|
||||
let char1 = charValue(base85string.charCodeAt(i + 0));
|
||||
let char2 = charValue(base85string.charCodeAt(i + 1));
|
||||
let char3 = charValue(base85string.charCodeAt(i + 2));
|
||||
let char4 = charValue(base85string.charCodeAt(i + 3));
|
||||
let char5 = charValue(base85string.charCodeAt(i + 4));
|
||||
|
||||
data8.setUint32(i*4/5, char5 +
|
||||
char4*85 +
|
||||
char3*85*85 +
|
||||
char2*85*85*85 +
|
||||
char1*85*85*85*85, false); /* BE, yes */
|
||||
}
|
||||
|
||||
return buffer;
|
||||
},
|
||||
|
||||
load: function(base85string) {
|
||||
return this.init(this.base85decode(base85string));
|
||||
},
|
||||
|
||||
/* http://ecmanaut.blogspot.com/2006/07/encoding-decoding-utf8-in-javascript.html */
|
||||
toUtf8: function(string) { return unescape(encodeURIComponent(string)); },
|
||||
fromUtf8: function(string) { return decodeURIComponent(escape(string)); },
|
||||
|
||||
autocompletedCharsToUtf8: function(chars) {
|
||||
/* Strip incomplete UTF-8 chars from the autocompletion end */
|
||||
for(let i = chars.length - 1; i >= 0; --i) {
|
||||
let c = chars[i];
|
||||
|
||||
/* We're safe, finish */
|
||||
if(
|
||||
/* ASCII value at the end */
|
||||
(c < 128 && i + 1 == chars.length) ||
|
||||
|
||||
/* Full two-byte character at the end */
|
||||
((c & 0xe0) == 0xc0 && i + 2 == chars.length) ||
|
||||
|
||||
/* Full three-byte character at the end */
|
||||
((c & 0xf0) == 0xe0 && i + 3 == chars.length) ||
|
||||
|
||||
/* Full four-byte character at the end */
|
||||
((c & 0xf8) == 0xf0 && i + 4 == chars.length)
|
||||
) break;
|
||||
|
||||
/* Continuing UTF-8 character, go further back */
|
||||
if((c & 0xc0) == 0x80) continue;
|
||||
|
||||
/* Otherwise the character is not complete, drop it from the end */
|
||||
chars.length = i;
|
||||
break;
|
||||
}
|
||||
|
||||
/* Convert the autocompleted UTF-8 sequence to a string */
|
||||
let suggestedTabAutocompletionString = '';
|
||||
for(let i = 0; i != chars.length; ++i)
|
||||
suggestedTabAutocompletionString += String.fromCharCode(chars[i]);
|
||||
return suggestedTabAutocompletionString;
|
||||
},
|
||||
|
||||
/* Returns the values in UTF-8, but input is in whatever shitty 16bit
|
||||
encoding JS has */
|
||||
search: function(searchString) {
|
||||
/* Normalize the search string first, convert to UTF-8 and trim spaces
|
||||
from the left. From the right they're trimmed only if nothing is
|
||||
found, see below. */
|
||||
searchString = this.toUtf8(searchString.toLowerCase().replace(/^\s+/,''));
|
||||
|
||||
/* TODO: maybe i could make use of InputEvent.data and others here */
|
||||
|
||||
/* Find longest common prefix of previous and current value so we don't
|
||||
need to needlessly search again */
|
||||
let max = Math.min(searchString.length, this.searchString.length);
|
||||
let commonPrefix = 0;
|
||||
for(; commonPrefix != max; ++commonPrefix)
|
||||
if(searchString[commonPrefix] != this.searchString[commonPrefix]) break;
|
||||
|
||||
/* Drop items off the stack if it has has more than is needed for the
|
||||
common prefix (it needs to have at least one item, though) */
|
||||
if(commonPrefix + 1 < this.searchStack.length)
|
||||
this.searchStack.splice(commonPrefix + 1, this.searchStack.length - commonPrefix - 1);
|
||||
|
||||
/* Add new characters from the search string */
|
||||
let foundPrefix = commonPrefix;
|
||||
for(; foundPrefix != searchString.length; ++foundPrefix) {
|
||||
/* Calculate offset and count of children */
|
||||
let offset = this.searchStack[this.searchStack.length - 1];
|
||||
|
||||
/* If there's a lot of results, the result count is a 16bit BE value
|
||||
instead */
|
||||
let resultCount = this.trie.getUint8(offset);
|
||||
let resultCountSize = 1;
|
||||
if(resultCount & 0x80) {
|
||||
resultCount = this.trie.getUint16(offset, false) & ~0x8000;
|
||||
++resultCountSize;
|
||||
}
|
||||
|
||||
let childCount = this.trie.getUint8(offset + resultCountSize);
|
||||
|
||||
/* Go through all children and find the next offset */
|
||||
let childOffset = offset + resultCountSize + 1 + resultCount*this.resultIdBytes;
|
||||
let found = false;
|
||||
for(let j = 0; j != childCount; ++j) {
|
||||
if(String.fromCharCode(this.trie.getUint8(childOffset + j)) != searchString[foundPrefix])
|
||||
continue;
|
||||
|
||||
this.searchStack.push(this.trie.getUint32(childOffset + childCount + j*this.fileOffsetBytes, true) & this.fileOffsetMask & ~this.lookaheadBarrierMask);
|
||||
found = true;
|
||||
break;
|
||||
}
|
||||
|
||||
/* Character not found */
|
||||
if(!found) {
|
||||
/* If we found everything except spaces at the end, pretend the
|
||||
spaces aren't there. On the other hand, we *do* want to
|
||||
try searching with the spaces first -- it can narrow down
|
||||
the result list for page names or show subpages (which are
|
||||
after a lookahead barrier that's a space). */
|
||||
if(!searchString.substr(foundPrefix).trim().length)
|
||||
searchString = searchString.substr(0, foundPrefix);
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/* Save the whole found prefix for next time */
|
||||
this.searchString = searchString.substr(0, foundPrefix);
|
||||
|
||||
/* If the whole thing was not found, return an empty result and offer
|
||||
external search */
|
||||
if(foundPrefix != searchString.length) {
|
||||
/* istanbul ignore if */
|
||||
if(typeof document !== 'undefined') {
|
||||
let link = document.getElementById('search-external');
|
||||
if(link)
|
||||
link.href = link.dataset.searchEngine.replace('{query}', encodeURIComponent(searchString));
|
||||
}
|
||||
return [[], ''];
|
||||
}
|
||||
|
||||
/* Otherwise gather the results */
|
||||
let suggestedTabAutocompletionChars = [];
|
||||
let results = [];
|
||||
let leaves = [[this.searchStack[this.searchStack.length - 1], 0]];
|
||||
while(leaves.length) {
|
||||
/* Pop offset from the queue */
|
||||
let current = leaves.shift();
|
||||
let offset = current[0];
|
||||
let suffixLength = current[1];
|
||||
|
||||
/* Calculate child count. If there's a lot of results, the count
|
||||
"leaks over" to the child count storage. */
|
||||
/* TODO: hmmm. this is helluvalot duplicated code. hmm. */
|
||||
let resultCount = this.trie.getUint8(offset);
|
||||
let resultCountSize = 1;
|
||||
if(resultCount & 0x80) {
|
||||
resultCount = this.trie.getUint16(offset, false) & ~0x8000;
|
||||
++resultCountSize;
|
||||
}
|
||||
|
||||
let childCount = this.trie.getUint8(offset + resultCountSize);
|
||||
|
||||
/* Populate the results with all values associated with this node */
|
||||
for(let i = 0; i != resultCount; ++i) {
|
||||
let index = this.trie.getUint32(offset + resultCountSize + 1 + i*this.resultIdBytes, true) & this.resultIdMask;
|
||||
results.push(this.gatherResult(index, suffixLength, 0xffffff)); /* should be enough haha */
|
||||
|
||||
/* 'nuff said. */
|
||||
if(results.length >= this.maxResults)
|
||||
return [results, this.autocompletedCharsToUtf8(suggestedTabAutocompletionChars)];
|
||||
}
|
||||
|
||||
/* Dig deeper */
|
||||
let childOffset = offset + resultCountSize + 1 + resultCount*this.resultIdBytes;
|
||||
for(let j = 0; j != childCount; ++j) {
|
||||
let offsetBarrier = this.trie.getUint32(childOffset + childCount + j*this.fileOffsetBytes, true) & this.fileOffsetMask;
|
||||
|
||||
/* Lookahead barrier, don't dig deeper */
|
||||
if(offsetBarrier & this.lookaheadBarrierMask) continue;
|
||||
|
||||
/* Append to the queue */
|
||||
leaves.push([offsetBarrier & ~this.lookaheadBarrierMask, suffixLength + 1]);
|
||||
|
||||
/* We don't have anything yet and this is the only path
|
||||
forward, add the char to suggested Tab autocompletion. Can't
|
||||
extract it from the leftmost 8 bits of offsetBarrier because
|
||||
that would make it negative, have to load as Uint8 instead.
|
||||
Also can't use String.fromCharCode(), because later doing
|
||||
str.charCodeAt() would give me back UTF-16 values, which is
|
||||
absolutely unwanted when all I want is check for truncated
|
||||
UTF-8. */
|
||||
if(!results.length && leaves.length == 1 && childCount == 1)
|
||||
suggestedTabAutocompletionChars.push(this.trie.getUint8(childOffset + j));
|
||||
}
|
||||
}
|
||||
|
||||
return [results, this.autocompletedCharsToUtf8(suggestedTabAutocompletionChars)];
|
||||
},
|
||||
|
||||
gatherResult: function(index, suffixLength, maxUrlPrefix) {
|
||||
let flags = this.map.getUint8(this.mapFlagsOffset + index);
|
||||
let resultOffset = this.map.getUint32(index*this.fileOffsetBytes, true) & this.fileOffsetMask;
|
||||
|
||||
/* The result is an alias, parse the aliased prefix */
|
||||
let aliasedIndex = null;
|
||||
if((flags & 0xf0) == 0x00) {
|
||||
aliasedIndex = this.map.getUint32(resultOffset, true) & this.resultIdMask;
|
||||
resultOffset += this.resultIdBytes;
|
||||
}
|
||||
|
||||
/* The result has a prefix, parse that first, recursively */
|
||||
let name = '';
|
||||
let url = '';
|
||||
if(flags & (1 << 3)) {
|
||||
let prefixIndex = this.map.getUint32(resultOffset, true) & this.resultIdMask;
|
||||
let prefixUrlPrefixLength = Math.min(this.map.getUint16(resultOffset + this.resultIdBytes, true) & this.nameSizeMask, maxUrlPrefix);
|
||||
|
||||
let prefix = this.gatherResult(prefixIndex, 0 /*ignored*/, prefixUrlPrefixLength);
|
||||
name = prefix.name;
|
||||
url = prefix.url;
|
||||
|
||||
resultOffset += this.resultIdBytes + this.nameSizeBytes;
|
||||
}
|
||||
|
||||
/* The result has a suffix, extract its length */
|
||||
let resultSuffixLength = 0;
|
||||
if(flags & (1 << 0)) {
|
||||
resultSuffixLength = this.map.getUint16(resultOffset, true) & this.nameSizeMask;
|
||||
resultOffset += this.nameSizeBytes;
|
||||
}
|
||||
|
||||
let nextResultOffset = this.map.getUint32((index + 1)*this.fileOffsetBytes, true) & this.fileOffsetMask;
|
||||
|
||||
/* Extract name */
|
||||
let j = resultOffset;
|
||||
for(; j != nextResultOffset; ++j) {
|
||||
let c = this.map.getUint8(j);
|
||||
|
||||
/* End of null-delimited name */
|
||||
if(!c) {
|
||||
++j;
|
||||
break; /* null-delimited */
|
||||
}
|
||||
|
||||
name += String.fromCharCode(c); /* eheh. IS THIS FAST?! */
|
||||
}
|
||||
|
||||
/* The result is an alias and we're not deep inside resolving a prefix,
|
||||
extract the aliased name and URL */
|
||||
/* TODO: this abuses 0xffffff to guess how the call stack is deep and
|
||||
that's just wrong, fix! */
|
||||
if(aliasedIndex != null && maxUrlPrefix == 0xffffff) {
|
||||
let alias = this.gatherResult(aliasedIndex, 0 /* ignored */, 0xffffff); /* should be enough haha */
|
||||
|
||||
/* Keeping in UTF-8, as we need that for proper slicing (and concatenating) */
|
||||
return {name: name,
|
||||
alias: alias.name,
|
||||
url: alias.url,
|
||||
flags: alias.flags,
|
||||
cssClass: alias.cssClass,
|
||||
typeName: alias.typeName,
|
||||
suffixLength: suffixLength + resultSuffixLength};
|
||||
}
|
||||
|
||||
/* Otherwise extract URL from here */
|
||||
let max = Math.min(j + maxUrlPrefix - url.length, nextResultOffset);
|
||||
for(; j != max; ++j) {
|
||||
url += String.fromCharCode(this.map.getUint8(j));
|
||||
}
|
||||
|
||||
/* This is an alias, return what we have, without parsed CSS class and
|
||||
type name as those are retrieved from the final target type */
|
||||
if(!(flags >> 4))
|
||||
return {name: name,
|
||||
url: url,
|
||||
flags: flags & 0x0f,
|
||||
suffixLength: suffixLength + resultSuffixLength};
|
||||
|
||||
/* Otherwise, get CSS class and type name for the result label */
|
||||
let typeMapIndex = (flags >> 4) - 1;
|
||||
let cssClass = [
|
||||
/* Keep in sync with _search.py */
|
||||
'm-default',
|
||||
'm-primary',
|
||||
'm-success',
|
||||
'm-warning',
|
||||
'm-danger',
|
||||
'm-info',
|
||||
'm-dim'
|
||||
][this.typeMap.getUint8(typeMapIndex*2)];
|
||||
let typeNameOffset = this.typeMap.getUint8(typeMapIndex*2 + 1);
|
||||
let nextTypeNameOffset = this.typeMap.getUint8((typeMapIndex + 1)*2 + 1);
|
||||
let typeName = '';
|
||||
for(let j = typeNameOffset; j != nextTypeNameOffset; ++j)
|
||||
typeName += String.fromCharCode(this.typeMap.getUint8(j));
|
||||
|
||||
/* Keeping in UTF-8, as we need that for proper slicing (and
|
||||
concatenating). Strip the type from the flags, as it's now expressed
|
||||
directly. */
|
||||
return {name: name,
|
||||
url: url,
|
||||
flags: flags & 0x0f,
|
||||
cssClass: cssClass,
|
||||
typeName: typeName,
|
||||
suffixLength: suffixLength + resultSuffixLength};
|
||||
},
|
||||
|
||||
escape: function(name) {
|
||||
return name.replace(/[\"&<>]/g, function (a) {
|
||||
return { '"': '"', '&': '&', '<': '<', '>': '>' }[a];
|
||||
});
|
||||
},
|
||||
escapeForRtl: function(name) {
|
||||
/* Besides the obvious escaping of HTML entities we also need
|
||||
to escape punctuation, because due to the RTL hack to cut
|
||||
text off on left side the punctuation characters get
|
||||
reordered (of course). Prepending ‎ works for most
|
||||
characters, parentheses we need to *soak* in it. But only
|
||||
the right ones. And that for some reason needs to be also for &.
|
||||
Huh. https://en.wikipedia.org/wiki/Right-to-left_mark */
|
||||
return this.escape(name).replace(/[:=]/g, '‎$&').replace(/(\)|>|&|\/)/g, '‎$&‎');
|
||||
},
|
||||
|
||||
renderResults: /* istanbul ignore next */ function(resultsSuggestedTabAutocompletion) {
|
||||
if(!this.searchString.length) {
|
||||
document.getElementById('search-help').style.display = 'block';
|
||||
document.getElementById('search-results').style.display = 'none';
|
||||
document.getElementById('search-notfound').style.display = 'none';
|
||||
return;
|
||||
}
|
||||
|
||||
document.getElementById('search-help').style.display = 'none';
|
||||
|
||||
/* Results found */
|
||||
if(resultsSuggestedTabAutocompletion[0].length) {
|
||||
let results = resultsSuggestedTabAutocompletion[0];
|
||||
|
||||
document.getElementById('search-results').style.display = 'block';
|
||||
document.getElementById('search-notfound').style.display = 'none';
|
||||
|
||||
let list = '';
|
||||
for(let i = 0; i != results.length; ++i) {
|
||||
/* Labels + */
|
||||
list += '<li' + (i ? '' : ' id="search-current"') + '><a href="' + results[i].url + '" onmouseover="selectResult(event)" data-md-link-title="' + this.escape(results[i].name.substr(results[i].name.length - this.searchString.length - results[i].suffixLength)) + '"><div class="m-label m-flat ' + results[i].cssClass + '">' + results[i].typeName + '</div>' + (results[i].flags & 2 ? '<div class="m-label m-danger">deprecated</div>' : '') + (results[i].flags & 4 ? '<div class="m-label m-danger">deleted</div>' : '');
|
||||
|
||||
/* Render the alias (cut off from the right) */
|
||||
if(results[i].alias) {
|
||||
list += '<div class="m-doc-search-alias"><span class="m-text m-dim">' + this.escape(results[i].name.substr(0, results[i].name.length - this.searchString.length - results[i].suffixLength)) + '</span><span class="m-doc-search-typed">' + this.escape(results[i].name.substr(results[i].name.length - this.searchString.length - results[i].suffixLength, this.searchString.length)) + '</span>' + this.escapeForRtl(results[i].name.substr(results[i].name.length - results[i].suffixLength)) + '<span class="m-text m-dim">: ' + this.escape(results[i].alias) + '</span>';
|
||||
|
||||
/* Render the normal thing (cut off from the left, have to
|
||||
escape for RTL) */
|
||||
} else {
|
||||
list += '<div><span class="m-text m-dim">' + this.escapeForRtl(results[i].name.substr(0, results[i].name.length - this.searchString.length - results[i].suffixLength)) + '</span><span class="m-doc-search-typed">' + this.escapeForRtl(results[i].name.substr(results[i].name.length - this.searchString.length - results[i].suffixLength, this.searchString.length)) + '</span>' + this.escapeForRtl(results[i].name.substr(results[i].name.length - results[i].suffixLength));
|
||||
}
|
||||
|
||||
/* The closing */
|
||||
list += '</div></a></li>';
|
||||
}
|
||||
document.getElementById('search-results').innerHTML = this.fromUtf8(list);
|
||||
document.getElementById('search-current').scrollIntoView(true);
|
||||
|
||||
/* Append the suggested tab autocompletion, if any, and if the user
|
||||
didn't just delete it */
|
||||
let searchInput = document.getElementById('search-input');
|
||||
if(this.autocompleteNextInputEvent && resultsSuggestedTabAutocompletion[1].length && searchInput.selectionEnd == searchInput.value.length) {
|
||||
let suggestedTabAutocompletion = this.fromUtf8(resultsSuggestedTabAutocompletion[1]);
|
||||
|
||||
let lengthBefore = searchInput.value.length;
|
||||
searchInput.value += suggestedTabAutocompletion;
|
||||
searchInput.setSelectionRange(lengthBefore, searchInput.value.length);
|
||||
}
|
||||
|
||||
/* Nothing found */
|
||||
} else {
|
||||
document.getElementById('search-results').innerHTML = '';
|
||||
document.getElementById('search-results').style.display = 'none';
|
||||
document.getElementById('search-notfound').style.display = 'block';
|
||||
}
|
||||
|
||||
/* Don't allow things to be selected just by motionless mouse cursor
|
||||
suddenly appearing over a search result */
|
||||
this.mouseMovedSinceLastRender = false;
|
||||
|
||||
/* Reset autocompletion, if it was allowed. It'll get whitelisted next
|
||||
time a character gets inserted. */
|
||||
this.autocompleteNextInputEvent = false;
|
||||
},
|
||||
|
||||
searchAndRender: /* istanbul ignore next */ function(value) {
|
||||
let prev = performance.now();
|
||||
let results = this.search(value);
|
||||
let after = performance.now();
|
||||
this.renderResults(results);
|
||||
if(this.searchString.length) {
|
||||
document.getElementById('search-symbolcount').innerHTML =
|
||||
results[0].length + (results[0].length >= this.maxResults ? '+' : '') + " results (" + Math.round((after - prev)*10)/10 + " ms)";
|
||||
} else
|
||||
document.getElementById('search-symbolcount').innerHTML = this.symbolCount;
|
||||
},
|
||||
};
|
||||
|
||||
/* istanbul ignore next */
|
||||
function selectResult(event) {
|
||||
if(!Search.mouseMovedSinceLastRender) return;
|
||||
|
||||
if(event.currentTarget.parentNode.id == 'search-current') return;
|
||||
|
||||
let current = document.getElementById('search-current');
|
||||
current.removeAttribute('id');
|
||||
event.currentTarget.parentNode.id = 'search-current';
|
||||
}
|
||||
|
||||
/* This is separated from showSearch() because we need non-destructive behavior
|
||||
when appearing directly on a URL with #search */ /* istanbul ignore next */
|
||||
function updateForSearchVisible() {
|
||||
/* Prevent accidental scrolling of the body, prevent page layout jumps */
|
||||
let scrolledBodyWidth = document.body.offsetWidth;
|
||||
document.body.style.overflow = 'hidden';
|
||||
document.body.style.paddingRight = (document.body.offsetWidth - scrolledBodyWidth) + 'px';
|
||||
|
||||
document.getElementById('search-input').value = '';
|
||||
document.getElementById('search-input').focus();
|
||||
document.getElementById('search-results').style.display = 'none';
|
||||
document.getElementById('search-notfound').style.display = 'none';
|
||||
document.getElementById('search-help').style.display = 'block';
|
||||
}
|
||||
|
||||
/* istanbul ignore next */
|
||||
function showSearch() {
|
||||
window.location.hash = '#search';
|
||||
Search.canGoBackToHideSearch = true;
|
||||
|
||||
updateForSearchVisible();
|
||||
document.getElementById('search-symbolcount').innerHTML = Search.symbolCount;
|
||||
return false;
|
||||
}
|
||||
|
||||
/* istanbul ignore next */
|
||||
function hideSearch() {
|
||||
/* If the search box was opened using showSearch(), we can go back in the
|
||||
history. Otherwise (for example when we landed to #search from a
|
||||
bookmark or another server), going back would not do the right thing and
|
||||
in that case we simply replace the current history state. */
|
||||
if(Search.canGoBackToHideSearch) {
|
||||
Search.canGoBackToHideSearch = false;
|
||||
window.history.back();
|
||||
} else {
|
||||
window.location.hash = '#!';
|
||||
window.history.replaceState('', '', window.location.pathname);
|
||||
}
|
||||
|
||||
/* Restore scrollbar, prevent page layout jumps */
|
||||
document.body.style.overflow = 'auto';
|
||||
document.body.style.paddingRight = '0';
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/* istanbul ignore next */
|
||||
function copyToKeyboard(text) {
|
||||
/* Append to the popup, appending to document.body would cause it to
|
||||
scroll when focused */
|
||||
let searchPopup = document.getElementsByClassName('m-doc-search')[0];
|
||||
let textarea = document.createElement("textarea");
|
||||
textarea.value = text;
|
||||
searchPopup.appendChild(textarea);
|
||||
textarea.focus();
|
||||
textarea.select();
|
||||
|
||||
document.execCommand('copy');
|
||||
|
||||
searchPopup.removeChild(textarea);
|
||||
document.getElementById('search-input').focus();
|
||||
}
|
||||
|
||||
/* Only in case we're running in a browser. Why a simple if(document) doesn't
|
||||
work is beyond me. */ /* istanbul ignore if */
|
||||
if(typeof document !== 'undefined') {
|
||||
document.getElementById('search-input').oninput = function(event) {
|
||||
Search.searchAndRender(document.getElementById('search-input').value);
|
||||
};
|
||||
|
||||
document.onkeydown = function(event) {
|
||||
/* Search shown */
|
||||
if(window.location.hash == '#search') {
|
||||
/* Close the search */
|
||||
if(event.key == 'Escape') {
|
||||
hideSearch();
|
||||
|
||||
/* Focus the search input, if not already, using T or Tab */
|
||||
} else if((!document.activeElement || document.activeElement.id != 'search-input') && (event.key.toLowerCase() == 't' || event.key == 'Tab') && !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey) {
|
||||
document.getElementById('search-input').focus();
|
||||
return false; /* so T doesn't get entered into the box */
|
||||
|
||||
/* Fill in the autocompleted selection */
|
||||
} else if(event.key == 'Tab' && !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey) {
|
||||
/* But only if the input has selection at the end */
|
||||
let input = document.getElementById('search-input');
|
||||
if(input.selectionEnd == input.value.length && input.selectionStart != input.selectionEnd) {
|
||||
input.setSelectionRange(input.value.length, input.value.length);
|
||||
return false; /* so input won't lose focus */
|
||||
}
|
||||
|
||||
/* Select next item */
|
||||
} else if(event.key == 'ArrowDown') {
|
||||
let current = document.getElementById('search-current');
|
||||
if(current) {
|
||||
let next = current.nextSibling;
|
||||
if(next) {
|
||||
current.id = '';
|
||||
next.id = 'search-current';
|
||||
next.scrollIntoView(false);
|
||||
}
|
||||
}
|
||||
return false; /* so the keypress doesn't affect input cursor */
|
||||
|
||||
/* Select prev item */
|
||||
} else if(event.key == 'ArrowUp') {
|
||||
let current = document.getElementById('search-current');
|
||||
if(current) {
|
||||
let prev = current.previousSibling;
|
||||
if(prev) {
|
||||
current.id = '';
|
||||
prev.id = 'search-current';
|
||||
prev.scrollIntoView(false);
|
||||
}
|
||||
}
|
||||
return false; /* so the keypress doesn't affect input cursor */
|
||||
|
||||
/* Go to result (if any) */
|
||||
} else if(event.key == 'Enter') {
|
||||
let result = document.getElementById('search-current');
|
||||
if(result) {
|
||||
result.firstElementChild.click();
|
||||
|
||||
/* We might be staying on the same page, so restore scrollbar,
|
||||
and prevent page layout jumps */
|
||||
document.body.style.overflow = 'auto';
|
||||
document.body.style.paddingRight = '0';
|
||||
}
|
||||
return false; /* so the form doesn't get sent */
|
||||
|
||||
/* Copy (Markdown) link to keyboard */
|
||||
} else if((event.key.toLowerCase() == 'l' || event.key.toLowerCase() == 'm') && event.metaKey) {
|
||||
let result = document.getElementById('search-current');
|
||||
if(result) {
|
||||
let plain = event.key.toLowerCase() == 'l';
|
||||
let link = plain ? result.firstElementChild.href :
|
||||
'[' + result.firstElementChild.dataset.mdLinkTitle + '](' + result.firstElementChild.href + ')';
|
||||
|
||||
copyToKeyboard(link);
|
||||
|
||||
/* Add CSS class to the element for visual feedback (this
|
||||
will get removed on keyup), but only if it's not already
|
||||
there (in case of key repeat, e.g.) */
|
||||
if(result.className.indexOf('m-doc-search-copied') == -1)
|
||||
result.className += ' m-doc-search-copied';
|
||||
console.log("Copied " + (plain ? "link" : "Markdown link") + " to " + result.firstElementChild.dataset.mdLinkTitle);
|
||||
}
|
||||
|
||||
return false; /* so L doesn't get entered into the box */
|
||||
|
||||
/* Looks like the user is inserting some text (and not cutting,
|
||||
copying or whatever), allow autocompletion for the new
|
||||
character. The oninput event resets this back to false, so this
|
||||
basically whitelists only keyboard input, including Shift-key
|
||||
and special chars using right Alt (or equivalent on Mac), but
|
||||
excluding Ctrl-key, which is usually not for text input. In the
|
||||
worst case the autocompletion won't be allowed ever, which is
|
||||
much more acceptable behavior than having no ability to disable
|
||||
it and annoying the users. */
|
||||
} else if(event.key != 'Backspace' && event.key != 'Delete' && !event.metaKey && (!event.ctrlKey || event.altKey)
|
||||
/* Don't ever attempt autocompletion with Android virtual
|
||||
keyboards, as those report all `event.key`s as
|
||||
`Unidentified` (on Chrome) or `Process` (on Firefox) with
|
||||
`event.code` 229 and thus we have no way to tell if a text
|
||||
is entered or deleted. See this WONTFIX bug for details:
|
||||
https://bugs.chromium.org/p/chromium/issues/detail?id=118639
|
||||
Couldn't find any similar bugreport for Firefox, but I
|
||||
assume the virtual keyboard is to blame.
|
||||
|
||||
An alternative is to hook into inputEvent, which has the
|
||||
data, but ... there's more cursed issues right after that:
|
||||
|
||||
- setSelectionRange() in Chrome on Android only renders
|
||||
stuff, but doesn't actually act as such. Pressing
|
||||
Backspace will only remove the highlight, but the text
|
||||
stays here. Only delay-calling it through a timeout will
|
||||
work as intended. Possibly related SO suggestion (back
|
||||
then not even the rendering worked properly):
|
||||
https://stackoverflow.com/a/13235951
|
||||
Possibly related Chrome bug:
|
||||
https://bugs.chromium.org/p/chromium/issues/detail?id=32865
|
||||
|
||||
- On Firefox Mobile, programmatically changing an input
|
||||
value (for the autocompletion highlight) will trigger an
|
||||
input event, leading to search *and* autocompletion being
|
||||
triggered again. Ultimately that results in newly typed
|
||||
characters not replacing the autocompletion but rather
|
||||
inserting before it, corrupting the searched string. This
|
||||
event has to be explicitly ignored.
|
||||
|
||||
- On Firefox Mobile, deleting a highlight with the
|
||||
backspace key will result in *three* input events instead
|
||||
of one:
|
||||
1. `deleteContentBackward` removing the selection (same
|
||||
as Chrome or desktop Firefox)
|
||||
2. `deleteContentBackward` removing *the whole word*
|
||||
that contained the selection (or the whole text if
|
||||
it's just one word)
|
||||
3. `insertCompositionText`, adding the word back in,
|
||||
resulting in the same state as (1).
|
||||
I have no idea WHY it has to do this (possibly some
|
||||
REALLY NASTY workaround to trigger correct font shaping?)
|
||||
but ultimately it results in the autocompletion being
|
||||
added again right after it got deleted, making this whole
|
||||
thing VERY annoying to use.
|
||||
|
||||
I attempted to work around the above, but it resulted in a
|
||||
huge amount of browser-specific code that achieves only 90%
|
||||
of the goal, with certain corner cases still being rather
|
||||
broken (such as autocompletion randomly triggering when
|
||||
erasing the text, even though it shouldn't). So disabling
|
||||
autocompletion on this HELLISH BROKEN PLATFORM is the best
|
||||
option at the moment. */
|
||||
&& event.key != 'Unidentified' && event.key != 'Process'
|
||||
) {
|
||||
Search.autocompleteNextInputEvent = true;
|
||||
/* Otherwise reset the flag, because when the user would press e.g.
|
||||
the 'a' key and then e.g. ArrowRight (which doesn't trigger
|
||||
oninput), a Backspace after would still result in
|
||||
autocompleteNextInputEvent, because nothing reset it back. */
|
||||
} else {
|
||||
Search.autocompleteNextInputEvent = false;
|
||||
}
|
||||
|
||||
/* Search hidden */
|
||||
} else {
|
||||
/* Open the search on the T or Tab key */
|
||||
if((event.key.toLowerCase() == 't' || event.key == 'Tab') && !event.shiftKey && !event.ctrlKey && !event.altKey && !event.metaKey) {
|
||||
showSearch();
|
||||
return false; /* so T doesn't get entered into the box */
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
document.onkeyup = function(event) {
|
||||
/* Remove highlight after key is released after a link copy */
|
||||
if((event.key.toLowerCase() == 'l' || event.key.toLowerCase() == 'm') && event.metaKey) {
|
||||
let result = document.getElementById('search-current');
|
||||
if(result) result.className = result.className.replace(' m-doc-search-copied', '');
|
||||
}
|
||||
};
|
||||
|
||||
/* Allow selecting items by mouse hover only after it moves once the
|
||||
results are populated. This prevents a random item getting selected if
|
||||
the cursor is left motionless over the result area. */
|
||||
document.getElementById('search-results').onmousemove = function() {
|
||||
Search.mouseMovedSinceLastRender = true;
|
||||
};
|
||||
|
||||
/* If #search is already present in the URL, hide the scrollbar etc. for a
|
||||
consistent experience */
|
||||
if(window.location.hash == '#search') updateForSearchVisible();
|
||||
}
|
||||
|
||||
/* For Node.js testing */ /* istanbul ignore else */
|
||||
if(typeof module !== 'undefined') { module.exports = { Search: Search }; }
|
||||
2
searchdata-v2.js
Normal file
2
searchdata-v2.js
Normal file
File diff suppressed because one or more lines are too long
Reference in a new issue