epoc32/include/mw/aiwcommon.rh
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/aiwcommon.rh	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/aiwcommon.rh	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,99 @@
     1.4 -aiwcommon.rh
     1.5 +/*
     1.6 +* Copyright (c) 2003-2005 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:     Contains common resource declarations for the AIWFW.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <aiwcommon.hrh>
    1.28 +
    1.29 +//  MACROS  
    1.30 +
    1.31 +//  STRUCTURE DEFINITIONS
    1.32 +
    1.33 +// -----------------------------------------------------------------------------
    1.34 +// Option item for a criteria.
    1.35 +// -----------------------------------------------------------------------------
    1.36 +STRUCT AIW_CRITERIA_OPTION
    1.37 +    {
    1.38 +    }
    1.39 +
    1.40 +// -----------------------------------------------------------------------------
    1.41 +// Criteria item.
    1.42 +// Resource structure to define criteria item consumer.
    1.43 +// -----------------------------------------------------------------------------
    1.44 +//
    1.45 +// Criteria item
    1.46 +//
    1.47 +STRUCT AIW_CRITERIA_ITEM
    1.48 +    {
    1.49 +    // Criteria ID to be used in UI elements referring to this criteria
    1.50 +    // By default the ID should be same as the serviceCmd, but it can be
    1.51 +    // different as well e.g. for mapping old menu items to use AIW
    1.52 +    // This can be consumer defined or predefined, if common interest
    1.53 +    // is allocated.
    1.54 +    LONG id;
    1.55 +
    1.56 +    // --------------------------------------------------------------
    1.57 +    // Actual criteria data used when resolving providers from which
    1.58 +    // a consumer is interested in.
    1.59 +    // --------------------------------------------------------------
    1.60 +
    1.61 +    // Command ID for service command, mandatory.
    1.62 +    LONG serviceCmd = KAiwCmdNone;
    1.63 +
    1.64 +    // Content MIME type, event type or any agreed one.
    1.65 +    LTEXT8 contentType = "";
    1.66 +
    1.67 +    // Services class tells what kind of service is expected from
    1.68 +    // provider. See TAiwServiceClass enum for allowed values.
    1.69 +    // Optional, if not defined the default (KAiwClassMenu) is used.
    1.70 +    LONG serviceClass = KAiwClassMenu;
    1.71 +
    1.72 +    // --------------------------------------------------------------
    1.73 +    // Additional options, if any.
    1.74 +    // --------------------------------------------------------------
    1.75 +
    1.76 +    // Defines UID for default provider. If provider for this
    1.77 +    // UID exists, all the setup calls will be forwarded to it
    1.78 +    // first (eg. if default provider implements 'menu' service class, it will
    1.79 +    // be the first provider to insert its menu items to the consumer menu).
    1.80 +    LONG defaultProvider = 0;
    1.81 +
    1.82 +    // The maximum number of providers allowed for the criteria item.
    1.83 +    // There might be cases to limit the number of providers, e.g. for
    1.84 +    // limiting the number of menu items. Maximum is 255 providers per interest.
    1.85 +    BYTE maxProviders = 0xff;
    1.86 +
    1.87 +    // Other options bits (8 bits reserved).
    1.88 +    BYTE loadOptions=0;
    1.89 +
    1.90 +    // Reserved for extensions.
    1.91 +    LLINK reserved = 0; 
    1.92 +    }
    1.93 +
    1.94 +//
    1.95 +// Interest is an array of criteria items.
    1.96 +//
    1.97 +STRUCT AIW_INTEREST
    1.98 +    {
    1.99 +    STRUCT items[]; // AIW_CRITERIA_ITEM's
   1.100 +    }
   1.101 +
   1.102 +
   1.103 +// End of File