TVPbkFieldVersitProperty Class Reference

class TVPbkFieldVersitProperty

A basic field Versit property.

The structure of Versit property is defined in VBK_FIELD_VERSIT_PROPERTY in VPbkFieldType.rh.

MVPbkFieldType MVPbkFieldType::Matches VPbkEng.lib

Constructor & Destructor Documentation

TVPbkFieldVersitProperty()

IMPORT_C TVPbkFieldVersitProperty ( )

Default constructor. Resets all fields to null values.

TVPbkFieldVersitProperty(TResourceReader &)

IMPORT_C TVPbkFieldVersitProperty ( TResourceReader & aResReader )

Constructs this object from a VBK_FIELD_VERSIT_PROPERTY resource.

Sets also the Versit extension name. Only a reference to the extension name is stored so the client must either keep the resource buffer alive or make a copy of the extension name and use SetExtensionName. The reference must be valid for the lifetime of this object.

Parameters

TResourceReader & aResReader A reader to the VBK_FIELD_VERSIT_PROPERTY resource.

Member Functions Documentation

ExtensionName()

TPtrC8 ExtensionName ( ) const [inline]

Returns the Versit extension name.

Matches(const TVPbkFieldVersitProperty &)

IMPORT_C TBool Matches ( const TVPbkFieldVersitProperty & aOther ) const

Returns true if this versit property matches aOther.

If aOther matches this property it doesn't necessary mean that this property will match to aOther.

Parameters

const TVPbkFieldVersitProperty & aOther Another property that is matched to this property.

Name()

TVPbkFieldTypeName Name ( ) const [inline]

Returns the Versit property name.

Parameters()

const TVPbkFieldTypeParameters & Parameters ( ) const [inline]

Returns the Versit property parameters (read-only).

Parameters()

TVPbkFieldTypeParameters & Parameters ( ) [inline]

Returns the Versit property parameters (read-write).

ReadFromResource(TResourceReader &)

IMPORT_C void ReadFromResource ( TResourceReader & aResReader )

Reads this object's contents from a VBK_FIELD_VERSIT_PROPERTY resource.

Sets also the Versit extension name. Only a reference to the extension name is stored so the client must either keep the resource buffer alive or make a copy of the extension name and use SetExtensionName. The reference must be valid for the lifetime of this object.

Parameters

TResourceReader & aResReader A reader to the VBK_FIELD_VERSIT_PROPERTY resource.

SetExtensionName(const TDesC8 &)

void SetExtensionName ( const TDesC8 & aExtensionName ) [inline]

Sets the Versit extension name.

Only a reference to the name is stored. The reference must be valid for the lifetime of this object.

Parameters

const TDesC8 & aExtensionName The extension name reference that is set to this property.

SetName(TVPbkFieldTypeName)

void SetName ( TVPbkFieldTypeName aName ) [inline]

Sets the Versit property name.

Parameters

TVPbkFieldTypeName aName The name that is set to this property.

SetParameters(const TVPbkFieldTypeParameters &)

void SetParameters ( const TVPbkFieldTypeParameters & aParameters ) [inline]

Sets the Versit property parameters.

Parameters

const TVPbkFieldTypeParameters & aParameters Parameters that are set to this property.

SetSubField(TVPbkSubFieldType)

void SetSubField ( TVPbkSubFieldType aSubField ) [inline]

Sets the Versit property subfield.

Parameters

TVPbkSubFieldType aSubField The sub field that is set to this property.

SubField()

TVPbkSubFieldType SubField ( ) const [inline]

Returns the Versit property subfield.

Member Data Documentation

TVPbkFieldVersitPropertyExt * iExtension

TVPbkFieldVersitPropertyExt * iExtension [private]

TPtrC8 iExtensionName

TPtrC8 iExtensionName [private]

TVPbkFieldTypeName iName

TVPbkFieldTypeName iName [private]

TVPbkFieldTypeParameters iParameters

TVPbkFieldTypeParameters iParameters [private]

TVPbkSubFieldType iSubField

TVPbkSubFieldType iSubField [private]