1 /*

     2 * Copyright (c) 2005-2005 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:  header file of layout interface

    15 *

    16 */

    17 

    18 

    19 #ifndef C_CPENINPUTUILAYOUTINTERFACE_H

    20 #define C_CPENINPUTUILAYOUTINTERFACE_H

    21 

    22 #include <e32base.h>

    23 #include <ecom.h>

    24 #include <badesca.h>

    25 

    26 class MPenUiLayoutBase;

    27 class MLayoutOwner;

    28 

    29 /** UID of HWR layout this interface */

    30 const TInt KHwrInputMethodId = 0x102072FC;

    31 

    32 

    33 /**

    34  * Class CFepUiLayoutInterface for layout interface

    35  *   

    36  * This is the layout interface for fep ui. Plugins need implement this interface.

    37  *

    38  * @lib feplayouteng.lib

    39  * @since S60 v4.0

    40  */

    41 class CFepUiLayoutInterface : public CBase

    42     {

    43 public:

    44     // Constructors and destructor

    45     /**

    46      * Two-phased constructor.

    47      *

    48      * @since S60 v4.0

    49      * @param aInputMethodId The input mode unique id. Default value is HWR id

    50      * @return The implementation interface

    51      */

    52     IMPORT_C static CFepUiLayoutInterface* NewL(TInt aImputMethodId = KHwrInputMethodId);

    53 

    54     /**

    55      * Destructor

    56      *

    57      * @since S60 v4.0

    58      */

    59     IMPORT_C virtual ~CFepUiLayoutInterface();

    60     

    61     /**

    62      * Create the ui layout. Pure virtual function. 

    63      *

    64      * @since S60 v4.0

    65      * @param aLayoutOwner The layout owner

    66      * @param aData The data for creating layout

    67      * @return The created ui layout

    68      */

    69     virtual MPenUiLayoutBase* CreateFepUiLayoutL(MLayoutOwner* aLayoutOwner,const TAny* aData) = 0;

    70     

    71     /**

    72      * Set the key for destruction

    73      *

    74      * @since S60 v4.0

    75      * @param aKey The uid key to be sete

    76      */

    77     IMPORT_C void SetDestructorKey(TUid aKey);

    78 

    79     /**

    80      * get the key offset for destruction UID

    81      *

    82      * @since S60 v4.0

    83      * @return The uid key offset in class

    84      */    

    85     static TInt32 DestructorUidKeyOffset();

    86     

    87 protected:

    88     /**

    89      * Default constructor

    90      *

    91      * @since S60 v4.0

    92      */    

    93     IMPORT_C CFepUiLayoutInterface();

    94     

    95 private:

    96     /**

    97      * Unique instance identifier key for interface destruction

    98      */

    99     TUid iDtor_ID_Key;    

   100 };

   101 

   102 

   103 #endif  //C_CPENINPUTUILAYOUTINTERFACE_H

   104