classicui_plat/aiw_criteria_api/inc/AiwCommon.rh
changeset 45 667edd0b8678
parent 0 2f259fa3e83a
equal deleted inserted replaced
37:89c890c70182 45:667edd0b8678
       
     1 /*
       
     2 * Copyright (c) 2003-2005 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:     Contains common resource declarations for the AIWFW.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 //  INCLUDES
       
    23 #include <AiwCommon.hrh>
       
    24 
       
    25 //  MACROS  
       
    26 
       
    27 //  STRUCTURE DEFINITIONS
       
    28 
       
    29 // -----------------------------------------------------------------------------
       
    30 // Option item for a criteria.
       
    31 // -----------------------------------------------------------------------------
       
    32 STRUCT AIW_CRITERIA_OPTION
       
    33     {
       
    34     }
       
    35 
       
    36 // -----------------------------------------------------------------------------
       
    37 // Criteria item.
       
    38 // Resource structure to define criteria item consumer.
       
    39 // -----------------------------------------------------------------------------
       
    40 //
       
    41 // Criteria item
       
    42 //
       
    43 STRUCT AIW_CRITERIA_ITEM
       
    44     {
       
    45     // Criteria ID to be used in UI elements referring to this criteria
       
    46     // By default the ID should be same as the serviceCmd, but it can be
       
    47     // different as well e.g. for mapping old menu items to use AIW
       
    48     // This can be consumer defined or predefined, if common interest
       
    49     // is allocated.
       
    50     LONG id;
       
    51 
       
    52     // --------------------------------------------------------------
       
    53     // Actual criteria data used when resolving providers from which
       
    54     // a consumer is interested in.
       
    55     // --------------------------------------------------------------
       
    56 
       
    57     // Command ID for service command, mandatory.
       
    58     LONG serviceCmd = KAiwCmdNone;
       
    59 
       
    60     // Content MIME type, event type or any agreed one.
       
    61     LTEXT8 contentType = "";
       
    62 
       
    63     // Services class tells what kind of service is expected from
       
    64     // provider. See TAiwServiceClass enum for allowed values.
       
    65     // Optional, if not defined the default (KAiwClassMenu) is used.
       
    66     LONG serviceClass = KAiwClassMenu;
       
    67 
       
    68     // --------------------------------------------------------------
       
    69     // Additional options, if any.
       
    70     // --------------------------------------------------------------
       
    71 
       
    72     // Defines UID for default provider. If provider for this
       
    73     // UID exists, all the setup calls will be forwarded to it
       
    74     // first (eg. if default provider implements 'menu' service class, it will
       
    75     // be the first provider to insert its menu items to the consumer menu).
       
    76     LONG defaultProvider = 0;
       
    77 
       
    78     // The maximum number of providers allowed for the criteria item.
       
    79     // There might be cases to limit the number of providers, e.g. for
       
    80     // limiting the number of menu items. Maximum is 255 providers per interest.
       
    81     BYTE maxProviders = 0xff;
       
    82 
       
    83     // Other options bits (8 bits reserved).
       
    84     BYTE loadOptions=0;
       
    85 
       
    86     // Reserved for extensions.
       
    87     LLINK reserved = 0; 
       
    88     }
       
    89 
       
    90 //
       
    91 // Interest is an array of criteria items.
       
    92 //
       
    93 STRUCT AIW_INTEREST
       
    94     {
       
    95     STRUCT items[]; // AIW_CRITERIA_ITEM's
       
    96     }
       
    97 
       
    98 
       
    99 // End of File