qtmobility/src/serviceframework/qservicecontext.cpp
changeset 1 2b40d63a9c3d
child 11 06b8e2af4411
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qtmobility/src/serviceframework/qservicecontext.cpp	Fri Apr 16 15:51:22 2010 +0300
@@ -0,0 +1,137 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Mobility Components.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qservicecontext.h"
+
+QTM_BEGIN_NAMESPACE
+
+/*!
+    \class QServiceContext
+    \ingroup servicefw
+    \brief The QServiceContext class provides context information to 
+    services.
+
+    A service context is created by clients and passed on to the service.
+    It enables the opportunity to pass additional context information 
+    and errors between services, clients and the service framework.
+    
+    Clients must implement this abstract class to receive context information.
+
+    \sa QServiceManager
+
+*/
+
+/*!
+    \enum QServiceContext::ContextType
+
+    This enum describes the type of context information.
+
+    \value  DisplayContext              The service provides user visible display 
+                                        text such as an error message.
+    \value  ScriptContext               The service provides a script which may 
+                                        be executed by the client.
+    \value  UserDefined                 The first context type that can be used for service
+                                        specific context information.
+*/
+
+/*!
+    \fn void QServiceContext::notify(ContextType type, const QVariant& data) = 0
+
+    Services may call this function to notify the service client about service related
+    context information of the given \a type. The contextual information is stored in \a data.  
+*/
+
+/*!
+    Constrcuts a service context with the given \a parent.
+*/
+QServiceContext::QServiceContext(QObject* parent)
+    : QObject(parent)
+{
+
+}
+
+/*!
+    Destroys the service context object.
+*/
+QServiceContext::~QServiceContext() 
+{
+}
+
+/*!
+    \property QServiceContext::clientId
+    \brief the id of the client using the service.
+
+    By default, this value is empty but you can change this by calling
+    setClientId().
+*/
+QString QServiceContext::clientId() const
+{
+    return m_id;
+}
+
+/*!
+    Sets the \a id of the client using the service.
+*/
+void QServiceContext::setClientId(const QString& id)
+{
+    m_id = id;
+}
+
+/*!
+    \property QServiceContext::clientName
+    \brief the name of the client using the service.
+
+    By default, this value is empty but you can change this by calling
+    setClientName(). This string is translated and can be shown to the user.
+*/
+QString QServiceContext::clientName() const
+{
+    return m_displayName;
+}
+
+void QServiceContext::setClientName(const QString& name)
+{
+    m_displayName = name;
+}
+
+#include "moc_qservicecontext.cpp"
+
+QTM_END_NAMESPACE