CAknViewAppUi Class Reference
#include
<mw/aknViewAppUi.h>
Link against: Pbk2CommonUI.lib
| class CAknViewAppUi : public CAknAppUi |
| Inherited Functions |
|---|
| | CAknAppUi::CaptureKey(TUint,TUint,TUint) |
| | CAknAppUi::CaptureKeyL(TUint,TUint,TUint,TInt32 &) |
| | CAknAppUi::Cba() |
| | CAknAppUi::ConstructL() |
| | CAknAppUi::CurrentFixedToolbar()const |
| | CAknAppUi::CurrentPopupToolbar()const |
| | CAknAppUi::DecideWsClientBufferSizesL() |
| | CAknAppUi::DisableNextKeySound(TInt) |
| | CAknAppUi::DumpControl(CCoeControl *,TInt,RDebug &) |
| | CAknAppUi::ExitHidesInBackground()const |
| | CAknAppUi::GetAliasKeyCodeL(TUint &,const TKeyEvent &,TEventCode) |
| | CAknAppUi::HandleError(TInt,const SExtendedError &,TDes &,TDes &) |
| | CAknAppUi::HandleErrorL(TInt,HBufC **,TBool) |
| | CAknAppUi::HandleSystemEventL(const TWsEvent &) |
| | CAknAppUi::HandleTouchPaneSizeChange() |
| | CAknAppUi::HandleViewDeactivation(const TVwsViewId &,const TVwsViewId &) |
| | CAknAppUi::HideApplicationFromFSW(TBool) |
| | CAknAppUi::HideInBackground() |
| | CAknAppUi::IsAppHiddenInBackground()const |
| | CAknAppUi::IsAppShutterRunning()const |
| | CAknAppUi::PopupToolbar()const |
| | CAknAppUi::PrepareToExit() |
| | CAknAppUi::Reserved_MtsmObject() |
| | CAknAppUi::Reserved_MtsmPosition() |
| | CAknAppUi::RunAppShutter() |
| | CAknAppUi::SetAliasKeyCodeResolverL(MAknAliasKeyCodeResolver *) |
| | CAknAppUi::SetKeyBlockMode(TAknKeyBlockMode) |
| | CAknAppUi::StatusPane() |
| | CAknAppUi::StopDisplayingPopupToolbar() |
| | CAknAppUi::TouchPane() |
| | CAknAppUi::~CAknAppUi() |
| | CAknAppUiBase::ApplicationRect()const |
| | CAknAppUiBase::ApplyLayoutChangeL(TBool) |
| | CAknAppUiBase::CAknAppUiBase() |
| | CAknAppUiBase::EventForForegroundState(TBool,TBool) |
| | CAknAppUiBase::EventMonitor()const |
| | CAknAppUiBase::Exit() |
| | CAknAppUiBase::FindAppWgIdBelowMeL() |
| | CAknAppUiBase::HandleApplicationSpecificEventL(TInt,const TWsEvent &) |
| | CAknAppUiBase::HandleResourceChangeL(TInt) |
| | CAknAppUiBase::HandleScreenDeviceChangedL() |
| | CAknAppUiBase::HasFullOrPartialForeground()const |
| | CAknAppUiBase::IsAppClosing()const |
| | CAknAppUiBase::IsFaded()const |
| | CAknAppUiBase::IsForeground()const |
| | CAknAppUiBase::IsFullScreenApp()const |
| | CAknAppUiBase::IsLayoutAwareApp()const |
| | CAknAppUiBase::IsMSKEnabledApp()const |
| | CAknAppUiBase::IsPartialForeground()const |
| | CAknAppUiBase::IsSingleClickCompatible()const |
| | CAknAppUiBase::IsTouchCompatible()const |
| | CAknAppUiBase::KeySounds()const |
| | CAknAppUiBase::LocalUiZoom()const |
| | CAknAppUiBase::MopSupplyObject(TTypeUid) |
| | CAknAppUiBase::Orientation()const |
| | CAknAppUiBase::OrientationCanBeChanged()const |
| | CAknAppUiBase::PointerEventModifier() |
| | CAknAppUiBase::ReplaceKeySoundsL(TInt) |
| | CAknAppUiBase::ScreenMode()const |
| | CAknAppUiBase::SetFadedL(TBool) |
| | CAknAppUiBase::SetFullScreenApp(TBool) |
| | CAknAppUiBase::SetKeyEventFlags(const TInt) |
| | CAknAppUiBase::SetLayoutAwareApp(TBool) |
| | CAknAppUiBase::SetLocalUiZoom(TAknUiZoom) |
| | CAknAppUiBase::SetOrientationL(TAppUiOrientation) |
| | CAknAppUiBase::SetScreenModeL(TInt) |
| | CAknAppUiBase::SimulateWsEventL(TInt) |
| | CAknAppUiBase::ThreadIsForeground()const |
| | CAknAppUiBase::~CAknAppUiBase() |
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CCoeAppUi::ActivateTopViewL() |
| | CCoeAppUi::ActivateViewL(const TVwsViewId &) |
| | CCoeAppUi::ActivateViewL(const TVwsViewId &,TUid,const TDesC8 &) |
| | CCoeAppUi::AddToStackL(CCoeControl *,TInt,TInt) |
| | CCoeAppUi::AddToStackL(const MCoeView &,CCoeControl *,TInt,TInt) |
| | CCoeAppUi::AddToViewStackL(const MCoeView &,CCoeControl *,TInt,TInt) |
| | CCoeAppUi::AddViewActivationObserverL(MCoeViewActivationObserver *) |
| | CCoeAppUi::AddViewDeactivationObserverL(MCoeViewDeactivationObserver *) |
| | CCoeAppUi::AddViewObserverL(MCoeViewObserver *) |
| | CCoeAppUi::AppHelpContextL()const |
| | CCoeAppUi::CCoeAppUi() |
| | CCoeAppUi::CheckInitializeViewsL(TUid) |
| | CCoeAppUi::CheckSourceOfViewSwitchL(const TSecurityPolicy &,const char *)const |
| | CCoeAppUi::ConstructL(CCoeAppUi *) |
| | CCoeAppUi::CreateActivateViewEventL(const TVwsViewId &,TUid,const TDesC8 &) |
| | CCoeAppUi::DeactivateActiveViewIfOwnerMatchL() |
| | CCoeAppUi::DeactivateActiveViewL() |
| | CCoeAppUi::DeregisterApplicationView() |
| | CCoeAppUi::DeregisterView(const MCoeView &) |
| | CCoeAppUi::DeregisterViewAndRemoveStack(const MCoeView &) |
| | CCoeAppUi::EnableExternalViewSwitches(TBool) |
| | CCoeAppUi::FrameworkCallsRendezvous()const |
| | CCoeAppUi::GetActiveViewId(TVwsViewId &)const |
| | CCoeAppUi::GetDefaultViewId(TVwsViewId &)const |
| | CCoeAppUi::GetSystemDefaultViewL(TVwsViewId &) |
| | CCoeAppUi::GetTopViewId(TVwsViewId &)const |
| | CCoeAppUi::HandleStackChanged() |
| | CCoeAppUi::HandleStackedControlsResourceChange(TInt) |
| | CCoeAppUi::InputCapabilities()const |
| | CCoeAppUi::IsControlOnStack(CCoeControl *)const |
| | CCoeAppUi::IsDisplayingControlBetweenPriorities(TInt,TInt)const |
| | CCoeAppUi::IsDisplayingDialog()const |
| | CCoeAppUi::IsDisplayingMenuOrDialog()const |
| | CCoeAppUi::IsViewConstructed(const TVwsViewId &)const |
| | CCoeAppUi::MonitorWsEvent(const TWsEvent &) |
| | CCoeAppUi::NotifyFontChange(const CCoeFontProvider &) |
| | CCoeAppUi::NotifyNextActivation(MCoeViewActivationObserver &) |
| | CCoeAppUi::NotifyNextActivation(const TVwsViewId &,MCoeViewActivationObserver &) |
| | CCoeAppUi::NotifyNextDeactivation(MCoeViewDeactivationObserver &) |
| | CCoeAppUi::NotifyNextDeactivation(const TVwsViewId &,MCoeViewDeactivationObserver &) |
| | CCoeAppUi::RefetchPixelMappingL() |
| | CCoeAppUi::RegisterApplicationViewL(TUid) |
| | CCoeAppUi::RegisterViewAndAddStackL(MCoeView &) |
| | CCoeAppUi::RegisterViewL(MCoeView &) |
| | CCoeAppUi::RemoveFromStack(CCoeControl *) |
| | CCoeAppUi::RemoveFromViewStack(const MCoeView &,CCoeControl *) |
| | CCoeAppUi::RemoveViewActivationObserver(MCoeViewActivationObserver *) |
| | CCoeAppUi::RemoveViewDeactivationObserver(MCoeViewDeactivationObserver *) |
| | CCoeAppUi::RemoveViewObserver(MCoeViewObserver *) |
| | CCoeAppUi::SetApplicationViewAsDefaultL() |
| | CCoeAppUi::SetCurrentControlStackGroupId(TInt) |
| | CCoeAppUi::SetCustomControl(TInt) |
| | CCoeAppUi::SetDefaultViewL(const MCoeView &) |
| | CCoeAppUi::SetSystemDefaultViewL(const TVwsViewId &) |
| | CCoeAppUi::SetSystemDefaultViewL(const TVwsViewId &,TInt) |
| | CCoeAppUi::SetWindowGroupOrdinal(TInt) |
| | CCoeAppUi::TopFocusedControl()const |
| | CCoeAppUi::UpdateStackedControlFlags(CCoeControl *,TInt,TInt) |
| | CCoeAppUi::UpdateViewServerBackgroundColor(const TRgb &) |
| | CCoeAppUi::UpdateViewStackedControlFlags(const MCoeView &,CCoeControl *,TInt,TInt) |
| | CCoeAppUi::WriteInternalStateOfStackedControlsL(RWriteStream &)const |
| | CCoeAppUi::~CCoeAppUi() |
| | CEikAppUi::AppUiExtra() |
| | CEikAppUi::Application()const |
| | CEikAppUi::ApplicationLanguageL()const |
| | CEikAppUi::CEikAppUi() |
| | CEikAppUi::ClientRect()const |
| | CEikAppUi::ClosePopup() |
| | CEikAppUi::ContainerAppUi()const |
| | CEikAppUi::CreateFileL(const TDesC &) |
| | CEikAppUi::CreateHotKeyControlL(TInt) |
| | CEikAppUi::Document()const |
| | CEikAppUi::FadeWhenInBackground() |
| | CEikAppUi::HandleCommandL(TInt) |
| | CEikAppUi::HandleMessageL(TUint32,TUid,const TDesC8 &) |
| | CEikAppUi::HandleModelChangeL() |
| | CEikAppUi::HandleSideBarMenuL(TInt,const TPoint &,TInt,const CEikHotKeyTable *) |
| | CEikAppUi::LaunchPopupMenuL(TInt,const TPoint &,TPopupTargetPosType,const CEikHotKeyTable *) |
| | CEikAppUi::MopNext() |
| | CEikAppUi::OpenFileL(const TDesC &) |
| | CEikAppUi::ProcessCommandParametersL(CApaCommandLine &) |
| | CEikAppUi::ProcessCommandParametersL(TApaCommand,TFileName &) |
| | CEikAppUi::ProcessCommandParametersL(TApaCommand,TFileName &,const TDesC8 &) |
| | CEikAppUi::ProcessMessageL(TUid,const TDesC8 &) |
| | CEikAppUi::ReadAppInfoResourceL(TInt) |
| | CEikAppUi::ReportResourceChangedToAppL(TInt) |
| | CEikAppUi::ReportResourceChangedToAppStackL(CEikAppUi *,TInt) |
| | CEikAppUi::SaveAnyChangesL() |
| | CEikAppUi::SaveL() |
| | CEikAppUi::SetDocChanged() |
| | CEikAppUi::SetDocument(CEikDocument *) |
| | CEikAppUi::SetEmbeddedDocInfo(MApaEmbeddedDocObserver *,TBool) |
| | CEikAppUi::SetFaded(TBool) |
| | CEikAppUi::~CEikAppUi() |
Detailed Description
Base class for view architecture-based applications.
Member Type Definition Documentation
Typedef CAknViewActivationQueue
| typedef
CArrayPtrFlat< CViewActivationItem > | CAknViewActivationQueue |
Member Attribute Documentation
Constructor & Destructor Documentation
~CAknViewAppUi ( )
| IMPORT_C | ~CAknViewAppUi | ( | ) | [virtual] |
Member Function Documentation
ActivateLocalViewL ( TUid )
| IMPORT_C void | ActivateLocalViewL | ( | TUid | aViewId | ) | |
Activates a specified application view, without passing any message. The function leaves if activation of the view fails.
| Parameter | Description | | aViewId | Identifier of the view to activate. |
ActivateLocalViewL ( TUid, TUid, const TDesC8 & )
| 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.
| Parameter | Description | | aViewId | Identifier of the view to activate. |
| aCustomMessageId | Specifies the message type. |
| aCustomMessage | The message passed to the activated view. |
AddViewL ( CAknView * )
| Parameter | Description | | aView | The view to be registered and added. |
BaseConstructL ( TInt )
| IMPORT_C void | BaseConstructL | ( | TInt | aAppUiFlags = EStandardApp | ) | |
Initialises this app UI with standard values.
| Parameter | Description | | aAppUiFlags | Application user interface flags. |
EnableLocalScreenClearer ( TBool )
| 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.
| Parameter | Description | | aEnable | ETrue enables local screen clearer. EFalse disables local screen clearer. |
FocusedView ( )
| IMPORT_C TUid | FocusedView | ( | ) | const |
Returns the currently focused view.
- Since
- Series 60 5.0
Returns: UID of the currently focused view.
HandleForegroundEventL ( TBool )
| IMPORT_C void | HandleForegroundEventL | ( | TBool | aForeground | ) | [protected, virtual] |
From CCoeAppUi. Handles changes in keyboard focus when an application switches to foreground.
| Parameter | Description | | aForeground | ETrue if the application is in the foreground, otherwise EFalse. |
HandleStatusPaneSizeChange ( )
| IMPORT_C void | HandleStatusPaneSizeChange | ( | ) | [protected] |
From MEikStatusPaneObserver. Handles a change in the position or size of the screen area occupied by the status pane.
HandleViewNavigationL ( const TKeyEvent & )
Handles keyboard initiated navigation between visible split views.
- Since
- Series 60 5.0
| Parameter | Description | | aKeyEvent | Keyboard event. |
HandleWsEventL ( const TWsEvent &, CCoeControl * )
| 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.
- Since
- Series 60 3.0
| Parameter | Description | | aEvent | Window server event. |
| aDestination | Pointer to the control which the event is targeted to. |
NONSHARABLE_CLASS ( CViewActivationItem )
| NONSHARABLE_CLASS | ( | CViewActivationItem | | ) | [inline] |
NONSHARABLE_CLASS ( TAknSplitViewContainer )
| NONSHARABLE_CLASS | ( | TAknSplitViewContainer | | ) | [inline] |
Container class used to hold information about one split view.
ProcessCommandL ( TInt )
| IMPORT_C void | ProcessCommandL | ( | TInt | aCommand | ) | |
| Parameter | Description | | aCommand | A command ID. |
RemoveSplitViewL ( const TUid )
| 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.
- Since
- Series 60 5.0
| Parameter | Description | | aViewId | UID of a view combination. |
RemoveView ( TUid )
| IMPORT_C void | RemoveView | ( | TUid | aViewId | ) | |
| Parameter | Description | | aViewId | The view to be deregistered and removed. |
SetSplitViewL ( const TUid, const TUid, const TInt )
| 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.
- Since
- Series 60 5.0
| Parameter | Description | | aView1Id | UID of the first (leftmost) view. |
| aView2Id | UID of the second view. |
| aLeftViewSize | Size of the first view (in percentages). |
SplitViewActive ( )
| IMPORT_C TBool | SplitViewActive | ( | ) | const |
Checks if split view is in use.
- Since
- Series 60 5.0
Returns: ETrue if a split view is active.
StopDisplayingMenuBar ( )
| IMPORT_C void | StopDisplayingMenuBar | ( | ) | [virtual] |
Stops displaying the application s menu bar.
View ( TUid )
Gets a pointer to specified application view.
| Parameter | Description | | aView | ID of the application view. |
Returns: Pointer to application view object, NULL if aView doesn't exists.
ViewActivatedL ( CAknView *, const TVwsViewId &, TUid, const TDesC8 & )
ViewDeactivated ( CAknView * )
ViewRect ( const TUid )
Returns view's rectangle.
- Since
- Series 60 5.0
| Parameter | Description | | aViewId | UID of the view whose rectangle should be returned. |
ViewShown ( const TUid )
| IMPORT_C TBool | ViewShown | ( | const TUid | aViewId | ) | const |
Checks if the given view is visible on the screen.
- Since
- Series 60 5.0
| Parameter | Description | | aViewId | View to be checked. |
Returns: ETrue if the given view is visible.