ipcm_plat/bearer_settings_ui_plugin_api/inc/cpbearerapplugininterface.h
branchRCL_3
changeset 58 83ca720e2b9a
parent 57 05bc53fe583b
child 62 bb1f80fb7db2
equal deleted inserted replaced
57:05bc53fe583b 58:83ca720e2b9a
     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 the License "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 *   Control Panel plugin interface for bearer specific AP settings plugins.
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef CPBEARERAPPLUGININTERFACE_H
       
    20 #define CPBEARERAPPLUGININTERFACE_H
       
    21 
       
    22 // System includes
       
    23 #include <QtPlugin>
       
    24 
       
    25 // User includes
       
    26 
       
    27 // Forward declarations
       
    28 class CpBaseSettingView;
       
    29 
       
    30 // External data types
       
    31 
       
    32 // Constants
       
    33 
       
    34 // Class declaration
       
    35 
       
    36 /*!
       
    37     \class CpBearerApPluginInterface
       
    38     \brief This class is an interface for bearer specific AP settings plugins
       
    39            which can be displayed in the Control Panel application.
       
    40     
       
    41     Plugin stubs must be located in
       
    42     /resource/qt/plugins/controlpanel/bearerap directory.
       
    43  */
       
    44 
       
    45 class CpBearerApPluginInterface
       
    46 {
       
    47 public:
       
    48     /*!
       
    49         Destructor.
       
    50      */
       
    51     virtual ~CpBearerApPluginInterface() {}
       
    52     
       
    53     /*!
       
    54         Getter for bearer type. Bearer types are defined in the Connection
       
    55         Settings Shim API cmmanagerdefines_shim.h.
       
    56         
       
    57         \return Bearer type handled by the plugin.
       
    58      */
       
    59     virtual uint bearerType() const = 0;
       
    60     
       
    61     /*!
       
    62         Creates the settings view. Caller owns the object.
       
    63         
       
    64         \param connectionMethod Connection method ID.
       
    65         \return Pointer to a settings view object.
       
    66      */
       
    67     virtual CpBaseSettingView *createSettingView(
       
    68         uint connectionMethod) = 0;
       
    69         
       
    70 signals:
       
    71     
       
    72 public slots:
       
    73 
       
    74 protected:
       
    75 
       
    76 protected slots:
       
    77 
       
    78 private:
       
    79 
       
    80 private slots:
       
    81 
       
    82 private: // data
       
    83 
       
    84 };
       
    85 
       
    86 Q_DECLARE_INTERFACE(
       
    87     CpBearerApPluginInterface,
       
    88     "com.nokia.plugin.controlpanel.bearerap.platform.interface/1.0");
       
    89 
       
    90 #endif // CPBEARERAPPLUGININTERFACE_H