mpengine/src/mpmpxharvesterframeworkwrapper.cpp
changeset 22 ecf06a08d4d9
child 29 8192e5b5c935
equal deleted inserted replaced
20:82baf59ce8dd 22:ecf06a08d4d9
       
     1 /*
       
     2 * Copyright (c) 2009 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 "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: Wrapper for mpx harvester framework utilities.
       
    15 *
       
    16 */
       
    17 
       
    18 #include "mpmpxharvesterframeworkwrapper.h"
       
    19 #include "mpmpxharvesterframeworkwrapper_p.h"
       
    20 
       
    21 /*!
       
    22     \class MpMpxHarvesterFrameworkWrapper
       
    23     \brief Wrapper for mpx framework utilities.
       
    24 
       
    25     MPX harvester framework wrapper provides Qt style interface to the MPX harvester framework
       
    26     utilities. Its implementation is hidden using private class data pattern.
       
    27 */
       
    28 
       
    29 /*!
       
    30     \fn void scanStarted()
       
    31 
       
    32     This signal is emitted when scan operation is started.
       
    33 
       
    34  */
       
    35 
       
    36 /*!
       
    37     \fn void scanEnded( int count, int error )
       
    38 
       
    39     This signal is emitted when scan operation ends. It indicates the number
       
    40     of songs added and whether there was an error.
       
    41 
       
    42  */
       
    43 
       
    44 /*!
       
    45     \fn void scanCountChanged( int count )
       
    46 
       
    47     This signal is emitted when scan count is updated.
       
    48 
       
    49  */
       
    50 
       
    51 /*!
       
    52     \fn void diskEvent( MpxDiskEvent event )
       
    53 
       
    54     This signal is emitted when a disk event is received from MPX framework.
       
    55 
       
    56  */
       
    57 
       
    58  /*!
       
    59      \fn void usbEvent( MpxUsbEvent event )
       
    60 
       
    61      This signal is emitted when an USB event is received from MPX framework.
       
    62 
       
    63  */
       
    64 
       
    65 /*!
       
    66  Constructs the utility wrapper.
       
    67  */
       
    68 MpMpxHarvesterFrameworkWrapper::MpMpxHarvesterFrameworkWrapper( MpCommon::MpViewMode viewMode, TUid hostUid, QObject *parent )
       
    69     : QObject( parent )
       
    70 {
       
    71     d_ptr = new MpMpxHarvesterFrameworkWrapperPrivate( this );
       
    72     d_ptr->init( viewMode, hostUid );
       
    73 }
       
    74 
       
    75 /*!
       
    76  Destructs the utility wrapper.
       
    77  */
       
    78 MpMpxHarvesterFrameworkWrapper::~MpMpxHarvesterFrameworkWrapper()
       
    79 {
       
    80     delete d_ptr;
       
    81 }
       
    82 
       
    83 /*!
       
    84  Initiates song scanning.
       
    85  */
       
    86 void MpMpxHarvesterFrameworkWrapper::scan()
       
    87 {
       
    88     d_ptr->scan();
       
    89 }
       
    90 
       
    91 /*!
       
    92  Cancels ongoing song scanning.
       
    93  */
       
    94 void MpMpxHarvesterFrameworkWrapper::cancelScan()
       
    95 {
       
    96     d_ptr->cancelScan();
       
    97 }
       
    98 
       
    99 /*!
       
   100  Request Harvester to check if there are any system events active.
       
   101  */
       
   102 void MpMpxHarvesterFrameworkWrapper::checkForSystemEvents()
       
   103 {
       
   104     d_ptr->checkForSystemEvents();
       
   105 }
       
   106