1 /*

     2 * Copyright (c) 2006-2007 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:  Defines ECOM interface for Slide set setting dialog.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_PSLNSLIDESETDIALOGINTERFACE_H

    20 #define C_PSLNSLIDESETDIALOGINTERFACE_H

    21 

    22 #include <ecom/ecom.h>

    23 #include <AknDialog.h>

    24 

    25 // Constants used in ECOM implementation

    26 const TUid KPslnSlideSetPluginInterfaceUid    = { 0x102823AD };

    27 // Defines Wallpaper setting dialog entry in implementation table

    28 const TInt KPslnWallpaperSlideSettingDialog = 0;

    29 // Defines Screen Saver setting dialog entry in implementation table

    30 const TInt KPslnScreenSaverSlideSettingDialog = 1;

    31 

    32 // Defines type of slide set setting dialog.

    33 enum TPslnSlideSetDialogType

    34     {

    35     EPslnScreensaverDialog,

    36     EPslnWallpaperDialog

    37     };

    38 

    39 /**

    40  *  ECOM interface definition for setting dialog.

    41  *

    42  *  This interface defines interface for slide setting dialog base.

    43  *

    44  *  @lib pslnslidesetdialog.dll

    45  *  @since S60 3.2

    46  */

    47 

    48 class CPslnSlidesetDialogInterface : public CAknDialog

    49     {

    50 public:

    51 

    52     // Defines dialog launch mode.

    53     enum TPslnSlideSetLaunchMode

    54         {

    55         // Dialog is launched normally and 

    56         // user made selections are immediately activated

    57         EPslnNormal,

    58         // Dialog is launched for configuration only.

    59         // Settings need to be separately activated.

    60         EPslnConfigureOnly

    61         };

    62 

    63     // Defines dialog configurability state.

    64     enum TPslnSlideSetConfigurability

    65         {

    66         // State is unknown. Settings need to be defined.

    67         EPslnUnknown,

    68         // Dialog settings need to be configured before activation.

    69         EPslnNeedsToBeConfigured,

    70         // Slide set can directly activate - no need to define settings.

    71         EPslnDirectActivationPossible

    72         };

    73 

    74     // Defines dialog flags.

    75     enum TPslnSlideSetDialogFlags

    76         {

    77         // Type of dialog.

    78         EPslnDialogType,

    79         // For what purpose the dialog is launched.

    80         EPslnLaunchMode,

    81         // Can the slide set be directly activated.

    82         EPslnConfigurability

    83         };

    84 

    85     /**

    86     * Creates new Psln ECOM plugin for slideset dialog having the given UID.

    87     * Uses Leave code KErrNotFound if implementation is not found.

    88     *

    89     * @param aImplementationUid Implementation UID of the plugin to be

    90     *        created.

    91     */

    92     static CPslnSlidesetDialogInterface* NewL( const TUid aImplementationUid );

    93 

    94     /**

    95     * Destructor.

    96     */

    97     inline ~CPslnSlidesetDialogInterface();

    98 

    99     /**

   100     * Reserved for future use/plugin's custom functionality. This can be

   101     * overwritten if plugin needs to have custom functionality which cannot

   102     * be fulfilled otherwise.

   103     */

   104     virtual inline TAny* CustomOperationL( TAny* aParam1, TAny* aParam2 );

   105 

   106     /*

   107     * Executes dialog.

   108     *

   109     */

   110     virtual TInt ExecuteDialogLD() = 0;

   111     

   112     /*

   113     * Defines dialog flag. Currently supported flags are defined in 

   114     * TPslnSlideSetDialogFlags.

   115     * @param aFlag which flag to set new state to.

   116     * @param aValue new value of flag.

   117     */

   118     virtual void SetDialogFlag( const TInt aFlag, const TInt aValue ) = 0;

   119 

   120     /*

   121     * Inqueries for dialog flags. Currently supported flags are defined in 

   122     * TPslnSlideSetDialogFlags.

   123     * @param aFlag which flag to retrieve status for 

   124     *        (see TPslnSlideSetDialogFlags for details)

   125     * @return current value of the flag.

   126     *

   127     */

   128     virtual TInt GetDialogFlag( const TInt aFlag ) = 0;

   129 

   130 private: // data

   131 

   132     /**

   133      * ECOM plugin instance UID.

   134      */

   135      TUid iDtor_ID_Key;

   136 

   137     };

   138 

   139 

   140 #include "pslnslidesetdialoginterface.inl"

   141 

   142 

   143 #endif // C_PSLNSLIDESETDIALOGINTERFACE_H