| class CAknViewAppUi : public CAknAppUi |
Base class for view architecture-based applications.
Series 60 0.9
| Public Member Functions | |
|---|---|
| ~CAknViewAppUi() | |
| IMPORT_C void | ActivateLocalViewL(TUid) |
| IMPORT_C void | ActivateLocalViewL(TUid, TUid, const TDesC8 &) |
| IMPORT_C void | AddViewL(CAknView *) |
| IMPORT_C void | BaseConstructL(TInt) |
| IMPORT_C void | EnableLocalScreenClearer(TBool) |
| IMPORT_C TUid | FocusedView() |
| TKeyResponse | HandleViewNavigationL(const TKeyEvent &) |
| IMPORT_C void | ProcessCommandL(TInt) |
| IMPORT_C void | RemoveSplitViewL(const TUid) |
| IMPORT_C void | RemoveView(TUid) |
| IMPORT_C void | SetSplitViewL(const TUid, const TUid, const TInt) |
| IMPORT_C TBool | SplitViewActive() |
| IMPORT_C void | StopDisplayingMenuBar() |
| IMPORT_C CAknView * | View(TUid) |
| void | ViewActivatedL(CAknView *, const TVwsViewId &, TUid, const TDesC8 &) |
| void | ViewDeactivated(CAknView *) |
| TRect | ViewRect(const TUid) |
| IMPORT_C TBool | ViewShown(const TUid) |
| Protected Member Functions | |
|---|---|
| IMPORT_C void | HandleForegroundEventL(TBool) |
| IMPORT_C void | HandleStatusPaneSizeChange() |
| IMPORT_C void | HandleWsEventL(const TWsEvent &, CCoeControl *) |
| Private Member Functions | |
|---|---|
| void | ActivateSplitViewL(CViewActivationItem *) |
| TInt | ActivationCallBack(TAny *) |
| void | ActivationTick() |
| CAknViewAppUiExtension * | Extension() |
| void | QueueActivationTick() |
| TAknSplitViewContainer * | SplitView(const TUid) |
| Inherited Enumerations | |
|---|---|
| CAknAppUiBase:@154 | |
| CAknAppUiBase:TAppUiOrientation | |
| CAknAppUiBase:TKeyEventFlag | |
| CEikAppUi:@109 | |
| Public Member Type Definitions | |
|---|---|
| typedef | CArrayPtrFlat< CViewActivationItem > CAknViewActivationQueue |
| typedef | CArrayPtrFlat< CAknView > CAknViews |
| Protected Attributes | |
|---|---|
| CAknView * | iView |
| CAknViews * | iViews |
| Private Attributes | |
|---|---|
| CAknViewActivationQueue * | iActivationQueue |
| CIdle * | iActivationTick |
| CAknLocalScreenClearer * | iClearer |
| CAknViewAppUiExtension * | iExtension |
| CAknViewShutter * | iShutter |
| Inherited Attributes | |
|---|---|
| CCoeAppUi::iCoeEnv | |
| CEikAppUi::iContainerAppUi | |
| CEikAppUi::iDocument | |
| CEikAppUi::iDoorObserver | |
| CEikAppUi::iEmbeddedAndReadOnly | |
| CEikAppUi::iFlags | |
| IMPORT_C void | ActivateLocalViewL | ( | TUid | aViewId | ) |
Activates a specified application view, without passing any message. The function leaves if activation of the view fails.
| TUid aViewId | Identifier of the view to activate. |
| IMPORT_C void | ActivateLocalViewL | ( | TUid | aViewId, |
| TUid | aCustomMessageId, | |||
| const TDesC8 & | aCustomMessage | |||
| ) | ||||
Activates a specified application view, then passes the message text descriptor aCustomMessage for a message of type aCustomMessageId. The function leaves if activation of the view fails.
| void | ActivateSplitViewL | ( | CViewActivationItem * | aItem | ) | [private] |
Activates views in split view. Series 60 5.0
| CViewActivationItem * aItem |
| TInt | ActivationCallBack | ( | TAny * | aThis | ) | [private, static] |
| TAny * aThis |
| IMPORT_C void | AddViewL | ( | CAknView * | aView | ) |
Registers and adds the view to the app UI. This function calls CCoeAppUi::RegisterViewL.
| CAknView * aView | The view to be registered and added. |
| IMPORT_C void | BaseConstructL | ( | TInt | aAppUiFlags = EStandardApp | ) |
Initialises this app UI with standard values.
| TInt aAppUiFlags = EStandardApp | Application user interface flags. |
| IMPORT_C void | EnableLocalScreenClearer | ( | TBool | aEnable = ETrue | ) |
Enables/disables local screen clearer. Local screen clearer is used in the view based applications to clear the application window if/when the view itself fails to do this. By default, the clearer is used. This function must be called before the BaseConstructL() to prevent the screen clearer on application start up.
3.2
| TBool aEnable = ETrue | ETrue enables local screen clearer. EFalse disables local screen clearer. |
| CAknViewAppUiExtension * | Extension | ( | ) | const [private] |
Asserts that extension object has been created. Extension object.
| IMPORT_C TUid | FocusedView | ( | ) | const |
Returns the currently focused view. Series 60 5.0
UID of the currently focused view.
| IMPORT_C void | HandleForegroundEventL | ( | TBool | aForeground | ) | [protected, virtual] |
From CCoeAppUi. Handles changes in keyboard focus when an application switches to foreground.
| TBool aForeground | ETrue if the application is in the foreground, otherwise EFalse. |
| IMPORT_C void | HandleStatusPaneSizeChange | ( | ) | [protected] |
From MEikStatusPaneObserver. Handles a change in the position or size of the screen area occupied by the status pane.
| TKeyResponse | HandleViewNavigationL | ( | const TKeyEvent & | aKeyEvent | ) |
Handles keyboard initiated navigation between visible split views. Series 60 5.0
| const TKeyEvent & aKeyEvent | Keyboard event. |
| IMPORT_C void | HandleWsEventL | ( | const TWsEvent & | aEvent, |
| CCoeControl * | aDestination | |||
| ) | [protected, virtual] | |||
From AknAppUi. Handles pointer-initiated view switch. Currently this function does nothing but calls base class function. Series 60 3.0
| const TWsEvent & aEvent | Window server event. |
| CCoeControl * aDestination | Pointer to the control which the event is targeted to. |
| IMPORT_C void | ProcessCommandL | ( | TInt | aCommand | ) |
Processes user commands.
| TInt aCommand | A command ID. |
| IMPORT_C void | RemoveSplitViewL | ( | const TUid | aViewId | ) |
Removes a view combination containing the given view UID. If the view with the given UID is currently visible then the screen is switched to single view and the the given view stays active. Series 60 5.0
| const TUid aViewId | UID of a view combination. |
| IMPORT_C void | RemoveView | ( | TUid | aViewId | ) |
Removes and deregisteres the view from the app UI. This function calls CCoeAppUi::DeregisterView.
| TUid aViewId | The view to be deregistered and removed. |
| IMPORT_C void | SetSplitViewL | ( | const TUid | aView1Id, |
| const TUid | aView2Id, | |||
| const TInt | aLeftViewSize | |||
| ) | ||||
Combines two views. If either of the views belongs to another view combination then that combination is removed. Series 60 5.0
| TAknSplitViewContainer * | SplitView | ( | const TUid | aViewId | ) | const [private] |
If the given view is part of a split view then returns that split view, Series 60 5.0
Pointer to a correct split view or NULL if no corresponding split view was found.
| const TUid aViewId | UID of a view that belongs to a split view. |
| IMPORT_C TBool | SplitViewActive | ( | ) | const |
Checks if split view is in use. Series 60 5.0
ETrue if a split view is active.
| IMPORT_C void | StopDisplayingMenuBar | ( | ) | [virtual] |
Stops displaying the application s menu bar.
| IMPORT_C CAknView * | View | ( | TUid | aView | ) | const |
Gets a pointer to specified application view. Pointer to application view object, NULL if aView doesn't exists.
| TUid aView | ID of the application view. |
| void | ViewActivatedL | ( | CAknView * | aView, |
| const TVwsViewId & | aPrevViewId, | |||
| TUid | aCustomMessageId, | |||
| const TDesC8 & | aCustomMessage | |||
| ) | ||||
| CAknView * aView | |
| const TVwsViewId & aPrevViewId | |
| TUid aCustomMessageId | |
| const TDesC8 & aCustomMessage |
| TRect | ViewRect | ( | const TUid | aViewId | ) | const |
Returns view's rectangle. Series 60 5.0
| const TUid aViewId | UID of the view whose rectangle should be returned. |
| IMPORT_C TBool | ViewShown | ( | const TUid | aViewId | ) | const |
Checks if the given view is visible on the screen. Series 60 5.0
ETrue if the given view is visible.
| const TUid aViewId | View to be checked. |