Warning Older Docs! - You are viewing documentation for a previous released version of RhoMobile Suite.

QuitButton Module

The QuitButton Module is used to set the parameters of the quit button. When clicked, the Quit button will exit the RhoElements application.

Syntax

quitButton (Module) <META> Syntax

<META HTTP-Equiv="QuitButton" content="[parameter]">

QuitButton JavaScript Object Syntax:
By default the JavaScript Object 'quitButton' will exist on the current page and can be used to interact directly with the quitButton.
To Set quitButton parameters via JavaScript use the following syntax: quitbutton.parameter = 'value'; remembering to enclose your value in quotes where appropriate.

e.g. quitButton.left = 'value';
To set multiple EMML parameters / events on a single line use the following syntax: quitbutton.setEMML("[Your EMML Tags]");

e.g. quitButton.setEMML("left:value");
QuitButton Ruby Object Syntax:
By default the Ruby Object 'QuitButton' will exist on the current page and can be used to interact directly with the QuitButton. All Methods, Parameters and Events are the same as JavaScript, however, notice 'QuitButton' needs to start with an uppercase letter. Another difference in Ruby is that methods do not end in '()'
To Set QuitButton parameters via Ruby use the following syntax: QuitButton.parameter = 'value' remembering to enclose your value in quotes where appropriate.

e.g. QuitButton.left = 'value'

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

Name Possible Values Description Default Value
left:[Value] Positive number, representing pixels Sets the X position of the Quit button. Top right corner of the screen
top:[Value] Positive number, representing pixels Sets the Y position of the Quit button in pixels. Top right corner of the screen
height:[Value] Positive number, representing pixels Sets the height of the Quit button. Dependant on screen resolution
width:[Value] Positive number, representing pixels Sets the width of the Quit button. Dependant on screen resolution
imageUp:[Value] URL Sets the image to be displayed when the Quit Button is in the up state. See Remarks. Default image
imageDown:[Value] URL Sets the image to be displayed when the Quit Button is in the down state. See Remarks. Default image
visibility:[Value] Visible, Hidden Sets the visibility of the Quit button. Hidden.

Remarks

Use of Images on Buttons.

Images can be specified as local to the device or on an HTTP / FTP server, just specify the required protocol as part of your URL (file://\, HTTP:// and FTP://). Image will be scaled to the size of the button. JPEG and GIF images are only supported on WM devices. Both CE and WM support BMP files.

Default Positions

By default this control will be placed a the top of the screen. On Windows Mobile if the ‘FullScreen’ configuration setting is disabled the control will need to be moved, otherwise it will appear beneath the task bar.

Switching to Other Applications

On all devices but the Enterprise Tablet, all controls are designed to be shown on top of RhoElements. If you require to switch to an application other than RhoElements you should minimize RhoElements to ensure the buttons do not remain shown. (Not applicable to Enterprise Tablet)

Screen Orientation

When the screen orientation changes, either using the ScreenOrientation tag or by rotating a device with hardware support, the command areas will automatically move and resize to fit the new layout. However the buttons themselves are not moved and in some cases this may result in them being off the screen or not in the expected position. If so they must be moved manually by detecting the ScreenOrientationEvent.

Use in Production

This API is designed for debugging your application only and should not be used in production

Requirements

RhoElements Version 1.0.0 or above
Supported Devices All supported touch devices.
Minimum Requirements None.
Persistence Persistent - Changes to this module will persist when navigating to a new page.

HTML/JavaScript Examples

The following example shows the Quit button and sets the left and top coordinates to 50.

<META HTTP-Equiv="QuitButton" Content="Visibility:Visible">
<META HTTP-Equiv="QuitButton" Content="Left:50">
<META HTTP-Equiv="QuitButton" Content="Top:50">

The following example shows the Quit button and displays the quit_up.jpg / quit_down.jpg images on it (resizing the images if necessary).

<META HTTP-Equiv="QuitButton" Content="ImageUp:url('http://myaddress/quit_up.jpg'); ImageDown:url('http://myaddress/quit_down.jpg'); Visibility:Visible">
Back to Top