CSyncMLFilterProperty Class Reference

#include <SyncMLDataFilter.h>

Link against: syncmldatafilter.lib

class CSyncMLFilterProperty : public CBase

Inherits from

CSyncMLFilterProperty

Public Member Functions
	~CSyncMLFilterProperty()
IMPORT_C void	AddDefaultValueBoolL(const TBool, const TBool)
IMPORT_C void	AddDefaultValueDateL(const TTime &, const TBool)
IMPORT_C void	AddDefaultValueIntL(const TInt, const TBool)
IMPORT_C void	AddDefaultValueText16L(TDesC16 &, const TBool)
IMPORT_C void	AddDefaultValueText8L(TDesC8 &, const TBool)
IMPORT_C void	AddDefaultValueTimeL(const TTime &, const TBool)
IMPORT_C TBool	CanUseQueryValue()
IMPORT_C void	ClearDefaultValuesL()
IMPORT_C TInt	DataSize()
IMPORT_C TBool	DefaultValueBoolL(TInt)
IMPORT_C TInt	DefaultValueCount()
IMPORT_C TSyncMLFilterPropertyDataType	DefaultValueDataType()
IMPORT_C const TTime &	DefaultValueDateL(TInt)
IMPORT_C TInt	DefaultValueIntL(TInt)
IMPORT_C const TDesC16 &	DefaultValueText16L(TInt)
IMPORT_C const TDesC8 &	DefaultValueText8L(TInt)
IMPORT_C const TTime &	DefaultValueTimeL(TInt)
IMPORT_C const TDesC &	DisplayName()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TBool	IsDefaultValueSelected(TInt)
IMPORT_C TBool	IsQueryValueSelected()
IMPORT_C TUint	MaxTextLength()
IMPORT_C CSyncMLFilterProperty *	NewLC()
IMPORT_C CSyncMLFilterProperty *	NewLC(TResourceReader &)
IMPORT_C CSyncMLFilterProperty *	NewLC(RReadStream &)
IMPORT_C TBool	QueryValueBoolL()
IMPORT_C TSyncMLFilterPropertyDataType	QueryValueDataType()
IMPORT_C const TTime &	QueryValueDateL()
IMPORT_C TInt	QueryValueIntL()
IMPORT_C const TDesC16 &	QueryValueText16L()
IMPORT_C const TDesC8 &	QueryValueText8L()
IMPORT_C const TTime &	QueryValueTimeL()
IMPORT_C void	SelectDefaultValueL(TInt)
IMPORT_C void	SetQueryValueBoolL(TBool)
IMPORT_C void	SetQueryValueDateL(const TTime &)
IMPORT_C void	SetQueryValueIntL(TInt)
IMPORT_C void	SetQueryValueText16L(const TDesC16 &)
IMPORT_C void	SetQueryValueText8L(const TDesC8 &)
IMPORT_C void	SetQueryValueTimeL(const TTime &)
IMPORT_C TBool	SupportsEmptySelection()
IMPORT_C TBool	SupportsMultipleSelection()
IMPORT_C void	UnselectDefaultValueL(TInt)
IMPORT_C void	UnselectQueryValueL()

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()

Detailed Description

Filter Property Class.

Constructor & Destructor Documentation

~CSyncMLFilterProperty ( )

IMPORT_C

~CSyncMLFilterProperty

(

)

Destructor.

Member Function Documentation

AddDefaultValueBoolL ( const TBool, const TBool )

IMPORT_C void	AddDefaultValueBoolL	(	const TBool	aNewDefaultValue,
			const TBool	aSelected
		)

Adds default value for boolean property. This is useful only if data type is boolean.

Parameter	Description
aNewDefaultValue	Value of added default value.
aSelected	Specifies if value is selected or not.

AddDefaultValueDateL ( const TTime &, const TBool )

IMPORT_C void	AddDefaultValueDateL	(	const TTime &	aNewDefaultValue,
			const TBool	aSelected
		)

Adds default value for date property. This is useful only if data type is date.

Parameter	Description
aNewDefaultValue	Value of added default value.
aSelected	Specifies if value is selected or not.

AddDefaultValueIntL ( const TInt, const TBool )

IMPORT_C void	AddDefaultValueIntL	(	const TInt	aNewDefaultValue,
			const TBool	aSelected
		)

Adds default value for number property. This is useful only if data type is number.

Parameter	Description
aNewDefaultValue	Value of added default value.
aSelected	Specifies if value is selected or not.

AddDefaultValueText16L ( TDesC16 &, const TBool )

IMPORT_C void	AddDefaultValueText16L	(	TDesC16 &	aNewDefaultValue,
			const TBool	aSelected
		)

Adds default value for text16 property. This is useful only if data type is text16.

