Mercurialtest / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
epoc32/include/app/VPbkFieldType.rh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed. 
     1 /*

     2 * Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Field types resource structures.

    15 *

    16 */

    17 

    18 

    19 #ifndef VPBKFIELDTYPE_RH

    20 #define VPBKFIELDTYPE_RH

    21 

    22 #include <VPbkFieldType.hrh>

    23 

    24 /**

    25  * Resource structure for a Virtual Phonebook field basic Versit property.

    26  */

    27 STRUCT VBK_FIELD_VERSIT_PROPERTY

    28     {

    29     /**

    30      * Versit property name. One of the TVPbkFieldTypeName in vpbkfieldtype.hrh.

    31      * @see TVPbkFieldVersitProperty::iName

    32      */

    33     BYTE name = EVPbkVersitNameNone;

    34 

    35     /**

    36      * Versit subfield. One of the TVPbkSubFieldType in vpbkfieldtype.hrh.

    37      * @see TVPbkFieldVersitProperty::iSubField

    38      */

    39     BYTE subField = EVPbkVersitSubFieldNone;

    40 

    41     /**

    42      * Versit parameters. An array of TVPbkFieldTypeParameter in 

    43      * vpbkfieldtype.hrh.

    44      * @see TVPbkFieldVersitProperty::iParameters

    45      */

    46     LEN BYTE BYTE parameters[];

    47 

    48     /**

    49      * Name of a versit extension property.

    50      * @see TVPbkFieldVersitProperty::iExtensionName

    51      */

    52     LTEXT8 extensionName;

    53     }

    54 

    55 /**

    56  * Resource structure for Virtual Phonebook field type parameters.

    57  * @see enum TVPbkFieldTypeParameter

    58  * @see VPbkFieldType.hrh

    59  */

    60 STRUCT VPBK_FIELD_TYPE_PARAMS

    61     {

    62     LEN BYTE BYTE parameters[];

    63     }

    64 

    65 /**

    66  * Resource structure for Virtual Phonebook field type mapping.

    67  * @see TVPbkFieldTypeMapping

    68  */

    69 STRUCT VPBK_FIELD_TYPE_MAPPING

    70     {

    71     /**

    72      * Versit property for this field type mapping.

    73      *

    74      * @see VBK_FIELD_VERSIT_PROPERTY

    75      */

    76     STRUCT versitProperty;

    77 

    78     /**

    79      * Non-versit type for this field type mapping.

    80      *

    81      * @see TVPbkNonVersitFieldType in vpbkfieldtype.hrh.

    82      */

    83     BYTE nonVersitType = EVPbkNonVersitTypeNone;

    84     }

    85 

    86 /**

    87  * Resource structure for a collection of Virtual Phonebook field type mappings.

    88  * @see class CVPbkSortOrder

    89  */

    90 STRUCT VPBK_FIELD_TYPE_MAPPING_LIST

    91     {

    92     /**

    93      * Array of VPBK_FIELD_TYPE_MAPPING structures

    94      */

    95     STRUCT items[];

    96     }

    97 

    98 /**

    99  * Resource structure for Virtual Phonebook field type selector.

   100  * @see CVPbkFieldTypeSelector

   101  */

   102 STRUCT VPBK_FIELD_TYPE_SELECTOR

   103     {

   104     /**

   105      * The version of this field type selector. Defined by Virtual Phonebook.

   106      */

   107     BYTE version = EVPbkFieldTypeSelectorV2;

   108     

   109     /**

   110      * Included versit properties for this field type selector.

   111      *

   112      * @see VBK_FIELD_VERSIT_PROPERTY

   113      */

   114     STRUCT versitProperties[];

   115     

   116     /**

   117      * Included non-versit types for this field type selector.

   118      *

   119      * @see TVPbkNonVersitFieldType in vpbkfieldtype.hrh.

   120      */

   121     BYTE nonVersitType[];

   122     

   123     /**

   124      * Excluded Type parameters. When a Versit property is matched against this

   125      * field type it is considered a match only if it doesn't contain any of the

   126      * excluded parameters. 

   127      *

   128      * @see TVPbkFieldTypeParameter

   129      * @see MVPbkFieldType::ExcludedParameters()

   130      */

   131     LEN BYTE BYTE excludedParameters[];    

   132     }

   133 

   134 #endif // VPBKFIELDTYPE_RH

   135 //End of file

   136
test