epoc32/include/mw/aiwcommon.rh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:     Contains common resource declarations for the AIWFW.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
//  INCLUDES
williamr@4
    23
#include <AiwCommon.hrh>
williamr@2
    24
williamr@2
    25
//  MACROS  
williamr@2
    26
williamr@2
    27
//  STRUCTURE DEFINITIONS
williamr@2
    28
williamr@2
    29
// -----------------------------------------------------------------------------
williamr@2
    30
// Option item for a criteria.
williamr@2
    31
// -----------------------------------------------------------------------------
williamr@2
    32
STRUCT AIW_CRITERIA_OPTION
williamr@2
    33
    {
williamr@2
    34
    }
williamr@2
    35
williamr@2
    36
// -----------------------------------------------------------------------------
williamr@2
    37
// Criteria item.
williamr@2
    38
// Resource structure to define criteria item consumer.
williamr@2
    39
// -----------------------------------------------------------------------------
williamr@2
    40
//
williamr@2
    41
// Criteria item
williamr@2
    42
//
williamr@2
    43
STRUCT AIW_CRITERIA_ITEM
williamr@2
    44
    {
williamr@2
    45
    // Criteria ID to be used in UI elements referring to this criteria
williamr@2
    46
    // By default the ID should be same as the serviceCmd, but it can be
williamr@2
    47
    // different as well e.g. for mapping old menu items to use AIW
williamr@2
    48
    // This can be consumer defined or predefined, if common interest
williamr@2
    49
    // is allocated.
williamr@2
    50
    LONG id;
williamr@2
    51
williamr@2
    52
    // --------------------------------------------------------------
williamr@2
    53
    // Actual criteria data used when resolving providers from which
williamr@2
    54
    // a consumer is interested in.
williamr@2
    55
    // --------------------------------------------------------------
williamr@2
    56
williamr@2
    57
    // Command ID for service command, mandatory.
williamr@2
    58
    LONG serviceCmd = KAiwCmdNone;
williamr@2
    59
williamr@2
    60
    // Content MIME type, event type or any agreed one.
williamr@2
    61
    LTEXT8 contentType = "";
williamr@2
    62
williamr@2
    63
    // Services class tells what kind of service is expected from
williamr@2
    64
    // provider. See TAiwServiceClass enum for allowed values.
williamr@2
    65
    // Optional, if not defined the default (KAiwClassMenu) is used.
williamr@2
    66
    LONG serviceClass = KAiwClassMenu;
williamr@2
    67
williamr@2
    68
    // --------------------------------------------------------------
williamr@2
    69
    // Additional options, if any.
williamr@2
    70
    // --------------------------------------------------------------
williamr@2
    71
williamr@2
    72
    // Defines UID for default provider. If provider for this
williamr@2
    73
    // UID exists, all the setup calls will be forwarded to it
williamr@2
    74
    // first (eg. if default provider implements 'menu' service class, it will
williamr@2
    75
    // be the first provider to insert its menu items to the consumer menu).
williamr@2
    76
    LONG defaultProvider = 0;
williamr@2
    77
williamr@2
    78
    // The maximum number of providers allowed for the criteria item.
williamr@2
    79
    // There might be cases to limit the number of providers, e.g. for
williamr@2
    80
    // limiting the number of menu items. Maximum is 255 providers per interest.
williamr@2
    81
    BYTE maxProviders = 0xff;
williamr@2
    82
williamr@2
    83
    // Other options bits (8 bits reserved).
williamr@2
    84
    BYTE loadOptions=0;
williamr@2
    85
williamr@2
    86
    // Reserved for extensions.
williamr@2
    87
    LLINK reserved = 0; 
williamr@2
    88
    }
williamr@2
    89
williamr@2
    90
//
williamr@2
    91
// Interest is an array of criteria items.
williamr@2
    92
//
williamr@2
    93
STRUCT AIW_INTEREST
williamr@2
    94
    {
williamr@2
    95
    STRUCT items[]; // AIW_CRITERIA_ITEM's
williamr@2
    96
    }
williamr@2
    97
williamr@2
    98
williamr@2
    99
// End of File