Namespace chip.fullscreen
The namespace for the CHIP API's fullscreen contract, which allows you
to deal with toggling of fullscreen mode.
Defined in: fullscreen.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
chip.fullscreen.attachFullscreen(fnEventHandler)
Attaches the given event handler to the "fullscreen" event which is fired
whenever fullscreen mode is toggled.
|
| <static> |
chip.fullscreen.getFullscreen()
Tells whether fullscreen mode is currently turned on.
|
| <static> |
chip.fullscreen.setFullscreen(bOn)
Turns fullscreen mode on as specified.
|
Method Detail
<static>
chip.fullscreen.attachFullscreen(fnEventHandler)
Attaches the given event handler to the "fullscreen" event which is fired
whenever fullscreen mode is toggled.
Use
Function.prototype.bind() to determine the event handler's
this or some of its arguments.
Note: Without such an event handler, the CHIP will simply continue to display the
same content, no matter whether fullscreen mode is on or off.
- Parameters:
- {function} fnEventHandler
- the event handler for the "fullscreen" event
- Since:
- 1.2.0
<static>
{boolean}
chip.fullscreen.getFullscreen()
Tells whether fullscreen mode is currently turned on.
- Since:
- 1.2.0
- Returns:
- {boolean} whether fullscreen mode is turned on
<static>
chip.fullscreen.setFullscreen(bOn)
Turns fullscreen mode on as specified.
- Parameters:
- {boolean} bOn
- whether fullscreen mode is turned on
- Since:
- 1.2.0