Application

This function removes any close prompt that was set, regardless of which ApplicationSupport or Application object set the prompt. When the close prompt is cleared, no close prompt dialog box will appear when the user tries to close the application, and the application exits normally.

If there is no current close prompt, this method has no effect.

#include <bb/Application>

void saveApplicationData(bb::Application &myApp)
{
    saveData();

    // Application can now close cleanly since data is saved.
    myApp.clearClosePrompt();
}

import bb.cascades 1.0

Page {
    Container {
        
        Button {
            text: "Save"
            
            onClicked: {
                saveData();
                Application.clearClosePrompt();
            }
        }
        
        // Additional QML
    }
}

After deregistering, all state information about the window group is discarded.

Note that you do not have to explicitly register a window group for state to be maintained. This class automatically maintains the window state about any window group for which state events are received. When deleting a window group, it can be beneficial to deregister it so that state information is no longer maintained in memory.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state.

A window group is invisible if it cannot be seen on the display.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state.

A window group is thumbnailed if is is currently not fullscreen but is still visible on the display.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state. Specifically, the process must receive an execution state update from Navigator with the given windowGroupID before this method can return a correct result.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state. Specifically, the process must receive an execution state update from Navigator with the given windowGroupID before this method can return a correct result.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state. Specifically, the process must receive a UI state update from Navigator with the given windowGroupID before this method can return a correct result.

A window group is invisible if it cannot be seen on the display.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state. Specifically, the process must receive a UI state update from Navigator with the given windowGroupID before this method can return a correct result.

A window group is thumbnailed if is is currently not fullscreen but is still visible on the display.

If this method is called before Navigator events are processed, this method will return false since the application has not updated its state. Specifically, the process must receive a UI state update from Navigator with the given windowGroupID before this method can return a correct result.

This function allows an application to prevent the user from closing the application without warning. If the user tries to close the application, a dialog box is displayed with the title and message specified. The dialog box will have 2 buttons: "Cancel" and "Close". If the user selects "Close", the application will be closed. If the user selects "Cancel", the dialog box will close and the application will continue running.

Note that the save prompt for an application is stored persistently on the device. The last call to this method on any ApplicationSupport or Application object determines the close prompt that will be shown. The close prompt persists until unsetClosePrompt() is called on any ApplicationSupport or Application object. Destroying the object that set the close prompt does not reset the value.

Note that all commas and double quotes are stripped from the title and message parameters before they are displayed. These characters cannot be displayed correctly. If the text also includes backslash characters ('\'), this process can introduce unexpected white space characters like tabs ('\t') and newlines ('\n'). Since these whitespace characters are allowed in the dialog box, they cannot be stripped.

Escape characters can be used, but they may be awkward to specify. The string provided to this method is in turn forwarded to the device's home screen process, which interprets the string a second time, including any escape characters. This can require multiple levels of escaping to produce the desired effect. For instance, to add a backslash ('\') character to the close prompt, the string "\\\\" must be used. This provides the string "\\" to this object. When this string is forwarded to the home screen, "\\" is interpreted again to become '\'.

#include <bb/Application>

void applicationDataChanged(bb::Application &myApp)
{
    // Warn the user if they try to quit without saving.
    myApp.setClosePrompt("Unsaved changes", "The application has unsaved changes.");
}

import bb.cascades 1.0

Page {
    Container {
        TextField {
            onTextChanging: {
                Application.setClosePrompt("Unsaved changes",
                                           "The application has unsaved changes.");
            }
            // Other properties
        }
        // Additional QML
    }
}

This method can be used to register a specific window group as the application's main window group. The signals thumbnail(), fullscreen(), invisible(), asleep(), and awake() will be emitted when the corresponding event occurs on either no window group (window group ID of "none") or on the application's main window group.

If this method is not called, then the application's main window group will be the first valid window group that appears in a lifecycle event. A valid window group ID is a non-empty string that is not the value "none". For applications that do not use window groups or use a single window group (the default in a Cascades application), this default behavior should produce correct results for the five lifecycle signals (thumbnail(), fullscreen(), invisible(), asleep(), and awake()).

If an application creates multiple window groups (which must be done explicitly), then this method can be called to ensure the application's main group is set correctly. In this case, you should consider using the five lifecycle events augmented with the window group ID to receive more precise lifecycle information. These augmented signals are windowGroupThumbnailed(const QString &), windowGroupFullscreen(const QString &), windowGroupInvisible(const QString &), windowGroupAsleep(const QString &), and windowGroupAwake(const QString &).