Interface OSGUIWindow

lib/os-gui/os-gui.d.ts:1–245

interface OSGUIWindow {
	/**
	 * Sets the title, or if `text` isn't passed, returns the current title of the window.
	 * 
	 * Uses jQuery getter/setter function idiom.
	 */
	title(text: string): OSGUI$Window;
	title(): string;
	// title(text?: string): OSGUI$Window | string; // union of overloads isn't helping

	/**
	 * Returns the current title of the window. Alternative to `title()`.
	 */
	getTitle(): string;

	/**
	 * Closes the window.
	 */
	close(force?: boolean): void;

	/**
	 * Tries to focus something within the window, in this order of priority:
	 * - The last focused control within the window
	 * - A control with `class="default"`
	 * - If it's a tool window, the parent window
	 * - and otherwise the window itself (specifically `$window.$content`)
	 */
	focus(): void;

	/**
	 * Removes focus from the window. If focus is outside the window, it is left unchanged.
	 */
	blur(): void;

	/**
	 * Minimizes the window. If `$window.task.$task` is defined it will use that as a target for minimizing, otherwise the window will minimize to the bottom of the screen.
	 */
	minimize(): void;

	/**
	 * Restores the window from minimized state.
	 */
	private unminimize(): void;

	/**
	 * Maximizes the window. While maximized, the window will use `position: fixed`, so it will not scroll with the page.
	 */
	maximize(): void;

	/**
	 * Restores the window from minimized or maximized state. If the window is not minimized or maximized, this method does nothing.
	 */
	restore(): void;

	/**
	 * Centers the window in the page.
	 * You should call this after the contents of the window is fully rendered, or you've set a fixed size for the window.
	 * If you have images in the window, wait for them to load before showing and centering the window, or define a fixed size for the images.
	 */
	center(): void;