inc/FBaseColTypes.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                FBaseColTypes.h
  20  * @brief               This is the header file for the element deleter.
  21  *
  22  * This header file contains the declarations of the element deleter.
  23  * Depending on the element deleter, collection decides whether to remove the object or not.
  24  */
  25 #ifndef _FBASE_COL_TYPES_H_
  26 #define _FBASE_COL_TYPES_H_
  27
  28 #include <FBaseObject.h>
  29
  30 namespace Tizen { namespace Base { namespace Collection
  31 {
  32
  33 typedef void (*DeleterFunctionType)(Object* pObj);
  34
  35 /**
  36  * This function does not remove the object.
  37  *
  38  * @since 2.0
  39  *
  40  * @param[in]   pObj            The pointer to the object to remove
  41  */
  42 _OSP_EXPORT_ void NoOpDeleter(Object* pObj);
  43
  44 /**
  45  * This function removes the single object.
  46  *
  47  * @since 2.0
  48  *
  49  * @param[in]   pObj            The pointer to the object to remove
  50  */
  51 _OSP_EXPORT_ void SingleObjectDeleter(Object* pObj);
  52
  53 /**
  54  * This function removes the array object.
  55  *
  56  * @since 2.0
  57  *
  58  * @param[in]   pObj            The pointer to the object to remove
  59  */
  60 _OSP_EXPORT_ void ArrayDeleter(Object* pObj);
  61
  62 }}} // Tizen::Base::Collection
  63
  64 #endif  // _FBASE_COL_TYPES_H_