qtmobility/src/contacts/requests/qcontactdetaildefinitionremoverequest.cpp
changeset 1 2b40d63a9c3d
child 4 90517678cc4f
equal deleted inserted replaced
0:cfcbf08528c4 1:2b40d63a9c3d
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the Qt Mobility Components.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #include "qcontactdetaildefinitionremoverequest.h"
       
    43 #include "qcontactrequests_p.h"
       
    44 
       
    45 QTM_BEGIN_NAMESPACE
       
    46 
       
    47 /*!
       
    48   \class QContactDetailDefinitionRemoveRequest
       
    49   \brief The QContactDetailDefinitionRemoveRequest class allows a client to
       
    50   asynchronously request that certain detail definitions be removed from
       
    51   a contacts store.
       
    52 
       
    53   For a QContactDetailDefinitionRemoveRequest, the resultsUpdated() signal will be emitted when
       
    54   the individual item errors (which may be retrieved by calling errorMap()) are updated, or if the overall
       
    55   operation error (which may be retrieved by calling error()) is updated.
       
    56   
       
    57   \ingroup contacts-requests
       
    58  */
       
    59 
       
    60 /*! Constructs a new detail definition remove request */
       
    61 QContactDetailDefinitionRemoveRequest::QContactDetailDefinitionRemoveRequest()
       
    62     : QContactAbstractRequest(new QContactDetailDefinitionRemoveRequestPrivate)
       
    63 {
       
    64 }
       
    65 
       
    66 /*! Cleans up the memory in use by this detail definition remove request */
       
    67 QContactDetailDefinitionRemoveRequest::~QContactDetailDefinitionRemoveRequest()
       
    68 {
       
    69 }
       
    70 
       
    71 /*!
       
    72   Sets the type of contact for which detail definitions should be removed to \a contactType, and the names of the detail definitions to remove from the manager to \a names.
       
    73   Managers may store different definitions which are valid for different contact types, and so attempting to remove definitions with certain names may fail if no such
       
    74   definitions exist for contacts of the given contact type, or if \a contactType is empty.
       
    75  */
       
    76 void QContactDetailDefinitionRemoveRequest::setDefinitionNames(const QString& contactType, const QStringList& names)
       
    77 {
       
    78     Q_D(QContactDetailDefinitionRemoveRequest);
       
    79     d->m_contactType = contactType;
       
    80     d->m_names = names;
       
    81 }
       
    82 
       
    83 /*! Returns the list of names of the detail definitions that will be removed from the manager */
       
    84 QStringList QContactDetailDefinitionRemoveRequest::definitionNames() const
       
    85 {
       
    86     Q_D(const QContactDetailDefinitionRemoveRequest);
       
    87     return d->m_names;
       
    88 }
       
    89 
       
    90 /*! Returns the type of contact for which detail definitions will be removed */
       
    91 QString QContactDetailDefinitionRemoveRequest::contactType() const
       
    92 {
       
    93     Q_D(const QContactDetailDefinitionRemoveRequest);
       
    94     return d->m_contactType;
       
    95 }
       
    96 
       
    97 /*! Returns the map of input name list indices to errors which occurred */
       
    98 QMap<int, QContactManager::Error> QContactDetailDefinitionRemoveRequest::errorMap() const
       
    99 {
       
   100     Q_D(const QContactDetailDefinitionRemoveRequest);
       
   101     return d->m_errors;
       
   102 }
       
   103 
       
   104 #include "moc_qcontactdetaildefinitionremoverequest.cpp"
       
   105 
       
   106 QTM_END_NAMESPACE