Mercurial Mercurial > oss > API_REF > Public_API / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
epoc32/include/msvstd.inl
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4 
--- a/epoc32/include/msvstd.inl	Wed Mar 31 12:27:01 2010 +0100
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,590 +0,0 @@
-// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
-// All rights reserved.
-// This component and the accompanying materials are made available
-// 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
-// which accompanies this distribution, and is available
-// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
-//
-// Initial Contributors:
-// Nokia Corporation - initial contribution.
-//
-// Contributors:
-//
-// Description:
-//
-
-inline TMsvId TMsvEntry::Id() const
-/** Gets the value of the entry ID.
-
-@return The value of the entry ID */
-	{
-	return iId;
-	}
-
-inline void TMsvEntry::SetId(TMsvId aId)
-	{
-	iId = aId;
-	}
-
-inline TMsvId TMsvEntry::Parent() const
-/** Gets the value of the parent ID.
-
-@return The value of the parent ID */
-	{
-	return iParentId;
-	}
-
-inline void TMsvEntry::SetParent(TMsvId aParentId)
-	{
-	iParentId = aParentId;
-	}
-
-inline TBool TMsvEntry::Complete () const
-/** Gets the value of the message complete flag.
-
-Note that for email download without size limits, the complete flag will only
-be set to true once all the parts of the message (body text and attachments)
-have been downloaded.
-
-@return The value of the message complete flag */
-	{
-	return !(iData&KMsvEntryNotCompleteFlag);
-	}
-
-inline void TMsvEntry::SetComplete(TBool aComplete)
-/** Sets the message complete flag.
-
-Note that for email download without size limits, the complete flag will only
-be set to true once all the parts of the message (body text and attachments)
-have been downloaded.
-
-@param aComplete Value for the message complete flag */
-	{
-	iData = (iData & ~KMsvEntryNotCompleteFlag) | ((!aComplete)?KMsvEntryNotCompleteFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::New() const
-/** Gets the value of the new message flag.
-
-@return The value of the new message flag */
-	{
-	return iData&KMsvEntryNewFlag;
-	}
-
-inline void TMsvEntry::SetNew(TBool aNew)
-/** Sets the message new flag.
-
-@param aNew Value for the message new flag */
-	{
-	iData = (iData & ~KMsvEntryNewFlag) | (aNew?KMsvEntryNewFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Unread() const
-/** Gets the value of the message unread flag.
-
-@return The value of the message unread flag */
-	{
-	return iData&KMsvEntryUnreadFlag;
-	}
-
-inline void TMsvEntry::SetUnread(TBool aUnread)
-/** Sets the message unread flag.
-	
-@param aUnread Value for the message unread flag */
-	{
-	iData = (iData & ~KMsvEntryUnreadFlag) | (aUnread?KMsvEntryUnreadFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Failed() const
-/** Gets the value of the message send failed flag.
-
-@return The value of the message send failed flag */
-	{
-	return iData&KMsvEntryFailedFlag;
-	}
-
-inline void TMsvEntry::SetFailed(TBool aFailed)
-/** Sets the message send failed flag.
-
-@param aFailed Value for the message send failed flag */
-	{
-	iData = (iData & ~KMsvEntryFailedFlag) | (aFailed?KMsvEntryFailedFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Operation() const
-/** Gets the value of the disconnected operation queued flag.
-
-@return The value of the disconnected operation queued flag */
-	{
-	return iData&KMsvEntryOperationFlag;
-	}
-
-inline void TMsvEntry::SetOperation(TBool aOperation)
-/** Sets the disconnected operation queued flag.
-
-@param aOperation Value for the disconnected operation queued flag */
-	{
-	iData = (iData & ~KMsvEntryOperationFlag) | (aOperation?KMsvEntryOperationFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Owner() const
-/** Gets the value of the owner flag.
-
-@return The value of the owner flag */
-	{
-	return iData&KMsvEntryOwnerFlag;
-	}
-
-inline void TMsvEntry::SetOwner(TBool aOwner)
-	{
-	iData = (iData & ~KMsvEntryOwnerFlag) | (aOwner?KMsvEntryOwnerFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Attachment() const
-/** Gets the value of the attachment flag.
-
-@return The value of the attachment flag */
-	{
-	return iData&KMsvEntryAttachmentFlag;
-	}
-
-inline void TMsvEntry::SetAttachment(TBool aAttachmentFlag)
-/** Sets the attachment flag.
-
-@param aAttachmentFlag Value for the attachment flag */
-	{
-	iData = (iData & ~KMsvEntryAttachmentFlag) | (aAttachmentFlag?KMsvEntryAttachmentFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Visible() const
-/** Gets the value of the entry visible flag.
-
-@return The value of the entry visible flag */
-	{
-	return !((iData&KMsvEntryInvisibleFlag) || (iData&KMsvEntryPendingDeleteFlag));
-	}
-
-inline void TMsvEntry::SetVisible(TBool aVisble)
-/** Sets the entry visible flag.
-	
-@param aVisble Value for the entry visible flag */
-	{
-	iData = (iData & ~KMsvEntryInvisibleFlag) | ((!aVisble)?KMsvEntryInvisibleFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::MultipleRecipients() const
-/** Gets the value of the multiple recipients flag.
-
-@return The value of the multiple recipients flag */
-	{
-	return iData&KMsvEntryMultipleRecipientFlag;
-	}
-
-inline void TMsvEntry::SetMultipleRecipients(TBool aMultipleRecipient)
-/** Sets the multiple recipients flag.
-	
-@param aMultipleRecipient Value for the multiple recipients flag */
-	{
-	iData = (iData & ~KMsvEntryMultipleRecipientFlag) | (aMultipleRecipient?KMsvEntryMultipleRecipientFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::ReadOnly() const
-/** Gets the value of the read-only flag.
-
-@return The value of the read-only flag */
-	{
-	return iData&KMsvEntryReadOnlyFlag;
-	}
-
-inline void TMsvEntry::SetReadOnly(TBool aReadOnly)
-/** Sets the read-only flag.
-
-@param aReadOnly Value for the read-only flag */
-	{
-	iData = (iData & ~KMsvEntryReadOnlyFlag) | (aReadOnly?KMsvEntryReadOnlyFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Deleted() const
-/** Gets the value of the deleted flag.
-
-@return The value of the deleted flag */
-	{
-	return iData&KMsvEntryDeletedFlag;
-	}
-
-inline void TMsvEntry::SetDeleted(TBool aDeletedFlag)
-	{
-	iData = (iData & ~KMsvEntryDeletedFlag) | (aDeletedFlag?KMsvEntryDeletedFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::StandardFolder() const
-/** Gets the value of the standard folder flag.
-
-@return The value of the standard folder flag */
-	{
-	return iData&KMsvEntryStandardFolderFlag;
-	}
-
-inline void TMsvEntry::SetStandardFolder(TBool aStandardFolder)
-	{
-	iData = (iData & ~KMsvEntryStandardFolderFlag) | (aStandardFolder?KMsvEntryStandardFolderFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Connected() const
-/** Gets the value of the remote server connection flag.
-
-@return The value of the remote server connection flag */
-	{
-	return iData&KMsvEntryConnectedFlag;
-	}
-
-inline void TMsvEntry::SetConnected(TBool aConnected)
-/** Sets the remote server connection flag.
-
-@param aConnected Value for the remote server connection flag */
-	{
-	iData = (iData & ~KMsvEntryConnectedFlag) | (aConnected?KMsvEntryConnectedFlag:KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::InPreparation() const
-/** Gets the value of the in preparation flag.
-
-@return The value of the in preparation flag */
-	{
-	return iData&KMsvEntryInPreparationFlag;
-	}
-
-inline void TMsvEntry::SetInPreparation(TBool aInPreparation)
-/** Sets the in-preparation flag.
-
-@param aInPreparation Value for the in-preparation flag */
-	{
-	iData = (iData & ~KMsvEntryInPreparationFlag) | (aInPreparation?KMsvEntryInPreparationFlag:KMsvEntryClearFlag);
-	}
-
-inline TInt TMsvEntry::PcSyncCount() const
-/** Gets the value of the PC synchronisation field.
-
-@return The value of the PC synchronisation field */
-	{
-	return iPcSyncCount;
-	}
-
-inline void TMsvEntry::IncPcSyncCount()
-/** Increments the PC synchronisation field. */
-	{
-	iPcSyncCount++;
-	}
-
-inline void TMsvEntry::DecPcSyncCount()
-/** Decrements the PC synchronisation field. */
-	{
-	iPcSyncCount--;
-	}
-
-inline TUint TMsvEntry::PersistedFlags() const
-	{
-	return iData&KMsvEntryPersistedFlags;
-	}
-
-inline TUint TMsvEntry::TemporaryFlags() const
-	{
-	return iData&KMsvEntryTemporaryFlags;
-	}
-
-inline TBool TMsvEntry::OffPeak() const
-/** Gets the off-peak flag.
-
-@return The value of the off-peak flag */
-	{
-	return iData & KMsvOffPeakFlag;
-	}
-
-inline void TMsvEntry::SetOffPeak(TBool aOffPeak)
-/** Sets the off-peak flag.
-
-@param aOffPeak Value for off-peak flag. */
-	{
-	iData = (iData & ~KMsvOffPeakFlag) | (aOffPeak ? KMsvOffPeakFlag : KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Scheduled() const
-/** Gets the scheduled flag.
-
-@return The value of the scheduled flag */
-	{
-	return iData & KMsvScheduledFlag;
-	}
-
-inline void TMsvEntry::SetScheduled(TBool aScheduled)
-/** Sets the scheduled flag.
-
-@param aScheduled Value for the scheduled flag. */
-	{
-	iData = (iData & ~KMsvScheduledFlag) | (aScheduled ? KMsvScheduledFlag : KMsvEntryClearFlag);
-	}
-	
-inline TUint TMsvEntry::SendingState() const
-/** Gets the sending state.
- 
-@return The sending state */
-	{
-	return (iData & KMsvSendingStateFlags) >> KMsvSendingStateShift;
-	}
-	 
-inline void TMsvEntry::SetSendingState(TUint aSendingState)
-/** Sets the sending state.
-  
-@param aSendingState The sending state. This must be a value between 0x00 
-and KMsvSendStateMax. */
-	{
-	__ASSERT_DEBUG(aSendingState <= KMsvSendStateMax, User::Invariant());
-	iData = iData & ~KMsvSendingStateFlags | aSendingState << KMsvSendingStateShift;
-	}
-
-inline void TMsvEntry::SetPendingDelete(TBool aPendingDelete)
-	{
-	iData = (iData & ~KMsvEntryPendingDeleteFlag) | (aPendingDelete ? KMsvEntryPendingDeleteFlag : KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::PendingDelete() const
-	{
-	return iData & KMsvEntryPendingDeleteFlag;
-	}
-	
-
-inline void TMsvEntry::SetDeleteProtected(TBool aDeleteProtected)
-	{
-	/** temporary variable used to mask the anonymous global enum.		*/
-	TInt temp = KMsvEntryDeleteProtected;
-/** Sets the delete protected state */
-	iMtmData1 = (iMtmData1 & ~KMsvEntryDeleteProtected ) | (aDeleteProtected ? temp : KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::DeleteProtected() const
-	{
-/** returns the delete protected state */
-	return iMtmData1 & KMsvEntryDeleteProtected;
-	}
-	
-inline void TMsvEntry::SetForwarded(TBool aForwarded)
-	{
-	/** temporary variable used to mask the anonymous global enum.		*/
-	TInt temp = KMsvEntryForwarded ;
-/** Sets the forwarded state */
-	iMtmData1 = (iMtmData1 & ~KMsvEntryForwarded) | (aForwarded ? temp : KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::Forwarded() const
-	{
-/** returns the forwarded state */
-	return iMtmData1 & KMsvEntryForwarded;
-	}
-
-inline void TMsvEntry::SetLocallyDeleted(TBool aLocallyDeleted)
-	{
-	/** temporary variable used to mask the anonymous global enum.		*/
-	TInt temp = KMsvEntryLocallyDeleted ;
-/** Sets the locally deleted state */
-	iMtmData1 = (iMtmData1 & ~KMsvEntryLocallyDeleted) | (aLocallyDeleted ? temp : KMsvEntryClearFlag);
-	}
-
-inline TBool TMsvEntry::LocallyDeleted() const
-	{
-/** returns the locally deleted state  */
-	return iMtmData1 & KMsvEntryLocallyDeleted;
-	}	
-
-//**********************************
-// TMsvSelectionOrdering
-//**********************************
-
-inline TBool TMsvSelectionOrdering::GroupByType() const
-/** Gets the group-by-entry-type flag.
-
-@return Group-by-entry-type flag */
-	{
-	return iGrouping&KMsvGroupByType;
-	}
-
-inline TBool TMsvSelectionOrdering::GroupStandardFolders() const
-/** Gets the group-by-standard-folders flag.
-
-@return Group-by-standard-folders flag */
-	{
-	return iGrouping&KMsvStandardFolders;
-	}
-
-inline TBool TMsvSelectionOrdering::GroupByPriority() const
-/** Gets the group-by-priority flag.
-
-@return Group-by-priority flag */
-	{
-	return iGrouping&KMsvGroupByPriority;
-	}
-
-inline TBool TMsvSelectionOrdering::GroupByMtm() const
-/** Gets the group-by-MTM flag.
-
-@return Group-by-MTM flag */
-	{
-	return iGrouping&KMsvGroupByMtm;
-	}
-
-inline TBool TMsvSelectionOrdering::ShowInvisibleEntries() const
-/** Gets the show-invisible-entries flag. Entries whose entry visible flag index 
-field is not set are included in the ordered list only if this is set. 
-
-@return Show-invisible-entries flag */
-	{
-	return iGrouping&KMsvInvisibleFlag;
-	}
-
-inline void TMsvSelectionOrdering::SetGroupByType(TBool aFlag)
-	{
-	iGrouping = (iGrouping & ~KMsvGroupByStandardFolders) | ((aFlag)?KMsvGroupByType:0);
-	}
-
-inline void TMsvSelectionOrdering::SetGroupStandardFolders(TBool aFlag)
-	{
-	iGrouping = (iGrouping & ~KMsvStandardFolders) | ((aFlag)?KMsvGroupByStandardFolders:0);
-	}
-
-inline void TMsvSelectionOrdering::SetGroupByPriority(TBool aFlag)
-	{
-	iGrouping = (iGrouping & ~KMsvGroupByPriority) | ((aFlag)?KMsvGroupByPriority:0);
-	}
-
-inline void TMsvSelectionOrdering::SetGroupByMtm(TBool aFlag)
-	{
-	iGrouping = (iGrouping & ~KMsvGroupByMtm) | ((aFlag)?KMsvGroupByMtm:0);
-	}
-
-inline void TMsvSelectionOrdering::SetShowInvisibleEntries(TBool aFlag)
-	{
-	iGrouping = (iGrouping & ~KMsvInvisibleFlag) | ((aFlag)?KMsvInvisibleFlag:0);
-	}
-
-inline TMsvSorting TMsvSelectionOrdering::Sorting() const
-/** Gets the sorting order of entries within groups.
-
-@return Sorting order. */
-	{
-	return iSortType;
-	}
-
-inline void TMsvSelectionOrdering::SetSorting(TMsvSorting aSortType)
-	{
-	iSortType=aSortType;
-	}
-
-inline TBool TMsvSelectionOrdering::GroupingOn() const
-/** Tests whether any grouping option has been set.
-
-@return ETrue if one or more grouping options have been set, else EFalse */
-	{
-	return iGrouping&KMsvAllGroupingFlags;
-	}
-
-//**********************************
-// CMsvEntryFilter
-//**********************************
-
-inline TMsvId CMsvEntryFilter::Service() const
-/** Gets the service ID set for the filter.
-
-@return Service ID set for the filter */
-	{
-	return iServiceId;
-	}
-
-inline void CMsvEntryFilter::SetService(TMsvId aServiceId)
-/** Sets the service ID for the filter.
-
-@param aServiceId Service ID for the filter */
-	{
-	iServiceId = aServiceId;
-	}
-
-inline TUid CMsvEntryFilter::Mtm() const
-/** Gets the MTM UID set for the filter.
-
-@return MTM UID set for the filter */
-	{
-	return iMtm;
-	}
-
-inline void CMsvEntryFilter::SetMtm(TUid aMtm)
-/** Sets the MTM UID for the filter.
-
-@param aMtm MTM UID for the filter */
-	{
-	iMtm = aMtm;
-	}
-
-inline TUid CMsvEntryFilter::Type() const
-/** Gets the entry type set for the filter.
-
-@return Entry type set for the filter */
-	{
-	return iType;
-	}
-
-inline void CMsvEntryFilter::SetType(TUid aType)
-/** Sets the entry type for the filter.
-
-@param aType Entry type for the filter */
-	{
-	iType = aType;
-	}
-
-inline const TTime& CMsvEntryFilter::LastChangeDate() const
-/** Gets the last change date set for the filter.
-
-@return Last change date set for the filter */
-	{
-	return iLastChange;
-	}
-
-inline void CMsvEntryFilter::SetLastChangeDate(const TTime& aLastChange)
-/** Sets the last date change for the filter.
-
-This is used to retrieve entries that have changed since a particular date.
-
-@param aLastChange Last date change for the filter, specified in Universal 
-Time (GMT) */
-	{
-	iLastChange = aLastChange;
-	}
-
-inline const TMsvSelectionOrdering& CMsvEntryFilter::Order() const
-/** Gets the selection ordering set for the filter.
-
-@return Selection ordering set for the filter */
-	{
-	return iOrdering;
-	}
-
-inline void CMsvEntryFilter::SetOrder(const TMsvSelectionOrdering& aOrder)
-/** Sets the sort ordering for the filter.
-
-@param aOrder Selection ordering for the filter */
-	{
-	iOrdering = aOrder;
-	}
-
-inline TUid CMsvEntryFilter::SortMtm() const
-/** Gets the sorting by MTM for the filter.
-
-@return Sorting by MTM for the filter */
-	{
-	return iSortMtm;
-	}
-
-inline void CMsvEntryFilter::SetSortMtm(TUid aSortMtm)
-/** Sets the sorting by MTM for the filter.
-
-@param aSortMtm Sorting by MTM for the filter */
-	{
-	iSortMtm = aSortMtm;
-	}
API_REF/Public_API