#include <app/TVPbkFieldTypeParameters.h>
| class TVPbkFieldTypeParameters |
| Public Member Functions | |
|---|---|
| TVPbkFieldTypeParameters() | |
| TVPbkFieldTypeParameters(TResourceReader &) | |
| TVPbkFieldTypeParameters & | Add(TVPbkFieldTypeParameter) |
| TVPbkFieldTypeParameters & | AddAll(const TVPbkFieldTypeParameters &) |
| void | AddFromResource(TResourceReader &) |
| IMPORT_C TBool | Contains(TVPbkFieldTypeParameter) |
| IMPORT_C TBool | ContainsAll(const TVPbkFieldTypeParameters &) |
| IMPORT_C TBool | ContainsNone(const TVPbkFieldTypeParameters &) |
| TUint32 * | FieldTypeParameters() |
| IMPORT_C void | ReadFromResource(TResourceReader &) |
| TVPbkFieldTypeParameters & | Remove(TVPbkFieldTypeParameter) |
| TVPbkFieldTypeParameters & | RemoveAll(const TVPbkFieldTypeParameters &) |
| IMPORT_C void | Reset() |
| TInt | Size() |
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.
See also: VBK_FIELD_VERSIT_PROPERTY in VPbkFieldType.rh TVPbkFieldVersitProperty
| TVPbkFieldTypeParameters | ( | ) | [inline] |
Default constructor. Initializes this parameter set to empty.
| TVPbkFieldTypeParameters | ( | TResourceReader & | aResReader | ) | [inline] |
Constructs this parameter set from a resource. The resource must have LEN BYTE BYTE[] layout.
| VPbkError::Panic( |
VPbkError::EInvalidTypeParameterResource) if the resource is invalid. |
| Parameter | Description |
|---|---|
| aResReader | A reader to resource LEN BYTE BYTE[] that contains the parameters. |
| TVPbkFieldTypeParameters & | Add | ( | TVPbkFieldTypeParameter | aParam | ) | [inline] |
Adds aParam to this parameter set.
| Parameter | Description |
|---|---|
| aParam | A new parameter to this set. aParam >= 0 && aParam < KVPbkMaxVersitParams. VPbkError::Panic(VPbkError::EInvalidTypeParameter) is raised if the precondition does not hold. |
Returns: This object for easy chaining of calls. Contains(aParam)
| TVPbkFieldTypeParameters & | AddAll | ( | const TVPbkFieldTypeParameters & | aParams | ) | [inline] |
Adds all parameters of another parameter set to this set.
| Parameter | Description |
|---|---|
| aParams | A set of paramters that are added to this set. |
Returns: This object for easy chaining of calls. ContainsAll(aParams)
| void | AddFromResource | ( | TResourceReader & | aResReader | ) |
Adds parameter set from a resource. The resource must have LEN BYTE BYTE[] layout.
| VPbkError::Panic( |
VPbkError::EInvalidTypeParameterResource) if the resource is invalid. |
| Parameter | Description |
|---|---|
| aResReader | A reader to resource LEN BYTE BYTE[] that contains the parameters. |
| IMPORT_C TBool | Contains | ( | TVPbkFieldTypeParameter | aParam | ) | const |
Returns true if aParam is included in this parameter set.
| Parameter | Description |
|---|---|
| aParam | A parameter that is looked for. aParam >= 0 && aParam < KVPbkMaxVersitParams |
Returns: ETrue if aParam was found from this set.
| IMPORT_C TBool | ContainsAll | ( | const TVPbkFieldTypeParameters & | aOtherParams | ) | const |
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.
| Parameter | Description |
|---|---|
| aOtherParams | A set of parameters that are looked for. |
Returns: ETrue if all the aOtherParams were found from this set.
| IMPORT_C TBool | ContainsNone | ( | const TVPbkFieldTypeParameters & | aOtherParams | ) | const |
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.
| Parameter | Description |
|---|---|
| aOtherParams | A set of parameters that are looked for. |
Returns: ETrue if none of the aOtherParams were found from this set.
| IMPORT_C void | ReadFromResource | ( | TResourceReader & | aResReader | ) |
Initializes this parameter set from a resource. The resource must have LEN BYTE BYTE[] layout.
| VPbkError::Panic( |
VPbkError::EInvalidTypeParameterResource) if the resource is invalid. |
| Parameter | Description |
|---|---|
| aResReader | A reader to resource LEN BYTE BYTE[] that contains the parameters. |
| TVPbkFieldTypeParameters & | Remove | ( | TVPbkFieldTypeParameter | aParam | ) | [inline] |
Removes aParam from this parameter set.
| Parameter | Description |
|---|---|
| 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. |
Returns: This object for easy chaining of calls. !Contains(aParam)
| TVPbkFieldTypeParameters & | RemoveAll | ( | const TVPbkFieldTypeParameters & | aParams | ) | [inline] |
Removes all parameters of another parameter set from this set.
| Parameter | Description |
|---|---|
| aParams | Parameters that are removed from this set. |
Returns: This object for easy chaining of calls. ContainsAll(aParams)