gsprofilesrv_plat/controlpanel_api/inc/cplauncherinterface.h
author hgs
Wed, 29 Sep 2010 10:45:02 +0800
changeset 61 33e86ecbfdb4
parent 52 controlpanel/controlpanel_plat/inc/cplauncherinterface.h@58cebe0861a8
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 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
*
52
hgs
parents: 36
diff changeset
    14
* Description:  Interface for controlpanel plugins, with this interface client application can launch a view from outside of controlpanel application.
36
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef CPLAUNCHERINTERFACE_H
hgs
parents:
diff changeset
    20
#define CPLAUNCHERINTERFACE_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <QtPlugin>
hgs
parents:
diff changeset
    23
#include <QList>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/*!
hgs
parents:
diff changeset
    26
    \class CpLauncherInterface
52
hgs
parents: 36
diff changeset
    27
    \brief The class CpLauncherInterface defines an interface for plugins, if one controlpanel plugin implements
hgs
parents: 36
diff changeset
    28
    this interface, client application can launch a setting view from outside of controlpanel application by two ways.
hgs
parents: 36
diff changeset
    29
    
hgs
parents: 36
diff changeset
    30
    (1) launch setting view in client process, using CpPluginLauncher.
hgs
parents: 36
diff changeset
    31
    
hgs
parents: 36
diff changeset
    32
    \code
hgs
parents: 36
diff changeset
    33
    CpBaseSettingView *settingView = CpPluginLauncher::launchSettingView("cpmyplugin.dll",QVariant());
hgs
parents: 36
diff changeset
    34
    \endcode
hgs
parents: 36
diff changeset
    35
    
hgs
parents: 36
diff changeset
    36
    (2) launch setting view in embedded mode, using QtHighway client API.
hgs
parents: 36
diff changeset
    37
    
hgs
parents: 36
diff changeset
    38
    \code
hgs
parents: 36
diff changeset
    39
    if (mRequest) {
hgs
parents: 36
diff changeset
    40
        delete mRequest;
hgs
parents: 36
diff changeset
    41
        mRequest = 0;
hgs
parents: 36
diff changeset
    42
    }
hgs
parents: 36
diff changeset
    43
    
hgs
parents: 36
diff changeset
    44
    mRequest = mAppMgr.create("com.nokia.symbian.ICpPluginLauncher", "launchSettingView(QString,QVariant)", true);
hgs
parents: 36
diff changeset
    45
hgs
parents: 36
diff changeset
    46
    if (!mRequest)
hgs
parents: 36
diff changeset
    47
    {
hgs
parents: 36
diff changeset
    48
        return;
hgs
parents: 36
diff changeset
    49
    }
hgs
parents: 36
diff changeset
    50
    else
hgs
parents: 36
diff changeset
    51
    {
hgs
parents: 36
diff changeset
    52
        connect(mRequest, SIGNAL(requestOk(QVariant)), SLOT(handleReturnValue(QVariant)));
hgs
parents: 36
diff changeset
    53
        connect(mRequest, SIGNAL(requestError(int,QString)), SLOT(handleError(int,QString)));
hgs
parents: 36
diff changeset
    54
    }
hgs
parents: 36
diff changeset
    55
hgs
parents: 36
diff changeset
    56
    // Set arguments for request 
hgs
parents: 36
diff changeset
    57
    QList<QVariant> args;
hgs
parents: 36
diff changeset
    58
    args << QVariant("cpmyplugin.dll");
hgs
parents: 36
diff changeset
    59
    args << QVariant();
hgs
parents: 36
diff changeset
    60
    mRequest->setArguments(args);
hgs
parents: 36
diff changeset
    61
hgs
parents: 36
diff changeset
    62
    mRequest->setSynchronous(false);    
hgs
parents: 36
diff changeset
    63
    // Make the request
hgs
parents: 36
diff changeset
    64
    if (!mRequest->send())
hgs
parents: 36
diff changeset
    65
    {
hgs
parents: 36
diff changeset
    66
        //report error     
hgs
parents: 36
diff changeset
    67
    }
hgs
parents: 36
diff changeset
    68
    \endcode
hgs
parents: 36
diff changeset
    69
    
36
hgs
parents:
diff changeset
    70
 */
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
class QVariant;
hgs
parents:
diff changeset
    73
class CpBaseSettingView;
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
class CpLauncherInterface
hgs
parents:
diff changeset
    76
{
hgs
parents:
diff changeset
    77
public:
hgs
parents:
diff changeset
    78
    /*!
hgs
parents:
diff changeset
    79
     Destructor of CpLauncherInterface.
hgs
parents:
diff changeset
    80
     */
hgs
parents:
diff changeset
    81
    virtual ~CpLauncherInterface()
hgs
parents:
diff changeset
    82
    {
hgs
parents:
diff changeset
    83
    }
hgs
parents:
diff changeset
    84
    
hgs
parents:
diff changeset
    85
    /*!
hgs
parents:
diff changeset
    86
     Create a CpBaseSettingView by the parameter hint.
hgs
parents:
diff changeset
    87
     */
hgs
parents:
diff changeset
    88
    virtual CpBaseSettingView *createSettingView(const QVariant &hint) const = 0;
hgs
parents:
diff changeset
    89
};
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
Q_DECLARE_INTERFACE(CpLauncherInterface, "com.nokia.controlpanel.launcher.interface/1.0");
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
#endif /* CPLAUNCHERINTERFACE_H */