1 /*

     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  VT UI Component manager API definition.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_VTUICOMPONENTMANAGER_H

    20 #define M_VTUICOMPONENTMANAGER_H

    21 

    22 #include <e32base.h>

    23 

    24 #include "mvtuicomponent.h"

    25 

    26 class TVtUiComponentState;

    27 class MVtUiWindowServerEventObserver;

    28 class MVtUiResourceChangeObserver;

    29 class MVtUiKeyEventObserver;

    30 class MVtUiLayoutChangeObserver;

    31 

    32 /**

    33  *  MVtUiComponentManager

    34  *

    35  *  Component manager API definition.

    36  *

    37  *  @since S60 v3.2

    38  */

    39 class MVtUiComponentManager

    40     {

    41 

    42 public: // enumerations

    43 

    44     /**

    45      * Registration action.

    46      */

    47     enum TAction

    48         {

    49         /** Register action */

    50         ERegister,

    51 

    52         /** Unregister action */

    53         EUnregister

    54         };

    55 

    56 public: // public methods

    57 

    58     /**

    59      * Register or unregister Ws event listening.

    60      *

    61      * @param aComponent Observer whose registration will be changed.

    62      * @param aAction Registration action

    63      * @see MVtUiComponentManager::TAction

    64      * @return KErrNone if registration action succeeded.

    65      */

    66     virtual TInt ChangeWsEventRegistration(

    67         MVtUiWindowServerEventObserver& aComponent,

    68         TAction aAction ) = 0;

    69 

    70     /**

    71      * Register or unregister resource change event listening.

    72      *

    73      * @param aComponent Observer whose registration will be changed.

    74      * @param aAction Registration action

    75      * @see MVtUiComponentManager::TAction

    76      * @return KErrNone if registration action succeeded.

    77      */

    78     virtual TInt ChangeResourceChangeRegistration(

    79         MVtUiResourceChangeObserver& aComponent,

    80         TAction aAction ) = 0;

    81 

    82     /**

    83      * Register or unregister key event listening.

    84      *

    85      * @param aComponent Observer whose registration will be changed.

    86      * @param aAction Registration action

    87      * @see MVtUiComponentManager::TAction

    88      * @return KErrNone if registration action succeeded.

    89      */

    90     virtual TInt ChangeKeyEventRegistration( MVtUiKeyEventObserver& aComponent,

    91         TAction aAction ) = 0;

    92 

    93     /**

    94      * Register or unregister layout change listening.

    95      *

    96      * @param aComponent Observer whose registration will be changed.

    97      * @param aAction Registration action

    98      * @see MVtUiComponentManager::TAction

    99      * @return KErrNone if registration action succeeded.

   100      */

   101     virtual TInt ChangeLayoutChangeRegistration( MVtUiLayoutChangeObserver& aComponent,

   102         TAction aAction ) = 0;

   103 

   104     /**

   105      * Register or unregister component.

   106      *

   107      * @param aComponent Observer whose registration will be changed.

   108      * @param aAction Registration action

   109      * @see MVtUiComponentManager::TAction

   110      * @return KErrNone if registration action succeeded.

   111      */

   112     virtual TInt ChangeComponentRegistration( TVtUiComponentState& aComponent,

   113         TAction aAction ) = 0;

   114 

   115     /**

   116      * Request component activation.

   117      *

   118      * @param aId Id of component to be activated.

   119      */

   120     virtual void RequestActivationL( MVtUiComponent::TComponentId aId ) = 0;

   121 

   122     /**

   123      * Deactivate component.

   124      *

   125      * @param aId Id of component to be deactivated.

   126      */

   127     virtual void DeActivateComponentL( MVtUiComponent::TComponentId aId ) = 0;

   128 

   129     };

   130 

   131 #endif // M_VTUICOMPONENTMANAGER_H