Window

Since: BlackBerry 10.0.0

#include <bb/cascades/Window>

Provides access to native window properties and state.

The Window for the application is accessible through the Application::mainWindow property.


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::Window

QML properties

groupId: QString [read-only]
handle: QVariant [read-only]
screenIdleMode: bb::cascades::ScreenIdleMode::Type
state: bb::cascades::WindowState::Type [read-only]
objectName: QStringInherited
parent: QObject [read-only]Inherited

QML signals

Public Functions Index

virtual ~Window ()
QStringgroupId () const
screen_window_thandle () const
bb::cascades::ScreenIdleMode::TypescreenIdleMode () const
bb::cascades::WindowState::Typestate () const
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited

Public Slots Index

voidsetScreenIdleMode (bb::cascades::ScreenIdleMode::Type newScreenIdleMode)

Signals Index

voidposted ()
voidscreenIdleModeChanged (bb::cascades::ScreenIdleMode::Type newScreenIdleMode)
voidstateChanged (bb::cascades::WindowState::Type newState)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

QString groupId[read-only]

Property specifying the window group for this window.

Since:

BlackBerry 10.0.0

QVariant handle[read-only]

Property specifying the window handle for this window.

The value of this property can be safely converted to screen_window_t type.

Since:

BlackBerry 10.0.0

bb::cascades::ScreenIdleMode::Type screenIdleMode

Property indicating the idle behavior of the screen when this window is displayed.

The window may allow either the normal idle behavior with ScreenIdleMode::Normal, or it can prevent idle behavior with ScreenIdleMode::KeepAwake.

The default value is ScreenIdleMode::Normal.

Since:

BlackBerry 10.0.0

bb::cascades::WindowState::Type state[read-only]

Property indicating the state of the window.

A stateChanged() signal is emitted when the value of this property changes.

In addition a posted() signal is emitted when window changes its state to WindowState::Posted.

The default value is WindowState::Created.

Since:

BlackBerry 10.0.0

QString objectNameInherited

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parentInherited[read-only]

A read-only property that represents this object's parent.

The parent of an object is specified using QObject::setParent(QObject*). The purpose of the property is to expose the object's parent to QML.

This property is read-only to prevent modifications from QML, where typically the parent is declaratively set. In C++ code, the parent can be explicitly set using QObject::setParent(QObject*), or implicitly set by adding it to a visual container.

The default value of this property is 0.

Since:

BlackBerry 10.0.0

Public Functions

virtual~Window ()

Destructor.

Does not affect the represented native window.

Since:

BlackBerry 10.0.0

QString groupId ()

Returns the window group for this window.

Return:

A string representing window group

Since:

BlackBerry 10.0.0

screen_window_t handle ()

Returns the window handle for this window.

Return:

A window handle (can be casted to screen_window_t type)

Since:

BlackBerry 10.0.0

bb::cascades::ScreenIdleMode::Type screenIdleMode ()

Returns the current mode the window is using to control the idle behavior of the screen.

Typically, this is to leave the behavior unchanged with ScreenIdleMode::Normal.

Return:

The value of the current idle mode behavior. The returned value will be either ScreenIdleMode::Normal or ScreenIdleMode::KeepAwake.

Since:

BlackBerry 10.0.0

bb::cascades::WindowState::Type state ()

Returns the state of the window.

Return:

The state of the window

Since:

BlackBerry 10.0.0

void setObjectName (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (Inherited

Constructs an instance of BaseObject's subclass.

Parameters
parent

An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

Public Slots

void setScreenIdleMode (

Controls the idle behavior of the screen when this window is displayed.

Typically the idle behavior is to fade the display, but this may also include other behaviors like locking the device.

Parameters
newScreenIdleMode

The idle behavior to use when this window is displayed. Must be one of ScreenIdleMode::Normal, or ScreenIdleMode::KeepAwake.

Since:

BlackBerry 10.0.0

Signals

void posted ()

Emitted when the window state becomes WindowState::Posted.

After this signal is emitted it is safe to use Window's groupId and handle with the APIs which require the window to be posted (such as for use with Cards).

Since:

BlackBerry 10.0.0

void screenIdleModeChanged (

Emitted when the idle mode behavior is changed.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use screenIdleMode instead of newScreenIdleMode).

Parameters
newScreenIdleMode

The new idle behavior for the screen when this window is displayed.

Since:

BlackBerry 10.0.0

void stateChanged (

Emitted when the state of the window changes.

Note:

Due to a work around for a Qt Core issue with accessing enums from QML the argument of this signal doesn't follow naming convention for signals in which the signal arguments are typically named to match the associated property's name. Use the object's property to access current property value instead of the signal argument to avoid runtime errors (i.e. use state instead of newState).

Parameters
newState

the new state of the window

Since:

BlackBerry 10.0.0

void creationCompleted ()Inherited

Emitted when this object is instantiated as a result of loading a QML document and creating the root node (only after the root component that caused this instantiation has completed construction), or when the object is being constructed from its builder class.

This signal indicates that the construction and initialization of the object has been completed, the properties are initialized, and any QML binding values have been assigned to the object.

This signal is not emitted when the object is constructed from C++ using the constructor. If the object is constructed using its builder class, the signal is emitted when the the builder class returns the fully constructed object.

This signal can be used when there is an activity that needs to be performed, such as a property state integrity verification after the object is instantiated from a QML document or a builder, but before control is returned to the application.

See also:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus