1.1 --- a/epoc32/include/logcli.inl Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/logcli.inl Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -1,9 +1,9 @@
1.4 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 // All rights reserved.
1.6 // This component and the accompanying materials are made available
1.7 -// 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.8 +// under the terms of "Eclipse Public License v1.0"
1.9 // which accompanies this distribution, and is available
1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.12 //
1.13 // Initial Contributors:
1.14 // Nokia Corporation - initial contribution.
1.15 @@ -15,49 +15,48 @@
1.16 //
1.17 //
1.18
1.19 -inline TUid CLogEventType::Uid() const
1.20 /** Gets the UID identifying the event type.
1.21
1.22 @return The UID. */
1.23 +inline TUid CLogEventType::Uid() const
1.24 {
1.25 return iUid;
1.26 }
1.27
1.28 -inline void CLogEventType::SetUid(TUid aUid)
1.29 /** Sets the UID identifying the event type.
1.30
1.31 @param aUid The Uid. */
1.32 +inline void CLogEventType::SetUid(TUid aUid)
1.33 {
1.34 iUid = aUid;
1.35 }
1.36
1.37 -inline const TDesC& CLogEventType::Description() const
1.38 /** Gets the human readable and localised name of the event type.
1.39
1.40 @return A non-modifiable descriptor containing the name. */
1.41 +inline const TDesC& CLogEventType::Description() const
1.42 {
1.43 return *iDescription;
1.44 }
1.45
1.46 -inline void CLogEventType::SetDescription(const TDesC& aDescription)
1.47 /** Sets the human readable and localised name of the event type.
1.48
1.49 For example, Email.
1.50
1.51 @param aDescription The name. */
1.52 +inline void CLogEventType::SetDescription(const TDesC& aDescription)
1.53 {
1.54 iDescription->Des().Copy(aDescription);
1.55 }
1.56
1.57 -inline TBool CLogEventType::LoggingEnabled() const
1.58 /** Determines whether logging for this event type is enabled.
1.59
1.60 @return ETrue, if logging is enabled. EFalse, if logging is disabled. */
1.61 +inline TBool CLogEventType::LoggingEnabled() const
1.62 {
1.63 return iLoggingEnabled;
1.64 }
1.65
1.66 -inline void CLogEventType::SetLoggingEnabled(TBool aEnable)
1.67 /** Enables or disables logging for this event type.
1.68
1.69 Note that disabling the logging of an event type causes a CLogClient::AddEventL()
1.70 @@ -66,6 +65,7 @@
1.71 @param aEnable ETrue, to enable logging for this event type.EFalse, to disable
1.72 logging for this event type.
1.73 @see CLogClient::AddEvent() */
1.74 +inline void CLogEventType::SetLoggingEnabled(TBool aEnable)
1.75 {
1.76 iLoggingEnabled = aEnable;
1.77 }
1.78 @@ -74,144 +74,143 @@
1.79 // CLogFilter
1.80 //**********************************
1.81
1.82 -inline TUid CLogFilter::EventType() const
1.83 /** Gets the event type used by the filter.
1.84
1.85 @return The event type UID.
1.86 @see CLogEvent::EventType() */
1.87 +inline TUid CLogFilter::EventType() const
1.88 {
1.89 return iEventType;
1.90 }
1.91
1.92 -inline void CLogFilter::SetEventType(TUid aType)
1.93 /** Sets the event type to be used by the filter.
1.94
1.95 @param aType The event type UID.
1.96 @see CLogEvent::SetEventType() */
1.97 +inline void CLogFilter::SetEventType(TUid aType)
1.98 {
1.99 iEventType = aType;
1.100 }
1.101
1.102 -inline const TDesC& CLogFilter::RemoteParty() const
1.103 /** Gets the remote party string used by the filter.
1.104
1.105 @return A non-modifiable descriptor containing the remote party string.
1.106 @see CLogEvent::RemoteParty() */
1.107 +inline const TDesC& CLogFilter::RemoteParty() const
1.108 {
1.109 return *iRemoteParty;
1.110 }
1.111
1.112 -inline void CLogFilter::SetRemoteParty(const TDesC& aRemote)
1.113 /** Sets the remote party string to be used by the filter.
1.114
1.115 @param aRemote The remote party string.
1.116 @see CLogEvent::SetRemoteParty() */
1.117 +inline void CLogFilter::SetRemoteParty(const TDesC& aRemote)
1.118 {
1.119 iRemoteParty->Des().Copy(aRemote);
1.120 }
1.121
1.122 -inline const TDesC& CLogFilter::Direction() const
1.123 /** Gets the direction string used by the filter.
1.124
1.125 @return A non-modifiable descriptor containing the direction string.
1.126 @see CLogEvent::Direction() */
1.127 +inline const TDesC& CLogFilter::Direction() const
1.128 {
1.129 return *iDirection;
1.130 }
1.131
1.132 -inline void CLogFilter::SetDirection(const TDesC& aDirection)
1.133 /** Sets the direction string to be used by the filter.
1.134
1.135 @param aDirection The direction string.
1.136 @see CLogEvent::SetDirection() */
1.137 +inline void CLogFilter::SetDirection(const TDesC& aDirection)
1.138 {
1.139 iDirection->Des().Copy(aDirection);
1.140 }
1.141
1.142 -inline TLogDurationType CLogFilter::DurationType() const
1.143 /** Gets the duration type used by the filter.
1.144
1.145 @return The duration type.
1.146 @see CLogEvent::DurationType() */
1.147 +inline TLogDurationType CLogFilter::DurationType() const
1.148 {
1.149 return iDurationType;
1.150 }
1.151
1.152 -inline void CLogFilter::SetDurationType(TLogDurationType aType)
1.153 /** Sets the duration type to be used by the filter.
1.154
1.155 @param aType The duration type.
1.156 @see CLogEvent::SetDurationType() */
1.157 +inline void CLogFilter::SetDurationType(TLogDurationType aType)
1.158 {
1.159 iDurationType = aType;
1.160 }
1.161
1.162 -inline const TDesC& CLogFilter::Status() const
1.163 /** Gets the delivery status used by the filter.
1.164
1.165 @return A non-modifiable descriptor containing the delivery status.
1.166 @see CLogEvent::Status() */
1.167 +inline const TDesC& CLogFilter::Status() const
1.168 {
1.169 return *iStatus;
1.170 }
1.171
1.172 -inline void CLogFilter::SetStatus(const TDesC& aStatus)
1.173 /** Sets the delivery status to be used by the filter.
1.174
1.175 @param aStatus The delivery status.
1.176 @see CLogEvent::SetStatus() */
1.177 +inline void CLogFilter::SetStatus(const TDesC& aStatus)
1.178 {
1.179 iStatus->Des().Copy(aStatus);
1.180 }
1.181
1.182 -inline TLogContactItemId CLogFilter::Contact() const
1.183 /** Gets the contact ID used by the filter.
1.184
1.185 @return The contact ID.
1.186 @see CLogEvent::Contact() */
1.187 +inline TLogContactItemId CLogFilter::Contact() const
1.188 {
1.189 return iContact;
1.190 }
1.191
1.192 -inline void CLogFilter::SetContact(TLogContactItemId aContact)
1.193 /** Sets the contact ID to be used by the filter.
1.194
1.195 @param aContact The contact ID.
1.196 @see CLogEvent::SetContact() */
1.197 +inline void CLogFilter::SetContact(TLogContactItemId aContact)
1.198 {
1.199 iContact = aContact;
1.200 }
1.201
1.202 -inline const TDesC& CLogFilter::Number() const
1.203 /** Gets the phone number used by the filter.
1.204
1.205 @return A non-modifiable descriptor containing the phone number.
1.206 @see CLogEvent::Number() */
1.207 +inline const TDesC& CLogFilter::Number() const
1.208 {
1.209 return *iNumber;
1.210 }
1.211
1.212 -inline void CLogFilter::SetNumber(const TDesC& aNumber)
1.213 /** Sets the phone number to be used by the filter.
1.214
1.215 @param aNumber The phone number.
1.216 @see CLogEvent::SetNumber() */
1.217 +inline void CLogFilter::SetNumber(const TDesC& aNumber)
1.218 {
1.219 iNumber->Des().Copy(aNumber);
1.220 }
1.221
1.222 -inline TUint32 CLogFilter::NullFields() const
1.223 /** Identifies the fields defined as NULL in the filter. These are the fields that
1.224 the filter expects to be NULL in the database. A NULL field is one that has
1.225 no value.
1.226
1.227 @return Bit values defining the null fields.
1.228 @see SetNullFields() */
1.229 +inline TUint32 CLogFilter::NullFields() const
1.230 {
1.231 return iNullFields;
1.232 }
1.233
1.234 -inline void CLogFilter::SetNullFields(TUint32 aFields)
1.235 /** Defines NULL fields to the filter. These are the fields that the filter expects
1.236 to be NULL in the database. A NULL field is one that has no value.
1.237
1.238 @@ -224,70 +223,67 @@
1.239 @param aFields Bit values defining the null fields. These are one or more
1.240 of the following values defined in logwrap.hrh: ELogContactField, ELogDirectionField,
1.241 ELogDurationTypeField, ELogEventTypeField, ELogNumberField, ELogRemotePartyField,
1.242 -ELogStatusField, ELogFlagsField, ELogSubjectField, ELogLinkField and ELogDataField. */
1.243 +ELogStatusField, ELogFlagsField, ELogSubjectField, ELogLinkField, ELogDataField, ELogSimIdField. */
1.244 +inline void CLogFilter::SetNullFields(TUint32 aFields)
1.245 {
1.246 iNullFields = aFields;
1.247 }
1.248
1.249 -inline const TTime& CLogFilter::StartTime() const
1.250 /** Gets the UTC start time used by the filter.
1.251
1.252 -@since 7.0s
1.253 @return The UTC start time. */
1.254 +inline const TTime& CLogFilter::StartTime() const
1.255 {
1.256 return iStartTime;
1.257 }
1.258
1.259 -inline void CLogFilter::SetStartTime(const TTime& aStartTime)
1.260 /** Sets the specified UTC start time to be used by the filter.
1.261
1.262 -@since 7.0s
1.263 @param aStartTime The UTC start time to be set. */
1.264 +inline void CLogFilter::SetStartTime(const TTime& aStartTime)
1.265 {
1.266 iStartTime = aStartTime;
1.267 }
1.268
1.269 -inline const TTime& CLogFilter::EndTime() const
1.270 /** Gets the UTC end time used by the filter.
1.271
1.272 -@since 7.0s
1.273 @return The UTC end time. */
1.274 +inline const TTime& CLogFilter::EndTime() const
1.275 {
1.276 return iEndTime;
1.277 }
1.278
1.279 -inline void CLogFilter::SetEndTime(const TTime& aEndTime)
1.280 /** Sets the specified UTC end time to be used by the filter.
1.281
1.282 -@since 7.0s
1.283 @param aEndTime The UTC end time to be set. */
1.284 +inline void CLogFilter::SetEndTime(const TTime& aEndTime)
1.285 {
1.286 iEndTime = aEndTime;
1.287 }
1.288
1.289 -inline TLogFlags CLogFilter::Flags() const
1.290 /** Gets the flags used by the filter.
1.291
1.292 @return The flags. */
1.293 +inline TLogFlags CLogFilter::Flags() const
1.294 {
1.295 return iFlags;
1.296 }
1.297
1.298 -inline void CLogFilter::SetFlags(TLogFlags aFlags)
1.299 /** Sets the specified flags to be used by the filter.
1.300
1.301 @param aFlags The flags to be set. */
1.302 +inline void CLogFilter::SetFlags(TLogFlags aFlags)
1.303 {
1.304 __ASSERT_DEBUG(aFlags <= KLogFlagsMask, User::Invariant());
1.305 iFlags = (TLogFlags)(iFlags | aFlags);
1.306 }
1.307
1.308 -inline void CLogFilter::ClearFlags(TLogFlags aFlags)
1.309 /** Clears the specified flags to be used by the filter.
1.310
1.311 The constant KLogFlagsMask can be used to clear all the flags.
1.312
1.313 @param aFlags The flags to be cleared */
1.314 +inline void CLogFilter::ClearFlags(TLogFlags aFlags)
1.315 {
1.316 __ASSERT_DEBUG(aFlags <= KLogFlagsMask, User::Invariant());
1.317 iFlags = (TLogFlags)(iFlags & ~aFlags);