Symbian^3 Application Developer Library >

CSyncMLFilterProperty Class Reference

class CSyncMLFilterProperty : public CBase

Filter Property Class.

syncmldatafilter.lib

Inherits from

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 ()
Private Member Functions
CSyncMLFilterProperty ()
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()
Private Attributes
TBool iCanUseQueryValue
TSyncMLFilterPropertyDataType iDataTypeForDefaultValues
TSyncMLFilterPropertyDataType iDataTypeForQueryValue
RPointerArray < TTime > iDefaultValueDateOrTimeList
RArray < TInt > iDefaultValueIntOrBoolList
RArray < TBool > iDefaultValueSelected
RPointerArray < HBufC16 > iDefaultValueText16List
RPointerArray < HBufC8 > iDefaultValueText8List
HBufC * iDisplayName
TUint iMaxTextLength
TTime iQueryValueDateOrTime
TInt iQueryValueIntOrBool
TBool iQueryValueSelected
HBufC16 * iQueryValueText16
HBufC8 * iQueryValueText8
TBool iSupportsEmptySelection
TBool iSupportsMultpleSelection

Constructor & Destructor Documentation

CSyncMLFilterProperty()

CSyncMLFilterProperty ( ) [private]

Basic constructor.

~CSyncMLFilterProperty()

IMPORT_C ~CSyncMLFilterProperty ( )

Destructor.

Member Functions 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.

Parameters

const TBool aNewDefaultValue Value of added default value.
const TBool 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.

Parameters

const TTime & aNewDefaultValue Value of added default value.
const TBool 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.

Parameters

const TInt aNewDefaultValue Value of added default value.
const TBool 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.

Parameters

TDesC16 & aNewDefaultValue Value of added default value.
const TBool 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.

Parameters

TDesC8 & aNewDefaultValue Value of added default value.
const TBool 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.

Parameters

const TTime & aNewDefaultValue Value of added default value.
const TBool aSelected Specifies if value is selected or not.

CanUseQueryValue()

IMPORT_C TBool CanUseQueryValue ( ) const

Can use query value with default values or not.

ClearDefaultValuesL()

IMPORT_C void ClearDefaultValuesL ( )

Clears all default values and value selections.

DataSize()

IMPORT_C TInt DataSize ( )

Size of 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.

Parameters

TInt aIndex Specifies index where default value is returned.

DefaultValueCount()

IMPORT_C TInt DefaultValueCount ( ) const

Number of default values.

DefaultValueDataType()

IMPORT_C TSyncMLFilterPropertyDataType DefaultValueDataType ( ) const

Data type of default values for filter property.

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.

Parameters

TInt aIndex Specifies index where default value is returned.

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.

Parameters

TInt aIndex Specifies index where default value is returned.

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.

Parameters

TInt aIndex Specifies index where default value is returned.

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.

Parameters

TInt aIndex Specifies index where default value is returned.

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.

Parameters

TInt aIndex Specifies index where default value is returned.

DisplayName()

IMPORT_C const TDesC & DisplayName ( ) const

Name of filter property.

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const

Externalizes filter property.

Parameters

RWriteStream & 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.

Parameters

TInt aIndex Specifies index where selection information is returned.

IsQueryValueSelected()

IMPORT_C TBool IsQueryValueSelected ( ) const

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

MaxTextLength()

IMPORT_C TUint MaxTextLength ( ) const

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

NewLC()

IMPORT_C CSyncMLFilterProperty * NewLC ( ) [static]

Symbian two-phased constructor.

NewLC(TResourceReader &)

IMPORT_C CSyncMLFilterProperty * NewLC ( TResourceReader & aReader ) [static]

Symbian two-phased constructor.

Parameters

TResourceReader & 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.

Parameters

RReadStream & 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.

QueryValueDataType()

IMPORT_C TSyncMLFilterPropertyDataType QueryValueDataType ( ) const

Data type of query value for filter property.

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.

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.

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.

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.

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.

SelectDefaultValueL(TInt)

IMPORT_C void SelectDefaultValueL ( TInt aIndex )

Selects default value from given index.

Parameters

TInt 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.

Parameters

TBool 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.

Parameters

const TTime & 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.

Parameters

TInt 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.

Parameters

const TDesC16 & 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.

Parameters

const TDesC8 & 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.

Parameters

const TTime & aValue Specifies new value for query value.

SupportsEmptySelection()

IMPORT_C TBool SupportsEmptySelection ( ) const

Does filter property support empty selection.

SupportsMultipleSelection()

IMPORT_C TBool SupportsMultipleSelection ( ) const

Does filter property support multiple selection.

UnselectDefaultValueL(TInt)

IMPORT_C void UnselectDefaultValueL ( TInt aIndex )

Unselects default value from given index.

Parameters

TInt 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

Member Data Documentation

TBool iCanUseQueryValue

TBool iCanUseQueryValue [private]

TSyncMLFilterPropertyDataType iDataTypeForDefaultValues

TSyncMLFilterPropertyDataType iDataTypeForDefaultValues [private]

TSyncMLFilterPropertyDataType iDataTypeForQueryValue

TSyncMLFilterPropertyDataType iDataTypeForQueryValue [private]

RPointerArray< TTime > iDefaultValueDateOrTimeList

RPointerArray < TTime > iDefaultValueDateOrTimeList [private]

RArray< TInt > iDefaultValueIntOrBoolList

RArray < TInt > iDefaultValueIntOrBoolList [private]

RArray< TBool > iDefaultValueSelected

RArray < TBool > iDefaultValueSelected [private]

RPointerArray< HBufC16 > iDefaultValueText16List

RPointerArray < HBufC16 > iDefaultValueText16List [private]

RPointerArray< HBufC8 > iDefaultValueText8List

RPointerArray < HBufC8 > iDefaultValueText8List [private]

HBufC * iDisplayName

HBufC * iDisplayName [private]

TUint iMaxTextLength

TUint iMaxTextLength [private]

TTime iQueryValueDateOrTime

TTime iQueryValueDateOrTime [private]

TInt iQueryValueIntOrBool

TInt iQueryValueIntOrBool [private]

TBool iQueryValueSelected

TBool iQueryValueSelected [private]

HBufC16 * iQueryValueText16

HBufC16 * iQueryValueText16 [private]

HBufC8 * iQueryValueText8

HBufC8 * iQueryValueText8 [private]

TBool iSupportsEmptySelection

TBool iSupportsEmptySelection [private]

TBool iSupportsMultpleSelection

TBool iSupportsMultpleSelection [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.