Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 1 file). Show all
Unified · Split
| @@ -818,8 +818,12 @@ signals: · 817 unmodified lines | ||
| 818 | 818 | /**jsdoc |
| 819 | 819 | * Triggered when "minimized" state of the Interface window changes. |
| 820 | 820 | * @function Window.minimizedChanged |
| 821 | − * @param {bool} isMinimized - true if the Interface window is now minimized; false otherwise. | |
| 821 | + * @param {boolean} isMinimized - <code>true</code> if the Interface window is minimized, <code>false</code> if it isn't. | |
| 822 | 822 | * @returns {Signal} |
| 823 | + * @example <caption>Report the "minimized" state of the Interface window when it changes.</caption> | |
| 824 | + * function onWindowMinimizedChanged(minimized) { | |
| 825 | + * print("Window minimized: " + minimized); | |
| 826 | + * } | |
| 823 | 827 | * |
| 824 | 828 | * Window.minimizedChanged.connect(onWindowMinimizedChanged); |
| 825 | 829 | */ |