epoc32/include/mw/coeview.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    18 
    18 
    19 #include <vwsdef.h>
    19 #include <vwsdef.h>
    20 #include <coemain.h> // for CCoeStatic
    20 #include <coemain.h> // for CCoeStatic
    21 
    21 
    22 class CCoeAppUi;
    22 class CCoeAppUi;
       
    23 class TVwsViewEvent;
    23 
    24 
    24 /** Specifies an interface for views. 
    25 /** Specifies an interface for views. 
    25 
    26 
    26 This class should be implemented by all application views. 
    27 This class should be implemented by all application views. 
    27 
    28 
    71 	IMPORT_C virtual void MCoeView_Reserved_3();
    72 	IMPORT_C virtual void MCoeView_Reserved_3();
    72 private:
    73 private:
    73 	TInt iMCoeView_Reserved1;
    74 	TInt iMCoeView_Reserved1;
    74 	};
    75 	};
    75 
    76 
    76 /** An interface through which view deactivations can be
    77 /** An interface through which view events can be notified to an observer.
    77 notified to an observer.
       
    78 
       
    79 Dialogs and other floating windows such as virtual keyboards which should be dismissed
       
    80 when a view is deactivated can implement this interface and take any action required.
       
    81 
    78 
    82 @publishedAll
    79 @publishedAll
    83 @released */
    80 @released */
    84 class MCoeViewDeactivationObserver
    81 class MCoeViewObserver
    85 	{
    82 	{
    86 public:
    83 public:
    87 	//
    84 	virtual void HandleViewEventL(const TVwsViewEvent& aEvent)=0;
    88 	// Handles the deactivation of the view identified by aViewIdToBeDeactivated before the newly activated
       
    89 	// view with id aNewlyActivatedViewId is marked as current.
       
    90 	//
       
    91 	virtual void HandleViewDeactivation(const TVwsViewId& aViewIdToBeDeactivated,const TVwsViewId& aNewlyActivatedViewId)=0;
       
    92 protected:
    85 protected:
    93 	IMPORT_C MCoeViewDeactivationObserver();
    86 	IMPORT_C MCoeViewObserver();
    94 private:
    87 private:
    95 	IMPORT_C virtual void MCoeViewDeactivationObserver_Reserved_1();
    88 	IMPORT_C virtual void MCoeViewObserver_Reserved1();
    96 	IMPORT_C virtual void MCoeViewDeactivationObserver_Reserved_2();
    89 	IMPORT_C virtual void MCoeViewObserver_Reserved2();
    97 private:
    90 private:
    98 	TInt iMCoeViewDeactivationObserver_Reserved1;
    91 	TInt iMCoeViewObserver_Reserved1;
    99 	};
    92 	};
   100 
    93 
   101 /** An interface through which view activations can be notified to an observer.
    94 /** An interface through which view activations can be notified to an observer.
   102 
    95 
   103 @publishedPartner
    96 @publishedAll
   104 @released
    97 @released
   105 */
    98 */
   106 class MCoeViewActivationObserver
    99 class MCoeViewActivationObserver
   107 	{
   100 	{
   108 public:
   101 public:
   118 	IMPORT_C virtual void MCoeViewActivationObserver_Reserved_2();
   111 	IMPORT_C virtual void MCoeViewActivationObserver_Reserved_2();
   119 private:
   112 private:
   120 	TInt iMCoeViewActivationObserver_Reserved1;
   113 	TInt iMCoeViewActivationObserver_Reserved1;
   121 	};
   114 	};
   122 
   115 
       
   116 /** An interface through which view deactivations can be
       
   117 notified to an observer.
   123 
   118 
   124 /** An interface through which view events can be notified to an observer.
   119 Dialogs and other floating windows such as virtual keyboards which should be dismissed
       
   120 when a view is deactivated can implement this interface and take any action required.
   125 
   121 
   126 @publishedPartner
   122 @publishedAll
   127 @released */
   123 @released */
   128 class MCoeViewObserver
   124 
       
   125 class MCoeViewDeactivationObserver
   129 	{
   126 	{
   130 public:
   127 public:
   131 	virtual void HandleViewEventL(const TVwsViewEvent& aEvent)=0;
   128 	//
       
   129 	// Handles the deactivation of the view identified by aViewIdToBeDeactivated before the newly activated
       
   130 	// view with id aNewlyActivatedViewId is marked as current.
       
   131 	//
       
   132 	virtual void HandleViewDeactivation(const TVwsViewId& aViewIdToBeDeactivated,const TVwsViewId& aNewlyActivatedViewId)=0;
   132 protected:
   133 protected:
   133 	IMPORT_C MCoeViewObserver();
   134 	IMPORT_C MCoeViewDeactivationObserver();
   134 private:
   135 private:
   135 	IMPORT_C virtual void MCoeViewObserver_Reserved1();
   136 	IMPORT_C virtual void MCoeViewDeactivationObserver_Reserved_1();
   136 	IMPORT_C virtual void MCoeViewObserver_Reserved2();
   137 	IMPORT_C virtual void MCoeViewDeactivationObserver_Reserved_2();
   137 private:
   138 private:
   138 	TInt iMCoeViewObserver_Reserved1;
   139 	TInt iMCoeViewDeactivationObserver_Reserved1;
   139 	};
   140 	};
   140 
       
   141 
   141 
   142 //
   142 //
   143 // Handles any screen device changes that occur while a view is active 
   143 // Handles any screen device changes that occur while a view is active 
   144 //
   144 //
   145 /** A default screen device change handler. 
   145 /** A default screen device change handler.