classicui_plat/screensaver_animation_plugin_definitions_api/inc/NPNExtensions.h
changeset 14 3320e4e6e8bb
parent 0 2f259fa3e83a
child 21 558113899881
equal deleted inserted replaced
0:2f259fa3e83a 14:3320e4e6e8bb
     1 /*
       
     2 * Copyright (c) 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:  ScreenSaverAnimPluginInfo exports the list of enumerations 
       
    15 *                to format specific plugins
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef NPNEXTENSIONS_H
       
    20 #define NPNEXTENSIONS_H
       
    21 
       
    22 /* 
       
    23 * Enumerations for setting the information from Screensaver Animation
       
    24 * plugin to format specific plugins
       
    25 */
       
    26 
       
    27 enum
       
    28     {
       
    29     /* Defines the interaction mode with the plugin */  
       
    30     NPNInteractionMode = 100,
       
    31     
       
    32     /* Defines Start/end animation event */
       
    33     NPNScreenSaverAnimationEvent=101
       
    34     };
       
    35     
       
    36 /* 
       
    37 * Enumerations for getting the information from format specific plugins 
       
    38 * by Screen saver animation plugin  
       
    39 */    
       
    40     
       
    41 enum
       
    42     {
       
    43     /* Gets the file validity, Int - KErrNone if the file is valid 
       
    44      * other error codes if not
       
    45      */
       
    46     NPPCheckFileIsValid=100,
       
    47     
       
    48     /* Gets the last error encountered by the plugin. 
       
    49      * Int - System wide error code
       
    50      */
       
    51     NPPScreenSaverGetLastError=101,
       
    52     
       
    53     /* Checks whether the error is fatal 
       
    54      * Bool True if the error is fatal, false if not
       
    55      */
       
    56     NPPScreenSaverIsErrorFatal=102
       
    57     };
       
    58     
       
    59 typedef enum 
       
    60     {
       
    61     /* Default Mode */
       
    62     NPDefaultMode = 1,
       
    63     
       
    64     /* Set when the plugin is started for ScreenSaver */ 
       
    65     NPScreenSaverMode
       
    66     } NPInteractionMode;    
       
    67     
       
    68 typedef enum 
       
    69     {
       
    70     /* Sent to the plugin when the ScreenSaver is activated */
       
    71     NPStartAnimation = 1,
       
    72     
       
    73     /* Sent to the plugin when the ScreenSaver is deactivated */
       
    74     NPEndAnimation
       
    75     } NPAnimationEvent;
       
    76         
       
    77 typedef struct _NPCheckFile
       
    78     {
       
    79     /* Error returned by the plugin after validity check */
       
    80     TInt  fileValidityCheckError;
       
    81     
       
    82     /* Name of the file to be checked for Validity */
       
    83     HBufC* fileName;
       
    84     } NPCheckFile;
       
    85   
       
    86   
       
    87 /* 
       
    88  * The NPInteractionMode needs to be sent to the Flash Plugin
       
    89  * in the newp call, The interaction mode attribute name is passed 
       
    90  * in argn and the attribute value is passed in argv parameter.
       
    91  * The mode parameter of newp is not used in Screensaver mode.
       
    92  */
       
    93 _LIT( KAttributeInteractionMode , "interactionmode" );
       
    94 _LIT( KValueScreensaver, "screensaver" );
       
    95     
       
    96     
       
    97 
       
    98 #endif // NPNEXTENSIONS_H
       
    99 // End Of file
       
   100 
       
   101