History

Fix up InteractiveWindow JSDoc per recent changes

David Rowe committed 6 years ago

Commit c52fa7a1 parent ccc4be54 files · +97 −48Browse files

Showing the changes to interface/src/ui/InteractiveWindow.cpp (1 of 4 files). Show all

Unified · Split

interface/src/ui/InteractiveWindow.cpp+31−8
@@ -129,8 +129,8 @@ void InteractiveWindow::emitMainWindowResizeEvent() { · 128 unmodified lines
129}129}
130 130
131/**jsdoc131/**jsdoc
132 * A set of properties used when creating an <code>InteractiveWindow</code>.132 * Property values used when creating an <code>InteractiveWindow</code>.
133 * @typedef {object} InteractiveWindow.Properties133 * @typedef {object} InteractiveWindow.WindowProperties
134 * @property {string} [title="InteractiveWindow] - The title of the window.134 * @property {string} [title="InteractiveWindow] - The title of the window.
135 * @property {Vec2} [position] - The initial position of the window, in pixels.135 * @property {Vec2} [position] - The initial position of the window, in pixels.
136 * @property {Vec2} [size] - The initial size of the window, in pixels136 * @property {Vec2} [size] - The initial size of the window, in pixels
@@ -142,13 +142,36 @@ void InteractiveWindow::emitMainWindowResizeEvent() { · 5 unmodified lines
142 * @property {InteractiveWindow.PresentationWindowInfo} [presentationWindowInfo] - Controls how a <code>NATIVE</code> window is142 * @property {InteractiveWindow.PresentationWindowInfo} [presentationWindowInfo] - Controls how a <code>NATIVE</code> window is
143 * displayed. If used, the window is docked to the specified edge of the Interface window, otherwise the window is143 * displayed. If used, the window is docked to the specified edge of the Interface window, otherwise the window is
144 * displayed as its own separate window.144 * displayed as its own separate window.
145 * @property {InteractiveWindow.AdditionalFlags} [additionalFlags=0] - Window behavior flags in addition to "native window flags" (minimize/maximize/close),145 * @property {InteractiveWindow.Flags} [additionalFlags=0] - Customizes window behavior.
146 * set at window creation. Possible flag values are provided as {@link Desktop|Desktop.ALWAYS_ON_TOP} and {@link Desktop|Desktop.CLOSE_BUTTON_HIDES}.146 * @property {InteractiveWindow.OverrideFlags} [overrideFlags=0] - Customizes window controls.
147 * Additional flag values can be found on Qt's website at https://doc.qt.io/qt-5/qt.html#WindowType-enum.147
148 * @property {InteractiveWindow.OverrideFlags} [overrideFlags=0] - Window behavior flags instead of the default window flags.148 * @property {InteractiveWindow.RelativePositionAnchor} [relativePositionAnchor] - he anchor for the
149 * Set at window creation. Possible flag values are provided as {@link Desktop|Desktop.ALWAYS_ON_TOP} and {@link Desktop|Desktop.CLOSE_BUTTON_HIDES}.149 * <code>relativePosition</code>, if used.
150 * Additional flag values can be found on Qt's website at https://doc.qt.io/qt-5/qt.html#WindowType-enum.150 * @property {Vec2} [relativePosition] - The position of the window, relative to the <code>relativePositionAnchor</code>, in
151 * pixels. Excludes the window frame.
152 * @property {boolean} [isFullScreenWindow] - <code>true</code> to make the window full screen.
151 */153 */
154/**jsdoc
155 * <p>A set of flags customizing <code>InteractiveWindow</code> controls. The value is constructed by using the <code>|</code>
156 * (bitwise OR) operator on the individual flag values.</code>.</p>
157 * <table>
158 * <thead>
159 * <tr><th>Value</th><th>Name</th><th>Description</th></tr>
160 * </thead>
161 * <tbody>
162 * <tr><td><code>0x00000001</code></td><td>Window</td><td>Displays the window as a window rather than a dialog.</td></tr>
163 * <tr><td><code>0x00001000</code></td><td>WindowTitleHint</td><td>Adds a title bar.</td><td>
164 * <tr><td><code>0x00002000</code></td><td>WindowSystemMenuHint</td><td>Adds a window system menu.</td><td>
165 * <tr><td><code>0x00004000</code></td><td>WindowMinimizeButtonHint</td><td>Adds a minimize button.</td><td>
166 * <tr><td><code>0x00008000</code></td><td>WindowMaximizeButtonHint</td><td>Adds a maximize button.</td><td>
167 * <tr><td><code>0x00040000</code></td><td>WindowStaysOnTopHint</td><td>The window stays on top of other windows.
168 * <em>Not used on Windows.</em>
169 * <tr><td><code>0x08000000</code></td><td>WindowCloseButtonHint</td><td>Adds a close button.</td><td>
170 * <tbody>
171 * </table>
172 * @typedef {number} InteractiveWindow.OverrideFlags
173 */
174// OverrideFlags is per InteractiveWindow.qml.
152InteractiveWindow::InteractiveWindow(const QString& sourceUrl, const QVariantMap& properties, bool restricted) {175InteractiveWindow::InteractiveWindow(const QString& sourceUrl, const QVariantMap& properties, bool restricted) {
153 InteractiveWindowPresentationMode presentationMode = InteractiveWindowPresentationMode::Native;176 InteractiveWindowPresentationMode presentationMode = InteractiveWindowPresentationMode::Native;
154 177