wlanutilities/wlanwizard/inc/wlanwizardscanlist.h
author hgs
Fri, 09 Jul 2010 10:38:19 +0300
changeset 43 72ebcbb64834
parent 39 7b3e49e4608a
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
39
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 WLANWIZARDSCANLIST_H_
hgs
parents:
diff changeset
    20
#define WLANWIZARDSCANLIST_H_
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// System includes
hgs
parents:
diff changeset
    23
#include <QList>
hgs
parents:
diff changeset
    24
#include <QHash>
hgs
parents:
diff changeset
    25
#include <QMetaType>
hgs
parents:
diff changeset
    26
#include <QString>
hgs
parents:
diff changeset
    27
#include <QSharedPointer>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/*!
hgs
parents:
diff changeset
    30
   @addtogroup group_wlan_wizard
hgs
parents:
diff changeset
    31
   @{
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
// User includes
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
// Forward declarations
hgs
parents:
diff changeset
    37
class WlanQtUtilsAp;
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
// External data types
hgs
parents:
diff changeset
    40
/*!
hgs
parents:
diff changeset
    41
 * Data structure with scan results and access point visibility information.
hgs
parents:
diff changeset
    42
 */
hgs
parents:
diff changeset
    43
class WlanScanResult
hgs
parents:
diff changeset
    44
{
hgs
parents:
diff changeset
    45
public:
hgs
parents:
diff changeset
    46
    QSharedPointer<WlanQtUtilsAp> scanResult;
hgs
parents:
diff changeset
    47
    bool networkHidden;
hgs
parents:
diff changeset
    48
};
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
/*!
hgs
parents:
diff changeset
    51
 * Data structure containing security setting information and wizard page
hgs
parents:
diff changeset
    52
 * navigation information.
hgs
parents:
diff changeset
    53
 */
hgs
parents:
diff changeset
    54
class WlanSecuritySetting
hgs
parents:
diff changeset
    55
{
hgs
parents:
diff changeset
    56
public:
43
hgs
parents: 39
diff changeset
    57
    //! Enumerated value defined by CMManagerShim::WlanSecMode
39
hgs
parents:
diff changeset
    58
    int mode;
43
hgs
parents: 39
diff changeset
    59
    
hgs
parents: 39
diff changeset
    60
    //! true, if passkey is required, false otherwise
39
hgs
parents:
diff changeset
    61
    bool usePsk;
43
hgs
parents: 39
diff changeset
    62
    
hgs
parents: 39
diff changeset
    63
    /*! 
hgs
parents: 39
diff changeset
    64
     * Identifier of the next page associated with this security mode.
hgs
parents: 39
diff changeset
    65
     * Page ids are defined in WlanWizardPageInternal::WlanPageIds
hgs
parents: 39
diff changeset
    66
     */
39
hgs
parents:
diff changeset
    67
    int nextPageId;
hgs
parents:
diff changeset
    68
    
hgs
parents:
diff changeset
    69
    bool operator==(const WlanSecuritySetting& setting) const {
hgs
parents:
diff changeset
    70
        return (mode == setting.mode && 
hgs
parents:
diff changeset
    71
            usePsk == setting.usePsk &&
hgs
parents:
diff changeset
    72
            nextPageId == setting.nextPageId);
hgs
parents:
diff changeset
    73
    }
hgs
parents:
diff changeset
    74
};
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
/*!
hgs
parents:
diff changeset
    77
 * Data structure containing network mode, visibility and wireless protection
hgs
parents:
diff changeset
    78
 * setup suppport information.
hgs
parents:
diff changeset
    79
 */
hgs
parents:
diff changeset
    80
class WlanNetworkSetting 
hgs
parents:
diff changeset
    81
{
hgs
parents:
diff changeset
    82
public:
43
hgs
parents: 39
diff changeset
    83
    //! Enumerated value defined by CMManagerShim::WlanConnMode
39
hgs
parents:
diff changeset
    84
    int mode;
43
hgs
parents: 39
diff changeset
    85
    
hgs
parents: 39
diff changeset
    86
    //! true, if hidden, false otherwise
39
hgs
parents:
diff changeset
    87
    bool hidden;
43
hgs
parents: 39
diff changeset
    88
    
hgs
parents: 39
diff changeset
    89
    //! true, if supported, false otherwise
39
hgs
parents:
diff changeset
    90
    bool wpsSupported;
hgs
parents:
diff changeset
    91
    
hgs
parents:
diff changeset
    92
    bool operator==(const WlanNetworkSetting& setting) const {
hgs
parents:
diff changeset
    93
        return (mode == setting.mode && 
hgs
parents:
diff changeset
    94
            hidden == setting.hidden &&
hgs
parents:
diff changeset
    95
            wpsSupported == setting.wpsSupported);
hgs
parents:
diff changeset
    96
    }
hgs
parents:
diff changeset
    97
};
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
/*!
hgs
parents:
diff changeset
   100
 * Necessary public function for an argument of type WlanNetworkSetting to
hgs
parents:
diff changeset
   101
 * function as a QHash key.
hgs
parents:
diff changeset
   102
 */
hgs
parents:
diff changeset
   103
inline uint qHash(const WlanNetworkSetting &key)
hgs
parents:
diff changeset
   104
 {
hgs
parents:
diff changeset
   105
    uint hash = key.mode;
hgs
parents:
diff changeset
   106
    hash <<= 1;
hgs
parents:
diff changeset
   107
    hash |= key.hidden ? 1 : 0;
hgs
parents:
diff changeset
   108
    hash <<= 1;
hgs
parents:
diff changeset
   109
    hash |= key.wpsSupported ? 1 : 0;
hgs
parents:
diff changeset
   110
    return qHash(hash);
hgs
parents:
diff changeset
   111
 }
hgs
parents:
diff changeset
   112
hgs
parents:
diff changeset
   113
// Constants
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
class WlanWizardScanList
hgs
parents:
diff changeset
   116
{
hgs
parents:
diff changeset
   117
public:
hgs
parents:
diff changeset
   118
    WlanWizardScanList();
hgs
parents:
diff changeset
   119
    WlanWizardScanList(const WlanWizardScanList &scanList);
hgs
parents:
diff changeset
   120
    ~WlanWizardScanList();
hgs
parents:
diff changeset
   121
    void build(const QList<WlanScanResult> &results);
hgs
parents:
diff changeset
   122
    const WlanSecuritySetting &getSecMode(WlanNetworkSetting netMode, int index = 0) const;
hgs
parents:
diff changeset
   123
    int netModes() const;
hgs
parents:
diff changeset
   124
    int secModes(WlanNetworkSetting netMode) const;
hgs
parents:
diff changeset
   125
    QList<WlanNetworkSetting> getNetModes() const;
43
hgs
parents: 39
diff changeset
   126
    bool wpsSelected() const;
39
hgs
parents:
diff changeset
   127
    
hgs
parents:
diff changeset
   128
private:
hgs
parents:
diff changeset
   129
    // Disabling implicit assignment operator
hgs
parents:
diff changeset
   130
    WlanWizardScanList &operator=(const WlanWizardScanList &);
hgs
parents:
diff changeset
   131
    
hgs
parents:
diff changeset
   132
private:
hgs
parents:
diff changeset
   133
    QHash<WlanNetworkSetting, QList<WlanSecuritySetting> > mOpenOptions;
43
hgs
parents: 39
diff changeset
   134
    bool mWpsSelected;
39
hgs
parents:
diff changeset
   135
};
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
/*!
hgs
parents:
diff changeset
   138
 * This macro makes WlanWizardScanList QVariant-compatible.
hgs
parents:
diff changeset
   139
 */
hgs
parents:
diff changeset
   140
Q_DECLARE_METATYPE(WlanWizardScanList)
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
/*! @} */
hgs
parents:
diff changeset
   143
hgs
parents:
diff changeset
   144
#endif /* WLANWIZARDSCANLIST_H_ */