Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 220 files). Show all
Unified · Split
| @@ -22,7 +22,7 @@ · 21 unmodified lines | |||
| 22 | 22 | ||
| 23 | #include <DependencyManager.h> | 23 | #include <DependencyManager.h> |
| 24 | 24 | ||
| 25 | /**jsdoc | 25 | /*@jsdoc |
| 26 | * The <code>Window</code> API provides various facilities not covered elsewhere, including: window dimensions, window focus, | 26 | * The <code>Window</code> API provides various facilities not covered elsewhere, including: window dimensions, window focus, |
| 27 | * camera view, announcements, user connections, common dialog boxes, snapshots, file import, domain navigation, domain changes, | 27 | * camera view, announcements, user connections, common dialog boxes, snapshots, file import, domain navigation, domain changes, |
| 28 | * domain physics, OS clipboard, build number. | 28 | * domain physics, OS clipboard, build number. |
| @@ -64,27 +64,27 @@ public: · 35 unmodified lines | |||
| 64 | 64 | ||
| 65 | public slots: | 65 | public slots: |
| 66 | 66 | ||
| 67 | /**jsdoc | 67 | /*@jsdoc |
| 68 | * Checks whether the Interface window has focus. | 68 | * Checks whether the Interface window has focus. |
| 69 | * @function Window.hasFocus | 69 | * @function Window.hasFocus |
| 70 | * @returns {boolean} <code>true</code> if the Interface window has focus, <code>false</code> if it doesn't. | 70 | * @returns {boolean} <code>true</code> if the Interface window has focus, <code>false</code> if it doesn't. |
| 71 | */ | 71 | */ |
| 72 | QScriptValue hasFocus(); | 72 | QScriptValue hasFocus(); |
| 73 | 73 | ||
| 74 | /**jsdoc | 74 | /*@jsdoc |
| 75 | * Makes the Interface window have focus. On Windows, if Interface doesn't already have focus, the task bar icon flashes to | 75 | * Makes the Interface window have focus. On Windows, if Interface doesn't already have focus, the task bar icon flashes to |
| 76 | * indicate that Interface wants attention but focus isn't taken away from the application that the user is using. | 76 | * indicate that Interface wants attention but focus isn't taken away from the application that the user is using. |
| 77 | * @function Window.setFocus | 77 | * @function Window.setFocus |
| 78 | */ | 78 | */ |
| 79 | void setFocus(); | 79 | void setFocus(); |
| 80 | 80 | ||
| 81 | /**jsdoc | 81 | /*@jsdoc |
| 82 | * Raises the Interface window if it is minimized. If raised, the window gains focus. | 82 | * Raises the Interface window if it is minimized. If raised, the window gains focus. |
| 83 | * @function Window.raise | 83 | * @function Window.raise |
| 84 | */ | 84 | */ |
| 85 | void raise(); | 85 | void raise(); |
| 86 | 86 | ||
| 87 | /**jsdoc | 87 | /*@jsdoc |
| 88 | * Displays a dialog with the specified message and an "OK" button. The dialog is non-modal; the script continues without | 88 | * Displays a dialog with the specified message and an "OK" button. The dialog is non-modal; the script continues without |
| 89 | * waiting for a user response. | 89 | * waiting for a user response. |
| 90 | * @function Window.alert | 90 | * @function Window.alert |
| @@ -95,7 +95,7 @@ public slots: · 4 unmodified lines | |||
| 95 | */ | 95 | */ |
| 96 | void alert(const QString& message = ""); | 96 | void alert(const QString& message = ""); |
| 97 | 97 | ||
| 98 | /**jsdoc | 98 | /*@jsdoc |
| 99 | * Prompts the user to confirm something. Displays a modal dialog with a message plus "Yes" and "No" buttons. | 99 | * Prompts the user to confirm something. Displays a modal dialog with a message plus "Yes" and "No" buttons. |
| 100 | * @function Window.confirm | 100 | * @function Window.confirm |
| 101 | * @param {string} [message=""] - The question to display. | 101 | * @param {string} [message=""] - The question to display. |
| @@ -106,7 +106,7 @@ public slots: · 4 unmodified lines | |||
| 106 | */ | 106 | */ |
| 107 | QScriptValue confirm(const QString& message = ""); | 107 | QScriptValue confirm(const QString& message = ""); |
| 108 | 108 | ||
| 109 | /**jsdoc | 109 | /*@jsdoc |
| 110 | * Prompts the user to enter some text. Displays a modal dialog with a message and a text box, plus "OK" and "Cancel" | 110 | * Prompts the user to enter some text. Displays a modal dialog with a message and a text box, plus "OK" and "Cancel" |
| 111 | * buttons. | 111 | * buttons. |
| 112 | * @function Window.prompt | 112 | * @function Window.prompt |
| @@ -123,7 +123,7 @@ public slots: · 10 unmodified lines | |||
| 123 | */ | 123 | */ |
| 124 | QScriptValue prompt(const QString& message, const QString& defaultText); | 124 | QScriptValue prompt(const QString& message, const QString& defaultText); |
| 125 | 125 | ||
| 126 | /**jsdoc | 126 | /*@jsdoc |
| 127 | * Prompts the user to enter some text. Displays a non-modal dialog with a message and a text box, plus "OK" and "Cancel" | 127 | * Prompts the user to enter some text. Displays a non-modal dialog with a message and a text box, plus "OK" and "Cancel" |
| 128 | * buttons. A {@link Window.promptTextChanged|promptTextChanged} signal is emitted when the user OKs the dialog; no signal | 128 | * buttons. A {@link Window.promptTextChanged|promptTextChanged} signal is emitted when the user OKs the dialog; no signal |
| 129 | * is emitted if the user cancels the dialog. | 129 | * is emitted if the user cancels the dialog. |
| @@ -141,7 +141,7 @@ public slots: · 11 unmodified lines | |||
| 141 | */ | 141 | */ |
| 142 | void promptAsync(const QString& message = "", const QString& defaultText = ""); | 142 | void promptAsync(const QString& message = "", const QString& defaultText = ""); |
| 143 | 143 | ||
| 144 | /**jsdoc | 144 | /*@jsdoc |
| 145 | * Prompts the user to choose a directory. Displays a modal dialog that navigates the directory tree. | 145 | * Prompts the user to choose a directory. Displays a modal dialog that navigates the directory tree. |
| 146 | * @function Window.browseDir | 146 | * @function Window.browseDir |
| 147 | * @param {string} [title=""] - The title to display at the top of the dialog. | 147 | * @param {string} [title=""] - The title to display at the top of the dialog. |
| @@ -153,7 +153,7 @@ public slots: · 5 unmodified lines | |||
| 153 | */ | 153 | */ |
| 154 | QScriptValue browseDir(const QString& title = "", const QString& directory = ""); | 154 | QScriptValue browseDir(const QString& title = "", const QString& directory = ""); |
| 155 | 155 | ||
| 156 | /**jsdoc | 156 | /*@jsdoc |
| 157 | * Prompts the user to choose a directory. Displays a non-modal dialog that navigates the directory tree. A | 157 | * Prompts the user to choose a directory. Displays a non-modal dialog that navigates the directory tree. A |
| 158 | * {@link Window.browseDirChanged|browseDirChanged} signal is emitted when a directory is chosen; no signal is emitted if | 158 | * {@link Window.browseDirChanged|browseDirChanged} signal is emitted when a directory is chosen; no signal is emitted if |
| 159 | * the user cancels the dialog. | 159 | * the user cancels the dialog. |
| @@ -171,7 +171,7 @@ public slots: · 11 unmodified lines | |||
| 171 | */ | 171 | */ |
| 172 | void browseDirAsync(const QString& title = "", const QString& directory = ""); | 172 | void browseDirAsync(const QString& title = "", const QString& directory = ""); |
| 173 | 173 | ||
| 174 | /**jsdoc | 174 | /*@jsdoc |
| 175 | * Prompts the user to choose a file. Displays a modal dialog that navigates the directory tree. | 175 | * Prompts the user to choose a file. Displays a modal dialog that navigates the directory tree. |
| 176 | * @function Window.browse | 176 | * @function Window.browse |
| 177 | * @param {string} [title=""] - The title to display at the top of the dialog. | 177 | * @param {string} [title=""] - The title to display at the top of the dialog. |
| @@ -185,7 +185,7 @@ public slots: · 7 unmodified lines | |||
| 185 | */ | 185 | */ |
| 186 | QScriptValue browse(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); | 186 | QScriptValue browse(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); |
| 187 | 187 | ||
| 188 | /**jsdoc | 188 | /*@jsdoc |
| 189 | * Prompts the user to choose a file. Displays a non-modal dialog that navigates the directory tree. A | 189 | * Prompts the user to choose a file. Displays a non-modal dialog that navigates the directory tree. A |
| 190 | * {@link Window.browseChanged|browseChanged} signal is emitted when a file is chosen; no signal is emitted if the user | 190 | * {@link Window.browseChanged|browseChanged} signal is emitted when a file is chosen; no signal is emitted if the user |
| 191 | * cancels the dialog. | 191 | * cancels the dialog. |
| @@ -205,7 +205,7 @@ public slots: · 13 unmodified lines | |||
| 205 | */ | 205 | */ |
| 206 | void browseAsync(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); | 206 | void browseAsync(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); |
| 207 | 207 | ||
| 208 | /**jsdoc | 208 | /*@jsdoc |
| 209 | * Prompts the user to specify the path and name of a file to save to. Displays a modal dialog that navigates the directory | 209 | * Prompts the user to specify the path and name of a file to save to. Displays a modal dialog that navigates the directory |
| 210 | * tree and allows the user to type in a file name. | 210 | * tree and allows the user to type in a file name. |
| 211 | * @function Window.save | 211 | * @function Window.save |
| @@ -221,7 +221,7 @@ public slots: · 9 unmodified lines | |||
| 221 | */ | 221 | */ |
| 222 | QScriptValue save(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); | 222 | QScriptValue save(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); |
| 223 | 223 | ||
| 224 | /**jsdoc | 224 | /*@jsdoc |
| 225 | * Prompts the user to specify the path and name of a file to save to. Displays a non-modal dialog that navigates the | 225 | * Prompts the user to specify the path and name of a file to save to. Displays a non-modal dialog that navigates the |
| 226 | * directory tree and allows the user to type in a file name. A {@link Window.saveFileChanged|saveFileChanged} signal is | 226 | * directory tree and allows the user to type in a file name. A {@link Window.saveFileChanged|saveFileChanged} signal is |
| 227 | * emitted when a file is specified; no signal is emitted if the user cancels the dialog. | 227 | * emitted when a file is specified; no signal is emitted if the user cancels the dialog. |
| @@ -241,7 +241,7 @@ public slots: · 13 unmodified lines | |||
| 241 | */ | 241 | */ |
| 242 | void saveAsync(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); | 242 | void saveAsync(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); |
| 243 | 243 | ||
| 244 | /**jsdoc | 244 | /*@jsdoc |
| 245 | * Prompts the user to choose an Asset Server item. Displays a modal dialog that navigates the tree of assets on the Asset | 245 | * Prompts the user to choose an Asset Server item. Displays a modal dialog that navigates the tree of assets on the Asset |
| 246 | * Server. | 246 | * Server. |
| 247 | * @function Window.browseAssets | 247 | * @function Window.browseAssets |
| @@ -256,7 +256,7 @@ public slots: · 8 unmodified lines | |||
| 256 | */ | 256 | */ |
| 257 | QScriptValue browseAssets(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); | 257 | QScriptValue browseAssets(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); |
| 258 | 258 | ||
| 259 | /**jsdoc | 259 | /*@jsdoc |
| 260 | * Prompts the user to choose an Asset Server item. Displays a non-modal dialog that navigates the tree of assets on the | 260 | * Prompts the user to choose an Asset Server item. Displays a non-modal dialog that navigates the tree of assets on the |
| 261 | * Asset Server. An {@link Window.assetsDirChanged|assetsDirChanged} signal is emitted when an asset is chosen; no signal is | 261 | * Asset Server. An {@link Window.assetsDirChanged|assetsDirChanged} signal is emitted when an asset is chosen; no signal is |
| 262 | * emitted if the user cancels the dialog. | 262 | * emitted if the user cancels the dialog. |
| @@ -276,7 +276,7 @@ public slots: · 13 unmodified lines | |||
| 276 | */ | 276 | */ |
| 277 | void browseAssetsAsync(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); | 277 | void browseAssetsAsync(const QString& title = "", const QString& directory = "", const QString& nameFilter = ""); |
| 278 | 278 | ||
| 279 | /**jsdoc | 279 | /*@jsdoc |
| 280 | * Opens the Asset Browser dialog. If a file to upload is specified, the user is prompted to enter the folder and name to | 280 | * Opens the Asset Browser dialog. If a file to upload is specified, the user is prompted to enter the folder and name to |
| 281 | * map the file to on the asset server. | 281 | * map the file to on the asset server. |
| 282 | * @function Window.showAssetServer | 282 | * @function Window.showAssetServer |
| @@ -288,35 +288,35 @@ public slots: · 5 unmodified lines | |||
| 288 | */ | 288 | */ |
| 289 | void showAssetServer(const QString& upload = ""); | 289 | void showAssetServer(const QString& upload = ""); |
| 290 | 290 | ||
| 291 | /**jsdoc | 291 | /*@jsdoc |
| 292 | * Gets Interface's build number. | 292 | * Gets Interface's build number. |
| 293 | * @function Window.checkVersion | 293 | * @function Window.checkVersion |
| 294 | * @returns {string} Interface's build number. | 294 | * @returns {string} Interface's build number. |
| 295 | */ | 295 | */ |
| 296 | QString checkVersion(); | 296 | QString checkVersion(); |
| 297 | 297 | ||
| 298 | /**jsdoc | 298 | /*@jsdoc |
| 299 | * Gets Interface's user agent. | 299 | * Gets Interface's user agent. |
| 300 | * @function Window.getUserAgent | 300 | * @function Window.getUserAgent |
| 301 | * @returns {string} Interface's user agent. | 301 | * @returns {string} Interface's user agent. |
| 302 | */ | 302 | */ |
| 303 | QString getUserAgent(); | 303 | QString getUserAgent(); |
| 304 | 304 | ||
| 305 | /**jsdoc | 305 | /*@jsdoc |
| 306 | * Gets the signature for Interface's protocol version. | 306 | * Gets the signature for Interface's protocol version. |
| 307 | * @function Window.protocolSignature | 307 | * @function Window.protocolSignature |
| 308 | * @returns {string} A string uniquely identifying the version of the metaverse protocol that Interface is using. | 308 | * @returns {string} A string uniquely identifying the version of the metaverse protocol that Interface is using. |
| 309 | */ | 309 | */ |
| 310 | QString protocolSignature(); | 310 | QString protocolSignature(); |
| 311 | 311 | ||
| 312 | /**jsdoc | 312 | /*@jsdoc |
| 313 | * Copies text to the operating system's clipboard. | 313 | * Copies text to the operating system's clipboard. |
| 314 | * @function Window.copyToClipboard | 314 | * @function Window.copyToClipboard |
| 315 | * @param {string} text - The text to copy to the operating system's clipboard. | 315 | * @param {string} text - The text to copy to the operating system's clipboard. |
| 316 | */ | 316 | */ |
| 317 | void copyToClipboard(const QString& text); | 317 | void copyToClipboard(const QString& text); |
| 318 | 318 | ||
| 319 | /**jsdoc | 319 | /*@jsdoc |
| 320 | * Takes a snapshot of the current Interface view from the primary camera. When a still image only is captured, | 320 | * Takes a snapshot of the current Interface view from the primary camera. When a still image only is captured, |
| 321 | * {@link Window.stillSnapshotTaken|stillSnapshotTaken} is emitted; when a still image plus moving images are captured, | 321 | * {@link Window.stillSnapshotTaken|stillSnapshotTaken} is emitted; when a still image plus moving images are captured, |
| 322 | * {@link Window.processingGifStarted|processingGifStarted} and {@link Window.processingGifCompleted|processingGifCompleted} | 322 | * {@link Window.processingGifStarted|processingGifStarted} and {@link Window.processingGifCompleted|processingGifCompleted} |
| @@ -364,7 +364,7 @@ public slots: · 41 unmodified lines | |||
| 364 | */ | 364 | */ |
| 365 | void takeSnapshot(bool notify = true, bool includeAnimated = false, float aspectRatio = 0.0f, const QString& filename = QString()); | 365 | void takeSnapshot(bool notify = true, bool includeAnimated = false, float aspectRatio = 0.0f, const QString& filename = QString()); |
| 366 | 366 | ||
| 367 | /**jsdoc | 367 | /*@jsdoc |
| 368 | * Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API. | 368 | * Takes a still snapshot of the current view from the secondary camera that can be set up through the {@link Render} API. |
| 369 | * <p>Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the | 369 | * <p>Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the |
| 370 | * {@link Snapshot} API.</p> | 370 | * {@link Snapshot} API.</p> |
| @@ -379,7 +379,7 @@ public slots: · 8 unmodified lines | |||
| 379 | */ | 379 | */ |
| 380 | void takeSecondaryCameraSnapshot(const bool& notify = true, const QString& filename = QString()); | 380 | void takeSecondaryCameraSnapshot(const bool& notify = true, const QString& filename = QString()); |
| 381 | 381 | ||
| 382 | /**jsdoc | 382 | /*@jsdoc |
| 383 | * Takes a 360° snapshot at a given position for the secondary camera. The secondary camera does not need to have been | 383 | * Takes a 360° snapshot at a given position for the secondary camera. The secondary camera does not need to have been |
| 384 | * set up. | 384 | * set up. |
| 385 | * <p>Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the | 385 | * <p>Snapshots are saved to the path specified in Settings > General > Snapshots, which can be accessed via the |
| @@ -398,7 +398,7 @@ public slots: · 12 unmodified lines | |||
| 398 | */ | 398 | */ |
| 399 | void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const bool& notify = true, const QString& filename = QString()); | 399 | void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const bool& notify = true, const QString& filename = QString()); |
| 400 | 400 | ||
| 401 | /**jsdoc | 401 | /*@jsdoc |
| 402 | * Emits a {@link Window.connectionAdded|connectionAdded} or a {@link Window.connectionError|connectionError} signal that | 402 | * Emits a {@link Window.connectionAdded|connectionAdded} or a {@link Window.connectionError|connectionError} signal that |
| 403 | * indicates whether or not a user connection was successfully made using the Web API. | 403 | * indicates whether or not a user connection was successfully made using the Web API. |
| 404 | * @function Window.makeConnection | 404 | * @function Window.makeConnection |
| @@ -408,7 +408,7 @@ public slots: · 3 unmodified lines | |||
| 408 | */ | 408 | */ |
| 409 | void makeConnection(bool success, const QString& userNameOrError); | 409 | void makeConnection(bool success, const QString& userNameOrError); |
| 410 | 410 | ||
| 411 | /**jsdoc | 411 | /*@jsdoc |
| 412 | * Displays a notification message. Notifications are displayed in panels by the default script, nofications.js. An | 412 | * Displays a notification message. Notifications are displayed in panels by the default script, nofications.js. An |
| 413 | * {@link Window.announcement|announcement} signal is emitted when this function is called. | 413 | * {@link Window.announcement|announcement} signal is emitted when this function is called. |
| 414 | * @function Window.displayAnnouncement | 414 | * @function Window.displayAnnouncement |
| @@ -424,7 +424,7 @@ public slots: · 9 unmodified lines | |||
| 424 | */ | 424 | */ |
| 425 | void displayAnnouncement(const QString& message); | 425 | void displayAnnouncement(const QString& message); |
| 426 | 426 | ||
| 427 | /**jsdoc | 427 | /*@jsdoc |
| 428 | * Prepares a snapshot ready for sharing. A {@link Window.snapshotShared|snapshotShared} signal is emitted when the snapshot | 428 | * Prepares a snapshot ready for sharing. A {@link Window.snapshotShared|snapshotShared} signal is emitted when the snapshot |
| 429 | * has been prepared. | 429 | * has been prepared. |
| 430 | * @function Window.shareSnapshot | 430 | * @function Window.shareSnapshot |
| @@ -433,7 +433,7 @@ public slots: · 2 unmodified lines | |||
| 433 | */ | 433 | */ |
| 434 | void shareSnapshot(const QString& path, const QUrl& href = QUrl("")); | 434 | void shareSnapshot(const QString& path, const QUrl& href = QUrl("")); |
| 435 | 435 | ||
| 436 | /**jsdoc | 436 | /*@jsdoc |
| 437 | * Checks to see if physics is active for you in the domain you're visiting - there is a delay between your arrival at a | 437 | * Checks to see if physics is active for you in the domain you're visiting - there is a delay between your arrival at a |
| 438 | * domain and physics becoming active for you in that domain. | 438 | * domain and physics becoming active for you in that domain. |
| 439 | * @function Window.isPhysicsEnabled | 439 | * @function Window.isPhysicsEnabled |
| @@ -456,7 +456,7 @@ public slots: · 16 unmodified lines | |||
| 456 | */ | 456 | */ |
| 457 | bool isPhysicsEnabled(); | 457 | bool isPhysicsEnabled(); |
| 458 | 458 | ||
| 459 | /**jsdoc | 459 | /*@jsdoc |
| 460 | * Sets what to show on the PC display. For entity camera view, the entity camera is configured using | 460 | * Sets what to show on the PC display. For entity camera view, the entity camera is configured using |
| 461 | * {@link Camera.setCameraEntity} and {@link Camera|Camera.mode}. | 461 | * {@link Camera.setCameraEntity} and {@link Camera|Camera.mode}. |
| 462 | * @function Window.setDisplayTexture | 462 | * @function Window.setDisplayTexture |
| @@ -465,7 +465,7 @@ public slots: · 2 unmodified lines | |||
| 465 | */ | 465 | */ |
| 466 | bool setDisplayTexture(const QString& name); | 466 | bool setDisplayTexture(const QString& name); |
| 467 | 467 | ||
| 468 | /**jsdoc | 468 | /*@jsdoc |
| 469 | * Checks if a 2D point is within the desktop window if in desktop mode, or the drawable area of the HUD overlay if in HMD | 469 | * Checks if a 2D point is within the desktop window if in desktop mode, or the drawable area of the HUD overlay if in HMD |
| 470 | * mode. | 470 | * mode. |
| 471 | * @function Window.isPointOnDesktopWindow | 471 | * @function Window.isPointOnDesktopWindow |
| @@ -474,21 +474,21 @@ public slots: · 2 unmodified lines | |||
| 474 | */ | 474 | */ |
| 475 | bool isPointOnDesktopWindow(QVariant point); | 475 | bool isPointOnDesktopWindow(QVariant point); |
| 476 | 476 | ||
| 477 | /**jsdoc | 477 | /*@jsdoc |
| 478 | * Gets the size of the drawable area of the Interface window if in desktop mode or the HMD rendering surface if in HMD mode. | 478 | * Gets the size of the drawable area of the Interface window if in desktop mode or the HMD rendering surface if in HMD mode. |
| 479 | * @function Window.getDeviceSize | 479 | * @function Window.getDeviceSize |
| 480 | * @returns {Vec2} The width and height of the Interface window or HMD rendering surface, in pixels. | 480 | * @returns {Vec2} The width and height of the Interface window or HMD rendering surface, in pixels. |
| 481 | */ | 481 | */ |
| 482 | glm::vec2 getDeviceSize() const; | 482 | glm::vec2 getDeviceSize() const; |
| 483 | 483 | ||
| 484 | /**jsdoc | 484 | /*@jsdoc |
| 485 | * Gets the last domain connection error when a connection is refused. | 485 | * Gets the last domain connection error when a connection is refused. |
| 486 | * @function Window.getLastDomainConnectionError | 486 | * @function Window.getLastDomainConnectionError |
| 487 | * @returns {Window.ConnectionRefusedReason} Integer number that enumerates the last domain connection refused. | 487 | * @returns {Window.ConnectionRefusedReason} Integer number that enumerates the last domain connection refused. |
| 488 | */ | 488 | */ |
| 489 | int getLastDomainConnectionError() const; | 489 | int getLastDomainConnectionError() const; |
| 490 | 490 | ||
| 491 | /**jsdoc | 491 | /*@jsdoc |
| 492 | * Opens a non-modal message box that can have a variety of button combinations. See also, | 492 | * Opens a non-modal message box that can have a variety of button combinations. See also, |
| 493 | * {@link Window.updateMessageBox|updateMessageBox} and {@link Window.closeMessageBox|closeMessageBox}. | 493 | * {@link Window.updateMessageBox|updateMessageBox} and {@link Window.closeMessageBox|closeMessageBox}. |
| 494 | * @function Window.openMessageBox | 494 | * @function Window.openMessageBox |
| @@ -520,7 +520,7 @@ public slots: · 25 unmodified lines | |||
| 520 | */ | 520 | */ |
| 521 | int openMessageBox(QString title, QString text, int buttons, int defaultButton); | 521 | int openMessageBox(QString title, QString text, int buttons, int defaultButton); |
| 522 | 522 | ||
| 523 | /**jsdoc | 523 | /*@jsdoc |
| 524 | * Opens a URL in the Interface window or other application, depending on the URL's scheme. The following schemes are | 524 | * Opens a URL in the Interface window or other application, depending on the URL's scheme. The following schemes are |
| 525 | * supported: | 525 | * supported: |
| 526 | * <ul> | 526 | * <ul> |
| @@ -534,7 +534,7 @@ public slots: · 7 unmodified lines | |||
| 534 | */ | 534 | */ |
| 535 | void openUrl(const QUrl& url); | 535 | void openUrl(const QUrl& url); |
| 536 | 536 | ||
| 537 | /**jsdoc | 537 | /*@jsdoc |
| 538 | * Opens an Android activity and optionally return back to the scene when the activity is completed. <em>Android only.</em> | 538 | * Opens an Android activity and optionally return back to the scene when the activity is completed. <em>Android only.</em> |
| 539 | * @function Window.openAndroidActivity | 539 | * @function Window.openAndroidActivity |
| 540 | * @param {string} activityName - The name of the activity to open: one of <code>"Home"</code>, <code>"Login"</code>, or | 540 | * @param {string} activityName - The name of the activity to open: one of <code>"Home"</code>, <code>"Login"</code>, or |
| @@ -544,7 +544,7 @@ public slots: · 3 unmodified lines | |||
| 544 | */ | 544 | */ |
| 545 | void openAndroidActivity(const QString& activityName, const bool backToScene); | 545 | void openAndroidActivity(const QString& activityName, const bool backToScene); |
| 546 | 546 | ||
| 547 | /**jsdoc | 547 | /*@jsdoc |
| 548 | * Updates the content of a message box that was opened with {@link Window.openMessageBox|openMessageBox}. | 548 | * Updates the content of a message box that was opened with {@link Window.openMessageBox|openMessageBox}. |
| 549 | * @function Window.updateMessageBox | 549 | * @function Window.updateMessageBox |
| 550 | * @param {number} id - The ID of the message box. | 550 | * @param {number} id - The ID of the message box. |
| @@ -556,28 +556,28 @@ public slots: · 5 unmodified lines | |||
| 556 | */ | 556 | */ |
| 557 | void updateMessageBox(int id, QString title, QString text, int buttons, int defaultButton); | 557 | void updateMessageBox(int id, QString title, QString text, int buttons, int defaultButton); |
| 558 | 558 | ||
| 559 | /**jsdoc | 559 | /*@jsdoc |
| 560 | * Closes a message box that was opened with {@link Window.openMessageBox|openMessageBox}. | 560 | * Closes a message box that was opened with {@link Window.openMessageBox|openMessageBox}. |
| 561 | * @function Window.closeMessageBox | 561 | * @function Window.closeMessageBox |
| 562 | * @param {number} id - The ID of the message box. | 562 | * @param {number} id - The ID of the message box. |
| 563 | */ | 563 | */ |
| 564 | void closeMessageBox(int id); | 564 | void closeMessageBox(int id); |
| 565 | 565 | ||
| 566 | /**jsdoc | 566 | /*@jsdoc |
| 567 | * @function Window.domainLoadingProgress | 567 | * @function Window.domainLoadingProgress |
| 568 | * @returns {number} Progress. | 568 | * @returns {number} Progress. |
| 569 | * @deprecated This function is deprecated and will be removed. | 569 | * @deprecated This function is deprecated and will be removed. |
| 570 | */ | 570 | */ |
| 571 | float domainLoadingProgress(); | 571 | float domainLoadingProgress(); |
| 572 | 572 | ||
| 573 | /**jsdoc | 573 | /*@jsdoc |
| 574 | * Gets the number of display plugins currently available. | 574 | * Gets the number of display plugins currently available. |
| 575 | * @function Window.getDisplayPluginCount | 575 | * @function Window.getDisplayPluginCount |
| 576 | * @returns {number} The number of display plugins currently available. | 576 | * @returns {number} The number of display plugins currently available. |
| 577 | */ | 577 | */ |
| 578 | int getDisplayPluginCount(); | 578 | int getDisplayPluginCount(); |
| 579 | 579 | ||
| 580 | /**jsdoc | 580 | /*@jsdoc |
| 581 | * Gets the name of a display plugin. | 581 | * Gets the name of a display plugin. |
| 582 | * @function Window.getDisplayPluginName | 582 | * @function Window.getDisplayPluginName |
| 583 | * @param {number} index - The index of the display plugin. Must be less than the value returned by | 583 | * @param {number} index - The index of the display plugin. Must be less than the value returned by |
| @@ -590,7 +590,7 @@ public slots: · 6 unmodified lines | |||
| 590 | */ | 590 | */ |
| 591 | QString getDisplayPluginName(int index); | 591 | QString getDisplayPluginName(int index); |
| 592 | 592 | ||
| 593 | /**jsdoc | 593 | /*@jsdoc |
| 594 | * Checks whether a display plugin is an HMD. | 594 | * Checks whether a display plugin is an HMD. |
| 595 | * @function Window.isDisplayPluginHmd | 595 | * @function Window.isDisplayPluginHmd |
| 596 | * @param {number} index - The index of the display plugin. Must be less than the value returned by | 596 | * @param {number} index - The index of the display plugin. Must be less than the value returned by |
| @@ -599,7 +599,7 @@ public slots: · 2 unmodified lines | |||
| 599 | */ | 599 | */ |
| 600 | bool isDisplayPluginHmd(int index); | 600 | bool isDisplayPluginHmd(int index); |
| 601 | 601 | ||
| 602 | /**jsdoc | 602 | /*@jsdoc |
| 603 | * Gets the index of the currently active display plugin. | 603 | * Gets the index of the currently active display plugin. |
| 604 | * @function Window.getActiveDisplayPlugin | 604 | * @function Window.getActiveDisplayPlugin |
| 605 | * @returns {number} The index of the currently active display plugin. The first display plugin has an index of | 605 | * @returns {number} The index of the currently active display plugin. The first display plugin has an index of |
| @@ -607,7 +607,7 @@ public slots: · 1 unmodified line | |||
| 607 | */ | 607 | */ |
| 608 | int getActiveDisplayPlugin(); | 608 | int getActiveDisplayPlugin(); |
| 609 | 609 | ||
| 610 | /**jsdoc | 610 | /*@jsdoc |
| 611 | * Sets the currently active display plugin. | 611 | * Sets the currently active display plugin. |
| 612 | * @function Window.setActiveDisplayPlugin | 612 | * @function Window.setActiveDisplayPlugin |
| 613 | * @param {number} index - The index of the display plugin. Must be less than the value returned by | 613 | * @param {number} index - The index of the display plugin. Must be less than the value returned by |
| @@ -615,7 +615,7 @@ public slots: · 1 unmodified line | |||
| 615 | */ | 615 | */ |
| 616 | void setActiveDisplayPlugin(int index); | 616 | void setActiveDisplayPlugin(int index); |
| 617 | 617 | ||
| 618 | /**jsdoc | 618 | /*@jsdoc |
| 619 | * Opens an Interface web browser window. | 619 | * Opens an Interface web browser window. |
| 620 | * @function Window.openWebBrowser | 620 | * @function Window.openWebBrowser |
| 621 | * @param {string} [url=""] - The URL of the web page to display. | 621 | * @param {string} [url=""] - The URL of the web page to display. |
| @@ -630,7 +630,7 @@ private slots: · 8 unmodified lines | |||
| 630 | 630 | ||
| 631 | signals: | 631 | signals: |
| 632 | 632 | ||
| 633 | /**jsdoc | 633 | /*@jsdoc |
| 634 | * Triggered when you change the domain you're visiting. | 634 | * Triggered when you change the domain you're visiting. |
| 635 | * <p><strong>Warning:</strong> Is not emitted if you go to a domain that isn't running.</p> | 635 | * <p><strong>Warning:</strong> Is not emitted if you go to a domain that isn't running.</p> |
| 636 | * @function Window.domainChanged | 636 | * @function Window.domainChanged |
| @@ -645,7 +645,7 @@ signals: · 8 unmodified lines | |||
| 645 | */ | 645 | */ |
| 646 | void domainChanged(QUrl domainURL); | 646 | void domainChanged(QUrl domainURL); |
| 647 | 647 | ||
| 648 | /**jsdoc | 648 | /*@jsdoc |
| 649 | * Triggered when you try to navigate to a *.json, *.svo, or *.svo.json URL in a Web browser within Interface. | 649 | * Triggered when you try to navigate to a *.json, *.svo, or *.svo.json URL in a Web browser within Interface. |
| 650 | * @function Window.svoImportRequested | 650 | * @function Window.svoImportRequested |
| 651 | * @param {string} url - The URL of the file to import. | 651 | * @param {string} url - The URL of the file to import. |
| @@ -653,7 +653,7 @@ signals: · 1 unmodified line | |||
| 653 | */ | 653 | */ |
| 654 | void svoImportRequested(const QString& url); | 654 | void svoImportRequested(const QString& url); |
| 655 | 655 | ||
| 656 | /**jsdoc | 656 | /*@jsdoc |
| 657 | * Triggered when you try to visit a domain but are refused connection. | 657 | * Triggered when you try to visit a domain but are refused connection. |
| 658 | * @function Window.domainConnectionRefused | 658 | * @function Window.domainConnectionRefused |
| 659 | * @param {string} reasonMessage - A description of the refusal. | 659 | * @param {string} reasonMessage - A description of the refusal. |
| @@ -663,7 +663,7 @@ signals: · 3 unmodified lines | |||
| 663 | */ | 663 | */ |
| 664 | void domainConnectionRefused(const QString& reasonMessage, int reasonCode, const QString& extraInfo); | 664 | void domainConnectionRefused(const QString& reasonMessage, int reasonCode, const QString& extraInfo); |
| 665 | 665 | ||
| 666 | /**jsdoc | 666 | /*@jsdoc |
| 667 | * Triggered when you try to visit a domain but are redirected into the error state. | 667 | * Triggered when you try to visit a domain but are redirected into the error state. |
| 668 | * @function Window.redirectErrorStateChanged | 668 | * @function Window.redirectErrorStateChanged |
| 669 | * @param {boolean} isInErrorState - <code>true</code> if the user has been redirected to the error URL, <code>false</code> | 669 | * @param {boolean} isInErrorState - <code>true</code> if the user has been redirected to the error URL, <code>false</code> |
| @@ -672,7 +672,7 @@ signals: · 2 unmodified lines | |||
| 672 | */ | 672 | */ |
| 673 | void redirectErrorStateChanged(bool isInErrorState); | 673 | void redirectErrorStateChanged(bool isInErrorState); |
| 674 | 674 | ||
| 675 | /**jsdoc | 675 | /*@jsdoc |
| 676 | * Triggered when the interstitial mode changes. | 676 | * Triggered when the interstitial mode changes. |
| 677 | * @function Window.interstitialModeChanged | 677 | * @function Window.interstitialModeChanged |
| 678 | * @param {boolean} interstitialMode - <code>true</code> if the interstitial graphics are displayed when the domain is | 678 | * @param {boolean} interstitialMode - <code>true</code> if the interstitial graphics are displayed when the domain is |
| @@ -681,7 +681,7 @@ signals: · 2 unmodified lines | |||
| 681 | */ | 681 | */ |
| 682 | void interstitialModeChanged(bool interstitialMode); | 682 | void interstitialModeChanged(bool interstitialMode); |
| 683 | 683 | ||
| 684 | /**jsdoc | 684 | /*@jsdoc |
| 685 | * Triggered when a still snapshot has been taken by calling {@link Window.takeSnapshot|takeSnapshot} with | 685 | * Triggered when a still snapshot has been taken by calling {@link Window.takeSnapshot|takeSnapshot} with |
| 686 | * <code>includeAnimated = false</code> or {@link Window.takeSecondaryCameraSnapshot|takeSecondaryCameraSnapshot}. | 686 | * <code>includeAnimated = false</code> or {@link Window.takeSecondaryCameraSnapshot|takeSecondaryCameraSnapshot}. |
| 687 | * @function Window.stillSnapshotTaken | 687 | * @function Window.stillSnapshotTaken |
| @@ -692,7 +692,7 @@ signals: · 4 unmodified lines | |||
| 692 | */ | 692 | */ |
| 693 | void stillSnapshotTaken(const QString& pathStillSnapshot, bool notify); | 693 | void stillSnapshotTaken(const QString& pathStillSnapshot, bool notify); |
| 694 | 694 | ||
| 695 | /**jsdoc | 695 | /*@jsdoc |
| 696 | * Triggered when a still 360° snapshot has been taken by calling | 696 | * Triggered when a still 360° snapshot has been taken by calling |
| 697 | * {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot}. | 697 | * {@link Window.takeSecondaryCamera360Snapshot|takeSecondaryCamera360Snapshot}. |
| 698 | * @function Window.snapshot360Taken | 698 | * @function Window.snapshot360Taken |
| @@ -703,7 +703,7 @@ signals: · 4 unmodified lines | |||
| 703 | */ | 703 | */ |
| 704 | void snapshot360Taken(const QString& path360Snapshot, bool notify); | 704 | void snapshot360Taken(const QString& path360Snapshot, bool notify); |
| 705 | 705 | ||
| 706 | /**jsdoc | 706 | /*@jsdoc |
| 707 | * Triggered when a snapshot submitted via {@link Window.shareSnapshot|shareSnapshot} is ready for sharing. The snapshot | 707 | * Triggered when a snapshot submitted via {@link Window.shareSnapshot|shareSnapshot} is ready for sharing. The snapshot |
| 708 | * may then be shared via the {@link Account.metaverseServerURL} Web API. | 708 | * may then be shared via the {@link Account.metaverseServerURL} Web API. |
| 709 | * @function Window.snapshotShared | 709 | * @function Window.snapshotShared |
| @@ -714,7 +714,7 @@ signals: · 4 unmodified lines | |||
| 714 | */ | 714 | */ |
| 715 | void snapshotShared(bool isError, const QString& reply); | 715 | void snapshotShared(bool isError, const QString& reply); |
| 716 | 716 | ||
| 717 | /**jsdoc | 717 | /*@jsdoc |
| 718 | * Triggered when the snapshot images have been captured by {@link Window.takeSnapshot|takeSnapshot} and the GIF is | 718 | * Triggered when the snapshot images have been captured by {@link Window.takeSnapshot|takeSnapshot} and the GIF is |
| 719 | * starting to be processed. | 719 | * starting to be processed. |
| 720 | * @function Window.processingGifStarted | 720 | * @function Window.processingGifStarted |
| @@ -723,7 +723,7 @@ signals: · 2 unmodified lines | |||
| 723 | */ | 723 | */ |
| 724 | void processingGifStarted(const QString& pathStillSnapshot); | 724 | void processingGifStarted(const QString& pathStillSnapshot); |
| 725 | 725 | ||
| 726 | /**jsdoc | 726 | /*@jsdoc |
| 727 | * Triggered when a GIF has been prepared of the snapshot images captured by {@link Window.takeSnapshot|takeSnapshot}. | 727 | * Triggered when a GIF has been prepared of the snapshot images captured by {@link Window.takeSnapshot|takeSnapshot}. |
| 728 | * @function Window.processingGifCompleted | 728 | * @function Window.processingGifCompleted |
| 729 | * @param {string} pathAnimatedSnapshot - The path and name of the moving snapshot GIF file. | 729 | * @param {string} pathAnimatedSnapshot - The path and name of the moving snapshot GIF file. |
| @@ -732,7 +732,7 @@ signals: · 2 unmodified lines | |||
| 732 | void processingGifCompleted(const QString& pathAnimatedSnapshot); | 732 | void processingGifCompleted(const QString& pathAnimatedSnapshot); |
| 733 | 733 | ||
| 734 | 734 | ||
| 735 | /**jsdoc | 735 | /*@jsdoc |
| 736 | * Triggered when you've successfully made a user connection. | 736 | * Triggered when you've successfully made a user connection. |
| 737 | * @function Window.connectionAdded | 737 | * @function Window.connectionAdded |
| 738 | * @param {string} message - A description of the success. | 738 | * @param {string} message - A description of the success. |
| @@ -740,7 +740,7 @@ signals: · 1 unmodified line | |||
| 740 | */ | 740 | */ |
| 741 | void connectionAdded(const QString& connectionName); | 741 | void connectionAdded(const QString& connectionName); |
| 742 | 742 | ||
| 743 | /**jsdoc | 743 | /*@jsdoc |
| 744 | * Triggered when you failed to make a user connection. | 744 | * Triggered when you failed to make a user connection. |
| 745 | * @function Window.connectionError | 745 | * @function Window.connectionError |
| 746 | * @param {string} message - A description of the error. | 746 | * @param {string} message - A description of the error. |
| @@ -748,7 +748,7 @@ signals: · 1 unmodified line | |||
| 748 | */ | 748 | */ |
| 749 | void connectionError(const QString& errorString); | 749 | void connectionError(const QString& errorString); |
| 750 | 750 | ||
| 751 | /**jsdoc | 751 | /*@jsdoc |
| 752 | * Triggered when a message is announced by {@link Window.displayAnnouncement|displayAnnouncement}. | 752 | * Triggered when a message is announced by {@link Window.displayAnnouncement|displayAnnouncement}. |
| 753 | * @function Window.announcement | 753 | * @function Window.announcement |
| 754 | * @param {string} message - The message text. | 754 | * @param {string} message - The message text. |
| @@ -757,7 +757,7 @@ signals: · 2 unmodified lines | |||
| 757 | void announcement(const QString& message); | 757 | void announcement(const QString& message); |
| 758 | 758 | ||
| 759 | 759 | ||
| 760 | /**jsdoc | 760 | /*@jsdoc |
| 761 | * Triggered when the user closes a message box that was opened with {@link Window.openMessageBox|openMessageBox}. | 761 | * Triggered when the user closes a message box that was opened with {@link Window.openMessageBox|openMessageBox}. |
| 762 | * @function Window.messageBoxClosed | 762 | * @function Window.messageBoxClosed |
| 763 | * @param {number} id - The ID of the message box that was closed. | 763 | * @param {number} id - The ID of the message box that was closed. |
| @@ -767,7 +767,7 @@ signals: · 3 unmodified lines | |||
| 767 | */ | 767 | */ |
| 768 | void messageBoxClosed(int id, int button); | 768 | void messageBoxClosed(int id, int button); |
| 769 | 769 | ||
| 770 | /**jsdoc | 770 | /*@jsdoc |
| 771 | * Triggered when the user chooses a directory in a {@link Window.browseDirAsync|browseDirAsync} dialog. | 771 | * Triggered when the user chooses a directory in a {@link Window.browseDirAsync|browseDirAsync} dialog. |
| 772 | * @function Window.browseDirChanged | 772 | * @function Window.browseDirChanged |
| 773 | * @param {string} directory - The directory the user chose in the dialog. | 773 | * @param {string} directory - The directory the user chose in the dialog. |
| @@ -775,7 +775,7 @@ signals: · 1 unmodified line | |||
| 775 | */ | 775 | */ |
| 776 | void browseDirChanged(QString browseDir); | 776 | void browseDirChanged(QString browseDir); |
| 777 | 777 | ||
| 778 | /**jsdoc | 778 | /*@jsdoc |
| 779 | * Triggered when the user chooses an asset in a {@link Window.browseAssetsAsync|browseAssetsAsync} dialog. | 779 | * Triggered when the user chooses an asset in a {@link Window.browseAssetsAsync|browseAssetsAsync} dialog. |
| 780 | * @function Window.assetsDirChanged | 780 | * @function Window.assetsDirChanged |
| 781 | * @param {string} asset - The path and name of the asset the user chose in the dialog. | 781 | * @param {string} asset - The path and name of the asset the user chose in the dialog. |
| @@ -783,7 +783,7 @@ signals: · 1 unmodified line | |||
| 783 | */ | 783 | */ |
| 784 | void assetsDirChanged(QString assetsDir); | 784 | void assetsDirChanged(QString assetsDir); |
| 785 | 785 | ||
| 786 | /**jsdoc | 786 | /*@jsdoc |
| 787 | * Triggered when the user specifies a file in a {@link Window.saveAsync|saveAsync} dialog. | 787 | * Triggered when the user specifies a file in a {@link Window.saveAsync|saveAsync} dialog. |
| 788 | * @function Window.saveFileChanged | 788 | * @function Window.saveFileChanged |
| 789 | * @param {string} filename - The path and name of the file that the user specified in the dialog. | 789 | * @param {string} filename - The path and name of the file that the user specified in the dialog. |
| @@ -791,7 +791,7 @@ signals: · 1 unmodified line | |||
| 791 | */ | 791 | */ |
| 792 | void saveFileChanged(QString filename); | 792 | void saveFileChanged(QString filename); |
| 793 | 793 | ||
| 794 | /**jsdoc | 794 | /*@jsdoc |
| 795 | * Triggered when the user chooses a file in a {@link Window.browseAsync|browseAsync} dialog. | 795 | * Triggered when the user chooses a file in a {@link Window.browseAsync|browseAsync} dialog. |
| 796 | * @function Window.browseChanged | 796 | * @function Window.browseChanged |
| 797 | * @param {string} filename - The path and name of the file the user chose in the dialog. | 797 | * @param {string} filename - The path and name of the file the user chose in the dialog. |
| @@ -799,7 +799,7 @@ signals: · 1 unmodified line | |||
| 799 | */ | 799 | */ |
| 800 | void browseChanged(QString filename); | 800 | void browseChanged(QString filename); |
| 801 | 801 | ||
| 802 | /**jsdoc | 802 | /*@jsdoc |
| 803 | * Triggered when the user OKs a {@link Window.promptAsync|promptAsync} dialog. | 803 | * Triggered when the user OKs a {@link Window.promptAsync|promptAsync} dialog. |
| 804 | * @function Window.promptTextChanged | 804 | * @function Window.promptTextChanged |
| 805 | * @param {string} text - The text the user entered in the dialog. | 805 | * @param {string} text - The text the user entered in the dialog. |
| @@ -808,7 +808,7 @@ signals: · 2 unmodified lines | |||
| 808 | void promptTextChanged(QString text); | 808 | void promptTextChanged(QString text); |
| 809 | 809 | ||
| 810 | 810 | ||
| 811 | /**jsdoc | 811 | /*@jsdoc |
| 812 | * Triggered when the position or size of the Interface window changes. | 812 | * Triggered when the position or size of the Interface window changes. |
| 813 | * @function Window.geometryChanged | 813 | * @function Window.geometryChanged |
| 814 | * @param {Rect} geometry - The position and size of the drawable area of the Interface window. | 814 | * @param {Rect} geometry - The position and size of the drawable area of the Interface window. |
| @@ -823,7 +823,7 @@ signals: · 8 unmodified lines | |||
| 823 | void geometryChanged(QRect geometry); | 823 | void geometryChanged(QRect geometry); |
| 824 | 824 | ||
| 825 | 825 | ||
| 826 | /**jsdoc | 826 | /*@jsdoc |
| 827 | * Triggered when "minimized" state of the Interface window changes. | 827 | * Triggered when "minimized" state of the Interface window changes. |
| 828 | * @function Window.minimizedChanged | 828 | * @function Window.minimizedChanged |
| 829 | * @param {boolean} isMinimized - <code>true</code> if the Interface window is minimized, <code>false</code> if it isn't. | 829 | * @param {boolean} isMinimized - <code>true</code> if the Interface window is minimized, <code>false</code> if it isn't. |