CSyncMLFilterProperty Class Reference

#include <SyncMLDataFilter.h>

Link against: syncmldatafilter.lib

class CSyncMLFilterProperty : public CBase

Inherits from

  • CSyncMLFilterProperty
    Public Member Functions
    ~CSyncMLFilterProperty()
    IMPORT_C voidAddDefaultValueBoolL(const TBool, const TBool)
    IMPORT_C voidAddDefaultValueDateL(const TTime &, const TBool)
    IMPORT_C voidAddDefaultValueIntL(const TInt, const TBool)
    IMPORT_C voidAddDefaultValueText16L(TDesC16 &, const TBool)
    IMPORT_C voidAddDefaultValueText8L(TDesC8 &, const TBool)
    IMPORT_C voidAddDefaultValueTimeL(const TTime &, const TBool)
    IMPORT_C TBoolCanUseQueryValue()
    IMPORT_C voidClearDefaultValuesL()
    IMPORT_C TIntDataSize()
    IMPORT_C TBoolDefaultValueBoolL(TInt)
    IMPORT_C TIntDefaultValueCount()
    IMPORT_C TSyncMLFilterPropertyDataTypeDefaultValueDataType()
    IMPORT_C const TTime &DefaultValueDateL(TInt)
    IMPORT_C TIntDefaultValueIntL(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 voidExternalizeL(RWriteStream &)
    IMPORT_C TBoolIsDefaultValueSelected(TInt)
    IMPORT_C TBoolIsQueryValueSelected()
    IMPORT_C TUintMaxTextLength()
    IMPORT_C CSyncMLFilterProperty *NewLC()
    IMPORT_C CSyncMLFilterProperty *NewLC(TResourceReader &)
    IMPORT_C CSyncMLFilterProperty *NewLC(RReadStream &)
    IMPORT_C TBoolQueryValueBoolL()
    IMPORT_C TSyncMLFilterPropertyDataTypeQueryValueDataType()
    IMPORT_C const TTime &QueryValueDateL()
    IMPORT_C TIntQueryValueIntL()
    IMPORT_C const TDesC16 &QueryValueText16L()
    IMPORT_C const TDesC8 &QueryValueText8L()
    IMPORT_C const TTime &QueryValueTimeL()
    IMPORT_C voidSelectDefaultValueL(TInt)
    IMPORT_C voidSetQueryValueBoolL(TBool)
    IMPORT_C voidSetQueryValueDateL(const TTime &)
    IMPORT_C voidSetQueryValueIntL(TInt)
    IMPORT_C voidSetQueryValueText16L(const TDesC16 &)
    IMPORT_C voidSetQueryValueText8L(const TDesC8 &)
    IMPORT_C voidSetQueryValueTimeL(const TTime &)
    IMPORT_C TBoolSupportsEmptySelection()
    IMPORT_C TBoolSupportsMultipleSelection()
    IMPORT_C voidUnselectDefaultValueL(TInt)
    IMPORT_C voidUnselectQueryValueL()
    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 voidAddDefaultValueBoolL(const TBoolaNewDefaultValue,
    const TBoolaSelected
    )

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

    ParameterDescription
    aNewDefaultValueValue of added default value.
    aSelectedSpecifies if value is selected or not.

    AddDefaultValueDateL ( const TTime &, const TBool )

    IMPORT_C voidAddDefaultValueDateL(const TTime &aNewDefaultValue,
    const TBoolaSelected
    )

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

    ParameterDescription
    aNewDefaultValueValue of added default value.
    aSelectedSpecifies if value is selected or not.

    AddDefaultValueIntL ( const TInt, const TBool )

    IMPORT_C voidAddDefaultValueIntL(const TIntaNewDefaultValue,
    const TBoolaSelected
    )

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

    ParameterDescription
    aNewDefaultValueValue of added default value.
    aSelectedSpecifies if value is selected or not.

    AddDefaultValueText16L ( TDesC16 &, const TBool )

    IMPORT_C voidAddDefaultValueText16L(TDesC16 &aNewDefaultValue,
    const TBoolaSelected
    )

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

    ParameterDescription
    aNewDefaultValueValue of added default value.
    aSelectedSpecifies if value is selected or not.

    AddDefaultValueText8L ( TDesC8 &, const TBool )

    IMPORT_C voidAddDefaultValueText8L(TDesC8 &aNewDefaultValue,
    const TBoolaSelected
    )

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

    ParameterDescription
    aNewDefaultValueValue of added default value.
    aSelectedSpecifies if value is selected or not.

    AddDefaultValueTimeL ( const TTime &, const TBool )

    IMPORT_C voidAddDefaultValueTimeL(const TTime &aNewDefaultValue,
    const TBoolaSelected
    )

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

    ParameterDescription
    aNewDefaultValueValue of added default value.
    aSelectedSpecifies if value is selected or not.

    CanUseQueryValue ( )

    IMPORT_C TBoolCanUseQueryValue()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 voidClearDefaultValuesL()

    Clears all default values and value selections.

    DataSize ( )

    IMPORT_C TIntDataSize()

    Size of data

    Returns: Size of internal data

    DefaultValueBoolL ( TInt )

    IMPORT_C TBoolDefaultValueBoolL(TIntaIndex)const

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

    ParameterDescription
    aIndexSpecifies index where default value is returned.

    Returns: TBool Default value from given index.

    DefaultValueCount ( )

    IMPORT_C TIntDefaultValueCount()const

    Number of default values.

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

    DefaultValueDataType ( )

    IMPORT_C TSyncMLFilterPropertyDataTypeDefaultValueDataType()const

    Data type of default values for filter property.

    Returns: TSyncMLFilterPropertyDataType Data type.

    DefaultValueDateL ( TInt )

    IMPORT_C const TTime &DefaultValueDateL(TIntaIndex)const

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

    ParameterDescription
    aIndexSpecifies index where default value is returned.

    Returns: TTime Default value from given index.

    DefaultValueIntL ( TInt )

    IMPORT_C TIntDefaultValueIntL(TIntaIndex)const

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

    ParameterDescription
    aIndexSpecifies index where default value is returned.

    Returns: TInt Default value from given index.

    DefaultValueText16L ( TInt )

    IMPORT_C const TDesC16 &DefaultValueText16L(TIntaIndex)const

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

    ParameterDescription
    aIndexSpecifies index where default value is returned.

    Returns: TDesC16 Default value from given index.

    DefaultValueText8L ( TInt )

    IMPORT_C const TDesC8 &DefaultValueText8L(TIntaIndex)const

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

    ParameterDescription
    aIndexSpecifies index where default value is returned.

    Returns: TDesC8 Default value from given index.

    DefaultValueTimeL ( TInt )

    IMPORT_C const TTime &DefaultValueTimeL(TIntaIndex)const

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

    ParameterDescription
    aIndexSpecifies 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 voidExternalizeL(RWriteStream &aStream)const

    Externalizes filter property.

    ParameterDescription
    aStreamSpecifies stream where filter property is externalized.

    IsDefaultValueSelected ( TInt )

    IMPORT_C TBoolIsDefaultValueSelected(TIntaIndex)const

    Returns information about which default values are selected.

    ParameterDescription
    aIndexSpecifies 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 TBoolIsQueryValueSelected()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 TUintMaxTextLength()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.

    ParameterDescription
    aReaderTResourceReader for recource file that includes needed information to initialize filter property.

    NewLC ( RReadStream & )

    IMPORT_C CSyncMLFilterProperty *NewLC(RReadStream &aStream)[static]

    Symbian two-phased constructor.

    ParameterDescription
    aStreamRReadStream for stream that includes needed information to initialize filter property.

    QueryValueBoolL ( )

    IMPORT_C TBoolQueryValueBoolL()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 TSyncMLFilterPropertyDataTypeQueryValueDataType()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 TIntQueryValueIntL()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 voidSelectDefaultValueL(TIntaIndex)

    Selects default value from given index.

    ParameterDescription
    aIndexSpecifies index which is selected.

    SetQueryValueBoolL ( TBool )

    IMPORT_C voidSetQueryValueBoolL(TBoolaValue)

    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.

    ParameterDescription
    aValueSpecifies new value for query value.

    SetQueryValueDateL ( const TTime & )

    IMPORT_C voidSetQueryValueDateL(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.

    ParameterDescription
    aValueSpecifies new value for query value.

    SetQueryValueIntL ( TInt )

    IMPORT_C voidSetQueryValueIntL(TIntaValue)

    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.

    ParameterDescription
    aValueSpecifies new value for query value.

    SetQueryValueText16L ( const TDesC16 & )

    IMPORT_C voidSetQueryValueText16L(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.

    ParameterDescription
    aValueSpecifies new value for query value.

    SetQueryValueText8L ( const TDesC8 & )

    IMPORT_C voidSetQueryValueText8L(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.

    ParameterDescription
    aValueSpecifies new value for query value.

    SetQueryValueTimeL ( const TTime & )

    IMPORT_C voidSetQueryValueTimeL(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.

    ParameterDescription
    aValueSpecifies new value for query value.

    SupportsEmptySelection ( )

    IMPORT_C TBoolSupportsEmptySelection()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 TBoolSupportsMultipleSelection()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 voidUnselectDefaultValueL(TIntaIndex)

    Unselects default value from given index.

    ParameterDescription
    aIndexSpecifies index which is unselected.

    UnselectQueryValueL ( )

    IMPORT_C voidUnselectQueryValueL()

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