wlanutilities/wlansniffer/mainapplication/inc/wsfdocument.h
branchRCL_3
changeset 25 f28ada11abbf
parent 0 56b72877c1cb
equal deleted inserted replaced
24:63be7eb3fc78 25:f28ada11abbf
       
     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 CWsfDocument
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef C_WSFDOCUMENT_H
       
    19 #define C_WSFDOCUMENT_H
       
    20 
       
    21 //External includes
       
    22 #include <AknDoc.h>
       
    23 
       
    24 //Internal includes
       
    25 #include "wsfmaincontroller.h"
       
    26 
       
    27 
       
    28 // Forward references
       
    29 class CWsfAppUi;
       
    30 class CEikApplication;
       
    31 class CWsfModel;
       
    32 class CWsfWlanInfoArrayVisitor;
       
    33 
       
    34 
       
    35 /**
       
    36  * The document class of the Symbian OS application’s architecture.
       
    37  * 
       
    38  * @since S60 v5.0
       
    39  * @lib wlansniffer.exe
       
    40  */
       
    41 NONSHARABLE_CLASS( CWsfDocument ) : public CAknDocument
       
    42     {
       
    43     public:
       
    44     
       
    45         /**
       
    46          * Two-phased constructor
       
    47          * @since S60 5.0 
       
    48          * @param aApp application creating this document
       
    49          * @return a pointer to the created instance of CWsfDocument
       
    50          */
       
    51         static CWsfDocument* NewL( CEikApplication& aApp );
       
    52     
       
    53         /**
       
    54          * Two-phased constructor. Leaves the object on CleanupStack
       
    55          * @since S60 5.0 
       
    56          * @param aApp application creating this document
       
    57          * @return a pointer to the created instance of CWsfDocument
       
    58          */
       
    59         static CWsfDocument* NewLC( CEikApplication& aApp );
       
    60     
       
    61         /**
       
    62          * Destructor of CWsfDocument class
       
    63          * @since S60 5.0     
       
    64          */
       
    65         ~CWsfDocument();
       
    66         
       
    67     public:
       
    68 
       
    69         /**
       
    70          * The handle for iWlanInfoBranding 
       
    71          * (reference for CWsfWlanInfoArrayVisitor)
       
    72          * @since S60 5.0    
       
    73          * @return reference for CWsfWlanInfoArrayVisitor
       
    74          */
       
    75         inline CWsfWlanInfoArrayVisitor& WlanInfoBranding() const;
       
    76         
       
    77         /**
       
    78          * Returns a reference for the model (CWsfModel)
       
    79          * @since S60 5.0    
       
    80          * @return reference to CWsfModel
       
    81          */
       
    82         inline CWsfModel& Model() const;
       
    83     
       
    84     public: // from CAknDocument
       
    85         
       
    86         /**
       
    87          * From CAknDocument.
       
    88          * Function to create the AppUi.
       
    89          *
       
    90          * @since S60 v5.0
       
    91          * @return the created AppUi instance
       
    92          */
       
    93         CEikAppUi* CreateAppUiL();
       
    94         
       
    95     
       
    96     private:
       
    97     
       
    98         /**
       
    99          * 2nd phase constructor
       
   100          * @since S60 5.0 
       
   101          */
       
   102         void ConstructL();
       
   103     
       
   104         /**
       
   105          * Default C++ constructor 
       
   106          * @since S60 5.0 
       
   107          * @param aApp application creating this document
       
   108          */
       
   109         CWsfDocument( CEikApplication& aApp );
       
   110     
       
   111     private: 
       
   112     
       
   113         /**
       
   114          * Main Controller
       
   115          */
       
   116         TWsfMainController iMainController;
       
   117         
       
   118         /**
       
   119          * Model
       
   120          * Own.
       
   121          */
       
   122         CWsfModel* iModel;
       
   123         
       
   124         /**
       
   125          * WlanInfoArrayVisitor
       
   126          * Own.
       
   127          */
       
   128         CWsfWlanInfoArrayVisitor *iWlanInfoBranding;
       
   129     };
       
   130 
       
   131 
       
   132 #include "wsfdocument.inl"
       
   133 
       
   134 
       
   135 #endif // C_WSFDOCUMENT_H