epoc32/include/mw/lbttriggerchangeevent.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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:  Data class for trigger change event.
    15 *
    16 */
    17 
    18 
    19 #ifndef LBTTRIGGERCHANGEEVENT_H
    20 #define LBTTRIGGERCHANGEEVENT_H
    21 
    22 #include <e32std.h>
    23 #include <lbtcommon.h>
    24 
    25 /**
    26  * Specifies the type of trigger change event.
    27  *
    28  * If there is no adequate event type to describe the change,
    29  * @p ELbtTriggerChangeEventMultiple will be used. This event type is also 
    30  * used for mass operations, e.g. delete several triggers, in order to bundle
    31  * the events. In this case, multiple trigger items might have been changed.
    32  * 
    33  * Note, no changing event is issued if only the distance from the trigger
    34  * to the latest acquired location is changed.
    35  *
    36  * @since S60 5.1
    37  */
    38 enum TLbtTriggerChangeEventType
    39     {
    40     /**
    41      * An event related to changes to multiple triggers have occurred.
    42      * This event is issued if more than one trigger has been added, modified 
    43      * or deleted.
    44      */
    45     ELbtTriggerChangeEventMultiple = 1,
    46     /**
    47      * A new trigger has been created.
    48      */
    49     ELbtTriggerChangeEventCreated = 2,
    50     /**
    51      * A trigger has been deleted.
    52      */
    53     ELbtTriggerChangeEventDeleted = 3,
    54     /**
    55      * One or more trigger entry's attributes have been updated,
    56      * or the trigger's validity status is changed.
    57      */
    58     ELbtTriggerChangeEventUpdated = 4,
    59     };
    60 
    61 /**
    62  * Structure defines detailed information of a triggering change event.
    63  *
    64  * @since S60 5.1
    65  */
    66 struct TLbtTriggerChangeEvent
    67     {
    68     /**
    69      * Type of the event.
    70      */
    71     TLbtTriggerChangeEventType iEventType;
    72     
    73     /**
    74      * ID of a trigger. The ID indicates that the event is associated with
    75      * one trigger item. If the change is not associated with exactly one
    76      * item, item ID will be set to @p KLbtNullTriggerId.
    77      * For instance in the case of @p ELbtTriggerChangeEventMultiple event.
    78      */
    79     TLbtTriggerId iTriggerId;
    80     
    81     /**
    82      * For future use
    83      */
    84     TUint8 iUnused[8];
    85     };
    86 
    87 
    88 #endif // LBTTRIGGERCHANGEEVENT_H