Android Widget windows

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Overview
Creating an Android Widget window
Characteristics of Android Widget window
Size of a Widget window
Update the content
Redisplaying the Widget window
Image of Widget
Programming an Android Widget window
Opening a Widget window
Closing a Widget window

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Creating an Android Widget

Android Widget windows

Overview

An Android application can contain one or more Widget windows. These windows can be displayed on the home screen of tablet or phone.

The information displayed in these windows is updated on a regular basis. The Widgets windows allow simple interactions with the user.

Creating an Android Widget window

To create an Android Widget window:

Click among the quick access buttons:
- The element creation window appears: click "Window" then "Window".
- The window creation wizard starts.
In the "Standard" tab, in the "Other platform" area, select "Blank for Widget" and validate.
A new window is created in the editor. Only 3 types of controls are available in the Widget windows: the Button controls, the Static controls and Image controls.

Remark: It is also possible to change the type of an existing window:

Open the window description ("Description" in the popup menu).
In the "UI" tab, select "Widget (Android)".
Validate.

Characteristics of Android Widget window

Size of a Widget window

The size of a Widget window is defined in number of vertical and horizontal cells. This size can be configured in the "UI" tab of description window:

The size of a cell is set to 74 pixels for the side (for a dpi of 160).

For a display compatible with most of the devices (phones and tablets), the maximum size should not exceed 4 x 4 cells.

Remark: The Widgets created with WINDEV Mobile cannot be resized.

Update the content

Widget windows include a specific event: Refreshing the Widget. This event is used to update the Widget content. This event starts at regular time intervals. The refresh frequency is defined in the "UI" tab of description window.

Remarks:

This refresh frequency cannot be less than 30 minutes.
The WidgetDisplay function causes the Widget to be displayed again and the "Refresh Widget" event to be executed.

Redisplaying the Widget window

The drawing of a Widget window is displayed by the process that manages the home screen of device. This display is not always performed. It is updated in the following cases:

Adding a new instance of the Widget on the home screen.
Once a Widget button or image was clicked.
Once the Widget content was updated.

Remark: The WidgetDisplay function causes the Widget to be displayed again and the "Refresh Widget" event to be executed.

Image of Widget

When installing a Widget on the desktop, the user can see the list of Widgets found on his computer. This list contains, for each Widget, the Widget name and the preview image.

The preview image of Widget is defined in the "UI" tab of description window.

You can:

provide a specific image.
genereate a screenshot of the window. In this case, the screenshot is automatically associated with the preview image.

If no image is specified, the icon of the Android application will be automatically used.

Programming an Android Widget window

Opening a Widget window

You cannot explicitly request the opening of a Widget window. The opening functions (OpenSister, OpenChild, Use) will trigger a fatal error if they are used in Widget mode.

The Widget windows are automatically opened in the following cases :

Adding on the home screen the first instance of the Widget corresponding to the window.
Once the device is started if at least one instance of the Widget is found on the home screen.
When updating the Widget or when the user interacts with the Widget (click on a button for example).
If the process was stopped by the system (if it needs resources for example).

The events run when a Widget window is open are :

"Global declarations" of the window.
"Initializing" window controls.
"Initializing" the window.
"Refreshing the Widget".

The event "Initializing" associated with the project will only be run before the first Widget window of the application is opened. To differentiate the Widget-specific code from the application-specific code in this event, use InWidgetMode.

Closing a Widget window

You cannot explicitly request the closing of a Widget window. ferme will trigger a fatal error if it is used in Widget mode.

The Widget windows are automatically closed when the last instance of the Widget is removed from the home screen. The event "Closing" (associated with the window) is run when a Widget window is closed.

The closing process of the project will be run when the last instance of the application Widget is removed from the home screen and when no other instance is displayed for the other Widgets of the application.