1 /*

     2  * Copyright (c) 2010 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: 

    15  *   WLAN Wizard Plugin API: Service required from the wizard plugin.

    16  *

    17  */

    18 

    19 #ifndef WLANWIZARDPLUGIN_H

    20 #define WLANWIZARDPLUGIN_H

    21 

    22 // System includes

    23 

    24 // User includes

    25 

    26 // Forward declarations

    27 

    28 // External data types

    29 

    30 // Constants

    31 

    32 /*!

    33    @addtogroup group_wlan_wizard_api_internal

    34    @{

    35  */

    36 

    37 /*!

    38    Interface that wizard plugin must implement or at least the plugin MUST 

    39    inherit this interface and use the default implementations.

    40  */

    41 class WlanWizardPlugin

    42 {

    43 public:

    44     /*!

    45        Enumerators for WLAN Wizard summary page.

    46      */

    47     enum Summary {

    48         //! EAP Outer Type

    49         SummaryEapOuterType = 0,

    50         //! EAP Inner Type

    51         SummaryEapInnerType, 

    52         //! EAP Fast: Provisioning mode

    53         SummaryEapFastProvisioningMode,

    54     };

    55     

    56 public:

    57     /*!

    58        This method is used to query summary items from the wizard plugins

    59        that are eap and wps wizard.

    60        

    61        Both item and value are localized strings.

    62        

    63        @param [in] sum Summary id to be queried

    64        @param [out] item The item string is returned here 

    65        @param [out] value the value of item is returned here.

    66        

    67        @return true if summary item is found, false otherwise.

    68      */

    69     virtual bool summary(

    70         WlanWizardPlugin::Summary sum, 

    71         QString &item, 

    72         QString &value) 

    73     {

    74         Q_UNUSED(sum);

    75         Q_UNUSED(item);

    76         Q_UNUSED(value);

    77         return false;

    78     };

    79     

    80     /*!

    81        Stores wizard specific settings if any.

    82      */

    83     virtual bool storeSettings() 

    84     {

    85         return true;

    86     };

    87     

    88     /*!

    89        Maps plugin specific error codes into a localized string.

    90        

    91        @param [in] errorCode Symbian error code.

    92        

    93        @return If mapping can be done a localized error string is returned

    94        otherwise an empty string is returned. In case of empty string wlanwizard

    95        will use default error code.

    96      */

    97     virtual QString errorString(int errorCode) 

    98     {

    99         Q_UNUSED(errorCode);

   100         return QString();

   101     }

   102 signals:

   103     

   104 public slots:

   105     

   106 protected:

   107 

   108 protected slots:

   109 

   110 private:

   111 

   112 private slots:

   113 

   114 private: // data    

   115 };

   116 /*! @} */

   117 

   118 #endif /* WLANWIZARDPLUGIN_H */