wlanutilities/wlanwizard/inc/wlanwizardplugin.h
author hgs
Mon, 24 May 2010 21:11:39 +0300
changeset 31 e8f4211554fb
child 39 7b3e49e4608a
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
31
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description: 
hgs
parents:
diff changeset
    15
 *   WLAN Wizard Plugin API: Service required from the wizard plugin.
hgs
parents:
diff changeset
    16
 *
hgs
parents:
diff changeset
    17
 */
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef WLANWIZARDPLUGIN_H
hgs
parents:
diff changeset
    20
#define WLANWIZARDPLUGIN_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// System includes
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// User includes
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// Forward declarations
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// External data types
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// Constants
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
/*!
hgs
parents:
diff changeset
    33
   @addtogroup group_wlan_wizard_api_internal
hgs
parents:
diff changeset
    34
   @{
hgs
parents:
diff changeset
    35
 */
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
/*!
hgs
parents:
diff changeset
    38
   Interface that wizard plugin must implement or at least the plugin MUST 
hgs
parents:
diff changeset
    39
   inherit this interface and use the default implementations.
hgs
parents:
diff changeset
    40
 */
hgs
parents:
diff changeset
    41
class WlanWizardPlugin
hgs
parents:
diff changeset
    42
{
hgs
parents:
diff changeset
    43
public:
hgs
parents:
diff changeset
    44
    /*!
hgs
parents:
diff changeset
    45
       Enumerators for WLAN Wizard summary page.
hgs
parents:
diff changeset
    46
     */
hgs
parents:
diff changeset
    47
    enum Summary {
hgs
parents:
diff changeset
    48
        //! EAP Outer Type
hgs
parents:
diff changeset
    49
        SummaryEapOuterType = 0,
hgs
parents:
diff changeset
    50
        //! EAP Inner Type
hgs
parents:
diff changeset
    51
        SummaryEapInnerType, 
hgs
parents:
diff changeset
    52
        //! EAP Fast: Provisioning mode
hgs
parents:
diff changeset
    53
        SummaryEapFastProvisioningMode,
hgs
parents:
diff changeset
    54
    };
hgs
parents:
diff changeset
    55
    
hgs
parents:
diff changeset
    56
public:
hgs
parents:
diff changeset
    57
    /*!
hgs
parents:
diff changeset
    58
       This method is used to query summary items from the wizard plugins
hgs
parents:
diff changeset
    59
       that are eap and wps wizard.
hgs
parents:
diff changeset
    60
       
hgs
parents:
diff changeset
    61
       Both item and value are localized strings.
hgs
parents:
diff changeset
    62
       
hgs
parents:
diff changeset
    63
       @param [in] sum Summary id to be queried
hgs
parents:
diff changeset
    64
       @param [out] item The item string is returned here 
hgs
parents:
diff changeset
    65
       @param [out] value the value of item is returned here.
hgs
parents:
diff changeset
    66
       
hgs
parents:
diff changeset
    67
       @return true if summary item is found, false otherwise.
hgs
parents:
diff changeset
    68
     */
hgs
parents:
diff changeset
    69
    virtual bool summary(
hgs
parents:
diff changeset
    70
        WlanWizardPlugin::Summary sum, 
hgs
parents:
diff changeset
    71
        QString &item, 
hgs
parents:
diff changeset
    72
        QString &value) 
hgs
parents:
diff changeset
    73
    {
hgs
parents:
diff changeset
    74
        Q_UNUSED(sum);
hgs
parents:
diff changeset
    75
        Q_UNUSED(item);
hgs
parents:
diff changeset
    76
        Q_UNUSED(value);
hgs
parents:
diff changeset
    77
        return false;
hgs
parents:
diff changeset
    78
    };
hgs
parents:
diff changeset
    79
    
hgs
parents:
diff changeset
    80
    /*!
hgs
parents:
diff changeset
    81
       Stores wizard specific settings if any.
hgs
parents:
diff changeset
    82
     */
hgs
parents:
diff changeset
    83
    virtual bool storeSettings() 
hgs
parents:
diff changeset
    84
    {
hgs
parents:
diff changeset
    85
        return true;
hgs
parents:
diff changeset
    86
    };
hgs
parents:
diff changeset
    87
    
hgs
parents:
diff changeset
    88
    /*!
hgs
parents:
diff changeset
    89
       Deletes wizard specific settings if any.
hgs
parents:
diff changeset
    90
     */
hgs
parents:
diff changeset
    91
    virtual void deleteSettings() {};
hgs
parents:
diff changeset
    92
    
hgs
parents:
diff changeset
    93
    /*!
hgs
parents:
diff changeset
    94
       Maps plugin specific error codes into a localized string.
hgs
parents:
diff changeset
    95
       
hgs
parents:
diff changeset
    96
       @param [in] errorCode Symbian error code.
hgs
parents:
diff changeset
    97
       
hgs
parents:
diff changeset
    98
       @return If mapping can be done a localized error string is returned
hgs
parents:
diff changeset
    99
       otherwise an empty string is returned. In case of empty string wlanwizard
hgs
parents:
diff changeset
   100
       will use default error code.
hgs
parents:
diff changeset
   101
     */
hgs
parents:
diff changeset
   102
    virtual QString errorString(int errorCode) 
hgs
parents:
diff changeset
   103
    {
hgs
parents:
diff changeset
   104
        Q_UNUSED(errorCode);
hgs
parents:
diff changeset
   105
        return QString();
hgs
parents:
diff changeset
   106
    }
hgs
parents:
diff changeset
   107
signals:
hgs
parents:
diff changeset
   108
    
hgs
parents:
diff changeset
   109
public slots:
hgs
parents:
diff changeset
   110
    
hgs
parents:
diff changeset
   111
protected:
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
protected slots:
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
private:
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
private slots:
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
private: // data    
hgs
parents:
diff changeset
   120
};
hgs
parents:
diff changeset
   121
/*! @} */
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
#endif /* WLANWIZARDPLUGIN_H */