inc/FUiCtrlTableViewContextItem.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 FUiCtrlTableViewContextItem.h
  20 * @brief This is the header file for the %TableViewContextItem class.
  21 *
  22 * This header file contains the declarations of the %TableViewContextItem class and its helper classes.
  23 */
  24
  25 #ifndef _FUI_CTRL_TABLE_VIEW_CONTEXT_ITEM_H_
  26 #define _FUI_CTRL_TABLE_VIEW_CONTEXT_ITEM_H_
  27
  28 #include <FUiCtrlTableViewItemBase.h>
  29
  30 namespace Tizen { namespace Ui { namespace Controls
  31 {
  32 /**
  33 * @class TableViewContextItem
  34 * @brief This class defines common behavior for a %TableViewContextItem.
  35 *
  36 * @since 2.0
  37 *
  38 * The %TableViewContextItem class is a class which represents a context item for TableView.
  39 * A context item is shown when a table view item is swept, if %TableViewContextItem is set to the table view item.
  40 *
  41 */
  42
  43 class _OSP_EXPORT_ TableViewContextItem
  44         : public TableViewItemBase
  45 {
  46 public:
  47         /**
  48         * The object is not fully constructed after this constructor is called. Hence, the Construct() method must be called after calling this constructor.
  49         *
  50         * @since 2.0
  51         */
  52         TableViewContextItem(void);
  53
  54         /**
  55         * This destructor overrides Tizen::Base::Object::~Object().
  56         *
  57         * @since 2.0
  58         */
  59         virtual ~TableViewContextItem(void);
  60
  61         /**
  62         * Initializes this instance of %TableViewContextItem with the specified parameter.
  63         *
  64         * @since 2.0
  65         *
  66         * @return  An error code
  67         * @param[in] itemSize          The size of the item
  68         * @exception E_SUCCESS         The method is successful.
  69         * @exception E_OUT_OF_MEMORY   The memory is insufficient.
  70         */
  71         result Construct(const Tizen::Graphics::Dimension& itemSize);
  72
  73         /**
  74         * Initializes this instance of %TableViewContextItem with the specified parameter.
  75         *
  76         * @since 2.1
  77         *
  78         * @return  An error code
  79         * @param[in] itemSize          The size of the item
  80         * @exception E_SUCCESS         The method is successful.
  81         * @exception E_OUT_OF_MEMORY   The memory is insufficient.
  82         */
  83         result Construct(const Tizen::Graphics::FloatDimension& itemSize);
  84
  85 private:
  86         friend class _TableViewItemImpl;
  87
  88         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
  89         TableViewContextItem(const TableViewContextItem& rhs);
  90
  91         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
  92         TableViewContextItem& operator =(const TableViewContextItem& rhs);
  93 }; // TableViewContextItem
  94
  95 }}} // Tizen::Ui::Controls
  96
  97 #endif // _FUI_CTRL_TABLE_VIEW_CONTEXT_ITEM_H_