TVPbkFieldTypeParameters Class Reference
| class TVPbkFieldTypeParameters |
A class for managing field type parameters.
Parameters are based on the Versit 2.1 standard and they can be found from TVPbkFieldTypeParameter in VPbkFieldType.hrh.
VBK_FIELD_VERSIT_PROPERTY in VPbkFieldType.rh TVPbkFieldVersitProperty VPbkEng.lib
Constructor & Destructor Documentation
TVPbkFieldTypeParameters()
| TVPbkFieldTypeParameters | ( | ) | [inline] |
Default constructor. Initializes this parameter set to empty.
TVPbkFieldTypeParameters(TResourceReader &)
Constructs this parameter set from a resource. The resource must have LEN BYTE BYTE[] layout.
- Exceptions
-
| VPbkError::Panic( |
VPbkError::EInvalidTypeParameterResource) if the resource is invalid.
|
Parameters
| TResourceReader & aResReader | A reader to resource LEN BYTE BYTE[] that contains the parameters. |
Member Functions Documentation
Add(TVPbkFieldTypeParameter)
Adds aParam to this parameter set.
Parameters
| TVPbkFieldTypeParameter aParam | A new parameter to this set. aParam >= 0 && aParam < KVPbkMaxVersitParams. VPbkError::Panic(VPbkError::EInvalidTypeParameter) is raised if the precondition does not hold. |
AddAll(const TVPbkFieldTypeParameters &)
Adds all parameters of another parameter set to this set.
AddFromResource(TResourceReader &)
Adds parameter set from a resource. The resource must have LEN BYTE BYTE[] layout.
- Exceptions
-
| VPbkError::Panic( |
VPbkError::EInvalidTypeParameterResource) if the resource is invalid.
|
Parameters
| TResourceReader & aResReader | A reader to resource LEN BYTE BYTE[] that contains the parameters. |
Contains(TVPbkFieldTypeParameter)
Returns true if aParam is included in this parameter set.
ContainsAll(const TVPbkFieldTypeParameters &)
Returns true if this parameter set contains all the parameters in aOtherParams.
This function is more efficient than calling Contains(TVPbkFieldTypeParameter) in a loop when multiple parameters are checked.
ContainsNone(const TVPbkFieldTypeParameters &)
Returns true if this parameter set contains none of the parameters in aOtherParams.
This function is more efficient than calling Contains(TVPbkFieldTypeParameter) in a loop when multiple parameters are checked.
DoAdd(TVPbkFieldTypeParameter)
DoAddAll(const TVPbkFieldTypeParameters &)
DoRemove(TVPbkFieldTypeParameter)
DoRemoveAll(const TVPbkFieldTypeParameters &)
FieldTypeParameters()
Returns field type params configuration.
ReadFromResource(TResourceReader &)
Initializes this parameter set from a resource. The resource must have LEN BYTE BYTE[] layout.
- Exceptions
-
| VPbkError::Panic( |
VPbkError::EInvalidTypeParameterResource) if the resource is invalid.
|
Parameters
| TResourceReader & aResReader | A reader to resource LEN BYTE BYTE[] that contains the parameters. |
Remove(TVPbkFieldTypeParameter)
Removes aParam from this parameter set.
Parameters
| TVPbkFieldTypeParameter aParam | A parameter that is removed from this set. aParam >= 0 && aParam < KVPbkMaxVersitParams. VPbkError::Panic(VPbkError::EInvalidTypeParameter) is raised if the precondition does not hold. |
RemoveAll(const TVPbkFieldTypeParameters &)
Removes all parameters of another parameter set from this set.
Reset()
Removes all parameters from this set.
Size()
Size of field type params configuration.
Member Data Documentation
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.