-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__gui__dialogs___text_viewer.html
203 lines (199 loc) · 12.9 KB
/
group__cpp__kodi__gui__dialogs___text_viewer.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
<!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: Dialog Text Viewer</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('group__cpp__kodi__gui__dialogs___text_viewer.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="headertitle">
<div class="title">Dialog Text Viewer<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__gui.html">Interface - kodi::gui</a> » <a class="el" href="group__cpp__kodi__gui__dialogs.html">2. Dialogs</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p> <h4><code><span style="font-style: italic;">Namespace: </span><span style="font-style: bold;"><font color=31363b><big> kodi::gui::dialogs::TextViewer </big></font></span></code></h4> <b>Text viewer dialog</b><br />
The text viewer dialog can be used to display descriptions, help texts or other larger texts. </p>
<p>In order to achieve a line break is a <b>\n</b> directly in the text or in the <em>"./resources/language/resource.language.??_??/strings.po"</em> to call with <b>std::string kodi::general::GetLocalizedString(...);</b>.</p>
<p>It has the header <a class="el" href="_text_viewer_8h_source.html">#include <kodi/gui/dialogs/TextViewer.h></a> be included to enjoy it. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabed1c74c41956fbd6bba949aba60b93c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabed1c74c41956fbd6bba949aba60b93c">◆ </a></span>Show()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ATTRIBUTE_HIDDEN kodi::gui::dialogs::TextViewer::Show </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>heading</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show info text dialog. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">heading</td><td>mall heading text </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>Showed text on dialog</td></tr>
</table>
</dd>
</dl>
<hr />
<p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include <kodi/gui/dialogs/TextViewer.h></span></div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__gui__dialogs___context_menu.html#ga56ee6fca3c5ee198a0668909a5d169d4">kodi::gui::dialogs::TextViewer::Show</a>(<span class="stringliteral">"The Wizard of Oz (1939 film)"</span>,</div>
<div class="line"> <span class="stringliteral">"The Wizard of Oz is a 1939 American musical comedy-drama fantasy film "</span></div>
<div class="line"> <span class="stringliteral">"produced by Metro-Goldwyn-Mayer, and the most well-known and commercially "</span></div>
<div class="line"> <span class="stringliteral">"successful adaptation based on the 1900 novel The Wonderful Wizard of Oz "</span></div>
<div class="line"> <span class="stringliteral">"by L. Frank Baum. The film stars Judy Garland as Dorothy Gale. The film"</span></div>
<div class="line"> <span class="stringliteral">"co-stars Terry the dog, billed as Toto; Ray Bolger, Jack Haley, Bert Lahr, "</span></div>
<div class="line"> <span class="stringliteral">"Frank Morgan, Billie Burke, Margaret Hamilton, with Charley Grapewin and "</span></div>
<div class="line"> <span class="stringliteral">"Clara Blandick, and the Singer Midgets as the Munchkins.\n"</span></div>
<div class="line"> <span class="stringliteral">"\n"</span></div>
<div class="line"> <span class="stringliteral">"Notable for its use of Technicolor, fantasy storytelling, musical score and "</span></div>
<div class="line"> <span class="stringliteral">"unusual characters, over the years it has become an icon of American popular "</span></div>
<div class="line"> <span class="stringliteral">"culture. It was nominated for six Academy Awards, including Best Picture but "</span></div>
<div class="line"> <span class="stringliteral">"lost to Gone with the Wind. It did win in two other categories including Best "</span></div>
<div class="line"> <span class="stringliteral">"Original Song for \"Over the Rainbow\". However, the film was a box office "</span></div>
<div class="line"> <span class="stringliteral">"disappointment on its initial release, earning only $3,017,000 on a $2,777,000 "</span></div>
<div class="line"> <span class="stringliteral">"budget, despite receiving largely positive reviews. It was MGM's most "</span></div>
<div class="line"> <span class="stringliteral">"expensive production at that time, and did not completely recoup the studio's "</span></div>
<div class="line"> <span class="stringliteral">"investment and turn a profit until theatrical re-releases starting in 1949.\n"</span></div>
<div class="line"> <span class="stringliteral">"\n"</span></div>
<div class="line"> <span class="stringliteral">"The 1956 broadcast television premiere of the film on CBS re-introduced the "</span></div>
<div class="line"> <span class="stringliteral">"film to the wider public and eventually made the presentation an annual "</span></div>
<div class="line"> <span class="stringliteral">"tradition, making it one of the most known films in cinema history. The "</span></div>
<div class="line"> <span class="stringliteral">"film was named the most-viewed motion picture on television syndication by "</span></div>
<div class="line"> <span class="stringliteral">"the Library of Congress who also included the film in its National Film "</span></div>
<div class="line"> <span class="stringliteral">"Registry in its inaugural year in 1989. Designation on the registry calls "</span></div>
<div class="line"> <span class="stringliteral">"for efforts to preserve it for being \"culturally, historically, and "</span></div>
<div class="line"> <span class="stringliteral">"aesthetically significant\". It is also one of the few films on UNESCO's "</span></div>
<div class="line"> <span class="stringliteral">"Memory of the World Register.\n"</span></div>
<div class="line"> <span class="stringliteral">"\n"</span></div>
<div class="line"> <span class="stringliteral">"The Wizard of Oz is often ranked on best-movie lists in critics' and public "</span></div>
<div class="line"> <span class="stringliteral">"polls. It is the source of many quotes referenced in modern popular culture. "</span></div>
<div class="line"> <span class="stringliteral">"It was directed primarily by Victor Fleming (who left production to take "</span></div>
<div class="line"> <span class="stringliteral">"over direction on the troubled Gone with the Wind production). Noel Langley, "</span></div>
<div class="line"> <span class="stringliteral">"Florence Ryerson and Edgar Allan Woolf received credit for the screenplay, "</span></div>
<div class="line"> <span class="stringliteral">"but there were uncredited contributions by others. The songs were written "</span></div>
<div class="line"> <span class="stringliteral">"by Edgar \"Yip\" Harburg (lyrics) and Harold Arlen (music). The incidental "</span></div>
<div class="line"> <span class="stringliteral">"music, based largely on the songs, was composed by Herbert Stothart, with "</span></div>
<div class="line"> <span class="stringliteral">"interspersed renderings from classical composers.\n"</span>);</div>
<div class="ttc" id="agroup__cpp__kodi__gui__dialogs___context_menu_html_ga56ee6fca3c5ee198a0668909a5d169d4"><div class="ttname"><a href="group__cpp__kodi__gui__dialogs___context_menu.html#ga56ee6fca3c5ee198a0668909a5d169d4">kodi::gui::dialogs::ContextMenu::Show</a></div><div class="ttdeci">int ATTRIBUTE_HIDDEN Show(const std::string &heading, const std::vector< std::string > &entries)</div><div class="ttdoc">Show a context menu dialog about given parts.</div><div class="ttdef"><b>Definition:</b> ContextMenu.h:68</div></div>
</div><!-- fragment -->
</div>
</div>
</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.9.1 </li>
</ul>
</div>
</body>
</html>