-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_application_context_8hpp_source.html
214 lines (212 loc) · 21.6 KB
/
_application_context_8hpp_source.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>score: ApplicationContext.hpp Source File</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="http://ossia.io">score </a>
</div>
<ul class="nav navbar-nav">
<li class="active"><a href="index.html">Home</a></li>
<li><a href="classes.html">Classes</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="files.html">Files</a></li>
</ul>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel " style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_application_context_8hpp_source.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">
<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">ApplicationContext.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include <score/application/ApplicationComponents.hpp></span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacescore.html">score</a></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span>{</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">class </span>ApplicationComponents;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">struct </span>ApplicationSettings;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">class </span>SettingsDelegateModel;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">class </span>DocumentManager;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">class </span>MenuManager;</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">class </span>ToolbarManager;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">class </span>ActionManager;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">struct </span>DocumentList;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">struct </span>DocumentContext;</div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structscore_1_1_application_context.html"> 23</a></span><span class="keyword">struct </span>SCORE_LIB_BASE_EXPORT <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a></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> <span class="keyword">explicit</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>(</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">const</span> <a class="code hl_struct" href="structscore_1_1_application_settings.html">score::ApplicationSettings</a>&, <span class="keyword">const</span> <a class="code hl_class" href="classscore_1_1_application_components.html">ApplicationComponents</a>&, <a class="code hl_struct" href="structscore_1_1_document_list.html">DocumentList</a>& l,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">const</span> std::vector<std::unique_ptr<score::SettingsDelegateModel>>&);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>(<a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>&&) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>& operator=(<span class="keyword">const</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>&) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_struct" href="structscore_1_1_application_context.html">~ApplicationContext</a>();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structscore_1_1_application_context.html#a00655aa4737305da2087253200d93064"> 40</a></span> T& <a class="code hl_function" href="structscore_1_1_application_context.html#a00655aa4737305da2087253200d93064">settings</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">for</span>(<span class="keyword">auto</span>& elt : this->m_settings)</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="keywordflow">if</span>(<span class="keyword">auto</span> c = <span class="keyword">dynamic_cast<</span>T*<span class="keyword">></span>(elt.get()))</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">return</span> *c;</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> }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> SCORE_ABORT;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">throw</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="structscore_1_1_application_context.html#a5ab7160ce378a711b3f5b9f28d9ead14"> 59</a></span> <span class="keyword">const</span> <span class="keyword">auto</span>& <a class="code hl_function" href="structscore_1_1_application_context.html#a5ab7160ce378a711b3f5b9f28d9ead14">addons</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> components.addons(); }</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="foldopen" id="foldopen00067" data-start="{" data-end="}">
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="structscore_1_1_application_context.html#af021fe95f288b8657dad09af97e67fe5"> 67</a></span> <span class="keyword">const</span> T& <a class="code hl_function" href="structscore_1_1_application_context.html#af021fe95f288b8657dad09af97e67fe5">interfaces</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> components.interfaces<T>();</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="foldopen" id="foldopen00083" data-start="{" data-end="}">
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="structscore_1_1_application_context.html#ae40c943760793bab6015490e56a44d34"> 83</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="structscore_1_1_application_context.html#ae40c943760793bab6015490e56a44d34">instantiateUndoCommand</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structscore_1_1_command_data.html">CommandData</a>& cmd)<span class="keyword"> const</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">return</span> components.instantiateUndoCommand(cmd);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div>
</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">const</span> <a class="code hl_struct" href="structscore_1_1_document_context.html">score::DocumentContext</a>* currentDocument() const noexcept;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="structscore_1_1_application_context.html#a63ad78c9bf47c24bb16edecf48eac2b3"> 91</a></span> const <a class="code hl_namespace" href="namespacescore.html">score</a>::<a class="code hl_struct" href="structscore_1_1_application_settings.html">ApplicationSettings</a>& applicationSettings;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> const <a class="code hl_namespace" href="namespacescore.html">score</a>::<a class="code hl_class" href="classscore_1_1_application_components.html">ApplicationComponents</a>& components;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_struct" href="structscore_1_1_document_list.html">DocumentList</a>& documents;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>private:</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> const <a class="code hl_namespace" href="namespacestd.html">std</a>::vector<<a class="code hl_namespace" href="namespacestd.html">std</a>::unique_ptr<<a class="code hl_namespace" href="namespacescore.html">score</a>::<a class="code hl_class" href="classscore_1_1_settings_delegate_model.html">SettingsDelegateModel</a>>>& m_settings;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>};</div>
</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment">// By default this is defined in score::Application</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>SCORE_LIB_BASE_EXPORT const <a class="code hl_struct" href="structscore_1_1_application_context.html">ApplicationContext</a>& AppContext();</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>}</div>
<div class="ttc" id="aclassscore_1_1_application_components_html"><div class="ttname"><a href="classscore_1_1_application_components.html">score::ApplicationComponents</a></div><div class="ttdef"><b>Definition</b> ApplicationComponents.hpp:68</div></div>
<div class="ttc" id="aclassscore_1_1_settings_delegate_model_html"><div class="ttname"><a href="classscore_1_1_settings_delegate_model.html">score::SettingsDelegateModel</a></div><div class="ttdef"><b>Definition</b> SettingsDelegateModel.hpp:16</div></div>
<div class="ttc" id="anamespacescore_html"><div class="ttname"><a href="namespacescore.html">score</a></div><div class="ttdoc">Base toolkit upon which the software is built.</div><div class="ttdef"><b>Definition</b> Application.cpp:90</div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
<div class="ttc" id="astructscore_1_1_application_context_html"><div class="ttname"><a href="structscore_1_1_application_context.html">score::ApplicationContext</a></div><div class="ttdoc">Used to access all the application-wide state and structures.</div><div class="ttdef"><b>Definition</b> ApplicationContext.hpp:24</div></div>
<div class="ttc" id="astructscore_1_1_application_context_html_a00655aa4737305da2087253200d93064"><div class="ttname"><a href="structscore_1_1_application_context.html#a00655aa4737305da2087253200d93064">score::ApplicationContext::settings</a></div><div class="ttdeci">T & settings() const</div><div class="ttdoc">Access a specific Settings model instance.</div><div class="ttdef"><b>Definition</b> ApplicationContext.hpp:40</div></div>
<div class="ttc" id="astructscore_1_1_application_context_html_a5ab7160ce378a711b3f5b9f28d9ead14"><div class="ttname"><a href="structscore_1_1_application_context.html#a5ab7160ce378a711b3f5b9f28d9ead14">score::ApplicationContext::addons</a></div><div class="ttdeci">const auto & addons() const</div><div class="ttdoc">List of all the registered addons.</div><div class="ttdef"><b>Definition</b> ApplicationContext.hpp:59</div></div>
<div class="ttc" id="astructscore_1_1_application_context_html_ae40c943760793bab6015490e56a44d34"><div class="ttname"><a href="structscore_1_1_application_context.html#ae40c943760793bab6015490e56a44d34">score::ApplicationContext::instantiateUndoCommand</a></div><div class="ttdeci">auto instantiateUndoCommand(const CommandData &cmd) const</div><div class="ttdoc">instantiateUndoCommand Is used to generate a Command from its serialized data.</div><div class="ttdef"><b>Definition</b> ApplicationContext.hpp:83</div></div>
<div class="ttc" id="astructscore_1_1_application_context_html_af021fe95f288b8657dad09af97e67fe5"><div class="ttname"><a href="structscore_1_1_application_context.html#af021fe95f288b8657dad09af97e67fe5">score::ApplicationContext::interfaces</a></div><div class="ttdeci">const T & interfaces() const</div><div class="ttdoc">Access to a specific interface list.</div><div class="ttdef"><b>Definition</b> ApplicationContext.hpp:67</div></div>
<div class="ttc" id="astructscore_1_1_application_settings_html"><div class="ttname"><a href="structscore_1_1_application_settings.html">score::ApplicationSettings</a></div><div class="ttdoc">Load-time settings.</div><div class="ttdef"><b>Definition</b> ApplicationSettings.hpp:17</div></div>
<div class="ttc" id="astructscore_1_1_command_data_html"><div class="ttname"><a href="structscore_1_1_command_data.html">score::CommandData</a></div><div class="ttdoc">Utility class for the serialization and deserialization of commands.</div><div class="ttdef"><b>Definition</b> CommandData.hpp:14</div></div>
<div class="ttc" id="astructscore_1_1_document_context_html"><div class="ttname"><a href="structscore_1_1_document_context.html">score::DocumentContext</a></div><div class="ttdef"><b>Definition</b> DocumentContext.hpp:18</div></div>
<div class="ttc" id="astructscore_1_1_document_list_html"><div class="ttname"><a href="structscore_1_1_document_list.html">score::DocumentList</a></div><div class="ttdef"><b>Definition</b> DocumentManager.hpp:28</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>