2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://floralicense.org/license/
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.
19 * @file FUiCtrlTableViewSimpleGroupItem.h
20 * @brief This is the header file for the %TableViewSimpleGroupItem class.
22 * This header file contains the declarations of the %TableViewSimpleGroupItem class and its helper classes.
25 #ifndef _FUI_CTRL_TABLE_VIEW_SIMPLE_GROUP_ITEM_H_
26 #define _FUI_CTRL_TABLE_VIEW_SIMPLE_GROUP_ITEM_H_
28 #include <FUiCtrlTableViewGroupItem.h>
30 namespace Tizen { namespace Ui { namespace Controls
33 * @class TableViewSimpleGroupItem
34 * @brief This class defines common behavior of %TableViewSimpleGroupItem.
38 * The %TableViewSimpleGroupItem class displays a table view group item. The basic layout of the %TableViewSimpleGroupItem instance is text and a bitmap arranged horizontally in one line. The bitmap can be omitted while text must be given.
41 class _OSP_EXPORT_ TableViewSimpleGroupItem
42 : public TableViewGroupItem
46 * This is the default constructor for this class.
50 TableViewSimpleGroupItem(void);
53 * This destructor overrides Tizen::Base::Object::~Object().
57 virtual ~TableViewSimpleGroupItem(void);
60 * Initializes this instance of %TableViewSimpleGroupItem with the specified parameter.
64 * @return An error code
65 * @param[in] itemSize The size of the item
66 * @exception E_SUCCESS The method is successful.
67 * @exception E_INVALID_ARG A specified input parameter is invalid.
69 result Construct(const Tizen::Graphics::Dimension& itemSize);
72 * Initializes this instance of %TableViewSimpleGroupItem with the specified parameter.
76 * @return An error code
77 * @param[in] layout The layout for both of the portrait and landscape modes
78 * @param[in] itemSize The size of the item
79 * @exception E_SUCCESS The method is successful.
80 * @exception E_INVALID_ARG A specified input parameter is invalid.
82 result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::Dimension& itemSize);
85 * Initializes this instance of %TableViewSimpleGroupItem with the specified parameter.
89 * @return An error code
90 * @param[in] itemSize The size of the item
91 * @exception E_SUCCESS The method is successful.
92 * @exception E_INVALID_ARG A specified input parameter is invalid.
94 result Construct(const Tizen::Graphics::FloatDimension& itemSize);
97 * Initializes this instance of %TableViewSimpleGroupItem with the specified parameter.
101 * @return An error code
102 * @param[in] layout The layout for both of the portrait and landscape modes
103 * @param[in] itemSize The size of the item
104 * @exception E_SUCCESS The method is successful.
105 * @exception E_INVALID_ARG A specified input parameter is invalid.
107 result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::FloatDimension& itemSize);
110 * Sets the text string and bitmap image for %TableViewSimpleGroupItem.
114 * @return An error code
115 * @param[in] text The text string to add
116 * @param[in] pBitmap The bitmap image to display
117 * @exception E_SUCCESS The method is successful.
118 * @exception E_INVALID_ARG A specified input parameter is invalid.
120 result SetItemContents(const Tizen::Base::String& text, const Tizen::Graphics::Bitmap* pBitmap = null);
123 * Sets the color of the text.
127 * @return An error code
128 * @param[in] color The text color
129 * @param[in] status The item drawing state
130 * @exception E_SUCCESS The method is successful.
131 * @exception E_INVALID_ARG A specified input parameter is invalid.
132 * @see GetTextColor()
134 result SetTextColor(const Tizen::Graphics::Color& color, TableViewItemDrawingStatus status = TABLE_VIEW_ITEM_DRAWING_STATUS_NORMAL);
137 * Gets the color of the text.
141 * @return The text color
142 * @param[in] status The item drawing state
143 * @see SetTextColor()
145 Tizen::Graphics::Color GetTextColor(TableViewItemDrawingStatus status = TABLE_VIEW_ITEM_DRAWING_STATUS_NORMAL) const;
148 * Sets the size of the text.
152 * @return An error code
153 * @param[in] size The size of the text
154 * @exception E_SUCCESS The method is successful.
155 * @exception E_INVALID_ARG The specified input parameter is invalid.
158 result SetTextSize(int size);
161 * Gets the size of the text.
165 * @return The size of the text
168 int GetTextSize(void) const;
171 friend class _TableViewItemImpl;
173 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
174 TableViewSimpleGroupItem(const TableViewSimpleGroupItem& rhs);
176 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
177 TableViewSimpleGroupItem& operator =(const TableViewSimpleGroupItem& rhs);
178 }; // TableViewSimpleGroupItem
180 }}} // Tizen::Ui::Controls
182 #endif // _FUI_CTRL_TABLE_VIEW_SIMPLE_GROUP_ITEM_H_