1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/lbttriggerinfo.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,172 @@
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 information
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef LBTTRIGGERINFO_H
1.23 +#define LBTTRIGGERINFO_H
1.24 +
1.25 +#include <e32base.h>
1.26 +#include <lbtcommon.h>
1.27 +#include <s32strm.h>
1.28 +
1.29 +class CLbtTriggerEntry;
1.30 +struct TLbtTriggerDynamicInfo;
1.31 +
1.32 +
1.33 +/**
1.34 + * Data class for trigger information. The trigger information contains trigger
1.35 + * entry and trigger dynamic information.
1.36 + *
1.37 + * @lib lbt.lib
1.38 + *
1.39 + * @since S60 5.1
1.40 + */
1.41 +class CLbtTriggerInfo : public CBase
1.42 + {
1.43 +public:
1.44 + /**
1.45 + * Constructs a new instance of trigger information object.
1.46 + *
1.47 + * @return The new instance of trigger information object.
1.48 + */
1.49 + IMPORT_C static CLbtTriggerInfo* NewL();
1.50 +
1.51 + /**
1.52 + * Constructs a new instance of trigger information object
1.53 + * and pushes it onto cleanup stack.
1.54 + *
1.55 + * @return The new instance of trigger information object.
1.56 + */
1.57 + IMPORT_C static CLbtTriggerInfo* NewLC();
1.58 +
1.59 + /**
1.60 + * Constructs a new instance of trigger information object.
1.61 + *
1.62 + * @param[in] aEntry The pointer to the trigger entry.
1.63 + * Ownership is transferred to this object.
1.64 + * @param[in] aDynInfo The pointer to the trigger dynamic
1.65 + * information object. Ownership is transferred to this object.
1.66 + * @return The new instance of trigger information object.
1.67 + */
1.68 + IMPORT_C static CLbtTriggerInfo* NewL(
1.69 + CLbtTriggerEntry* aEntry,
1.70 + TLbtTriggerDynamicInfo* aDynInfo );
1.71 +
1.72 + /**
1.73 + * Destructor
1.74 + */
1.75 + IMPORT_C virtual ~CLbtTriggerInfo();
1.76 +
1.77 + /**
1.78 + * Gets trigger entry object.
1.79 + *
1.80 + * @return Pointer to the trigger entry object. Ownership is
1.81 + * not transferred to the client.
1.82 + */
1.83 + IMPORT_C CLbtTriggerEntry* TriggerEntry();
1.84 +
1.85 + /**
1.86 + * Sets trigger entry.
1.87 + *
1.88 + * @param[in] aEntry The trigger entry object. Ownership is
1.89 + * transferred to this object.
1.90 + */
1.91 + IMPORT_C void SetTriggerEntry( CLbtTriggerEntry* aEntry );
1.92 +
1.93 + /**
1.94 + * Gets trigger dynamic information object.
1.95 + *
1.96 + * @return Pointer to the trigger dynamic information object.
1.97 + * Ownership is not transferred to the client.
1.98 + */
1.99 + IMPORT_C TLbtTriggerDynamicInfo* DynInfo();
1.100 +
1.101 + /**
1.102 + * Sets trigger dynamic information object.
1.103 + *
1.104 + * @param[in] aDynInfo Pointer to the trigger dynamic
1.105 + * information object. Ownership is transferred to this object.
1.106 + */
1.107 + IMPORT_C void SetDynInfo( TLbtTriggerDynamicInfo* aDynInfo );
1.108 +
1.109 +
1.110 + /**
1.111 + * Internalizes the trigger object's details and attributes
1.112 + * from stream.
1.113 + *
1.114 + * The presence of this function means that the standard template
1.115 + * operator>>() ( defined in s32strm.h ) is available to internalize objects
1.116 + * of this class.
1.117 + *
1.118 + * @param[in] aStream Stream from which the object should be internalized.
1.119 + */
1.120 + IMPORT_C void InternalizeL( RReadStream& aStream );
1.121 +
1.122 + /**
1.123 + * Externalizes the trigger object's details and attributes
1.124 + * to stream.
1.125 + *
1.126 + * The presence of this function means that the standard template
1.127 + * operator<<() ( defined in s32strm.h ) is available to externalize objects
1.128 + * of this class.
1.129 + *
1.130 + * @param[in] aStream Stream to which the object should be externalized.
1.131 + */
1.132 + IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
1.133 +
1.134 +protected:
1.135 + /**
1.136 + * Default constructor.
1.137 + */
1.138 + CLbtTriggerInfo();
1.139 +
1.140 +private:
1.141 + /**
1.142 + * Symbian 2nd phase constructor.
1.143 + */
1.144 + void ConstructL(CLbtTriggerEntry* aEntry,
1.145 + TLbtTriggerDynamicInfo* aDynInfo);
1.146 +
1.147 + /**
1.148 + * Symbian 2nd phase constructor.
1.149 + */
1.150 + void ConstructL();
1.151 +
1.152 + /**
1.153 + * By default, prohibit copy constructor
1.154 + */
1.155 + CLbtTriggerInfo( const CLbtTriggerInfo& );
1.156 +
1.157 + /**
1.158 + * Prohibit assigment operator
1.159 + */
1.160 + CLbtTriggerInfo& operator= ( const CLbtTriggerInfo& );
1.161 +
1.162 +
1.163 +private:// data
1.164 + /**
1.165 + * Trigger entry
1.166 + */
1.167 + CLbtTriggerEntry* iEntry;
1.168 +
1.169 + /**
1.170 + * Trigger dynamic info
1.171 + */
1.172 + TLbtTriggerDynamicInfo* iDynInfo;
1.173 + };
1.174 +
1.175 +#endif // LBTTRIGGERINFO_H