-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathclasskodi_1_1tools_1_1_c_end_time.html
151 lines (149 loc) · 12.1 KB
/
classkodi_1_1tools_1_1_c_end_time.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: CEndTime</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classkodi_1_1tools_1_1_c_end_time.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classkodi_1_1tools_1_1_c_end_time-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CEndTime<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__tools.html">Interface - kodi::tools</a> » <a class="el" href="group__cpp__kodi__tools___c_end_time.html">class CEndTime</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:gaf7c74416e31565470ab5bfacc5986367"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#gaf7c74416e31565470ab5bfacc5986367">CEndTime</a> ()=default</td></tr>
<tr class="memdesc:gaf7c74416e31565470ab5bfacc5986367"><td class="mdescLeft"> </td><td class="mdescRight">Class constructor with no time to expiry set. <a href="group__cpp__kodi__tools___c_end_time.html#gaf7c74416e31565470ab5bfacc5986367">More...</a><br /></td></tr>
<tr class="separator:gaf7c74416e31565470ab5bfacc5986367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9fb7423bc616469c9bf70217931156f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#ga9fb7423bc616469c9bf70217931156f0">CEndTime</a> (unsigned int millisecondsIntoTheFuture)</td></tr>
<tr class="memdesc:ga9fb7423bc616469c9bf70217931156f0"><td class="mdescLeft"> </td><td class="mdescRight">Class constructor to set future time when timer has expired. <a href="group__cpp__kodi__tools___c_end_time.html#ga9fb7423bc616469c9bf70217931156f0">More...</a><br /></td></tr>
<tr class="separator:ga9fb7423bc616469c9bf70217931156f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa66d0660e7e294771ca4fc0ccd1281f2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#gaa66d0660e7e294771ca4fc0ccd1281f2">GetInitialTimeoutValue</a> (void) const</td></tr>
<tr class="memdesc:gaa66d0660e7e294771ca4fc0ccd1281f2"><td class="mdescLeft"> </td><td class="mdescRight">Get the initial timeout value this timer had. <a href="group__cpp__kodi__tools___c_end_time.html#gaa66d0660e7e294771ca4fc0ccd1281f2">More...</a><br /></td></tr>
<tr class="separator:gaa66d0660e7e294771ca4fc0ccd1281f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa55355ef6e7bbc438d4d8c338c89017e"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#gaa55355ef6e7bbc438d4d8c338c89017e">GetStartTime</a> (void) const</td></tr>
<tr class="memdesc:gaa55355ef6e7bbc438d4d8c338c89017e"><td class="mdescLeft"> </td><td class="mdescRight">Get the time this timer started. <a href="group__cpp__kodi__tools___c_end_time.html#gaa55355ef6e7bbc438d4d8c338c89017e">More...</a><br /></td></tr>
<tr class="separator:gaa55355ef6e7bbc438d4d8c338c89017e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64fa3cd6cb16588acb6ed8ec6aa7776b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#ga64fa3cd6cb16588acb6ed8ec6aa7776b">IsInfinite</a> (void) const</td></tr>
<tr class="memdesc:ga64fa3cd6cb16588acb6ed8ec6aa7776b"><td class="mdescLeft"> </td><td class="mdescRight">Check if the timer has been set to infinite expiry. <a href="group__cpp__kodi__tools___c_end_time.html#ga64fa3cd6cb16588acb6ed8ec6aa7776b">More...</a><br /></td></tr>
<tr class="separator:ga64fa3cd6cb16588acb6ed8ec6aa7776b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89b569b134c745a8bd45788806722fec"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#ga89b569b134c745a8bd45788806722fec">IsTimePast</a> () const</td></tr>
<tr class="memdesc:ga89b569b134c745a8bd45788806722fec"><td class="mdescLeft"> </td><td class="mdescRight">Check if the expiry time has been reached. <a href="group__cpp__kodi__tools___c_end_time.html#ga89b569b134c745a8bd45788806722fec">More...</a><br /></td></tr>
<tr class="separator:ga89b569b134c745a8bd45788806722fec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ed5bd7916f715bfcb626595556d958a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#ga4ed5bd7916f715bfcb626595556d958a">MillisLeft</a> () const</td></tr>
<tr class="memdesc:ga4ed5bd7916f715bfcb626595556d958a"><td class="mdescLeft"> </td><td class="mdescRight">The amount of time left till this timer expires. <a href="group__cpp__kodi__tools___c_end_time.html#ga4ed5bd7916f715bfcb626595556d958a">More...</a><br /></td></tr>
<tr class="separator:ga4ed5bd7916f715bfcb626595556d958a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac704d1071f07d5f567b52704187b5435"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#gac704d1071f07d5f567b52704187b5435">Set</a> (unsigned int millisecondsIntoTheFuture)</td></tr>
<tr class="memdesc:gac704d1071f07d5f567b52704187b5435"><td class="mdescLeft"> </td><td class="mdescRight">Set the time in the future we cosider this timer as expired. <a href="group__cpp__kodi__tools___c_end_time.html#gac704d1071f07d5f567b52704187b5435">More...</a><br /></td></tr>
<tr class="separator:gac704d1071f07d5f567b52704187b5435"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad66e8d566068de83a1ef0e1cd1b03838"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#gad66e8d566068de83a1ef0e1cd1b03838">SetExpired</a> ()</td></tr>
<tr class="memdesc:gad66e8d566068de83a1ef0e1cd1b03838"><td class="mdescLeft"> </td><td class="mdescRight">Consider this timer expired. <a href="group__cpp__kodi__tools___c_end_time.html#gad66e8d566068de83a1ef0e1cd1b03838">More...</a><br /></td></tr>
<tr class="separator:gad66e8d566068de83a1ef0e1cd1b03838"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab804619f5fa54c2a8bab0b0b69ed4f13"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__tools___c_end_time.html#gab804619f5fa54c2a8bab0b0b69ed4f13">SetInfinite</a> ()</td></tr>
<tr class="memdesc:gab804619f5fa54c2a8bab0b0b69ed4f13"><td class="mdescLeft"> </td><td class="mdescRight">Set this timer as never expiring. <a href="group__cpp__kodi__tools___c_end_time.html#gab804619f5fa54c2a8bab0b0b69ed4f13">More...</a><br /></td></tr>
<tr class="separator:gab804619f5fa54c2a8bab0b0b69ed4f13"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/alwin/Development/Kodi/kodi-N-sync-addon-doxygen/xbmc/addons/kodi-dev-kit/include/kodi/tools/<a class="el" href="_end_time_8h_source.html">EndTime.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>kodi</b></li><li class="navelem"><b>tools</b></li><li class="navelem"><a class="el" href="classkodi_1_1tools_1_1_c_end_time.html">CEndTime</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>