widgetmodel/alfwidgetfactory/inc/alfwidgetfactory.h
branchRCL_3
changeset 26 0e9bb658ef58
parent 0 e83bab7cf002
equal deleted inserted replaced
25:4ea6f81c838a 26:0e9bb658ef58
       
     1 /*
       
     2 * Copyright (c) 2007-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:  Widget factory interface implementation
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef ALFWIDGETFACTORY_H
       
    20 #define ALFWIDGETFACTORY_H
       
    21 
       
    22 //OSN core includes
       
    23 #include <osn/alfptrvector.h>
       
    24 
       
    25 //Widget Utils Includes
       
    26 #include <alf/alffactorypluginloader.h>
       
    27 #include <alf/alftypes.h>
       
    28 
       
    29 //Widget Factory Includes
       
    30 #include <alf/ialfwidgetfactory.h>
       
    31 
       
    32 //Forward declarations 
       
    33 class CAlfEnv;
       
    34 class CAlfDisplay;
       
    35 
       
    36 //Namespaces
       
    37 namespace duiuimodel
       
    38 {
       
    39 class DuiNode;        
       
    40 }
       
    41 
       
    42 using namespace duiuimodel;
       
    43 using namespace osncore;
       
    44    
       
    45 namespace Alf
       
    46     {
       
    47 //Forward declarations  
       
    48 class IAlfWidgetControl;
       
    49 
       
    50 
       
    51 /**
       
    52  *  @class AlfWidgetFactory alfwidgetfactory.h "alf/alfwidgetfactory.h"
       
    53  *
       
    54  *  Widget factory implementation.
       
    55  *
       
    56  *  @lib alfwidgetfactory.lib
       
    57  *  @since S60 ?S60_version
       
    58  *  @status Draft
       
    59  *  @interfaces IAlfWidgetFactory.
       
    60  */
       
    61 class AlfWidgetFactory: public IAlfWidgetFactory
       
    62     {
       
    63 public: 
       
    64     /**
       
    65      * Destructor.
       
    66      */
       
    67     ~AlfWidgetFactory();
       
    68 
       
    69     /**
       
    70      * Explicit Parametrized Constructor
       
    71      */    
       
    72     explicit AlfWidgetFactory(CAlfEnv& aEnv);
       
    73        
       
    74 public: 
       
    75     
       
    76     // From IAlfWidgetFactory
       
    77 
       
    78     /**
       
    79      * @see IAlfWidgetFactory.
       
    80      */
       
    81     IAlfViewWidget* createViewWidget(
       
    82         const char* aInstanceId, 
       
    83         int aControlGroupID, 
       
    84         DuiNode* aNode=0, 
       
    85         CAlfDisplay* aDisplay=0, 
       
    86         const char* aFilePath=0, 
       
    87         AlfCustomInitDataBase* aCustomData=0);
       
    88 
       
    89     /**
       
    90      * @see IAlfWidgetFactory.
       
    91      */
       
    92     IAlfWidget* createWidget(
       
    93         const char* aLoadId, 
       
    94         const char* aInstanceId, 
       
    95         IAlfContainerWidget& aContainerWidget, 
       
    96         DuiNode* aNode=0, 
       
    97         const char* aFilePath=0,
       
    98         AlfCustomInitDataBase* aCustomData=0);
       
    99 
       
   100     /**
       
   101      * @see IAlfWidgetFactory.
       
   102      */
       
   103     int destroyWidget(IAlfWidget* aWidget);
       
   104     
       
   105     /**
       
   106      * @see IAlfWidgetFactory.
       
   107      */
       
   108     IAlfWidget* findWidget(const char* aWidgetName) const;
       
   109     
       
   110     
       
   111     /**
       
   112      * @see IAlfWidgetFactory.
       
   113      */
       
   114     int appendWidget(IAlfWidget* aWidget);
       
   115         
       
   116     
       
   117     /**
       
   118      * @see IAlfWidgetFactory.
       
   119      */
       
   120     IAlfModel* createModel(
       
   121         const char* aLoadId, 
       
   122         AlfCustomInitDataBase* aCustomData=0);
       
   123     
       
   124     /**
       
   125      * @see IAlfWidgetFactory.
       
   126      */
       
   127     IAlfWidgetControl* createControl(
       
   128         const char* aLoadId, 
       
   129         const char* aInstanceId, 
       
   130         CAlfDisplay* aDisplay=0, 
       
   131         AlfCustomInitDataBase* aCustomData=0);
       
   132     
       
   133     /**
       
   134      * @see IAlfWidgetFactory.
       
   135      */
       
   136     IAlfElement* createElement(
       
   137         const char* aLoadId, 
       
   138         const char* aInstanceId, 
       
   139         IAlfWidgetControl& aControl,
       
   140         DuiNode* aNode=0, 
       
   141         AlfCustomInitDataBase* aCustomData=0);
       
   142    
       
   143     /**
       
   144      * @see IAlfWidgetFactory.
       
   145      */
       
   146     IAlfVisualTemplate* createVisualTemplate(
       
   147         const char* aLoadId, 
       
   148         const char* aInstanceId, 
       
   149         DuiNode* aNode=0, 
       
   150         AlfCustomInitDataBase* aCustomData=0);
       
   151     
       
   152     /**
       
   153      * @see IAlfWidgetFactory.
       
   154      */
       
   155     IAlfWidgetEventHandler* createEventHandler(
       
   156         const char* aLoadId, 
       
   157         const char* aInstanceId,
       
   158         DuiNode* aNode=0, 
       
   159         AlfCustomInitDataBase* aCustomData=0);
       
   160     
       
   161     /**
       
   162      * @see IAlfWidgetFactory.
       
   163      */
       
   164     IAlfLayoutManager* createLayoutManager(
       
   165         const char* aLoadId, 
       
   166         const char* aInstanceId, 
       
   167         DuiNode* aNode=0, 
       
   168         AlfCustomInitDataBase* aCustomData=0);
       
   169 
       
   170     /**
       
   171      * @see IAlfWidgetFactory.
       
   172      */
       
   173     void registerCustomWidgetFactory(IAlfFactoryPlugin* aFactory);
       
   174 
       
   175 public: // From IAlfInterfaceBase
       
   176 
       
   177     /**
       
   178      * @see IAlfInterfaceBase.
       
   179      */
       
   180     IAlfInterfaceBase* makeInterface(const IfId& aType);
       
   181    
       
   182 private:
       
   183     /**
       
   184      * Not owned.
       
   185      */
       
   186     CAlfEnv& mAlfEnv;
       
   187     /**
       
   188      * Not owned.
       
   189      */
       
   190     AlfPtrVector<IAlfFactoryPlugin> mRegisteredFactoryList;
       
   191     
       
   192     /**
       
   193      * Owned.
       
   194      */    
       
   195     AlfFactoryPluginLoader mFactoryPluginLoader;
       
   196     
       
   197     /**
       
   198      * List of the widgets added to the factory
       
   199      * 
       
   200      * Owned
       
   201      */
       
   202     AlfPtrVector<IAlfWidget> mWidgetList;
       
   203     };
       
   204 
       
   205 
       
   206     } // namespace Alf
       
   207 #endif 
       
   208 
       
   209 // End of File