inc/FIoIMmcStorageFormatListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19 * @file         FIoIMmcStorageFormatListener.h
  20 * @brief        This is the header file for the %IMmcStorageFormatListener interface.
  21 *
  22 * This header file contains the declarations of the %IMmcStorageFormatListener interface.
  23 */
  24
  25 #ifndef _FIO_IMMC_STORAGE_FORMAT_LISTENER_H_
  26 #define _FIO_IMMC_STORAGE_FORMAT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29
  30 namespace Tizen { namespace Io
  31 {
  32
  33 /**
  34 * @interface     IMmcStorageFormatListener
  35 * @brief          This interface is the listener to receive the result of external MMC format operations.
  36 * @since         2.0
  37 *
  38 * The %IMmcStorageFormatListener interface must be registered and implemented by an application to receive the result of
  39 * external MMC format operations.
  40 *
  41 * @see MmcStorageManager
  42 */
  43 class _OSP_EXPORT_ IMmcStorageFormatListener
  44            : public virtual Tizen::Base::Runtime::IEventListener
  45 {
  46 public:
  47         /**
  48         * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface called.
  49         *
  50         * @since        2.0
  51         */
  52         virtual ~IMmcStorageFormatListener(void) {}
  53
  54         /**
  55         * Called when external MMC format operation is done.
  56         *
  57         * @since                2.0
  58         *
  59         * @param[in]    r                               The result of external MMC format operation
  60         * @exception    E_SUCCESS               The format operation is successful.
  61         * @exception    E_IO                    An unexpected device failure has occurred as the media ejected suddenly.
  62         * @exception    E_SYSTEM                The method cannot proceed due to a severe system error.
  63         */
  64         virtual void OnMmcStorageFormatted(result r) = 0;
  65
  66 protected:
  67         //
  68         // This method is for internal use only.
  69         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  70         //
  71         // @since 2.0
  72         virtual void IMmcStorageFormatListener_Reserved1(void) {}
  73
  74         //
  75         // This method is for internal use only.
  76         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  77         //
  78         // @since 2.0
  79         virtual void IMmcStorageFormatListener_Reserved2(void) {}
  80
  81         //
  82         // This method is for internal use only.
  83         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  84         //
  85         // @since 2.0
  86         virtual void IMmcStorageFormatListener_Reserved3(void) {}
  87
  88 }; // IMmcStorageFormatListener
  89
  90 } } // Tizen::Io
  91
  92 #endif // _FIO_IMMC_STORAGE_FORMAT_LISTENER_H