1 /*

     2 * Copyright (c) 2007-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:  Class header for CWsfAiHelperDocument

    15 *

    16 */

    17 

    18 

    19 #ifndef C_WSFAIHELPERDOCUMENT_H

    20 #define C_WSFAIHELPERDOCUMENT_H

    21 

    22 

    23 //  EXTERNAL INCLUDES

    24 #include <AknDoc.h>

    25 

    26 

    27 //  INTERNAL INCLUDES

    28 #include "wsfwlaninfo.h"

    29 

    30 

    31 //  FORWARD DECLARATIONS

    32 class CWsfAiHelperAppUi;

    33 class CEikApplication;

    34 class CWsfModel;

    35 

    36 

    37 //  CLASS DEFINITION

    38 /**

    39  * An instance of class CWsfAiHelperDocument is the Document part of the AVKON

    40  * application framework

    41  * 

    42  * @since S60 5.0

    43  * @lib wsfaihelper.exe

    44  */

    45 NONSHARABLE_CLASS( CWsfAiHelperDocument ): public CAknDocument

    46     {

    47     public:

    48     

    49         /**

    50          * Factory function

    51          * @since S60 5.0

    52          * @param aApp Reference to the Application object 

    53          *             (ownership not passed)

    54          * @return Class instance

    55          */

    56         static CWsfAiHelperDocument* NewL( CEikApplication& aApp );

    57     

    58         /**

    59          * Factory function

    60          * @since S60 5.0

    61          * @param aApp Reference to the Application object 

    62          *             (ownership not passed)

    63          * @return Class instance

    64          */

    65         static CWsfAiHelperDocument* NewLC( CEikApplication& aApp );

    66 

    67         /**

    68          * Destructor

    69          * @since S60 5.0

    70          */

    71         ~CWsfAiHelperDocument();

    72 

    73         

    74     private:

    75 

    76         /**

    77          * Second-phase constructor

    78          * @since S60 5.0

    79          */

    80         void ConstructL();

    81 

    82         /**

    83          * Constructor

    84          * @since S60 5.0

    85          * @param aApp Reference to the application creating this document

    86          *             (ownership not passed)

    87          */

    88         CWsfAiHelperDocument( CEikApplication& aApp );

    89 

    90         

    91     public: // from CEikDocument

    92         /**

    93          * Constructs the application UI.

    94          * @since S60 5.0

    95          * @return AppUi instance

    96          */

    97         CEikAppUi* CreateAppUiL();

    98     

    99 

   100         /**

   101          * Restores the document's state from the specified file, 

   102          * or creates a new default document.

   103          * @since S60 5.0

   104          * @param aDoOpen True to open an existing file, 

   105          *                false to create a new default file

   106          * @param aFilename The path and name of the file to open or create.

   107          * @param aFs File server session to use. 

   108          * @return The file store that stores the main document. 

   109          */

   110         CFileStore* OpenFileL( TBool aDoOpen, 

   111                                const TDesC& aFilename, 

   112                                RFs& aFs );

   113     

   114         

   115     public:     // new methods

   116         

   117         /**

   118          * Returns reference to the model

   119          * @since S60 5.0

   120          * @return Reference to the model (ownership not passed)

   121          */

   122         inline CWsfModel& Model();

   123         

   124         /** 

   125          * Returns reference to the current wlaninfo

   126          * @since S60 5.0

   127          * @return Reference to the wlaninfo used (ownership not passed)

   128          */

   129         inline TWsfWlanInfo& WlanInfo();

   130         

   131     

   132     private:    // data

   133     

   134         /**

   135          * Model object (owned)

   136          */

   137         CWsfModel* iModel;

   138         

   139         /**

   140          * Data of the currently used WLAN network

   141          */

   142         TWsfWlanInfo iWlanInfo;

   143         

   144     };

   145 

   146 

   147 #include "wsfaihelperdocument.inl"

   148 

   149 #endif // C_WSFAIHELPERDOCUMENT_H