epoc32/include/msvarray.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#if !defined(__MSVARRAY_H__)
williamr@2
    17
#define __MSVARRAY_H__
williamr@2
    18
williamr@2
    19
#if !defined(__MSVSTD_H__)
williamr@2
    20
#include <msvstd.h>
williamr@2
    21
#endif
williamr@2
    22
williamr@2
    23
//*************************
williamr@2
    24
//  class TKeyArrayFixPtr
williamr@2
    25
//*************************
williamr@2
    26
williamr@2
    27
class TKeyArrayFixPtr : public TKeyArrayFix
williamr@2
    28
// 
williamr@2
    29
// Generic Key class for sorting arrays of pointers in flat arrays. 
williamr@2
    30
//
williamr@2
    31
/**
williamr@2
    32
@internalComponent
williamr@2
    33
@released
williamr@2
    34
*/
williamr@2
    35
	{ 
williamr@2
    36
public:
williamr@2
    37
	inline TKeyArrayFixPtr(TInt anOffset,TKeyCmpText aType);
williamr@2
    38
	inline TKeyArrayFixPtr(TInt anOffset,TKeyCmpText aType,TInt aLength);
williamr@2
    39
	inline TKeyArrayFixPtr(TInt anOffset,TKeyCmpNumeric aType);
williamr@2
    40
	// At returns dereferenced pointer to objects (but not index)
williamr@2
    41
	IMPORT_C TAny* At(TInt anIndex) const;
williamr@2
    42
	};
williamr@2
    43
williamr@2
    44
williamr@2
    45
//**********************************
williamr@2
    46
// CMsvEntryArray
williamr@2
    47
//**********************************
williamr@2
    48
//
williamr@2
    49
// The array of TMsvEntry pointers
williamr@2
    50
//
williamr@2
    51
williamr@2
    52
class CMsvEntryArray : public CArrayPtrFlat<const TMsvEntry>
williamr@2
    53
/**
williamr@2
    54
@internalComponent
williamr@2
    55
@released
williamr@2
    56
*/
williamr@2
    57
	{ 
williamr@2
    58
public: 
williamr@2
    59
	IMPORT_C static CMsvEntryArray* NewL(const CArrayFix<TUid>& iMtmList); 
williamr@2
    60
	IMPORT_C static CMsvEntryArray* NewLC(const CArrayFix<TUid>& iMtmList); 
williamr@2
    61
	IMPORT_C void SortL(TMsvSelectionOrdering aOrdering);
williamr@2
    62
	IMPORT_C ~CMsvEntryArray();
williamr@2
    63
private:
williamr@2
    64
	enum TGroupCriterion
williamr@2
    65
		{
williamr@2
    66
		EGroupByStandardFolders, 
williamr@2
    67
		EGroupByType, 
williamr@2
    68
		EGroupByPriority, 
williamr@2
    69
		EGroupByMtm, 
williamr@2
    70
		EStopGrouping
williamr@2
    71
		};
williamr@2
    72
private:
williamr@2
    73
	TInt NumberOfArraysToSplitIntoL(TGroupCriterion aGroupCriterion);
williamr@2
    74
	TBool OkToGroup(TGroupCriterion aGroupCriterion,TMsvSelectionOrdering aOrdering) const;
williamr@2
    75
	TInt ArrayId(const TMsvEntry* aEntry,TGroupCriterion aGroupCriterion) const;
williamr@2
    76
	void GroupL(TGroupCriterion aGroupCriterion,TMsvSelectionOrdering aOrdering,TBool aDoSort);
williamr@2
    77
	void ReverseOrder(TMsvSorting aSortType);
williamr@2
    78
	void ReverseOrder();
williamr@2
    79
	CMsvEntryArray(const CArrayFix<TUid>& iMtmList);
williamr@2
    80
	TKeyArrayFixPtr MessageSortKey(TMsvSorting aSortType) const;
williamr@2
    81
williamr@2
    82
	TInt FindSubjectStart(const TDesC& aSubject, const TDesC& aSubjectSkipString) const;
williamr@2
    83
	void SubjectBasedSortL(TBool aReverse, const TDesC& aSubjectSkipString);
williamr@2
    84
	void DetailBasedSortL();
williamr@2
    85
williamr@2
    86
private:
williamr@2
    87
	const CArrayFix<TUid>& iOrigMtmList;
williamr@2
    88
	CArrayFix<TUid>* iActualMtmList;
williamr@2
    89
	};
williamr@2
    90
williamr@2
    91
// inline
williamr@2
    92
williamr@2
    93
inline TKeyArrayFixPtr::TKeyArrayFixPtr(TInt anOffset,TKeyCmpText aType)
williamr@2
    94
	: TKeyArrayFix(anOffset,aType)
williamr@2
    95
	{}
williamr@2
    96
williamr@2
    97
inline TKeyArrayFixPtr::TKeyArrayFixPtr(TInt anOffset,TKeyCmpText aType,TInt aLength)
williamr@2
    98
	: TKeyArrayFix(anOffset,aType,aLength)
williamr@2
    99
	{}
williamr@2
   100
williamr@2
   101
inline TKeyArrayFixPtr::TKeyArrayFixPtr(TInt anOffset,TKeyCmpNumeric aType)
williamr@2
   102
	: TKeyArrayFix(anOffset,aType)
williamr@2
   103
	{}
williamr@2
   104
williamr@2
   105
williamr@2
   106
#endif