Parameter	Description
aNewDefaultValue	Value of added default value.
aSelected	Specifies if value is selected or not.

AddDefaultValueText8L ( TDesC8 &, const TBool )

IMPORT_C void	AddDefaultValueText8L	(	TDesC8 &	aNewDefaultValue,
			const TBool	aSelected
		)

Adds default value for text8 property. This is useful only if data type is text8.

Parameter	Description
aNewDefaultValue	Value of added default value.
aSelected	Specifies if value is selected or not.

AddDefaultValueTimeL ( const TTime &, const TBool )

IMPORT_C void	AddDefaultValueTimeL	(	const TTime &	aNewDefaultValue,
			const TBool	aSelected
		)

Adds default value for time property. This is useful only if data type is time.

Parameter	Description
aNewDefaultValue	Value of added default value.
aSelected	Specifies if value is selected or not.

CanUseQueryValue ( )

IMPORT_C TBool

CanUseQueryValue

(

)

const

Can use query value with default values or not.

Returns: TBool Returns ETrue if query can be used. Otherwise EFalse is returned.

ClearDefaultValuesL ( )

IMPORT_C void

ClearDefaultValuesL

(

)

Clears all default values and value selections.

DataSize ( )

IMPORT_C TInt

DataSize

(

)

Size of data

Returns: Size of internal data

DefaultValueBoolL ( TInt )

IMPORT_C TBool

DefaultValueBoolL

(

TInt

aIndex

)

const

Default value from given index for boolean property. This is useful only if data type is boolean.

Parameter	Description
aIndex	Specifies index where default value is returned.

Returns: TBool Default value from given index.

DefaultValueCount ( )

IMPORT_C TInt

DefaultValueCount

(

)

const

Number of default values.

Returns: TInt Number of default values of the filter property.

DefaultValueDataType ( )

IMPORT_C TSyncMLFilterPropertyDataType

DefaultValueDataType

(

)

const

Data type of default values for filter property.

Returns: TSyncMLFilterPropertyDataType Data type.

DefaultValueDateL ( TInt )

IMPORT_C const TTime &

DefaultValueDateL

(

TInt

aIndex

)

const

Default value from given index for date property. This is useful only if data type is date.

Parameter	Description
aIndex	Specifies index where default value is returned.

Returns: TTime Default value from given index.

DefaultValueIntL ( TInt )

IMPORT_C TInt

DefaultValueIntL

(

TInt

aIndex

)

const

Default value from given index for number property. This is useful only if data type is number.

Parameter	Description
aIndex	Specifies index where default value is returned.

Returns: TInt Default value from given index.

DefaultValueText16L ( TInt )

IMPORT_C const TDesC16 &

DefaultValueText16L

(

TInt

aIndex

)

const

Default value from given index for text16 property. This is useful only if data type is text16.

Parameter	Description
aIndex	Specifies index where default value is returned.

Returns: TDesC16 Default value from given index.

DefaultValueText8L ( TInt )

IMPORT_C const TDesC8 &

DefaultValueText8L

(

TInt

aIndex

)

const

Default value from given index for text8 property. This is useful only if data type is text8.

Parameter	Description
aIndex	Specifies index where default value is returned.

Returns: TDesC8 Default value from given index.

DefaultValueTimeL ( TInt )

IMPORT_C const TTime &

DefaultValueTimeL

(

TInt

aIndex

)

const

Default value from given index for time property. This is useful only if data type is time.

Parameter	Description
aIndex	Specifies index where default value is returned.

Returns: TTime Default value from given index.

DisplayName ( )

IMPORT_C const TDesC &

DisplayName

(

)

const

Name of filter property.

Returns: TDesC Name of the filter property.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes filter property.

Parameter	Description
aStream	Specifies stream where filter property is externalized.

IsDefaultValueSelected ( TInt )

IMPORT_C TBool

IsDefaultValueSelected

(

TInt

aIndex

)

const

Returns information about which default values are selected.

Parameter	Description
aIndex	Specifies index where selection information is returned.

Returns: TBool Returns ETrue if default value in given index is selected. Otherwise EFalse is returned.

IsQueryValueSelected ( )

IMPORT_C TBool

IsQueryValueSelected

(

)

const

Returns information about query value selection. This is useful only if query value can be used.

Returns: TBool Returns ETrue if query value is selected. Otherwise EFalse is returned.

MaxTextLength ( )

IMPORT_C TUint

MaxTextLength

(

)

const

Maximum text length of filter property. This is useful only if data type is text16 or text8.

Returns: TUint Maximum text length of the filter property.

NewLC ( )

IMPORT_C CSyncMLFilterProperty *

NewLC

(

)

[static]

Symbian two-phased constructor.

NewLC ( TResourceReader & )

IMPORT_C CSyncMLFilterProperty *

