1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/lbttriggerchangeevent.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,88 @@
1.4 +/*
1.5 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description: Data class for trigger change event.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef LBTTRIGGERCHANGEEVENT_H
1.23 +#define LBTTRIGGERCHANGEEVENT_H
1.24 +
1.25 +#include <e32std.h>
1.26 +#include <lbtcommon.h>
1.27 +
1.28 +/**
1.29 + * Specifies the type of trigger change event.
1.30 + *
1.31 + * If there is no adequate event type to describe the change,
1.32 + * @p ELbtTriggerChangeEventMultiple will be used. This event type is also
1.33 + * used for mass operations, e.g. delete several triggers, in order to bundle
1.34 + * the events. In this case, multiple trigger items might have been changed.
1.35 + *
1.36 + * Note, no changing event is issued if only the distance from the trigger
1.37 + * to the latest acquired location is changed.
1.38 + *
1.39 + * @since S60 5.1
1.40 + */
1.41 +enum TLbtTriggerChangeEventType
1.42 + {
1.43 + /**
1.44 + * An event related to changes to multiple triggers have occurred.
1.45 + * This event is issued if more than one trigger has been added, modified
1.46 + * or deleted.
1.47 + */
1.48 + ELbtTriggerChangeEventMultiple = 1,
1.49 + /**
1.50 + * A new trigger has been created.
1.51 + */
1.52 + ELbtTriggerChangeEventCreated = 2,
1.53 + /**
1.54 + * A trigger has been deleted.
1.55 + */
1.56 + ELbtTriggerChangeEventDeleted = 3,
1.57 + /**
1.58 + * One or more trigger entry's attributes have been updated,
1.59 + * or the trigger's validity status is changed.
1.60 + */
1.61 + ELbtTriggerChangeEventUpdated = 4,
1.62 + };
1.63 +
1.64 +/**
1.65 + * Structure defines detailed information of a triggering change event.
1.66 + *
1.67 + * @since S60 5.1
1.68 + */
1.69 +struct TLbtTriggerChangeEvent
1.70 + {
1.71 + /**
1.72 + * Type of the event.
1.73 + */
1.74 + TLbtTriggerChangeEventType iEventType;
1.75 +
1.76 + /**
1.77 + * ID of a trigger. The ID indicates that the event is associated with
1.78 + * one trigger item. If the change is not associated with exactly one
1.79 + * item, item ID will be set to @p KLbtNullTriggerId.
1.80 + * For instance in the case of @p ELbtTriggerChangeEventMultiple event.
1.81 + */
1.82 + TLbtTriggerId iTriggerId;
1.83 +
1.84 + /**
1.85 + * For future use
1.86 + */
1.87 + TUint8 iUnused[8];
1.88 + };
1.89 +
1.90 +
1.91 +#endif // LBTTRIGGERCHANGEEVENT_H