Showing the changes to interface/src/scripting/DesktopScriptingInterface.cpp (1 of 3 files). Show all
Unified · Split
| @@ -22,6 +22,29 @@ · 21 unmodified lines | |||
| 22 | #include <DependencyManager.h> | 22 | #include <DependencyManager.h> |
| 23 | #include <OffscreenUi.h> | 23 | #include <OffscreenUi.h> |
| 24 | 24 | ||
| 25 | /**jsdoc | ||
| 26 | * The possible docking locations of an <code>InteractiveWindow</code>. | ||
| 27 | * @typedef {object} InteractiveWindow.DockAreas | ||
| 28 | * @property {InteractiveWindow.DockArea} TOP - Dock to the top edge of the Interface window. | ||
| 29 | * @property {InteractiveWindow.DockArea} BOTTOM - Dock to the bottom edge of the Interface window. | ||
| 30 | * @property {InteractiveWindow.DockArea} LEFT - Dock to the left edge of the Interface window. | ||
| 31 | * @property {InteractiveWindow.DockArea} RIGHT - Dock to the right edge of the Interface window. | ||
| 32 | */ | ||
| 33 | /**jsdoc | ||
| 34 | * A docking location of an <code>InteractiveWindow</code>. | ||
| 35 | * <table> | ||
| 36 | * <thead> | ||
| 37 | * <tr><th>Value</th><th>Name</p><th>Description</th> | ||
| 38 | * </thead> | ||
| 39 | * <tbody> | ||
| 40 | * <tr><td><code>0</code></td><td>TOP</td><td>Dock to the top edge of the Interface window.</td></tr> | ||
| 41 | * <tr><td><code>1</code></td><td>BOTTOM</td><td>Dock to the bottom edge of the Interface window.</td></tr> | ||
| 42 | * <tr><td><code>2</code></td><td>LEFT</td><td>Dock to the left edge of the Interface window.</td></tr> | ||
| 43 | * <tr><td><code>3</code></td><td>RIGHT</td><td>Dock to the right edge of the Interface window.</td></tr> | ||
| 44 | * <tbody> | ||
| 45 | * </table> | ||
| 46 | * @typedef {number} InteractiveWindow.DockArea | ||
| 47 | */ | ||
| 25 | static const QVariantMap DOCK_AREA { | 48 | static const QVariantMap DOCK_AREA { |
| 26 | { "TOP", DockArea::TOP }, | 49 | { "TOP", DockArea::TOP }, |
| 27 | { "BOTTOM", DockArea::BOTTOM }, | 50 | { "BOTTOM", DockArea::BOTTOM }, |
| @@ -39,11 +62,27 @@ int DesktopScriptingInterface::getHeight() { · 11 unmodified lines | |||
| 39 | } | 62 | } |
| 40 | 63 | ||
| 41 | /**jsdoc | 64 | /**jsdoc |
| 42 | * The presentation mode specifies how an {@link InteractiveWindow} is displayed. | 65 | * The possible display modes for an <code>InteractiveWindow</code>. |
| 43 | * @typedef {object} InteractiveWindow.PresentationMode | 66 | * @typedef {object} InteractiveWindow.PresentationModes |
| 44 | * @property {number} VIRTUAL - The window is displayed inside Interface: in the desktop window in desktop mode or on the HUD | 67 | * @property {InteractiveWindow.PresentationMode} VIRTUAL - The window is displayed inside Interface: in the desktop window in |
| 45 | * surface in HMD mode. | 68 | * desktop mode or on the HUD surface in HMD mode. |
| 46 | * @property {number} NATIVE - The window is displayed separately from the Interface window, as its own separate window. | 69 | * @property {InteractiveWindow.PresentationMode} NATIVE - The window is displayed separately from the Interface window, as its |
| 70 | * own separate window. | ||
| 71 | */ | ||
| 72 | /**jsdoc | ||
| 73 | * A display mode for an <code>InteractiveWindow</code>. | ||
| 74 | * <table> | ||
| 75 | * <thead> | ||
| 76 | * <tr><th>Value</th><th>Name</p><th>Description</th> | ||
| 77 | * </thead> | ||
| 78 | * <tbody> | ||
| 79 | * <tr><td><code>0</code></td><td>VIRTUAL</td><td>The window is displayed inside Interface: in the desktop window in | ||
| 80 | * desktop mode or on the HUD surface in HMD mode.</td></tr> | ||
| 81 | * <tr><td><code>1</code></td><td>NATIVE</td><td>The window is displayed separately from the Interface window, as its | ||
| 82 | * own separate window.</td></tr> | ||
| 83 | * <tbody> | ||
| 84 | * </table> | ||
| 85 | * @typedef {number} InteractiveWindow.PresentationMode | ||
| 47 | */ | 86 | */ |
| 48 | QVariantMap DesktopScriptingInterface::getPresentationMode() { | 87 | QVariantMap DesktopScriptingInterface::getPresentationMode() { |
| 49 | static QVariantMap presentationModes { | 88 | static QVariantMap presentationModes { |