Namespace: window

qui.window

Source:

Members

(static) $body :jQuery

jQuery-wrapped document body object.

Type:
  • jQuery
Source:

(static) $document :jQuery

jQuery-wrapped document object.

Type:
  • jQuery
Source:

(static) $window :jQuery

jQuery-wrapped window object.

Type:
  • jQuery
Source:

(static, constant) activeChangeSignal

Emitted whenever the application window becomes active or is no longer active. Handlers are called with the following parameters:

  • active: Boolean, telling if the application is active or not
Source:

(static, constant) closeSignal

Emitted when the application window is about to be closed. Handlers are called with no parameters. If any of the handlers returns false, window closing will be prevented, if possible.

Source:

(static, constant) focusChangeSignal

Emitted whenever the application window becomes focused or is no longer focused. Handlers are called with the following parameters:

  • focused: Boolean, telling if the application is focused or not
Source:

(static, constant) fullScreenChangeSignal

Emitted whenever the application enters or leaves full-screen mode. Handlers are called with the following parameters:

  • fullScreen, telling if the application is currently in full-screen mode, nor not: Boolean
Source:

(static, constant) resizeSignal

Emitted whenever the window is resized. Handlers are called with the following parameters:

  • width: Number, the new window width
  • height: Number, the new window height
Source:

(static, constant) screenLayoutChangeSignal

Emitted whenever the screen layout changes. Handlers are called with the following parameters:

  • smallScreen: Boolean, telling if the screen is small, as defined by qui.window.isSmallScreen
  • landscape: Boolean, telling if the screen orientation is landscape
Source:

Methods

(static) enterFullScreen()

Put the window full-screen mode.

Source:

(static) getHeight() → {Number}

Tell the current application window height.

Source:
Returns:
Type
Number

(static) getScalingFactor() → {Number}

Tell the current scaling factor.

Source:
Returns:
Type
Number

(static) getSmallScreenThreshold() → {Number}

Tell the current small screen threshold.

Source:
Returns:
Type
Number

(static) getWidth() → {Number}

Tell the current application window width.

Source:
Returns:
Type
Number

(static) isActive() → {Boolean}

Tell whether the application is active or not.

Source:
Returns:
Type
Boolean

(static) isClosing() → {Boolean}

Tell if the window is currently closing.

Source:
Returns:
Type
Boolean

(static) isFocused() → {Boolean}

Tell whether the application is focused or not.

Source:
Returns:
Type
Boolean

(static) isFullScreen() → {Boolean}

Tell whether the browser window is in full-screen mode or not.

Source:
Returns:
Type
Boolean

(static) isLandscape() → {Boolean}

Tell if the screen orientation is landscape (true) or portrait (false).

Source:
Returns:
Type
Boolean

(static) isSmallScreen() → {Boolean}

Tell whether the screen is small or not. A screen is considered small if its width is below a small threshold.

Source:
Returns:
Type
Boolean

(static) reload(pathopt)

Reload the window.

Parameters:
Name Type Attributes Description
path String <optional>

optional path to navigate
Source:

(static) setScalingFactor(factor)

Set the root scaling factor. Use 1 to disable scaling.

This function may force-close current pages and re-navigate to the current path, if screen layout is changed.

Parameters:
Name Type Description
factor Number
Source:

(static) setSmallScreenThreshold(thresholdnullable)

Set the small screen threshold. Defaults to 700 logical pixels.

You can set the threshold to 0 to disable small screen mode; setting it to a large number (e.g. 1e6) ensures that small screen mode is always active.

This function may force-close current pages and re-navigate to the current path, if screen layout is changed.

Parameters:
Name Type Attributes Description
threshold Number <nullable>

small screen threshold, in logical pixels; passing null will reset to default
Source: