epoc32/include/mw/screensaverpluginintdef.hrh
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.
     1 /*
     2 * Copyright (c) 2003 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:  
    15 *
    16 */
    17 
    18 #ifndef _SCREENSAVERPLUGININTDEF_HRH_
    19 #define _SCREENSAVERPLUGININTDEF_HRH_
    20 
    21 // This constant should be used in screensaver ecom plugins to define
    22 // the ecom plugin interface UID
    23 #define KCScreensaverPluginInterfaceDefinitionUid 0x101F87F8
    24 
    25 // Screen saver plugin capabilities
    26 enum TScPluginCaps
    27     {
    28     // Plugin has no special capabilities
    29     EScpCapsNone = 0x00,
    30     // Plugin implements the configure function
    31     EScpCapsConfigure = 0x01,
    32     // Plugin wants to be notified when selected as the active screensaver
    33     EScpCapsSelectionNotification = 0x02,
    34     // Plugin wants to be notified when preview command is selected
    35     EScpCapsPreviewNotification = 0x04
    36     };
    37 
    38 //
    39 // Screensaver plugins capabilities definition strings
    40 //
    41 
    42 /*
    43 * Screensaver plugin capabilities definition strings for ECom
    44 * plugin registration data for convenience. Note that if you define
    45 * a combination of capabilities, the ORed value as a string must be used
    46 * (not defined here).
    47 * E.g. EScpCapsConfigure | EScpCapsSelectionNotification = 3 -> "03"
    48 * The values MUST be taken from TScPluginCaps
    49 */
    50 #define KScrPluginCapabilitiesNoneStr                  "00"
    51 #define KScrPluginCapabilitiesConfigureStr             "01"
    52 #define KScrPluginCapabilitiesSelectionNotificationStr "02"
    53 #define KScrPluginCapabilitiesPreviewNotificationStr   "04"
    54 
    55 #endif  // _SCREENSAVERPLUGININTDEF_HRH_
    56 // End of file.