commonuis/CommonUi/LibLoad/inc/commonuinpdapiloader.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 2006 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:  Loads Npdlib.dll dynamically.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_COMMONUINPDAPILOADER
       
    20 #define C_COMMONUINPDAPILOADER
       
    21 
       
    22 #include <e32base.h>
       
    23 #include <f32file.h>
       
    24 
       
    25 
       
    26 /**
       
    27 *  Interface class for saving a notepad memo.
       
    28 *  
       
    29 *  @lib commonuinpdapiloader.lib
       
    30 *  @since Series 60 3.1
       
    31 */
       
    32 class MCommonUiNpdApiLoader
       
    33     {
       
    34     public:
       
    35         
       
    36         /**
       
    37         * Pure virtual method for saving a notepad memo.
       
    38         * @param aFileName name of the file to be saved.
       
    39         * @since Series 60 3.1
       
    40         */
       
    41         virtual void SaveFileAsMemoL( const TDesC& aFileName ) = 0;
       
    42     
       
    43     	/**
       
    44         * Pure virtual method for saving a notepad memo.
       
    45         * @param aFileHandle handle of the file to be saved.
       
    46         * @since Series 60 3.1
       
    47         */        
       
    48         virtual void SaveFileAsMemoL( const RFile& aFileHandle ) = 0;
       
    49             
       
    50     };
       
    51 
       
    52 /**
       
    53 *  This class is for dynamically loading commonuinpdloader.dll that 
       
    54 *  enables saving memos.
       
    55 *
       
    56 *  @lib CommonUiNpdApiLoader.lib
       
    57 *  @since Series 60 3.1
       
    58 */
       
    59 class CCommonUiNpdApiLoader : public CBase, public MCommonUiNpdApiLoader
       
    60     {
       
    61 public:
       
    62     /**
       
    63     * Two-phased constructor.
       
    64     * @return new instance of CCommonUiNpdApiLoader.
       
    65     */
       
    66     static CCommonUiNpdApiLoader* NewL();
       
    67     
       
    68     /**
       
    69     * Destructor.
       
    70     */
       
    71     virtual ~CCommonUiNpdApiLoader();
       
    72 
       
    73 	/**
       
    74     * Saves a files as a memo.
       
    75     * @param aFile name of the file to be saved.
       
    76     */
       
    77     void SaveFileAsMemoL( const TDesC& aFileName );
       
    78     
       
    79     /**
       
    80     * Saves a files as a memo.
       
    81     * @param aFile handle of the file to be saved.
       
    82     */
       
    83     void SaveFileAsMemoL( const RFile& aFileHandle );
       
    84     
       
    85 
       
    86 private:
       
    87 
       
    88     /**
       
    89     * C++ default constructor.
       
    90     */
       
    91     CCommonUiNpdApiLoader();
       
    92 
       
    93     /**
       
    94     * By default Symbian 2nd phase constructor is private.
       
    95     */
       
    96     void ConstructL();
       
    97 
       
    98     };
       
    99 
       
   100 // Environment gate function
       
   101 IMPORT_C TAny* GateFunction();
       
   102 
       
   103 #endif // C_COMMONUINPDAPILOADER
       
   104             
       
   105 // End of File