TVPbkFieldVersitProperty Class Reference

#include <app/TVPbkFieldVersitProperty.h>

class TVPbkFieldVersitProperty

Detailed Description

A basic field Versit property.

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

See also: MVPbkFieldType MVPbkFieldType::Matches

library
VPbkEng.lib

Constructor & Destructor Documentation

TVPbkFieldVersitProperty ( )

IMPORT_CTVPbkFieldVersitProperty()

Default constructor. Resets all fields to null values.

TVPbkFieldVersitProperty ( TResourceReader & )

IMPORT_CTVPbkFieldVersitProperty(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.

ParameterDescription
aResReaderA reader to the VBK_FIELD_VERSIT_PROPERTY resource.

Member Function Documentation

ExtensionName ( )

TPtrC8 ExtensionName()const [inline]

Returns the Versit extension name.

Returns: The Versit extension name.

Matches ( const TVPbkFieldVersitProperty & )

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

ParameterDescription
aOtherAnother property that is matched to this property.

Name ( )

TVPbkFieldTypeName Name()const [inline]

Returns the Versit property name.

Returns: The Versit property name.

Parameters ( )

const TVPbkFieldTypeParameters &Parameters()const [inline]

Returns the Versit property parameters (read-only).

Returns: The Versit property parameters (read-only).

Parameters ( )

TVPbkFieldTypeParameters &Parameters()[inline]

Returns the Versit property parameters (read-write).

Returns: The Versit property parameters (read-write).

ReadFromResource ( TResourceReader & )

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

ParameterDescription
aResReaderA reader to the VBK_FIELD_VERSIT_PROPERTY resource.

SetExtensionName ( const TDesC8 & )

voidSetExtensionName(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.

ParameterDescription
aExtensionNameThe extension name reference that is set to this property.

SetName ( TVPbkFieldTypeName )

voidSetName(TVPbkFieldTypeNameaName)[inline]

Sets the Versit property name.

ParameterDescription
aNameThe name that is set to this property.

SetParameters ( const TVPbkFieldTypeParameters & )

voidSetParameters(const TVPbkFieldTypeParameters &aParameters)[inline]

Sets the Versit property parameters.

ParameterDescription
aParametersParameters that are set to this property.

SetSubField ( TVPbkSubFieldType )

voidSetSubField(TVPbkSubFieldTypeaSubField)[inline]

Sets the Versit property subfield.

ParameterDescription
aSubFieldThe sub field that is set to this property.

SubField ( )

TVPbkSubFieldType SubField()const [inline]

Returns the Versit property subfield.

Returns: The Versit property subfield.