Repository navigation
Expand file tree
/
Copy pathblockprototype_8h_source.html
More file actions
185 lines (183 loc) · 14.3 KB
/
Copy pathblockprototype_8h_source.html
File metadata and controls
185 lines (183 loc) · 14.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<!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.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libscratchcpp: include/scratchcpp/blockprototype.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.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="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.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
"relPath": "",
"generateTreeView": true,
"searchEngine": true,
"serverBasedSearch": false,
"disableIndex": false,
"dynamicMenus": true,
"fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div><!-- main-nav -->
</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" class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('blockprototype_8h_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</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">blockprototype.h</div></div>
</div><!--header-->
<div class="contents">
<a href="blockprototype_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// SPDX-License-Identifier: Apache-2.0</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <vector></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "spimpl.h"</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "<a class="code" href="value_8h.html">value.h</a>"</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacelibscratchcpp.html">libscratchcpp</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">class </span>BlockPrototypePrivate;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span></div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classlibscratchcpp_1_1BlockPrototype.html"> 16</a></span><span class="keyword">class </span><a class="code hl_define" href="global_8h.html#a84ccbedd3b0c141a22802b00c2af538c">LIBSCRATCHCPP_EXPORT</a> <a class="code hl_function" href="classlibscratchcpp_1_1BlockPrototype.html#acc4013d2352e4ebc6ec740fb25e5ae73">BlockPrototype</a></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classlibscratchcpp_1_1BlockPrototype.html#a85b147c06d54b935d3c0c406b275840e"> 19</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classlibscratchcpp_1_1BlockPrototype.html#a85b147c06d54b935d3c0c406b275840e">ArgType</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classlibscratchcpp_1_1BlockPrototype.html#a85b147c06d54b935d3c0c406b275840ea4f1ac32bbc5d5c055d75869332a6129d"> 21</a></span> StringNum,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classlibscratchcpp_1_1BlockPrototype.html#a85b147c06d54b935d3c0c406b275840eac26f15e86e3de4c398a8273272aba034"> 22</a></span> <a class="code hl_variable" href="valuedata_8h.html#a39db6982619d623273fad8a383489309">Bool</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> };</div>
</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_class" href="classlibscratchcpp_1_1BlockPrototype.html">BlockPrototype</a>();</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_class" href="classlibscratchcpp_1_1BlockPrototype.html">BlockPrototype</a>(<span class="keyword">const</span> std::string &procCode);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">const</span> std::string &procCode() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">void</span> setProcCode(<span class="keyword">const</span> std::string &newProcCode);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">const</span> std::vector<std::string> &argumentIds() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> setArgumentIds(<span class="keyword">const</span> std::vector<std::string> &newArgumentIds);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">const</span> std::vector<std::string> &argumentNames() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> setArgumentNames(<span class="keyword">const</span> std::vector<std::string> &newArgumentNames);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">const</span> std::vector<Value> &argumentDefaults() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> std::vector<ArgType> &argumentTypes() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">bool</span> warp() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> setWarp(<span class="keywordtype">bool</span> newWarp);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> spimpl::impl_ptr<BlockPrototypePrivate> impl;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>};</div>
</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>} <span class="comment">// namespace libscratchcpp</span></div>
<div class="ttc" id="aclasslibscratchcpp_1_1BlockPrototype_html"><div class="ttname"><a href="classlibscratchcpp_1_1BlockPrototype.html">libscratchcpp::BlockPrototype</a></div><div class="ttdoc">The BlockPrototype class represents the prototype of a custom block.</div><div class="ttdef"><b>Definition</b> blockprototype.h:17</div></div>
<div class="ttc" id="aclasslibscratchcpp_1_1BlockPrototype_html_a85b147c06d54b935d3c0c406b275840e"><div class="ttname"><a href="classlibscratchcpp_1_1BlockPrototype.html#a85b147c06d54b935d3c0c406b275840e">libscratchcpp::BlockPrototype::ArgType</a></div><div class="ttdeci">ArgType</div><div class="ttdef"><b>Definition</b> blockprototype.h:20</div></div>
<div class="ttc" id="aclasslibscratchcpp_1_1BlockPrototype_html_acc4013d2352e4ebc6ec740fb25e5ae73"><div class="ttname"><a href="classlibscratchcpp_1_1BlockPrototype.html#acc4013d2352e4ebc6ec740fb25e5ae73">libscratchcpp::BlockPrototype::BlockPrototype</a></div><div class="ttdeci">BlockPrototype()</div><div class="ttdef"><b>Definition</b> blockprototype.cpp:10</div></div>
<div class="ttc" id="aglobal_8h_html_a84ccbedd3b0c141a22802b00c2af538c"><div class="ttname"><a href="global_8h.html#a84ccbedd3b0c141a22802b00c2af538c">LIBSCRATCHCPP_EXPORT</a></div><div class="ttdeci">#define LIBSCRATCHCPP_EXPORT</div><div class="ttdef"><b>Definition</b> global.h:17</div></div>
<div class="ttc" id="anamespacelibscratchcpp_html"><div class="ttname"><a href="namespacelibscratchcpp.html">libscratchcpp</a></div><div class="ttdoc">The main namespace of the library.</div><div class="ttdef"><b>Definition</b> asset.h:10</div></div>
<div class="ttc" id="avalue_8h_html"><div class="ttname"><a href="value_8h.html">value.h</a></div></div>
<div class="ttc" id="avaluedata_8h_html_a39db6982619d623273fad8a383489309"><div class="ttname"><a href="valuedata_8h.html#a39db6982619d623273fad8a383489309">Bool</a></div><div class="ttdeci">Bool</div><div class="ttdef"><b>Definition</b> valuedata.h:17</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_afeb8442df62db3d6112bcf897ce1e5f.html">scratchcpp</a></li><li class="navelem"><a href="blockprototype_8h.html">blockprototype.h</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.18.0 </li>
</ul>
</div>
</body>
</html>