NewLC

(

TResourceReader &

aReader

)

[static]

Symbian two-phased constructor.

Parameter	Description
aReader	TResourceReader for recource file that includes needed information to initialize filter property.

NewLC ( RReadStream & )

IMPORT_C CSyncMLFilterProperty *

NewLC

(

RReadStream &

aStream

)

[static]

Symbian two-phased constructor.

Parameter	Description
aStream	RReadStream for stream that includes needed information to initialize filter property.

QueryValueBoolL ( )

IMPORT_C TBool

QueryValueBoolL

(

)

const

Returns query value for boolean property. This is useful only if data type is boolean and if query value can be used.

Returns: TBool Query value.

QueryValueDataType ( )

IMPORT_C TSyncMLFilterPropertyDataType

QueryValueDataType

(

)

const

Data type of query value for filter property.

Returns: TSyncMLFilterPropertyDataType Data type.

QueryValueDateL ( )

IMPORT_C const TTime &

QueryValueDateL

(

)

const

Returns query value for date property. This is useful only if data type is date and if query value can be used.

Returns: TTime Query value.

QueryValueIntL ( )

IMPORT_C TInt

QueryValueIntL

(

)

const

Returns query value for number property. This is useful only if data type is number and if query value can be used.

Returns: TInt Query value.

QueryValueText16L ( )

IMPORT_C const TDesC16 &

QueryValueText16L

(

)

const

Returns query value for text16 property. This is useful only if data type is text16 and if query value can be used.

Returns: TDesC16 Query value.

QueryValueText8L ( )

IMPORT_C const TDesC8 &

QueryValueText8L

(

)

const

Returns query value for text8 property. This is useful only if data type is text8 and if query value can be used.

Returns: TDesC8 Query value.

QueryValueTimeL ( )

IMPORT_C const TTime &

QueryValueTimeL

(

)

const

Returns query value for time property. This is useful only if data type is time and if query value can be used.

Returns: TTime Query value.

SelectDefaultValueL ( TInt )

IMPORT_C void

SelectDefaultValueL

(

TInt

aIndex

)

Selects default value from given index.

Parameter	Description
aIndex	Specifies index which is selected.

SetQueryValueBoolL ( TBool )

IMPORT_C void

SetQueryValueBoolL

(

TBool

aValue

)

Sets query value for boolean property. This is useful only if data type is boolean and if query value can be used. This method also selects query value.

Parameter	Description
aValue	Specifies new value for query value.

SetQueryValueDateL ( const TTime & )

IMPORT_C void

SetQueryValueDateL

(

const TTime &

aValue

)

Sets query value for date property. This is useful only if data type is date and if query value can be used. This method also selects query value.

Parameter	Description
aValue	Specifies new value for query value.

SetQueryValueIntL ( TInt )

IMPORT_C void

SetQueryValueIntL

(

TInt

aValue

)

Sets query value for number property. This is useful only if data type is number and if query value can be used. This method also selects query value.

Parameter	Description
aValue	Specifies new value for query value.

SetQueryValueText16L ( const TDesC16 & )

IMPORT_C void

SetQueryValueText16L

(

const TDesC16 &

aValue

)

Sets query value for text16 property. This is useful only if data type is text16 and if query value can be used. This method also selects query value.

Parameter	Description
aValue	Specifies new value for query value.

SetQueryValueText8L ( const TDesC8 & )

IMPORT_C void

SetQueryValueText8L

(

const TDesC8 &

aValue

)

Sets query value for text8 property. This is useful only if data type is text8 and if query value can be used. This method also selects query value.

Parameter	Description
aValue	Specifies new value for query value.

SetQueryValueTimeL ( const TTime & )

IMPORT_C void

SetQueryValueTimeL

(

const TTime &

aValue

)

Sets query value for time property. This is useful only if data type is time and if query value can be used. This method also selects query value.

Parameter	Description
aValue	Specifies new value for query value.

SupportsEmptySelection ( )

IMPORT_C TBool

SupportsEmptySelection

(

)

const

Does filter property support empty selection.

Returns: TBool Returns ETrue if none of values can be selected. Otherwise EFalse is returned.

SupportsMultipleSelection ( )

IMPORT_C TBool

SupportsMultipleSelection

(

)

const

Does filter property support multiple selection.

Returns: TBool Returns ETrue if multiple values can be selected. Otherwise EFalse is returned.

UnselectDefaultValueL ( TInt )

IMPORT_C void

UnselectDefaultValueL

(

TInt

aIndex

)

Unselects default value from given index.

Parameter	Description
aIndex	Specifies index which is unselected.

UnselectQueryValueL ( )

IMPORT_C void

UnselectQueryValueL

(

)

Unselects query value. This is useful only if query value can be used. This method still keeps the value