C++ constructor.

To complete construction, call ConstructL().

The destructor frees all resources owned by the object, including the control stack and the view server session.

Activates the top view for this app UI.

This is the most recently active view, if any. Otherwise, it activates the default view. If there is no default view, it activates the first registered view.

Activates an application view.

A leave occurs if view activation fails.

Activates an application view and passes a message to it.

A leave occurs if view activation fails.

Notes:

Activation works synchronously so that in general, this method returns when the view is activated.

An application defines and publishes the message UIDs that it recognises. For example, a contacts application might activate an email editor view, passing an email address as a custom message. To do this, the contacts application must use a message UID, and descriptor encoding that the email application has published as being recognisable.

Inserts a control into the app UI's control stack.

Inserts a control into the app UI's control stack.

Use the other AddToStackL() overload if the app UI uses multiple views.

Adds an observer to the list of observers to be notified of view activations.

All view activation observers that have been added to the app UI are notified via their HandleViewActivation() function when any of this app UI's views are activated.

Adds an observer to the list of observers to be notified of view deactivations.

All view deactivation observers that have been added to the app UI are notified via their HandleViewDeactivation() function when any of this app UI's views are deactivated.

Adds the specified observer to the list of view observers.

All view observers added using this function are notified via their HandleViewEventL() function when the app UI receives any view activation or deactivation event.

Returns a list of help contexts appropriate to the current state of the application.

The array is generated from the help contexts for all visible controls on the app UI's control stack, and from the app UI itself (via CCoeAppUi::HelpContextL()).

Ensures that at least one view is registered for the app UI.

It adds an application view as the default if no views have been added, so that the application can participate in the view switching mechanism. It also sets a default view if none has been set.

This is called by the UI framework during application construction.

Checks whether the view-server client that initiated the current view-switch matches the security-policy given in the parameter.

This function leaves with KErrUnknown if called outside of an implementation of MCoeView's ViewConstructL or of MCoeView's ViewActivatedL.

TSecurityPolicy

Completes construction of the CCoeAppUi object.

It creates the application's control stack and starts a view server session.

Sends a request to the view server to activate the specified view, and returns without waiting for the request to complete.

Note that this method may return without error but the activation may subsequently fail.

Deactivates the active view if the current view is owned by this application.

Deactivating the active view is necessary before exiting if the app UI has an active view. This function is called by the UI framework during application closure.

Deactivates the active view.

Deactivating the active view is necessary before exiting if the app UI has an active view. In most cases, DeactivateActiveViewIfOwnerMatch should be used instead of this function.

DeactivateActiveViewIfOwnerMatch

Deregisters the application view from the view architecture.

Deregisters a view.

All views must be deregistered before the application exits. This is usually done in the app UI's destructor.

It has no effect if the specified view does not exist.

Enables/disables external view switches for this instance of this application

By default external view switches are enabled.

Indicates the default behaviour for synchronizing to the startup (usually SystemStarter).

Gets the ID of the app UI's currently active view.

Gets this app UI's default view ID.

Finds and returns the current top view, not necessarily the currently active view

Handles an application-specific event.

This function is called from HandleWsEventL() when the app UI receives a window server event that is not in the standard range (in other words, it has a positive value greater than EEventUser).

This default implementation is empty.

Handles changes in keyboard focus when the application is brought to the foreground, or put into the background.

This function is called from HandleWsEventL() when an EEventFocusLost or EEventFocusGained event occurs.

This default implementation is empty.

Handles key events.

This function is called by HandleWsEventL() if a key event occurred but none of the controls in the app UI's control stack consumed it.

Key events are sent to the application by the window server. A key press generates three separate key events in the order EEventKeyDown, EEventKey, and EEventKeyUp. Controls and app UIs are usually only interested in EEventKey events.

This default implementation simply returns EKeyWasNotConsumed. It may need to be overridden if the derived app UI needs to handle certain key events itself. For example, in some applications, arrow keys may be used to navigate between views. In this case, the app UI should override this function to consume the arrow keys.

Handles changes to the control stack.

This function ensures that the focusable control with the highest priority on the control stack has keyboard focus.

It may need to be called when a control's flag values are modified, by calling UpdateStackedControlFlags(). It is called automatically when a control is added to or removed from the stack.

Handles a change to the application's run-time resources for all controls on the app UI's control stack.

These are resources which are shared across the environment, such as colours, fonts or ZoomFactor.

Handles the special switch on event.

This function is called by HandleWsEventL() if the device is switched on. This default implementation is empty.

Handles system events generated by the window server.

This method should be overridden by the UI layer like CEikAppUi but not by individual applications. Application events (has a positive value greater than EEventUser) will be sent to HandleApplicationSpecificEventL.

Unrecognized events should be forwarded to the base class.

