navigator_window_cover_update()

Update the window cover used by the navigator.

Synopsis:

#include <bps/navigator.h>
 
BPS_API int navigator_window_cover_update(navigator_window_cover_attribute_t *attribute)

Since:

BlackBerry 10.0.0

Arguments:

attribute

A window cover attribute handle.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

When a NAVIGATOR_WINDOW_COVER_ENTER event occurs the app has a window cover being displayed. By default, this is a scaled down version of the application's screen. An application can call this function to change what is used for the app's window cover.

Returns:

On success, BPS_SUCCESS. Otherwise, BPS_FAILURE with errno set and the window cover will not be changed.