1.1 --- a/epoc32/include/msvstd.inl Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/msvstd.inl Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,590 @@
1.4 -msvstd.inl
1.5 +// Copyright (c) 1998-2009 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:
1.18 +//
1.19 +
1.20 +inline TMsvId TMsvEntry::Id() const
1.21 +/** Gets the value of the entry ID.
1.22 +
1.23 +@return The value of the entry ID */
1.24 + {
1.25 + return iId;
1.26 + }
1.27 +
1.28 +inline void TMsvEntry::SetId(TMsvId aId)
1.29 + {
1.30 + iId = aId;
1.31 + }
1.32 +
1.33 +inline TMsvId TMsvEntry::Parent() const
1.34 +/** Gets the value of the parent ID.
1.35 +
1.36 +@return The value of the parent ID */
1.37 + {
1.38 + return iParentId;
1.39 + }
1.40 +
1.41 +inline void TMsvEntry::SetParent(TMsvId aParentId)
1.42 + {
1.43 + iParentId = aParentId;
1.44 + }
1.45 +
1.46 +inline TBool TMsvEntry::Complete () const
1.47 +/** Gets the value of the message complete flag.
1.48 +
1.49 +Note that for email download without size limits, the complete flag will only
1.50 +be set to true once all the parts of the message (body text and attachments)
1.51 +have been downloaded.
1.52 +
1.53 +@return The value of the message complete flag */
1.54 + {
1.55 + return !(iData&KMsvEntryNotCompleteFlag);
1.56 + }
1.57 +
1.58 +inline void TMsvEntry::SetComplete(TBool aComplete)
1.59 +/** Sets the message complete flag.
1.60 +
1.61 +Note that for email download without size limits, the complete flag will only
1.62 +be set to true once all the parts of the message (body text and attachments)
1.63 +have been downloaded.
1.64 +
1.65 +@param aComplete Value for the message complete flag */
1.66 + {
1.67 + iData = (iData & ~KMsvEntryNotCompleteFlag) | ((!aComplete)?KMsvEntryNotCompleteFlag:KMsvEntryClearFlag);
1.68 + }
1.69 +
1.70 +inline TBool TMsvEntry::New() const
1.71 +/** Gets the value of the new message flag.
1.72 +
1.73 +@return The value of the new message flag */
1.74 + {
1.75 + return iData&KMsvEntryNewFlag;
1.76 + }
1.77 +
1.78 +inline void TMsvEntry::SetNew(TBool aNew)
1.79 +/** Sets the message new flag.
1.80 +
1.81 +@param aNew Value for the message new flag */
1.82 + {
1.83 + iData = (iData & ~KMsvEntryNewFlag) | (aNew?KMsvEntryNewFlag:KMsvEntryClearFlag);
1.84 + }
1.85 +
1.86 +inline TBool TMsvEntry::Unread() const
1.87 +/** Gets the value of the message unread flag.
1.88 +
1.89 +@return The value of the message unread flag */
1.90 + {
1.91 + return iData&KMsvEntryUnreadFlag;
1.92 + }
1.93 +
1.94 +inline void TMsvEntry::SetUnread(TBool aUnread)
1.95 +/** Sets the message unread flag.
1.96 +
1.97 +@param aUnread Value for the message unread flag */
1.98 + {
1.99 + iData = (iData & ~KMsvEntryUnreadFlag) | (aUnread?KMsvEntryUnreadFlag:KMsvEntryClearFlag);
1.100 + }
1.101 +
1.102 +inline TBool TMsvEntry::Failed() const
1.103 +/** Gets the value of the message send failed flag.
1.104 +
1.105 +@return The value of the message send failed flag */
1.106 + {
1.107 + return iData&KMsvEntryFailedFlag;
1.108 + }
1.109 +
1.110 +inline void TMsvEntry::SetFailed(TBool aFailed)
1.111 +/** Sets the message send failed flag.
1.112 +
1.113 +@param aFailed Value for the message send failed flag */
1.114 + {
1.115 + iData = (iData & ~KMsvEntryFailedFlag) | (aFailed?KMsvEntryFailedFlag:KMsvEntryClearFlag);
1.116 + }
1.117 +
1.118 +inline TBool TMsvEntry::Operation() const
1.119 +/** Gets the value of the disconnected operation queued flag.
1.120 +
1.121 +@return The value of the disconnected operation queued flag */
1.122 + {
1.123 + return iData&KMsvEntryOperationFlag;
1.124 + }
1.125 +
1.126 +inline void TMsvEntry::SetOperation(TBool aOperation)
1.127 +/** Sets the disconnected operation queued flag.
1.128 +
1.129 +@param aOperation Value for the disconnected operation queued flag */
1.130 + {
1.131 + iData = (iData & ~KMsvEntryOperationFlag) | (aOperation?KMsvEntryOperationFlag:KMsvEntryClearFlag);
1.132 + }
1.133 +
1.134 +inline TBool TMsvEntry::Owner() const
1.135 +/** Gets the value of the owner flag.
1.136 +
1.137 +@return The value of the owner flag */
1.138 + {
1.139 + return iData&KMsvEntryOwnerFlag;
1.140 + }
1.141 +
1.142 +inline void TMsvEntry::SetOwner(TBool aOwner)
1.143 + {
1.144 + iData = (iData & ~KMsvEntryOwnerFlag) | (aOwner?KMsvEntryOwnerFlag:KMsvEntryClearFlag);
1.145 + }
1.146 +
1.147 +inline TBool TMsvEntry::Attachment() const
1.148 +/** Gets the value of the attachment flag.
1.149 +
1.150 +@return The value of the attachment flag */
1.151 + {
1.152 + return iData&KMsvEntryAttachmentFlag;
1.153 + }
1.154 +
1.155 +inline void TMsvEntry::SetAttachment(TBool aAttachmentFlag)
1.156 +/** Sets the attachment flag.
1.157 +
1.158 +@param aAttachmentFlag Value for the attachment flag */
1.159 + {
1.160 + iData = (iData & ~KMsvEntryAttachmentFlag) | (aAttachmentFlag?KMsvEntryAttachmentFlag:KMsvEntryClearFlag);
1.161 + }
1.162 +
1.163 +inline TBool TMsvEntry::Visible() const
1.164 +/** Gets the value of the entry visible flag.
1.165 +
1.166 +@return The value of the entry visible flag */
1.167 + {
1.168 + return !((iData&KMsvEntryInvisibleFlag) || (iData&KMsvEntryPendingDeleteFlag));
1.169 + }
1.170 +
1.171 +inline void TMsvEntry::SetVisible(TBool aVisble)
1.172 +/** Sets the entry visible flag.
1.173 +
1.174 +@param aVisble Value for the entry visible flag */
1.175 + {
1.176 + iData = (iData & ~KMsvEntryInvisibleFlag) | ((!aVisble)?KMsvEntryInvisibleFlag:KMsvEntryClearFlag);
1.177 + }
1.178 +
1.179 +inline TBool TMsvEntry::MultipleRecipients() const
1.180 +/** Gets the value of the multiple recipients flag.
1.181 +
1.182 +@return The value of the multiple recipients flag */
1.183 + {
1.184 + return iData&KMsvEntryMultipleRecipientFlag;
1.185 + }
1.186 +
1.187 +inline void TMsvEntry::SetMultipleRecipients(TBool aMultipleRecipient)
1.188 +/** Sets the multiple recipients flag.
1.189 +
1.190 +@param aMultipleRecipient Value for the multiple recipients flag */
1.191 + {
1.192 + iData = (iData & ~KMsvEntryMultipleRecipientFlag) | (aMultipleRecipient?KMsvEntryMultipleRecipientFlag:KMsvEntryClearFlag);
1.193 + }
1.194 +
1.195 +inline TBool TMsvEntry::ReadOnly() const
1.196 +/** Gets the value of the read-only flag.
1.197 +
1.198 +@return The value of the read-only flag */
1.199 + {
1.200 + return iData&KMsvEntryReadOnlyFlag;
1.201 + }
1.202 +
1.203 +inline void TMsvEntry::SetReadOnly(TBool aReadOnly)
1.204 +/** Sets the read-only flag.
1.205 +
1.206 +@param aReadOnly Value for the read-only flag */
1.207 + {
1.208 + iData = (iData & ~KMsvEntryReadOnlyFlag) | (aReadOnly?KMsvEntryReadOnlyFlag:KMsvEntryClearFlag);
1.209 + }
1.210 +
1.211 +inline TBool TMsvEntry::Deleted() const
1.212 +/** Gets the value of the deleted flag.
1.213 +
1.214 +@return The value of the deleted flag */
1.215 + {
1.216 + return iData&KMsvEntryDeletedFlag;
1.217 + }
1.218 +
1.219 +inline void TMsvEntry::SetDeleted(TBool aDeletedFlag)
1.220 + {
1.221 + iData = (iData & ~KMsvEntryDeletedFlag) | (aDeletedFlag?KMsvEntryDeletedFlag:KMsvEntryClearFlag);
1.222 + }
1.223 +
1.224 +inline TBool TMsvEntry::StandardFolder() const
1.225 +/** Gets the value of the standard folder flag.
1.226 +
1.227 +@return The value of the standard folder flag */
1.228 + {
1.229 + return iData&KMsvEntryStandardFolderFlag;
1.230 + }
1.231 +
1.232 +inline void TMsvEntry::SetStandardFolder(TBool aStandardFolder)
1.233 + {
1.234 + iData = (iData & ~KMsvEntryStandardFolderFlag) | (aStandardFolder?KMsvEntryStandardFolderFlag:KMsvEntryClearFlag);
1.235 + }
1.236 +
1.237 +inline TBool TMsvEntry::Connected() const
1.238 +/** Gets the value of the remote server connection flag.
1.239 +
1.240 +@return The value of the remote server connection flag */
1.241 + {
1.242 + return iData&KMsvEntryConnectedFlag;
1.243 + }
1.244 +
1.245 +inline void TMsvEntry::SetConnected(TBool aConnected)
1.246 +/** Sets the remote server connection flag.
1.247 +
1.248 +@param aConnected Value for the remote server connection flag */
1.249 + {
1.250 + iData = (iData & ~KMsvEntryConnectedFlag) | (aConnected?KMsvEntryConnectedFlag:KMsvEntryClearFlag);
1.251 + }
1.252 +
1.253 +inline TBool TMsvEntry::InPreparation() const
1.254 +/** Gets the value of the in preparation flag.
1.255 +
1.256 +@return The value of the in preparation flag */
1.257 + {
1.258 + return iData&KMsvEntryInPreparationFlag;
1.259 + }
1.260 +
1.261 +inline void TMsvEntry::SetInPreparation(TBool aInPreparation)
1.262 +/** Sets the in-preparation flag.
1.263 +
1.264 +@param aInPreparation Value for the in-preparation flag */
1.265 + {
1.266 + iData = (iData & ~KMsvEntryInPreparationFlag) | (aInPreparation?KMsvEntryInPreparationFlag:KMsvEntryClearFlag);
1.267 + }
1.268 +
1.269 +inline TInt TMsvEntry::PcSyncCount() const
1.270 +/** Gets the value of the PC synchronisation field.
1.271 +
1.272 +@return The value of the PC synchronisation field */
1.273 + {
1.274 + return iPcSyncCount;
1.275 + }
1.276 +
1.277 +inline void TMsvEntry::IncPcSyncCount()
1.278 +/** Increments the PC synchronisation field. */
1.279 + {
1.280 + iPcSyncCount++;
1.281 + }
1.282 +
1.283 +inline void TMsvEntry::DecPcSyncCount()
1.284 +/** Decrements the PC synchronisation field. */
1.285 + {
1.286 + iPcSyncCount--;
1.287 + }
1.288 +
1.289 +inline TUint TMsvEntry::PersistedFlags() const
1.290 + {
1.291 + return iData&KMsvEntryPersistedFlags;
1.292 + }
1.293 +
1.294 +inline TUint TMsvEntry::TemporaryFlags() const
1.295 + {
1.296 + return iData&KMsvEntryTemporaryFlags;
1.297 + }
1.298 +
1.299 +inline TBool TMsvEntry::OffPeak() const
1.300 +/** Gets the off-peak flag.
1.301 +
1.302 +@return The value of the off-peak flag */
1.303 + {
1.304 + return iData & KMsvOffPeakFlag;
1.305 + }
1.306 +
1.307 +inline void TMsvEntry::SetOffPeak(TBool aOffPeak)
1.308 +/** Sets the off-peak flag.
1.309 +
1.310 +@param aOffPeak Value for off-peak flag. */
1.311 + {
1.312 + iData = (iData & ~KMsvOffPeakFlag) | (aOffPeak ? KMsvOffPeakFlag : KMsvEntryClearFlag);
1.313 + }
1.314 +
1.315 +inline TBool TMsvEntry::Scheduled() const
1.316 +/** Gets the scheduled flag.
1.317 +
1.318 +@return The value of the scheduled flag */
1.319 + {
1.320 + return iData & KMsvScheduledFlag;
1.321 + }
1.322 +
1.323 +inline void TMsvEntry::SetScheduled(TBool aScheduled)
1.324 +/** Sets the scheduled flag.
1.325 +
1.326 +@param aScheduled Value for the scheduled flag. */
1.327 + {
1.328 + iData = (iData & ~KMsvScheduledFlag) | (aScheduled ? KMsvScheduledFlag : KMsvEntryClearFlag);
1.329 + }
1.330 +
1.331 +inline TUint TMsvEntry::SendingState() const
1.332 +/** Gets the sending state.
1.333 +
1.334 +@return The sending state */
1.335 + {
1.336 + return (iData & KMsvSendingStateFlags) >> KMsvSendingStateShift;
1.337 + }
1.338 +
1.339 +inline void TMsvEntry::SetSendingState(TUint aSendingState)
1.340 +/** Sets the sending state.
1.341 +
1.342 +@param aSendingState The sending state. This must be a value between 0x00
1.343 +and KMsvSendStateMax. */
1.344 + {
1.345 + __ASSERT_DEBUG(aSendingState <= KMsvSendStateMax, User::Invariant());
1.346 + iData = iData & ~KMsvSendingStateFlags | aSendingState << KMsvSendingStateShift;
1.347 + }
1.348 +
1.349 +inline void TMsvEntry::SetPendingDelete(TBool aPendingDelete)
1.350 + {
1.351 + iData = (iData & ~KMsvEntryPendingDeleteFlag) | (aPendingDelete ? KMsvEntryPendingDeleteFlag : KMsvEntryClearFlag);
1.352 + }
1.353 +
1.354 +inline TBool TMsvEntry::PendingDelete() const
1.355 + {
1.356 + return iData & KMsvEntryPendingDeleteFlag;
1.357 + }
1.358 +
1.359 +
1.360 +inline void TMsvEntry::SetDeleteProtected(TBool aDeleteProtected)
1.361 + {
1.362 + /** temporary variable used to mask the anonymous global enum. */
1.363 + TInt temp = KMsvEntryDeleteProtected;
1.364 +/** Sets the delete protected state */
1.365 + iMtmData1 = (iMtmData1 & ~KMsvEntryDeleteProtected ) | (aDeleteProtected ? temp : KMsvEntryClearFlag);
1.366 + }
1.367 +
1.368 +inline TBool TMsvEntry::DeleteProtected() const
1.369 + {
1.370 +/** returns the delete protected state */
1.371 + return iMtmData1 & KMsvEntryDeleteProtected;
1.372 + }
1.373 +
1.374 +inline void TMsvEntry::SetForwarded(TBool aForwarded)
1.375 + {
1.376 + /** temporary variable used to mask the anonymous global enum. */
1.377 + TInt temp = KMsvEntryForwarded ;
1.378 +/** Sets the forwarded state */
1.379 + iMtmData1 = (iMtmData1 & ~KMsvEntryForwarded) | (aForwarded ? temp : KMsvEntryClearFlag);
1.380 + }
1.381 +
1.382 +inline TBool TMsvEntry::Forwarded() const
1.383 + {
1.384 +/** returns the forwarded state */
1.385 + return iMtmData1 & KMsvEntryForwarded;
1.386 + }
1.387 +
1.388 +inline void TMsvEntry::SetLocallyDeleted(TBool aLocallyDeleted)
1.389 + {
1.390 + /** temporary variable used to mask the anonymous global enum. */
1.391 + TInt temp = KMsvEntryLocallyDeleted ;
1.392 +/** Sets the locally deleted state */
1.393 + iMtmData1 = (iMtmData1 & ~KMsvEntryLocallyDeleted) | (aLocallyDeleted ? temp : KMsvEntryClearFlag);
1.394 + }
1.395 +
1.396 +inline TBool TMsvEntry::LocallyDeleted() const
1.397 + {
1.398 +/** returns the locally deleted state */
1.399 + return iMtmData1 & KMsvEntryLocallyDeleted;
1.400 + }
1.401 +
1.402 +//**********************************
1.403 +// TMsvSelectionOrdering
1.404 +//**********************************
1.405 +
1.406 +inline TBool TMsvSelectionOrdering::GroupByType() const
1.407 +/** Gets the group-by-entry-type flag.
1.408 +
1.409 +@return Group-by-entry-type flag */
1.410 + {
1.411 + return iGrouping&KMsvGroupByType;
1.412 + }
1.413 +
1.414 +inline TBool TMsvSelectionOrdering::GroupStandardFolders() const
1.415 +/** Gets the group-by-standard-folders flag.
1.416 +
1.417 +@return Group-by-standard-folders flag */
1.418 + {
1.419 + return iGrouping&KMsvStandardFolders;
1.420 + }
1.421 +
1.422 +inline TBool TMsvSelectionOrdering::GroupByPriority() const
1.423 +/** Gets the group-by-priority flag.
1.424 +
1.425 +@return Group-by-priority flag */
1.426 + {
1.427 + return iGrouping&KMsvGroupByPriority;
1.428 + }
1.429 +
1.430 +inline TBool TMsvSelectionOrdering::GroupByMtm() const
1.431 +/** Gets the group-by-MTM flag.
1.432 +
1.433 +@return Group-by-MTM flag */
1.434 + {
1.435 + return iGrouping&KMsvGroupByMtm;
1.436 + }
1.437 +
1.438 +inline TBool TMsvSelectionOrdering::ShowInvisibleEntries() const
1.439 +/** Gets the show-invisible-entries flag. Entries whose entry visible flag index
1.440 +field is not set are included in the ordered list only if this is set.
1.441 +
1.442 +@return Show-invisible-entries flag */
1.443 + {
1.444 + return iGrouping&KMsvInvisibleFlag;
1.445 + }
1.446 +
1.447 +inline void TMsvSelectionOrdering::SetGroupByType(TBool aFlag)
1.448 + {
1.449 + iGrouping = (iGrouping & ~KMsvGroupByStandardFolders) | ((aFlag)?KMsvGroupByType:0);
1.450 + }
1.451 +
1.452 +inline void TMsvSelectionOrdering::SetGroupStandardFolders(TBool aFlag)
1.453 + {
1.454 + iGrouping = (iGrouping & ~KMsvStandardFolders) | ((aFlag)?KMsvGroupByStandardFolders:0);
1.455 + }
1.456 +
1.457 +inline void TMsvSelectionOrdering::SetGroupByPriority(TBool aFlag)
1.458 + {
1.459 + iGrouping = (iGrouping & ~KMsvGroupByPriority) | ((aFlag)?KMsvGroupByPriority:0);
1.460 + }
1.461 +
1.462 +inline void TMsvSelectionOrdering::SetGroupByMtm(TBool aFlag)
1.463 + {
1.464 + iGrouping = (iGrouping & ~KMsvGroupByMtm) | ((aFlag)?KMsvGroupByMtm:0);
1.465 + }
1.466 +
1.467 +inline void TMsvSelectionOrdering::SetShowInvisibleEntries(TBool aFlag)
1.468 + {
1.469 + iGrouping = (iGrouping & ~KMsvInvisibleFlag) | ((aFlag)?KMsvInvisibleFlag:0);
1.470 + }
1.471 +
1.472 +inline TMsvSorting TMsvSelectionOrdering::Sorting() const
1.473 +/** Gets the sorting order of entries within groups.
1.474 +
1.475 +@return Sorting order. */
1.476 + {
1.477 + return iSortType;
1.478 + }
1.479 +
1.480 +inline void TMsvSelectionOrdering::SetSorting(TMsvSorting aSortType)
1.481 + {
1.482 + iSortType=aSortType;
1.483 + }
1.484 +
1.485 +inline TBool TMsvSelectionOrdering::GroupingOn() const
1.486 +/** Tests whether any grouping option has been set.
1.487 +
1.488 +@return ETrue if one or more grouping options have been set, else EFalse */
1.489 + {
1.490 + return iGrouping&KMsvAllGroupingFlags;
1.491 + }
1.492 +
1.493 +//**********************************
1.494 +// CMsvEntryFilter
1.495 +//**********************************
1.496 +
1.497 +inline TMsvId CMsvEntryFilter::Service() const
1.498 +/** Gets the service ID set for the filter.
1.499 +
1.500 +@return Service ID set for the filter */
1.501 + {
1.502 + return iServiceId;
1.503 + }
1.504 +
1.505 +inline void CMsvEntryFilter::SetService(TMsvId aServiceId)
1.506 +/** Sets the service ID for the filter.
1.507 +
1.508 +@param aServiceId Service ID for the filter */
1.509 + {
1.510 + iServiceId = aServiceId;
1.511 + }
1.512 +
1.513 +inline TUid CMsvEntryFilter::Mtm() const
1.514 +/** Gets the MTM UID set for the filter.
1.515 +
1.516 +@return MTM UID set for the filter */
1.517 + {
1.518 + return iMtm;
1.519 + }
1.520 +
1.521 +inline void CMsvEntryFilter::SetMtm(TUid aMtm)
1.522 +/** Sets the MTM UID for the filter.
1.523 +
1.524 +@param aMtm MTM UID for the filter */
1.525 + {
1.526 + iMtm = aMtm;
1.527 + }
1.528 +
1.529 +inline TUid CMsvEntryFilter::Type() const
1.530 +/** Gets the entry type set for the filter.
1.531 +
1.532 +@return Entry type set for the filter */
1.533 + {
1.534 + return iType;
1.535 + }
1.536 +
1.537 +inline void CMsvEntryFilter::SetType(TUid aType)
1.538 +/** Sets the entry type for the filter.
1.539 +
1.540 +@param aType Entry type for the filter */
1.541 + {
1.542 + iType = aType;
1.543 + }
1.544 +
1.545 +inline const TTime& CMsvEntryFilter::LastChangeDate() const
1.546 +/** Gets the last change date set for the filter.
1.547 +
1.548 +@return Last change date set for the filter */
1.549 + {
1.550 + return iLastChange;
1.551 + }
1.552 +
1.553 +inline void CMsvEntryFilter::SetLastChangeDate(const TTime& aLastChange)
1.554 +/** Sets the last date change for the filter.
1.555 +
1.556 +This is used to retrieve entries that have changed since a particular date.
1.557 +
1.558 +@param aLastChange Last date change for the filter, specified in Universal
1.559 +Time (GMT) */
1.560 + {
1.561 + iLastChange = aLastChange;
1.562 + }
1.563 +
1.564 +inline const TMsvSelectionOrdering& CMsvEntryFilter::Order() const
1.565 +/** Gets the selection ordering set for the filter.
1.566 +
1.567 +@return Selection ordering set for the filter */
1.568 + {
1.569 + return iOrdering;
1.570 + }
1.571 +
1.572 +inline void CMsvEntryFilter::SetOrder(const TMsvSelectionOrdering& aOrder)
1.573 +/** Sets the sort ordering for the filter.
1.574 +
1.575 +@param aOrder Selection ordering for the filter */
1.576 + {
1.577 + iOrdering = aOrder;
1.578 + }
1.579 +
1.580 +inline TUid CMsvEntryFilter::SortMtm() const
1.581 +/** Gets the sorting by MTM for the filter.
1.582 +
1.583 +@return Sorting by MTM for the filter */
1.584 + {
1.585 + return iSortMtm;
1.586 + }
1.587 +
1.588 +inline void CMsvEntryFilter::SetSortMtm(TUid aSortMtm)
1.589 +/** Sets the sorting by MTM for the filter.
1.590 +
1.591 +@param aSortMtm Sorting by MTM for the filter */
1.592 + {
1.593 + iSortMtm = aSortMtm;
1.594 + }