Collapse all Symbian^3 Product Developer Library

CMsgCheckNames Class Reference

class CMsgCheckNames : public CBase

Class, which provides check names functionality in message editors.

MsgEditorAppui.lib

Since: 2.0

Inherits from

CMsgCheckNames
- CBase

Public Member Functions
	~CMsgCheckNames()
void	AknInputBlockCancel()
void	ConfigurationChanged()
void	ConfigurationChangedComplete()
CContactMatcher &	ContactMatcher()
IMPORT_C void	FetchRecipientsL(CMsgRecipientArray &, TMsgAddressSelectType)
IMPORT_C void	FetchRecipientsL(CVPbkContactLinkArray &, TMsgAddressSelectType)
IMPORT_C TBool	FindAndCheckByNameL(const TDesC &, TMsgAddressSelectType, CMsgRecipientArray &, TInt)
IMPORT_C void	GetAliasL(const TDesC &, TDes &, TInt)
IMPORT_C CMsgCheckNames *	NewL()
IMPORT_C CMsgCheckNames *	NewLC()

Protected Member Functions
TAiwAddressSelectType	ConvertToPbk2Type(TMsgAddressSelectType)
void	DefineSearchFieldsL(CVPbkFieldTypeRefsList &)
void	ExecuteMultipleEntryFetchL(TAiwMultipleEntrySelectionDataV2)
void	ExecuteMultipleItemFetchL(TAiwMultipleItemSelectionDataV1 &)
void	ExecuteSingleItemFetchL(TAiwSingleItemSelectionDataV1)
TInt	HandleNotifyL(TInt, TInt, CAiwGenericParamList &, const CAiwGenericParamList &)
void	IdleFindCallback()
void	PutContactsToArrayL(CMsgRecipientArray &, TInt)

Private Member Functions
	CMsgCheckNames()
