williamr@2: /*
williamr@2: * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  Data class for trigger change event.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef LBTTRIGGERCHANGEEVENT_H
williamr@2: #define LBTTRIGGERCHANGEEVENT_H
williamr@2: 
williamr@2: #include <e32std.h>
williamr@2: #include <lbtcommon.h>
williamr@2: 
williamr@2: /**
williamr@2:  * Specifies the type of trigger change event.
williamr@2:  *
williamr@2:  * If there is no adequate event type to describe the change,
williamr@2:  * @p ELbtTriggerChangeEventMultiple will be used. This event type is also 
williamr@2:  * used for mass operations, e.g. delete several triggers, in order to bundle
williamr@2:  * the events. In this case, multiple trigger items might have been changed.
williamr@2:  * 
williamr@2:  * Note, no changing event is issued if only the distance from the trigger
williamr@2:  * to the latest acquired location is changed.
williamr@2:  *
williamr@2:  * @since S60 5.1
williamr@2:  */
williamr@2: enum TLbtTriggerChangeEventType
williamr@2:     {
williamr@2:     /**
williamr@2:      * An event related to changes to multiple triggers have occurred.
williamr@2:      * This event is issued if more than one trigger has been added, modified 
williamr@2:      * or deleted.
williamr@2:      */
williamr@2:     ELbtTriggerChangeEventMultiple = 1,
williamr@2:     /**
williamr@2:      * A new trigger has been created.
williamr@2:      */
williamr@2:     ELbtTriggerChangeEventCreated = 2,
williamr@2:     /**
williamr@2:      * A trigger has been deleted.
williamr@2:      */
williamr@2:     ELbtTriggerChangeEventDeleted = 3,
williamr@2:     /**
williamr@2:      * One or more trigger entry's attributes have been updated,
williamr@2:      * or the trigger's validity status is changed.
williamr@2:      */
williamr@2:     ELbtTriggerChangeEventUpdated = 4,
williamr@2:     };
williamr@2: 
williamr@2: /**
williamr@2:  * Structure defines detailed information of a triggering change event.
williamr@2:  *
williamr@2:  * @since S60 5.1
williamr@2:  */
williamr@2: struct TLbtTriggerChangeEvent
williamr@2:     {
williamr@2:     /**
williamr@2:      * Type of the event.
williamr@2:      */
williamr@2:     TLbtTriggerChangeEventType iEventType;
williamr@2:     
williamr@2:     /**
williamr@2:      * ID of a trigger. The ID indicates that the event is associated with
williamr@2:      * one trigger item. If the change is not associated with exactly one
williamr@2:      * item, item ID will be set to @p KLbtNullTriggerId.
williamr@2:      * For instance in the case of @p ELbtTriggerChangeEventMultiple event.
williamr@2:      */
williamr@2:     TLbtTriggerId iTriggerId;
williamr@2:     
williamr@2:     /**
williamr@2:      * For future use
williamr@2:      */
williamr@2:     TUint8 iUnused[8];
williamr@2:     };
williamr@2: 
williamr@2: 
williamr@2: #endif // LBTTRIGGERCHANGEEVENT_H