Handles events sent to the application by the window server.

This function is called whenever the window server sends key or pointer events or some other special events to the application. It calls one of a number of functions, according to the type of event.

For key events, it calls CCoeControl::OfferKeyEventL() for each control on the control stack, beginning with the control at the top (position 0) until a control consumes it. If no control on the stack consumes the key event, the app UI's HandleKeyEventL() is called. Note that CCoeControl::OfferKeyEventL() is not called for controls whose ECoeStackFlagRefusesAllKeys flag is set.

For pointer events, CCoeControl::ProcessPointerEventL() is called on the control specified in aDestination.

For pointer buffer ready events, ProcessPointerBufferReadyL() is called on the control specified in aDestination.

For other events, for instance focus change events, this function calls one of the following CCoeAppUi private virtual functions:

All these functions have empty implementations in this class, and are implemented by derived classes, if required.

CCoeAppUi::HandleWsEventL()

Gets a list of help contexts for the app UI.

This default implementation returns NULL.

Returns the input capabilities of the control with focus.

Classes that override CCoeAppUi::HandleKeyEventL() should also override this virtual function. The TCoeInputCapabilities object returned should have attributes that match the behaviour of the HandleKeyEventL() function.

Overriding app UIs should do a base-call and "merge" the returned input capabilities with its own input capabilities. If the overriding InputCapabilities() function needs to get the input capabilities of any top-level control, it should do so by calling CCoeControl::RecursivelyMergedInputCapabilities() on that control.

Tests whether the application is displaying a control between the given control stack priorities.

Tests whether the application is displaying a dialog.

Tests whether the application is displaying a menu bar or dialog.

Checks if the view has been constructed or not.

Monitor function for passing all windows events to registered monitor observers for optional inspection

Monitor function for passing all windows events to registered monitor observers for optional inspection

Requests that the next activation of the view identified by aViewId be notified to the specified view activation observer.

The request is cleared after the notification: the observer can only be notified once, and there can be no more than one such request pending.

Requests that the next activation of any view registered with the view server be notified to the specified observer.

The request is cleared after the notification: the observer can only be notified once, and there can be no more than one such pending request.

Requests that the next deactivation of the view identified by aViewId be notified to the specified view deactivation observer.

The request is cleared after the notification: the observer can only be notified once, and this app UI can have no more than one such request pending.

Requests that the next deactivation of any view registered with the view server be notified to the specified view deactivation observer.

The request is cleared after the notification: the observer can only be notified once, and this app UI can have no more than one such request pending.

Performs pre-exit processing on the control environment.

This function is called after the control environment's active scheduler exits, but before the control environment (i.e. the CCoeEnv object) is destroyed. The default implementation is empty, and this function is not implemented by CCoeAppUi, but it may be implemented by derived classes to perform pre-exit processing on the control environment.

Notify all CCoeFontProvider's that the global logical-to-pixel mapping has changed in CCoeControlStaticSettings

Registers a pseudo-view for the application identified by aAppUid.

The view server is notified that a view exists for the application, which allows it to participate in the view switching mechanism, even though it does not implement any views.

Activating the application view means bringing the application into the foreground.

Registers a view with the view server.

All views should be registered in the app UI's ConstructL().

Removes a control from the app UI's control stack.

This function also handles any focus changes that may occur.

Removes the specified observer from the list to be notified of view activations.

Removes an observer from the list to be notified of view deactivations.

This has no effect if the observer is not found in the list.

Removes the specified observer from the list of view observers.

This has no effect if the specified observer is not found in the list.

Sets the keyboard focus of a control and draws it.

This is called by HandleWsEventL() when it receives a focus change event and can also be called when a new control is moved to the top of the control stack.

This default implementation is empty. It is intended that an implementation should set the value of a focus flag within the control to the value given by aFocus. This flag indicates whether or not the control has keyboard focus. The function should then draw or change the appearance of the control to indicate whether or not it has focus.

Sets the application view to be the default view.

In debug builds, this panics if no application view has been added for this app UI.

Allows customised control of Window Group ordinal position during view activations

Sets one of the app UI's views as the default.

The default view should be constructed, drawn, registered and set as the default as early as possible in the app UI's ConstructL() function.

The meaning of the default view varies depending on the UI. It is normally the view that is displayed when the application is launched. It may also be the view that is displayed when the application is brought to the foreground.

Changes the default window group ordinal position used when bringing views to the foreground. Only used if CCoeAppUi::SetCustomControl has been called with a positive value.

Returns the top control of this appui which currently has the focus.

Updates the flag values for a control on the control stack.

The mask defines which flags are modified, while aFlags defines the values they are set to.

Changes the default background color for the View Server screen blanking window

Writes the internal state of all CCoeControls on the control stack into aWriteStream. Works in debug builds only.