classicui_plat/alternate_fs_api/inc/akncapserveralternatefsplugin.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 2005-2008 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 AKNCAPSERVERALTERNATEFSPLUGIN_H
       
    19 #define AKNCAPSERVERALTERNATEFSPLUGIN_H
       
    20 
       
    21 #include <e32base.h>
       
    22 #include <ecom/ecom.h>
       
    23 
       
    24 /**
       
    25  * Base class for ECOM plugins which provide alternate fast swap window 
       
    26  * functionality. AknCapServer will load the first of the found plugins or
       
    27  * if none found then use the built-in fast swapper.
       
    28  */
       
    29 class CAknCapAppServerAlternateFs : public CBase
       
    30 	{
       
    31 public:
       
    32     
       
    33     /**
       
    34      * Symbian two phased constructors.
       
    35      *
       
    36      * @param aImplementationUid Implementation to create.
       
    37      * @return CAlternateFsPlugin pointer.
       
    38      */
       
    39     inline static CAknCapAppServerAlternateFs* NewL( 
       
    40         const TUid& aImplementationUid );
       
    41     
       
    42     /**
       
    43      * Destructor.
       
    44      */
       
    45     inline virtual ~CAknCapAppServerAlternateFs();
       
    46     
       
    47     /**
       
    48      * Shows the alternate fast swap.
       
    49      */
       
    50     virtual void Show() = 0;
       
    51 
       
    52     /**
       
    53      * Dismisses the alternate fast swap.
       
    54      */
       
    55     virtual void Dismiss() = 0;
       
    56 
       
    57     /**
       
    58      * Checks if alternate fast swap is currently visible.
       
    59      * 
       
    60      * @return ETrue If alternate FS is visible.
       
    61      */    
       
    62     virtual TBool IsVisible() = 0;
       
    63 
       
    64     /**
       
    65      * Checks if alternate fast swap is ready to be shown.
       
    66      * 
       
    67      * @return ETrue If alternate FS is ready.
       
    68      */    
       
    69     virtual TBool IsReady() = 0;
       
    70 
       
    71     /**
       
    72      * Returns the ecom implementation uid of this plugin.
       
    73      **/
       
    74     inline TUid ImplementationUid() const;
       
    75 
       
    76 	/**
       
    77      * Forward long app key to the alternate fast swap
       
    78      */
       
    79     virtual void HandleLongAppKeyPress() = 0;
       
    80     
       
    81     /**
       
    82      * Forward short app key to the alternate fast swap
       
    83      */
       
    84     virtual void HandleShortAppKeyPress() = 0;
       
    85 
       
    86 private:
       
    87     
       
    88     /** Destructor Id */
       
    89     TUid iDtorKey;
       
    90     
       
    91     /** Impl uid */
       
    92     TUid iImplUid;
       
    93     
       
    94     /** For future purposes */
       
    95     TInt iReserved0;
       
    96     TInt iReserved1;
       
    97     TInt iReserved2;
       
    98     TInt iReserved3;    
       
    99     };
       
   100 
       
   101 // Inline functions
       
   102 #include <akncapserveralternatefsplugin.inl>
       
   103     
       
   104 #endif // AKNCAPSERVERALTERNATEFSPLUGIN_H