locationtriggering/ltcontainer/inc/lbttriggerchangeobserver.h
author hgs
Wed, 03 Nov 2010 23:28:39 +0530
changeset 56 4e949f03ecc5
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: Interface to notify clients about trigger change 
hgs
parents:
diff changeset
    15
* events
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef M_TRIGGERCHANGEOBSERVER_H
hgs
parents:
diff changeset
    21
#define M_TRIGGERCHANGEOBSERVER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#include <e32cmn.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
#include "lbtcontainer.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
/**
hgs
parents:
diff changeset
    29
 *  MLbtContainerChangeEventObserver is a an observer  
hgs
parents:
diff changeset
    30
 *  
hgs
parents:
diff changeset
    31
 *  @since S60 v4.0
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
class MLbtContainerChangeEventObserver
hgs
parents:
diff changeset
    34
    {
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
public:  // Interface methods
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
	/**
hgs
parents:
diff changeset
    39
	 * 
hgs
parents:
diff changeset
    40
	 */
hgs
parents:
diff changeset
    41
	 enum TLbtContainerChangedAreaType
hgs
parents:
diff changeset
    42
	 	{
hgs
parents:
diff changeset
    43
	 	// None
hgs
parents:
diff changeset
    44
	 	ETypeUnKnown = 0x0000,
hgs
parents:
diff changeset
    45
	 	// Only Cicular triggers have changed
hgs
parents:
diff changeset
    46
	 	ETypeCircularTriggerChange = 0x0001,
hgs
parents:
diff changeset
    47
	 	// Only rectangular triggers have changed
hgs
parents:
diff changeset
    48
	 	ETypeRectangularTriggerChange = 0x0002,
hgs
parents:
diff changeset
    49
	 	// Only cellular triggers have changed
hgs
parents:
diff changeset
    50
	 	ETypeCellularTriggerChange = 0x0004,
hgs
parents:
diff changeset
    51
	 	// Hybrid triggers have changed
hgs
parents:
diff changeset
    52
	 	ETypeHybridTriggerChange = 0x0010,
hgs
parents:
diff changeset
    53
	 	// All the different type of triggers have changed
hgs
parents:
diff changeset
    54
	 	ETypeAll = 0xFFFF
hgs
parents:
diff changeset
    55
	 	};
hgs
parents:
diff changeset
    56
	 
hgs
parents:
diff changeset
    57
    /**
hgs
parents:
diff changeset
    58
     * The method that has to be implemented to obtain events when the trigger
hgs
parents:
diff changeset
    59
     * store is modified.
hgs
parents:
diff changeset
    60
     *
hgs
parents:
diff changeset
    61
     * @param[in] aTriggerIds aList of triggers that were changed. The ownership
hgs
parents:
diff changeset
    62
     * is NOT transferred to the client. The client will have to delete this after 
hgs
parents:
diff changeset
    63
     * processing the event.
hgs
parents:
diff changeset
    64
     * @param[in] aEventMask The type of changes on the triggers. This is a 
hgs
parents:
diff changeset
    65
     * bitmask of CLbtContainer::TLbtTriggerChangeEvent.
hgs
parents:
diff changeset
    66
     *
hgs
parents:
diff changeset
    67
     * @note To obtain the events, the client will have to set itself as an
hgs
parents:
diff changeset
    68
     * observer using CLbtContainer::SetChangeObserver()
hgs
parents:
diff changeset
    69
     * 
hgs
parents:
diff changeset
    70
     * @note The client should not block this method for a long time.
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    virtual void TriggerStoreChanged( RArray<TLbtTriggerId>& aTriggerIds,
hgs
parents:
diff changeset
    73
                                      TLbtTriggerEventMask aEventMask,
hgs
parents:
diff changeset
    74
                                      TLbtContainerChangedAreaType aAreaType,
hgs
parents:
diff changeset
    75
                                      RArray<TUid>& aManagerUids ) = 0;
hgs
parents:
diff changeset
    76
    };
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
#endif      // M_TRIGGERCHANGEOBSERVER_H