email/imum/Mtms/Inc/ImumDiskSpaceObserver.h
branchRCL_3
changeset 60 7fdbb852d323
parent 0 72b543305e3a
equal deleted inserted replaced
57:ebe688cedc25 60:7fdbb852d323
       
     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:  ImumDiskSpaceObserver.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CIMUMDISKSPACEOBSERVER_H
       
    20 #define CIMUMDISKSPACEOBSERVER_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <f32file.h>        // RFs
       
    25 
       
    26 // CONSTANTS
       
    27 // MACROS
       
    28 // DATA TYPES
       
    29 // FUNCTION PROTOTYPES
       
    30 // FORWARD DECLARATIONS
       
    31 // CLASS DECLARATION
       
    32 
       
    33 
       
    34 /**
       
    35 *
       
    36 *  @lib
       
    37 *  @since S60 3.0
       
    38 */
       
    39 class MImumDiskSpaceObserver
       
    40     {
       
    41     // New virtual functions
       
    42     public:
       
    43         virtual void HandleDiskSpaceEvent() = 0;
       
    44     };
       
    45 
       
    46 /**
       
    47 *
       
    48 *  @lib
       
    49 *  @since S60 3.0
       
    50 */
       
    51 class CImumDiskSpaceObserver : public CActive
       
    52     {
       
    53     public:  // Constructors and destructor
       
    54 
       
    55         /**
       
    56         * Creates object from CImumDiskSpaceObserver and leaves it to cleanup stack
       
    57         * @since S60 3.0
       
    58         * @return, Constructed object
       
    59         */
       
    60         static CImumDiskSpaceObserver* NewLC(
       
    61             MImumDiskSpaceObserver& aObserver,
       
    62             RFs& aFileSession );
       
    63 
       
    64         /**
       
    65         * Create object from CImumDiskSpaceObserver
       
    66         * @since S60 3.0
       
    67         * @return, Constructed object
       
    68         */
       
    69         static CImumDiskSpaceObserver* NewL(
       
    70             MImumDiskSpaceObserver& aObserver,
       
    71             RFs& aFileSession );
       
    72 
       
    73         /**
       
    74         * Destructor
       
    75         * @since S60 3.0
       
    76         */
       
    77         virtual ~CImumDiskSpaceObserver();
       
    78 
       
    79     public: // New functions
       
    80 
       
    81         /**
       
    82         *
       
    83         * @since S60 3.0
       
    84         */
       
    85         void NotifyDiskSpace( const TInt64 aThreshold, const TInt aDrive );
       
    86 
       
    87     public: // Functions from base classes
       
    88 
       
    89     protected:  // Constructors
       
    90 
       
    91         /**
       
    92         * Default constructor for classCImumDiskSpaceObserver
       
    93         * @since S60 3.0
       
    94         * @return, Constructed object
       
    95         */
       
    96         CImumDiskSpaceObserver(
       
    97             MImumDiskSpaceObserver& aObserver,
       
    98             RFs& aFileSession );
       
    99 
       
   100         /**
       
   101         * Symbian 2-phase constructor
       
   102         * @since S60 3.0
       
   103         */
       
   104         void ConstructL();
       
   105 
       
   106     protected:  // New virtual functions
       
   107     protected:  // New functions
       
   108     protected:  // Functions from base classes
       
   109 
       
   110     private:  // New virtual functions
       
   111     private:  // New functions
       
   112 
       
   113     private:  // Functions from base classes
       
   114 
       
   115         /**
       
   116         *
       
   117         * @since S60 3.0
       
   118         */
       
   119         virtual void DoCancel();
       
   120 
       
   121         /**
       
   122         *
       
   123         * @since S60 3.0
       
   124         */
       
   125         virtual void RunL();
       
   126 
       
   127     public:     // Data
       
   128     protected:  // Data
       
   129     private:    // Data
       
   130 
       
   131         // Observer class to observer the disk space events
       
   132         MImumDiskSpaceObserver& iDiskObserver;
       
   133         // File session
       
   134         RFs&                    iFileSession;
       
   135     };
       
   136 
       
   137 #endif //  CIMUMDISKSPACEOBSERVER_H
       
   138 
       
   139 // End of File