-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathannotated.html
165 lines (163 loc) · 21.9 KB
/
annotated.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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libscratchcpp: Class List</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libscratchcpp
</div>
<div id="projectbrief">A library for C++ based Scratch project players</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('annotated.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacelibscratchcpp.html" target="_self">libscratchcpp</a></td><td class="desc">The main namespace of the library </td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="dynsection.toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacelibscratchcpp_1_1test.html" target="_self">test</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1test_1_1ScriptBuilder.html" target="_self">ScriptBuilder</a></td><td class="desc">Used to build Scratch scripts in unit tests </td></tr>
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Asset.html" target="_self">Asset</a></td><td class="desc">Scratch asset, for example a <a class="el" href="classlibscratchcpp_1_1Costume.html" title="The Costume class represents a Scratch costume.">Costume</a> or a <a class="el" href="classlibscratchcpp_1_1Sound.html" title="The Sound class represents a Scratch sound.">Sound</a> </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Block.html" target="_self">Block</a></td><td class="desc">Scratch block </td></tr>
<tr id="row_0_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1BlockPrototype.html" target="_self">BlockPrototype</a></td><td class="desc">Prototype of a custom block </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Broadcast.html" target="_self">Broadcast</a></td><td class="desc">Scratch broadcast </td></tr>
<tr id="row_0_5_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Comment.html" target="_self">Comment</a></td><td class="desc"><a class="el" href="classlibscratchcpp_1_1Comment.html" title="The Comment class represents a comment in the code area.">Comment</a> in the code area </td></tr>
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Compiler.html" target="_self">Compiler</a></td><td class="desc">API for compiling Scratch scripts </td></tr>
<tr id="row_0_7_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1CompilerConstant.html" target="_self">CompilerConstant</a></td><td class="desc">Constant value in compiled code </td></tr>
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1CompilerContext.html" target="_self">CompilerContext</a></td><td class="desc">The <a class="el" href="classlibscratchcpp_1_1CompilerContext.html" title="The CompilerContext represents a context for a specific target which is used with the Compiler class.">CompilerContext</a> represents a context for a specific target which is used with the <a class="el" href="classlibscratchcpp_1_1Compiler.html" title="The Compiler class provides API for compiling Scratch scripts.">Compiler</a> class </td></tr>
<tr id="row_0_9_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1CompilerLocalVariable.html" target="_self">CompilerLocalVariable</a></td><td class="desc">Statically typed local variable in compiled code </td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1CompilerValue.html" target="_self">CompilerValue</a></td><td class="desc">Local value in compiled code </td></tr>
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Costume.html" target="_self">Costume</a></td><td class="desc">Scratch costume </td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Drawable.html" target="_self">Drawable</a></td><td class="desc">Base class of rendered elements (stage, sprites, text bubbles) </td></tr>
<tr id="row_0_13_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Entity.html" target="_self">Entity</a></td><td class="desc">Base class of everything that is identified by an ID (<a class="el" href="classlibscratchcpp_1_1Target.html" title="The Target class is the Stage or a Sprite.">Target</a>, <a class="el" href="classlibscratchcpp_1_1Variable.html" title="The Variable class represents a Scratch variable.">Variable</a>, <a class="el" href="classlibscratchcpp_1_1List.html" title="The List class represents a Scratch list.">List</a>, etc.) </td></tr>
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1ExecutableCode.html" target="_self">ExecutableCode</a></td><td class="desc">Code of a compiled Scratch script </td></tr>
<tr id="row_0_15_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1ExecutionContext.html" target="_self">ExecutionContext</a></td><td class="desc">The <a class="el" href="classlibscratchcpp_1_1ExecutionContext.html" title="The ExecutionContext represents the execution context of a target (can be a clone) with variables,...">ExecutionContext</a> represents the execution context of a target (can be a clone) with variables, lists, etc </td></tr>
<tr id="row_0_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Field.html" target="_self">Field</a></td><td class="desc">Scratch block field </td></tr>
<tr id="row_0_17_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IEngine.html" target="_self">IEngine</a></td><td class="desc">API for running Scratch projects </td></tr>
<tr id="row_0_18_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IExtension.html" target="_self">IExtension</a></td><td class="desc">Interface for extensions </td></tr>
<tr id="row_0_19_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IGraphicsEffect.html" target="_self">IGraphicsEffect</a></td><td class="desc">The IGraphicsEffects class is an interface for custom graphics effects </td></tr>
<tr id="row_0_20_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IMonitorHandler.html" target="_self">IMonitorHandler</a></td><td class="desc"></td></tr>
<tr id="row_0_21_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Input.html" target="_self">Input</a></td><td class="desc">Scratch block input </td></tr>
<tr id="row_0_22_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1InputValue.html" target="_self">InputValue</a></td><td class="desc">Methods for the value of an <a class="el" href="classlibscratchcpp_1_1Input.html" title="The Input class represents a Scratch block input.">Input</a> </td></tr>
<tr id="row_0_23_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IRandomGenerator.html" target="_self">IRandomGenerator</a></td><td class="desc">Random number generator that can be received e. g. from an <a class="el" href="classlibscratchcpp_1_1ExecutionContext.html" title="The ExecutionContext represents the execution context of a target (can be a clone) with variables,...">ExecutionContext</a> </td></tr>
<tr id="row_0_24_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1ISpriteHandler.html" target="_self">ISpriteHandler</a></td><td class="desc"><a class="el" href="classlibscratchcpp_1_1Sprite.html" title="The Sprite class represents a Scratch sprite.">Sprite</a> interface for Scratch project players </td></tr>
<tr id="row_0_25_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IStackTimer.html" target="_self">IStackTimer</a></td><td class="desc">Timer that can be used by blocks </td></tr>
<tr id="row_0_26_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1IStageHandler.html" target="_self">IStageHandler</a></td><td class="desc"><a class="el" href="classlibscratchcpp_1_1Stage.html" title="The Stage class is the project stage.">Stage</a> interface for Scratch project players </td></tr>
<tr id="row_0_27_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1ITimer.html" target="_self">ITimer</a></td><td class="desc">Timer of a Scratch project </td></tr>
<tr id="row_0_28_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1KeyEvent.html" target="_self">KeyEvent</a></td><td class="desc">Scratch key event </td></tr>
<tr id="row_0_29_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1List.html" target="_self">List</a></td><td class="desc">Scratch list </td></tr>
<tr id="row_0_30_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Monitor.html" target="_self">Monitor</a></td><td class="desc"><a class="el" href="classlibscratchcpp_1_1Stage.html" title="The Stage class is the project stage.">Stage</a> monitor </td></tr>
<tr id="row_0_31_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Project.html" target="_self">Project</a></td><td class="desc">API for reading and running Scratch projects </td></tr>
<tr id="row_0_32_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Promise.html" target="_self">Promise</a></td><td class="desc">Eventual completion of an asynchronous operation </td></tr>
<tr id="row_0_33_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Rect.html" target="_self">Rect</a></td><td class="desc"></td></tr>
<tr id="row_0_34_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1ScratchConfiguration.html" target="_self">ScratchConfiguration</a></td><td class="desc">Methods for adding custom extensions </td></tr>
<tr id="row_0_35_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Script.html" target="_self">Script</a></td><td class="desc">Compiled Scratch script </td></tr>
<tr id="row_0_36_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Sound.html" target="_self">Sound</a></td><td class="desc">Scratch sound </td></tr>
<tr id="row_0_37_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Sprite.html" target="_self">Sprite</a></td><td class="desc">Scratch sprite </td></tr>
<tr id="row_0_38_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Stage.html" target="_self">Stage</a></td><td class="desc"><a class="el" href="classlibscratchcpp_1_1Project.html" title="The Project class provides API for reading and running Scratch projects.">Project</a> stage </td></tr>
<tr id="row_0_39_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlibscratchcpp_1_1StringPtr.html" target="_self">StringPtr</a></td><td class="desc">Holds a string data pointer and string size </td></tr>
<tr id="row_0_40_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Target.html" target="_self">Target</a></td><td class="desc"><a class="el" href="classlibscratchcpp_1_1Stage.html" title="The Stage class is the project stage.">Stage</a> or a <a class="el" href="classlibscratchcpp_1_1Sprite.html" title="The Sprite class represents a Scratch sprite.">Sprite</a> </td></tr>
<tr id="row_0_41_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1TextBubble.html" target="_self">TextBubble</a></td><td class="desc">Text bubble created using say or think block </td></tr>
<tr id="row_0_42_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Thread.html" target="_self">Thread</a></td><td class="desc">Running Scratch script </td></tr>
<tr id="row_0_43_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Value.html" target="_self">Value</a></td><td class="desc">Scratch value </td></tr>
<tr id="row_0_44_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlibscratchcpp_1_1ValueData.html" target="_self">ValueData</a></td><td class="desc">Holds the data of <a class="el" href="classlibscratchcpp_1_1Value.html" title="The Value class represents a Scratch value.">Value</a>. It's used in compiled Scratch code for better performance </td></tr>
<tr id="row_0_45_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classlibscratchcpp_1_1Variable.html" target="_self">Variable</a></td><td class="desc">Scratch variable </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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.13.2 </li>
</ul>
</div>
</body>
</html>