/usr/share/doc/libjuce/apiref/classNativeMessageBox.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <!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="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: NativeMessageBox Class Reference</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="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" />
</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classNativeMessageBox-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NativeMessageBox Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class contains some static methods for showing native alert windows.
<a href="classNativeMessageBox.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4f5c4b3d945b5f9f7a034fcd4a05b1b3"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNativeMessageBox.html#a4f5c4b3d945b5f9f7a034fcd4a05b1b3">showMessageBox</a> (<a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> iconType, const <a class="el" href="classString.html">String</a> &title, const <a class="el" href="classString.html">String</a> &message, <a class="el" href="classComponent.html">Component</a> *associatedComponent=nullptr)</td></tr>
<tr class="memdesc:a4f5c4b3d945b5f9f7a034fcd4a05b1b3"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box that just has a message and a single 'ok' button to close it. <a href="#a4f5c4b3d945b5f9f7a034fcd4a05b1b3">More...</a><br /></td></tr>
<tr class="separator:a4f5c4b3d945b5f9f7a034fcd4a05b1b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafc1ea7cf5c78b7512b4f8747a635513"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNativeMessageBox.html#aafc1ea7cf5c78b7512b4f8747a635513">showMessageBoxAsync</a> (<a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> iconType, const <a class="el" href="classString.html">String</a> &title, const <a class="el" href="classString.html">String</a> &message, <a class="el" href="classComponent.html">Component</a> *associatedComponent=nullptr, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback=nullptr)</td></tr>
<tr class="memdesc:aafc1ea7cf5c78b7512b4f8747a635513"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box that just has a message and a single 'ok' button to close it. <a href="#aafc1ea7cf5c78b7512b4f8747a635513">More...</a><br /></td></tr>
<tr class="separator:aafc1ea7cf5c78b7512b4f8747a635513"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89552c16933a6f9620cbfc20c9b14376"><td class="memItemLeft" align="right" valign="top">static bool <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNativeMessageBox.html#a89552c16933a6f9620cbfc20c9b14376">showOkCancelBox</a> (<a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> iconType, const <a class="el" href="classString.html">String</a> &title, const <a class="el" href="classString.html">String</a> &message, <a class="el" href="classComponent.html">Component</a> *associatedComponent=nullptr, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback=nullptr)</td></tr>
<tr class="memdesc:a89552c16933a6f9620cbfc20c9b14376"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box with two buttons. <a href="#a89552c16933a6f9620cbfc20c9b14376">More...</a><br /></td></tr>
<tr class="separator:a89552c16933a6f9620cbfc20c9b14376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e7c585bcb1a775e40ab014267ebc200"><td class="memItemLeft" align="right" valign="top">static int <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNativeMessageBox.html#a1e7c585bcb1a775e40ab014267ebc200">showYesNoCancelBox</a> (<a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> iconType, const <a class="el" href="classString.html">String</a> &title, const <a class="el" href="classString.html">String</a> &message, <a class="el" href="classComponent.html">Component</a> *associatedComponent=nullptr, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback=nullptr)</td></tr>
<tr class="memdesc:a1e7c585bcb1a775e40ab014267ebc200"><td class="mdescLeft"> </td><td class="mdescRight">Shows a dialog box with three buttons. <a href="#a1e7c585bcb1a775e40ab014267ebc200">More...</a><br /></td></tr>
<tr class="separator:a1e7c585bcb1a775e40ab014267ebc200"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class contains some static methods for showing native alert windows. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4f5c4b3d945b5f9f7a034fcd4a05b1b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f5c4b3d945b5f9f7a034fcd4a05b1b3">§ </a></span>showMessageBox()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> NativeMessageBox::showMessageBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> </td>
<td class="paramname"><em>iconType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>associatedComponent</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box that just has a message and a single 'ok' button to close it. </p>
<p>The box is shown modally, and the method will block until the user has clicked its button (or pressed the escape or return keys).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iconType</td><td>the type of icon to show </td></tr>
<tr><td class="paramname">title</td><td>the headline to show at the top of the box </td></tr>
<tr><td class="paramname">message</td><td>a longer, more descriptive message to show underneath the title </td></tr>
<tr><td class="paramname">associatedComponent</td><td>if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aafc1ea7cf5c78b7512b4f8747a635513"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafc1ea7cf5c78b7512b4f8747a635513">§ </a></span>showMessageBoxAsync()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> NativeMessageBox::showMessageBoxAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> </td>
<td class="paramname"><em>iconType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>associatedComponent</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box that just has a message and a single 'ok' button to close it. </p>
<p>The box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iconType</td><td>the type of icon to show </td></tr>
<tr><td class="paramname">title</td><td>the headline to show at the top of the box </td></tr>
<tr><td class="paramname">message</td><td>a longer, more descriptive message to show underneath the title </td></tr>
<tr><td class="paramname">associatedComponent</td><td>if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. </td></tr>
<tr><td class="paramname">callback</td><td>if this is non-null, the callback will receive a call to its modalStateFinished() when the box is dismissed. The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a89552c16933a6f9620cbfc20c9b14376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89552c16933a6f9620cbfc20c9b14376">§ </a></span>showOkCancelBox()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> NativeMessageBox::showOkCancelBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> </td>
<td class="paramname"><em>iconType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>associatedComponent</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box with two buttons. </p>
<p>Ideal for ok/cancel or yes/no choices. The return key can also be used to trigger the first button, and the escape key for the second button.</p>
<p>If the callback parameter is null, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iconType</td><td>the type of icon to show </td></tr>
<tr><td class="paramname">title</td><td>the headline to show at the top of the box </td></tr>
<tr><td class="paramname">message</td><td>a longer, more descriptive message to show underneath the title </td></tr>
<tr><td class="paramname">associatedComponent</td><td>if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. </td></tr>
<tr><td class="paramname">callback</td><td>if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the ok button was pressed, or 0 for cancel, The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if button 1 was clicked, false if it was button 2. If the callback parameter is not null, the method always returns false, and the user's choice is delivered later by the callback. </dd></dl>
</div>
</div>
<a id="a1e7c585bcb1a775e40ab014267ebc200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e7c585bcb1a775e40ab014267ebc200">§ </a></span>showYesNoCancelBox()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> NativeMessageBox::showYesNoCancelBox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classAlertWindow.html#a2582d1f79937cb47a6a3764c7d9bdba3">AlertWindow::AlertIconType</a> </td>
<td class="paramname"><em>iconType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>associatedComponent</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a dialog box with three buttons. </p>
<p>Ideal for yes/no/cancel boxes.</p>
<p>The escape key can be used to trigger the third button.</p>
<p>If the callback parameter is null, the box is shown modally, and the method will block until the user has clicked the button (or pressed the escape or return keys). If the callback parameter is non-null, the box will be displayed and placed into a modal state, but this method will return immediately, and the callback will be invoked later when the user dismisses the box.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">iconType</td><td>the type of icon to show </td></tr>
<tr><td class="paramname">title</td><td>the headline to show at the top of the box </td></tr>
<tr><td class="paramname">message</td><td>a longer, more descriptive message to show underneath the title </td></tr>
<tr><td class="paramname">associatedComponent</td><td>if this is non-null, it specifies the component that the alert window should be associated with. Depending on the look and feel, this might be used for positioning of the alert window. </td></tr>
<tr><td class="paramname">callback</td><td>if this is non-null, the box will be launched asynchronously, returning immediately, and the callback will receive a call to its modalStateFinished() when the box is dismissed, with its parameter being 1 if the "yes" button was pressed, 2 for the "no" button, or 0 if it was cancelled, The callback object will be owned and deleted by the system, so make sure that it works safely and doesn't keep any references to objects that might be deleted before it gets called.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the callback parameter has been set, this returns 0. Otherwise, it returns one of the following values:<ul>
<li>0 if 'cancel' was pressed</li>
<li>1 if 'yes' was pressed</li>
<li>2 if 'no' was pressed </li>
</ul>
</dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__NativeMessageBox_8h.html">juce_NativeMessageBox.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|