locationtriggering/ltcontainer/inc/lbttriggerchangeobserver.h
changeset 0 667063e416a2
equal deleted inserted replaced
-1:000000000000 0:667063e416a2
       
     1 /*
       
     2 * Copyright (c) 2006 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: Interface to notify clients about trigger change 
       
    15 * events
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef M_TRIGGERCHANGEOBSERVER_H
       
    21 #define M_TRIGGERCHANGEOBSERVER_H
       
    22 
       
    23 
       
    24 #include <e32cmn.h>
       
    25 
       
    26 #include "lbtcontainer.h"
       
    27 
       
    28 /**
       
    29  *  MLbtContainerChangeEventObserver is a an observer  
       
    30  *  
       
    31  *  @since S60 v4.0
       
    32  */
       
    33 class MLbtContainerChangeEventObserver
       
    34     {
       
    35 
       
    36 public:  // Interface methods
       
    37 
       
    38 	/**
       
    39 	 * 
       
    40 	 */
       
    41 	 enum TLbtContainerChangedAreaType
       
    42 	 	{
       
    43 	 	// None
       
    44 	 	ETypeUnKnown = 0x0000,
       
    45 	 	// Only Cicular triggers have changed
       
    46 	 	ETypeCircularTriggerChange = 0x0001,
       
    47 	 	// Only rectangular triggers have changed
       
    48 	 	ETypeRectangularTriggerChange = 0x0002,
       
    49 	 	// Only cellular triggers have changed
       
    50 	 	ETypeCellularTriggerChange = 0x0004,
       
    51 	 	// Hybrid triggers have changed
       
    52 	 	ETypeHybridTriggerChange = 0x0010,
       
    53 	 	// All the different type of triggers have changed
       
    54 	 	ETypeAll = 0xFFFF
       
    55 	 	};
       
    56 	 
       
    57     /**
       
    58      * The method that has to be implemented to obtain events when the trigger
       
    59      * store is modified.
       
    60      *
       
    61      * @param[in] aTriggerIds aList of triggers that were changed. The ownership
       
    62      * is NOT transferred to the client. The client will have to delete this after 
       
    63      * processing the event.
       
    64      * @param[in] aEventMask The type of changes on the triggers. This is a 
       
    65      * bitmask of CLbtContainer::TLbtTriggerChangeEvent.
       
    66      *
       
    67      * @note To obtain the events, the client will have to set itself as an
       
    68      * observer using CLbtContainer::SetChangeObserver()
       
    69      * 
       
    70      * @note The client should not block this method for a long time.
       
    71      */
       
    72     virtual void TriggerStoreChanged( RArray<TLbtTriggerId>& aTriggerIds,
       
    73                                       TLbtTriggerEventMask aEventMask,
       
    74                                       TLbtContainerChangedAreaType aAreaType,
       
    75                                       RArray<TUid>& aManagerUids ) = 0;
       
    76     };
       
    77 
       
    78 #endif      // M_TRIGGERCHANGEOBSERVER_H