1 /*

     2 * Copyright (c) 2002-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:  gspeninputplugin header file.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_GSPENINPUTPLUGIN_H

    20 #define C_GSPENINPUTPLUGIN_H

    21 

    22 // INCLUDES

    23 #include <gsbaseview.h>

    24 #include <gsfwviewuids.h>

    25 #include <gsplugininterface.h>

    26 

    27 // FORWARD CLASS DECLARATION

    28 class CAknViewAppUi;

    29 class CGSPenInputContainer;

    30 

    31 // CONSTANTS

    32 const TUid KGSInputPenPluginUID = { 0x1027510B };

    33 _LIT(KGSInputPenPluginResourceFileName, "z:GSPenInputPluginRsc.rsc");

    34                                                

    35 /**

    36  *  GSPenInputPlugin view class

    37  *

    38  *  This class is GSPenInputPlugin view class. It offers not only CAknView

    39  *  but also CGSBaseView behavior. General settings framework will use the class

    40  *  to show  GSPenInputPlugin main view.

    41  *

    42  *  @lib gspeninputplugin.dll

    43  *  @since S60 v3.2

    44  */

    45 class CGSPenInputPlugin : public CGSBaseView

    46     {

    47 

    48 public: 

    49 

    50     /**

    51      * Symbian constructor

    52      *

    53      * @since S60 v3.2

    54      * @param aInitParams Framework parameter

    55      * @return Pointer to created CGSPenInputPlugin object

    56      */

    57     static CGSPenInputPlugin* NewL(TAny* aInitParams);

    58 

    59     /**

    60      * Destructor

    61      *

    62      * @since S60 v3.2

    63      * @return None

    64      */

    65     virtual ~CGSPenInputPlugin();

    66         

    67 // From CAknView

    68 

    69     /**

    70      * From CAknView

    71      * Returns views id

    72      *

    73      * @since S60 v3.2

    74      * @return id for this view.

    75      */

    76     TUid Id() const;

    77 

    78     /**

    79      * From CAknView

    80      * Handle client area change

    81      *

    82      * @since S60 v3.2

    83      * @return None

    84      */

    85     void HandleClientRectChange();

    86 

    87     /** 

    88      * From CAknView

    89      * Activate GsPenInputPlugin view

    90      *

    91      * @since S60 v3.2 

    92      * @param aViewId Identifies the view to activate.

    93      * @param aCustomMessageId Specifies the message type.

    94      * @param aCustomMessage The message passed to the activated view.

    95      * @return None

    96      */

    97     void DoActivateL(const TVwsViewId& aPrevViewId,

    98                      TUid aCustomMessageId,

    99                      const TDesC8& aCustomMessage);

   100 

   101     /** 

   102      * From CAknView

   103      * Deactivation of GsPenInputPlugin view

   104      *

   105      * @since S60 v3.2 

   106      * @return None

   107      */

   108     void DoDeactivate();

   109 

   110     /** 

   111      * From CAknView

   112      * Command handling function called by application frame work

   113      * 

   114      * @since S60 v3.2 

   115      * @param aCommand ID of the command to respond to.

   116      * @return None 

   117      */

   118     void HandleCommandL(TInt aCommand);

   119 

   120 // From CGSPluginInterface

   121 

   122     /**

   123      * From CGSPluginInterface

   124      * Method for getting caption of this plugin

   125      *

   126      * @since S60 v3.2     

   127      * @param aCaption Reference to caption variable

   128      * @return None

   129      */

   130     void GetCaptionL(TDes& aCaption) const;

   131 

   132     /**

   133      * From CGSPluginInterface

   134      * Method for reading the ID of the plugin provider category. See

   135      * TGSPluginProviderCategory. PluginProviderCategory can be used for

   136      * sorting plugins.

   137      *

   138      * Default value is EGSPluginProvider3rdParty. Override this function

   139      * to change the category.

   140      *

   141      * @since S60 v3.2     

   142      * @return Plugin provider category ID defined by 

   143      *         TGSPluginProviderCategory

   144      */

   145     TInt PluginProviderCategory() const;

   146 

   147 // From CGSBaseView

   148  

   149     /**

   150      * From CGSBaseView

   151      * Returns the container this view has.

   152      *

   153      * @since S60 v3.2 

   154      * @return pointer to container

   155      */

   156     CGSPenInputContainer* Container() const;

   157 

   158     

   159 // From MEikMenuObserver

   160     

   161     /**

   162      * From MEikMenuObserver

   163      * 

   164      * @since S60 v3.2

   165      * @param aResourceId resource id 

   166      * @param aMenuPane 

   167      * @return None

   168      */

   169     virtual void DynInitMenuPaneL(TInt aResourceId, CEikMenuPane *aMenuPane);

   170     

   171 protected:

   172     

   173     /**

   174      * C++ default constructor

   175      *

   176      * @since S60 v3.2

   177      * @return None

   178      */          

   179     CGSPenInputPlugin();

   180 

   181     /**

   182      * Symbian second-phase constructor

   183      *

   184      * @since S60 v3.2

   185      * @return None

   186      */          

   187     void ConstructL();     

   188 

   189 private: // From CGSBaseView

   190     

   191     /*

   192      * From CGSBaseView

   193      * Functionality for creating a container.

   194      * 

   195      * @since S60 v3.2

   196      * @return None

   197      */

   198     void NewContainerL();

   199 

   200     /*

   201      * From CGSBaseView

   202      * Handles listbox selection.

   203      *

   204      * @since S60 v3.2

   205      * @return None

   206      */

   207     void HandleListBoxSelectionL();

   208     // From CGSPluginInterface

   209 

   210     /*     

   211      * Creates a new icon of desired type.

   212      *     

   213      * @return None

   214      */

   215     CGulIcon* CreateIconL( const TUid aIconType );

   216     

   217     

   218 public:

   219     TUid iDestrouctorIDKey;

   220     

   221     };

   222 

   223 #endif // C_GSPENINPUTPLUGIN_H

   224 

   225 // End Of File