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:  Abstract base class for location triggering entries

    15 *

    16 */

    17 

    18 

    19 #ifndef C_LBT_CONTAINER_LIST_OPTIONS_H

    20 #define C_LBT_CONTAINER_LIST_OPTIONS_H

    21 

    22 #include <lbtcommon.h>

    23 #include <lbttriggerinfo.h>

    24 #include <lbttriggerentry.h>

    25 #include <lbtlisttriggeroptions.h>

    26 

    27 typedef TUint64 TLbtTriggerDataMask;

    28 

    29 // forward declaration

    30 class CLbtContainerFilter;

    31 

    32 class CLbtExtendedTriggerInfo;

    33    

    34 

    35        	

    36 /* This is the main Trigger Information class used to set and access trigger information in the container.

    37 * It is derived from the CLbtTriggerInfo class from the Location Triggering API.

    38 */

    39        	

    40 NONSHARABLE_CLASS( CLbtContainerListOptions ) :public CBase

    41     {

    42 public:

    43     

    44         

    45     /**

    46      * Constructs a new instance of container trigger entry object.

    47      *

    48      * @return The new instance of the container trigger entry object.

    49      */

    50     IMPORT_C static CLbtContainerListOptions* NewL();

    51 

    52     /**

    53      * Constructs a new instance of container trigger entry object with the 

    54      * given parameters.

    55      *

    56      * @param[in] aEntry The pointer to the trigger entry. 

    57      * Ownership is transferred.

    58      * @param[in] aDynInfo The pointer to the trigger dynamic 

    59      * information object. Ownership is transferred.

    60      * @param[in] aExtendedTriggerInfo The pointer to the trigger derived dynamic 

    61      * information object. Ownership is transferred.

    62      *

    63      * @return The new instance of trigger information object.

    64      */

    65     IMPORT_C static CLbtContainerListOptions* NewL(

    66                         CLbtListTriggerOptions* aListOptions,

    67                         CLbtContainerFilter* aFilter );                

    68        

    69     /**

    70      * Destructor

    71      */

    72     IMPORT_C virtual ~CLbtContainerListOptions();

    73 

    74     /**

    75      * Gets trigger entry object.

    76      *

    77      * @return Pointer to the trigger entry object. Ownership is

    78      * not transferred.

    79      */

    80     IMPORT_C CLbtListTriggerOptions* ListOptions();

    81 

    82     /**

    83      * Sets trigger entry.

    84      *

    85      * @param[in] aEntry The trigger entry object. Ownership is transferred.

    86      */

    87     IMPORT_C void SetListOptions( CLbtListTriggerOptions* aListOptions );

    88 

    89     

    90     /**

    91      * Gets extended trigger information object.

    92      *

    93      * @return Pointer to the extended trigger information object.

    94      * Ownership is not transferred.

    95      */

    96     IMPORT_C CLbtContainerFilter* ContainerFilter();

    97 		

    98     /**

    99      * Sets extended trigger information object.

   100      *

   101      * @param[in] aDynInfo Pointer to the extended trigger

   102      * information object. Ownership is transferred.

   103      */

   104     IMPORT_C void SetContainerFilter( 

   105                         CLbtContainerFilter* aFilter );

   106                         

   107                         

   108      IMPORT_C TLbtTriggerDataMask DataMask();

   109      

   110      IMPORT_C void SetDataMask( TLbtTriggerDataMask aMask);

   111 	

   112 private:

   113     /**

   114      * Constructor.

   115      */

   116  	  CLbtContainerListOptions();

   117         

   118      // CLbtContainerListOptions( CLbtContainerListOptions& aEntry);   

   119     /**

   120      * Symbian 2nd phase of Construction.

   121      */

   122     void ConstructL();

   123 

   124     /**

   125      * Symbian 2nd phase of Construction.

   126      */

   127     void ConstructL(

   128                     CLbtListTriggerOptions* aListOptions,

   129                     CLbtContainerFilter* aFilter ); 

   130                     

   131      void CloneL(CLbtContainerListOptions& aEntry);              

   132        

   133 private:

   134     /**

   135      * Trigger entry

   136      */

   137     CLbtListTriggerOptions* iListOptions;

   138 

   139     TLbtTriggerDataMask iMask; 

   140     

   141     /**

   142      * Derived Trigger dynamic info

   143      */

   144     CLbtContainerFilter *iFilter;

   145     

   146     // Reserved pointer for future extension

   147     TAny* iReserved;

   148     };

   149 

   150 

   151 #endif // C_LBT_CONTAINER_LIST_OPTIONS_H