epoc32/include/mw/screensaverpluginintdef.hrh
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  
*
*/

#ifndef _SCREENSAVERPLUGININTDEF_HRH_
#define _SCREENSAVERPLUGININTDEF_HRH_

// This constant should be used in screensaver ecom plugins to define
// the ecom plugin interface UID
#define KCScreensaverPluginInterfaceDefinitionUid 0x101F87F8

// Screen saver plugin capabilities
enum TScPluginCaps
    {
    // Plugin has no special capabilities
    EScpCapsNone = 0x00,
    // Plugin implements the configure function
    EScpCapsConfigure = 0x01,
    // Plugin wants to be notified when selected as the active screensaver
    EScpCapsSelectionNotification = 0x02,
    // Plugin wants to be notified when preview command is selected
    EScpCapsPreviewNotification = 0x04
    };

//
// Screensaver plugins capabilities definition strings
//

/*
* Screensaver plugin capabilities definition strings for ECom
* plugin registration data for convenience. Note that if you define
* a combination of capabilities, the ORed value as a string must be used
* (not defined here).
* E.g. EScpCapsConfigure | EScpCapsSelectionNotification = 3 -> "03"
* The values MUST be taken from TScPluginCaps
*/
#define KScrPluginCapabilitiesNoneStr                  "00"
#define KScrPluginCapabilitiesConfigureStr             "01"
#define KScrPluginCapabilitiesSelectionNotificationStr "02"
#define KScrPluginCapabilitiesPreviewNotificationStr   "04"

#endif  // _SCREENSAVERPLUGININTDEF_HRH_
// End of file.