void	CleanupResetAndDestroy(TAny *)
void	ConstructL()
void	DoConfigurationChangedCompleteL()
void	PerformAdvancedMatchL(const TDesC &, CVPbkFieldTypeRefsList *)
void	SetDefaultPrioritiesL(TAiwAddressSelectType, RVPbkContactFieldDefaultPriorities &)
CDesCArray *	SplitFindStringL(const TDesC &)
TBool	UseAdvancedMatch(const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TMsgAddressSelectType { EMsgTypeSms, EMsgTypeMms, EMsgTypeMail, EMsgTypeAll }

Private Attributes
CContactMatcher *	iCommonUtils
CVPbkContactLinkArray *	iFoundContacts
CAiwServiceHandler *	iServiceHandler
TBool	iShutdown
CPbk2StoreConfiguration *	iStoreConfiguration
TBool	iUseAdvancedMatch
CActiveSchedulerWait	iWait

Constructor & Destructor Documentation

CMsgCheckNames()

CMsgCheckNames

(

)

[private]

C++ default constructor.

~CMsgCheckNames()

IMPORT_C

~CMsgCheckNames

(

)

[virtual]

Destructor.

Member Functions Documentation

AknInputBlockCancel()

void

AknInputBlockCancel

(

)

From MAknInputBlockCancelHandler. See AknInputBlock.h

Since: S60 3.2

CleanupResetAndDestroy(TAny *)

void

CleanupResetAndDestroy

(

TAny *

newItem

)

[private, static]

Custom cleanup item.

Parameters

TAny * newItem

ConfigurationChanged()

void

ConfigurationChanged

(

)

From MPbk2StoreConfigurationObserver Called when the store configuration changes.

ConfigurationChangedComplete()

void

ConfigurationChangedComplete

(

)

From MPbk2StoreConfigurationObserver Called when the configuration changed event has been delivered to all observers.

ConstructL()

void

ConstructL

(

)

[private]

Symbian 2nd phase constructor.

ContactMatcher()

CContactMatcher &

ContactMatcher

(

)

const [inline]

Returns the contact matcher.

Since: 3.2

ConvertToPbk2Type(TMsgAddressSelectType)

TAiwAddressSelectType

ConvertToPbk2Type

(

TMsgAddressSelectType

aAddressSelectType

)

[protected]

Converts from TMsgAddressSelectType into TAiwAddressSelectType. Once pbk2 headers are included to builds permanently, this could be removed

Since: 3.1

Parameters

TMsgAddressSelectType aAddressSelectType

DefineSearchFieldsL(CVPbkFieldTypeRefsList &)

void

DefineSearchFieldsL

(

CVPbkFieldTypeRefsList &

aOwnList

)

[protected]

Defines the search fields to be used in the search

Since: 3.1

Parameters

CVPbkFieldTypeRefsList & aOwnList

- the fields will be added here

DoConfigurationChangedCompleteL()

void

DoConfigurationChangedCompleteL

(

)

[private]

Performs configuration change handling.

ExecuteMultipleEntryFetchL(TAiwMultipleEntrySelectionDataV2)

void

ExecuteMultipleEntryFetchL

(

TAiwMultipleEntrySelectionDataV2

aData

)

[protected]

Executes the multiple entry fetch.

Since: 3.1

Parameters

TAiwMultipleEntrySelectionDataV2 aData

- is the selection data profiling the fetch

ExecuteMultipleItemFetchL(TAiwMultipleItemSelectionDataV1 &)

void

ExecuteMultipleItemFetchL

(

TAiwMultipleItemSelectionDataV1 &

aData

)

[protected]

Executes the multiple item fetch. This includes multiple entry and single item fetches.

Since: 3.2

Parameters

TAiwMultipleItemSelectionDataV1 & aData

- is the selection data profiling the fetch

ExecuteSingleItemFetchL(TAiwSingleItemSelectionDataV1)

void

ExecuteSingleItemFetchL

(

TAiwSingleItemSelectionDataV1

aData

)

[protected]

Executes the multiple entry fetch.

Since: 3.1

Parameters

TAiwSingleItemSelectionDataV1 aData

- is the selection data profiling the fetch

FetchRecipientsL(CMsgRecipientArray &, TMsgAddressSelectType)

IMPORT_C void	FetchRecipientsL	(	CMsgRecipientArray &	aRecipientList,
			TMsgAddressSelectType	aAddressSelectType
		)

Fetches the recipients for the editors while hiding the asynchronous AIW handling and the related parameters

Since: 3.1

Parameters

CMsgRecipientArray & aRecipientList	- is the array that will be filled for the caller aAddressSelectType - defines the addresstype for selection
TMsgAddressSelectType aAddressSelectType

FetchRecipientsL(CVPbkContactLinkArray &, TMsgAddressSelectType)

IMPORT_C void	FetchRecipientsL	(	CVPbkContactLinkArray &	aContactLinkArray,
			TMsgAddressSelectType	aAddressSelectType
		)

Fetches the recipients for the editors while hiding the asynchronous AIW handling and the related parameters

Since: 3.2

Parameters

CVPbkContactLinkArray & aContactLinkArray
TMsgAddressSelectType aAddressSelectType

FindAndCheckByNameL(const TDesC &, TMsgAddressSelectType, CMsgRecipientArray &, TInt)

IMPORT_C TBool	FindAndCheckByNameL	(	const TDesC &	aText,
			TMsgAddressSelectType	aAddressSelectType,
			CMsgRecipientArray &	aRecipientArray,
			TInt	aIndex
		)

Finds the contact items that match the given search string, checks if they are valid and if there are more than one valid matches shows them in a dialog where user can select one or more of the contacts. This function should be used when virtual phonebook is in use.

Since: 3.1

Parameters

const TDesC & aText	- contains the search descriptor aAddressSelectType - determines which one of single selection dialogs provided by phonebook to use. aRecipientArray - the array to be handled aIndex - current index of the array
TMsgAddressSelectType aAddressSelectType
CMsgRecipientArray & aRecipientArray
TInt aIndex

GetAliasL(const TDesC &, TDes &, TInt)

IMPORT_C void	GetAliasL	(	const TDesC &	aNumber,
			TDes &	aAlias,
			TInt	aMaxLength = KMaxRecipientLength
		)

Getalia from ContactDb based on given address.

Since: 5.0

Parameters

const TDesC & aNumber
TDes & aAlias	generated alias name (OUT).
TInt aMaxLength = KMaxRecipientLength	maximum length of the alias

HandleNotifyL(TInt, TInt, CAiwGenericParamList &, const CAiwGenericParamList &)

TInt	HandleNotifyL	(	TInt	aCmdId,
			TInt	aEventId,
			CAiwGenericParamList &	aEventParamList,
			const CAiwGenericParamList &	aInParamList
		)	[protected]

From MAiwNotifyCallback

Parameters

TInt aCmdId
TInt aEventId
CAiwGenericParamList & aEventParamList
const CAiwGenericParamList & aInParamList

IdleFindCallback()

void

IdleFindCallback

(

)

[protected]

From MIdleFindObserver

This callback function is called by CIdle::RunL() when nothing of a higher priority can be scheduled. It is called for every 16 items searched to give the application a chance to update its search status. Implementation puts the results of the search into iFoundContacts.

NewL()

IMPORT_C CMsgCheckNames *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CMsgCheckNames *

NewLC

(

)

[static]

Two-phased constructor. Leaves object into cleanup stack.

PerformAdvancedMatchL(const TDesC &, CVPbkFieldTypeRefsList *)

void	PerformAdvancedMatchL	(	const TDesC &	aFindString,
			CVPbkFieldTypeRefsList *	aFieldTypes
		)	[private]

Performs advanced match algorithm,

Parameters

const TDesC & aFindString
CVPbkFieldTypeRefsList * aFieldTypes

PutContactsToArrayL(CMsgRecipientArray &, TInt)

void	PutContactsToArrayL	(	CMsgRecipientArray &	aRecipientArray,
			TInt	aIndex
		)	[protected]

Puts the found contacts to the given array

Since: 3.1

Parameters

CMsgRecipientArray & aRecipientArray	- the array to which the recipients will be added aIndex - index of the array, this is where the adding should start
TInt aIndex

SetDefaultPrioritiesL(TAiwAddressSelectType, RVPbkContactFieldDefaultPriorities &)

void	SetDefaultPrioritiesL	(	TAiwAddressSelectType	aAddressType,
			RVPbkContactFieldDefaultPriorities &	aPriorities
		)	const [private]

Sets default priorities for given address type.

Parameters

TAiwAddressSelectType aAddressType
RVPbkContactFieldDefaultPriorities & aPriorities

SplitFindStringL(const TDesC &)

CDesCArray *

SplitFindStringL

(

const TDesC &

aFindString

)

[private]

Slits the find string.

Parameters

const TDesC & aFindString

UseAdvancedMatch(const TDesC &)

TBool

UseAdvancedMatch

(

const TDesC &

aFindString

)

[private]

Determines whether advanced match algorithm is needed.

Parameters

const TDesC & aFindString

Member Enumerations Documentation

Enum TMsgAddressSelectType

Enumerators

EMsgTypeSms
EMsgTypeMms
EMsgTypeMail
EMsgTypeAll

Member Data Documentation

CContactMatcher * iCommonUtils

CContactMatcher *

iCommonUtils

[private]

CVPbkContactLinkArray * iFoundContacts

CVPbkContactLinkArray *

iFoundContacts

[private]

CAiwServiceHandler * iServiceHandler

CAiwServiceHandler *

iServiceHandler

[private]

TBool iShutdown

TBool

iShutdown

[private]

CPbk2StoreConfiguration * iStoreConfiguration

CPbk2StoreConfiguration *

iStoreConfiguration

[private]

TBool iUseAdvancedMatch

TBool

iUseAdvancedMatch

[private]

CActiveSchedulerWait iWait

CActiveSchedulerWait

iWait

[private]