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.
18 * @file FUiCtrlICustomListElement.h
19 * @brief This is the header file for the %ICustomListElement interface.
21 * This header files contains the declarations of %ICustomListElement interface.
25 #ifndef _FUI_CTRL_ICUSTOM_LIST_ELEMENT_H_
26 #define _FUI_CTRL_ICUSTOM_LIST_ELEMENT_H_
29 #include <FGrpCanvas.h>
31 namespace Tizen { namespace Ui { namespace Controls
36 * @enum CustomListItemStatus
38 * Defines the value of status of the CustomList item.
40 * @brief <i> [Deprecated] </i>
41 * @deprecated This enum is deprecated. Instead of using this enum, use the ListItemStatus enumeration.
45 enum CustomListItemStatus
47 CUSTOM_LIST_ITEM_STATUS_NORMAL = 0, /**< @if OSPDEPREC The status of the item is normal @endif */
48 CUSTOM_LIST_ITEM_STATUS_SELECTED, /**< @if OSPDEPREC The status of the item is selected @endif */
49 CUSTOM_LIST_ITEM_STATUS_FOCUSED /**< @if OSPDEPREC The status of the item is focused @endif */
54 * @interface ICustomListElement
55 * @brief <i> [Deprecated] </i> This interface represents the common behaviors for a CustomList element.
57 * @deprecated This class is deprecated. Instead of using this class, use the ICustomElement class.
61 * The %ICustomListElement interface provides interfaces used for custom drawing
62 * in a custom list item.
64 * If an application wants to draw its own contents in a custom list item, it must
65 * implement %ICustomListElement and add elements by calling SetElement(int elementId,
66 * const %ICustomListElement &element). When the custom list item needs to be redrawn,
67 * DrawElement() is called by the framework.
70 class _OSP_EXPORT_ ICustomListElement
71 : public Tizen::Base::Object
76 * This is the destructor for this class.
78 * @brief <i> [Deprecated] </i>
79 * @deprecated This class is deprecated. Instead of using this class, use the ICustomElement class.
83 virtual ~ICustomListElement(void) {}
89 * Draws a custom element of the item.
91 * @brief <i> [Deprecated] </i>
92 * @deprecated This class is deprecated. Instead of using this class, use the ICustomElement class.
95 * @return An error code
96 * @param[in] canvas The graphic canvas of the list control
97 * @param[in] rect The location and size of the CustomList element
98 * @param[in] itemStatus The status of the item
99 * @exception E_SUCCESS The method is successful.
100 * @exception E_SYSTEM A system error has occurred.
103 virtual result DrawElement(const Tizen::Graphics::Canvas& canvas, const Tizen::Graphics::Rectangle& rect, CustomListItemStatus itemStatus) = 0;
104 }; //ICustomListElement
105 }}} //Tizen::Ui::Controls
106 #endif // _FUI_CTRL_ICUSTOM_LIST_ELEMENT_H_