// Open Service Platform
// Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
//
-// Licensed under the Flora License, Version 1.0 (the License);
+// Licensed under the Apache License, Version 2.0 (the License);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
-// http://floralicense.org/license/
+// http://www.apache.org/licenses/LICENSE-2.0/
//
// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
+// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
/**
+ * @if OSPDEPREC
* @file FUiCtrlGroupedList.h
* @brief This is the header file for the %GroupedList class.
*
* This header file contains the declarations of the %GroupedList class and its helper classes.
+ * @endif
*/
#ifndef _FUI_CTRL_GROUPED_LIST_H_
namespace Tizen { namespace Ui { namespace Controls {
/**
- * @if OSPDEPREC
+ * @if OSPDEPREC
* @class GroupedList
* @brief <i> [Deprecated] </i> This class defines the common behavior of a %GroupedList control.
*
}
// Adds the grouped list to the form
- AddControl(*__pGroupedList);
+ AddControl(__pGroupedList);
// Deallocates bitmaps
delete pBitmapNormal;
public:
/**
* @if OSPDEPREC
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the GroupedList::Construct() method must be called right after calling this constructor.
*
* @brief <i> [Deprecated] </i>
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
/**
* @if OSPDEPREC
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @brief <i> [Deprecated] </i>
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
*
* @return An error code
* @param[in] rect An instance of the Graphics::Rectangle class @n
- * This instance represents the X, Y coordinates of the top-left corner of the created %GroupedList along with the width and
+ * This instance represents the X, Y coordinates of the top-left corner of the created %GroupedList along with the width and
* height.
* @param[in] style The style of the %GroupedList control
* @param[in] itemDivider Set to @c true to display an item divider, @n
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The size of the control must be within the range as defined by the minimum and maximum size.
- * @remarks The minimum size of this control is 274 x 148 on a WVGA screen, 180 x 96 on a HVGA screen and 137 x 74 on a WQVGA screen.
+ * @remarks
+ * - The size of the control must be within the range as defined by the minimum and maximum size.
+ * - The minimum size of this control is 274 x 148 on a WVGA screen, 180 x 96 on a HVGA screen and 137 x 74 on a WQVGA screen.
* @endif
*/
result Construct(const Tizen::Graphics::Rectangle& rect, CustomListStyle style, bool itemDivider = true, bool fastScroll = false);
* @since 2.0
*
* @return An error code
- * @param[in] text The string of the group to be appended
+ * @param[in] text The string of the group to append
* @param[in] pBackgroundBitmap The background bitmap of the group
* @param[in] groupId The ID of the group
* @exception E_SUCCESS The method is successful.
*
* @return An error code
* @param[in] groupIndex The group index
- * @param[in] text The string of the group to be appended
+ * @param[in] text The string of the group to append
* @param[in] pBackgroundBitmap The bitmap of the group
* @param[in] groupId The ID of the group
* @exception E_SUCCESS The method is successful.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c groupIndex is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks When the specified group is removed, all the items in the group are also removed. @n
- * The removed list items are deleted from the memory.
+ * @remarks
+ * - When the specified group is removed, all the items in the group are also removed.
+ * - The removed list items are deleted from the memory.
* @endif
*/
result RemoveGroupAt(int groupIndex);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks When the specified group is removed, all the items in the group are also removed. @n
- * The removed list items are deleted from the memory.
+ * @remarks
+ * - When the specified group is removed, all the items in the group are also removed.
+ * - The removed list items are deleted from the memory.
* @endif
*/
result RemoveAllGroups(void);
*
* @return An error code
* @param[in] groupIndex The group index
- * @param[in] item The custom list item object to be added
+ * @param[in] item The custom list item object to add
* @param[in] itemId The specified item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c groupIndex or @c itemId is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The added item is deleted automatically when the list is destroyed. @n
- * Do not add, insert, or set an item that already belongs to a %GroupedList control.
+ * @remarks
+ * - The added item is deleted automatically when the list is destroyed.
+ * - Do not add, insert, or set an item that already belongs to a %GroupedList control.
* @endif
*/
result AddItem(int groupIndex, const CustomListItem& item, int itemId = LIST_ITEM_UNSPECIFIED_ID);
* @return An error code
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index in the specified group
- * @param[in] item The custom list item to be inserted
+ * @param[in] item The custom list item to insert
* @param[in] itemId The item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c groupIndex or @c itemId is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The inserted item is deleted automatically when the list is destroyed.
- * Do not add, insert, or set an item that already belongs to a %GroupedList control.
+ * @remarks
+ * - The inserted item is deleted automatically when the list is destroyed.
+ * - Do not add, insert, or set an item that already belongs to a %GroupedList control.
* @endif
*/
result InsertItemAt(int groupIndex, int itemIndex, const CustomListItem& item, int itemId = LIST_ITEM_UNSPECIFIED_ID);
* @return An error code
* @param[in] groupIndex The group index
* @param[in] itemIndex The item index in the specified group
- * @param[in] item The custom list item to be set
+ * @param[in] item The custom list item to set
* @param[in] itemId The item ID for this item
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c groupIndex or @c itemId is invalid.
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
* @since 2.0
*
- * @param[in] color The color of the text to be displayed
+ * @param[in] color The color of the text to display
* @endif
*/
void SetTextColorOfEmptyList(const Tizen::Graphics::Color& color);
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @endif
*/
void AddFastScrollEventListener(Tizen::Ui::IFastScrollEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @endif
*/
void RemoveFastScrollEventListener(Tizen::Ui::IFastScrollEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
* @since 2.0
*
- * @param[in] listener The listener to be added
+ * @param[in] listener The listener to add
* @endif
*/
void AddGroupedItemEventListener(Tizen::Ui::IGroupedItemEventListener& listener);
* @deprecated This class is deprecated. Instead of using this class, use GroupedListView class.
* @since 2.0
*
- * @param[in] listener The listener to be removed
+ * @param[in] listener The listener to remove
* @endif
*/
void RemoveGroupedItemEventListener(Tizen::Ui::IGroupedItemEventListener& listener);
projects / platform / framework / native / uifw.git / blobdiff