mmappfw_plat/mpx_collection_common_definition_api/inc/mpxcollectionmessage.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     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:  Collection message
       
    15 *
       
    16 */
       
    17 
       
    18  
       
    19 #ifndef TMPXCOLLECTIONMESSAGE_H
       
    20 #define TMPXCOLLECTIONMESSAGE_H
       
    21 
       
    22 #include <e32msgqueue.h>
       
    23 #include <mpxmessage.h>
       
    24 /**
       
    25  *  Collection message type
       
    26  */
       
    27 class TMPXCollectionMessage : public TMPXMessage
       
    28     {
       
    29 public:
       
    30     enum TEvent 
       
    31         { 
       
    32         ENoEvent,
       
    33         EError,  //EError must be 1. aType=TMPXCollectionServerOp, aData = error code
       
    34         EMediaChanged,// aData=the index of changed property
       
    35         EItemChanged, //aType=TMPXCollectionChangeType, 
       
    36                       //aData=id of currently opened item
       
    37         EPathChanged, //aType=TMPXCollectionPathChangeType
       
    38                       // For EMcPathChangedByOpen, aData = TMPXCollectionOpenEntry
       
    39                       // For EMcPathChangedByCollectionChange, aData not used        
       
    40         ECollectionChanged, // aData=UID of new collection
       
    41         EBroadcastEvent,    //aType=enum to event type
       
    42         EFocusChanged,  // Focused item changed, aData = index of focused item
       
    43         EAsyncOpComplete, // aType=TMPXCollectionServerOp, aData = error code
       
    44         //
       
    45         // Following enum is odd to have in a public API, however this whole
       
    46         // class is now deprecated and there will only ever be the "extended"
       
    47         // message API:
       
    48         // MMPXCollectionObserver::HandleCollectionMessageL(const CMPXMessage* aMsg)
       
    49         //
       
    50         EExtendedMessage // (Internal use) aData=MMPXData data handle
       
    51         };
       
    52 public:
       
    53     /**
       
    54      *  C++ constructor.
       
    55      *
       
    56      *  @since S60 3.2.3
       
    57      *  @param aEvent event
       
    58      *  @param aType event type
       
    59      *  @param aData optional data 
       
    60      */
       
    61     inline TMPXCollectionMessage(TEvent aEvent,TInt aType = 0, TInt aData = 0);
       
    62 
       
    63     /**
       
    64      *  C++ constructor.
       
    65      *
       
    66      *  @since S60 3.2.3
       
    67      */
       
    68     inline TMPXCollectionMessage();
       
    69     };
       
    70 
       
    71 #include "mpxcollectionmessage.inl"
       
    72 
       
    73 #endif // TMPXCOLLECTIONMESSAGE_H