inc/FUiCtrlTableViewContextItem.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 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 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. @n
  49         * For full construction, the %Construct() method must be called right after calling this constructor.
  50         *
  51         * @since 2.0
  52         */
  53         TableViewContextItem(void);
  54
  55         /**
  56         * This destructor overrides Tizen::Base::Object::~Object().
  57         *
  58         * @since 2.0
  59         */
  60         virtual ~TableViewContextItem(void);
  61
  62         /**
  63         * Initializes this instance of %TableViewContextItem with the specified parameter.
  64         *
  65         * @since 2.0
  66         *
  67         * @return  An error code
  68         * @param[in] itemSize          The size of the item
  69         * @exception E_SUCCESS         The method is successful.
  70         * @exception E_OUT_OF_MEMORY   The memory is insufficient.
  71         */
  72         result Construct(const Tizen::Graphics::Dimension& itemSize);
  73
  74         /**
  75         * Initializes this instance of %TableViewContextItem with the specified parameter.
  76         *
  77         * @since 2.1
  78         *
  79         * @return  An error code
  80         * @param[in] itemSize          The size of the item
  81         * @exception E_SUCCESS         The method is successful.
  82         * @exception E_OUT_OF_MEMORY   The memory is insufficient.
  83         */
  84         result Construct(const Tizen::Graphics::FloatDimension& itemSize);
  85
  86 private:
  87         friend class _TableViewItemImpl;
  88
  89         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
  90         TableViewContextItem(const TableViewContextItem& rhs);
  91
  92         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
  93         TableViewContextItem& operator =(const TableViewContextItem& rhs);
  94 }; // TableViewContextItem
  95
  96 }}} // Tizen::Ui::Controls
  97
  98 #endif // _FUI_CTRL_TABLE_VIEW_CONTEXT_ITEM_H_