// 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.
__pIconListView->AddIconListViewItemEventListener(*this);
// Adds the icon list view to the form
- AddControl(*__pIconListView);
+ AddControl(__pIconListView);
// Gets instances of Bitmap
AppResource* pAppResource = Application::GetInstance()->GetAppResource();
{
public:
/**
- * 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. For full construction, the Construct(const Tizen::Graphics::Rectangle&, const Tizen::Graphics::Dimension&, IconListViewStyle, IconListViewScrollDirection, IconListViewScrollStyle) method must be called right after calling this constructor.
*
* @since 2.0
*/
* @since 2.0
*
* @return An error code
- * @param[in] rect An instance of the Graphics::Rectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created %IconListView along with the width and height.
- * @param[in] itemBitmapSize The size of an icon in the %IconListView
+ * @param[in] rect An instance of the Tizen::Graphics::Rectangle class @n
+ * This instance represents the x and y coordinates of the top-left corner of the created %IconListView along with
+ * the width and height.@n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * @param[in] itemBitmapSize The size of an icon in %IconListView
* @param[in] style The style set of %IconListView
* @param[in] direction The direction of scroll
* @param[in] scrollStyle The scroll style of %IconListView
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
* @remarks The number of items to be displayed on a screen is calculated based on %IconListView size, item size, item spacing, and margins. @n
- * The %IconListView cannot display more than 256 items on the screen at once.
- * @remarks The actual size of bitmap to be displayed in %IconListView is smaller than the specified size when the border style is ICON_LIST_VIEW_ITEM_BORDER_STYLE_SHADOW.
+ * %IconListView cannot display more than @c 256 items on the screen at once.
+ * @remarks The actual size of bitmap to be displayed in %IconListView is smaller than the specified size when the border style is @c ICON_LIST_VIEW_ITEM_BORDER_STYLE_SHADOW.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, const Tizen::Graphics::Dimension& itemBitmapSize, IconListViewStyle style = ICON_LIST_VIEW_STYLE_NORMAL, IconListViewScrollDirection direction = ICON_LIST_VIEW_SCROLL_DIRECTION_VERTICAL, IconListViewScrollStyle scrollStyle = ICON_LIST_SCROLL_STYLE_FADE_OUT);
/**
* Initializes this instance of %IconListView with the specified parameters.
*
- * @since 2.1
+ * @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Graphics::FloatRectangle class @n
- * This instance represents the x and y coordinates of the top-left corner of the created %IconListView along with the width and height.
- * @param[in] itemBitmapSize The size of an icon in the %IconListView
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
+ * This instance represents the x and y coordinates of the top-left corner of the created %IconListView along with
+ * the width and height.@n
+ * The optimal size of the control is defined in
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
+ * @param[in] itemBitmapSize The size of an icon in %IconListView
* @param[in] style The style set of %IconListView
* @param[in] direction The direction of scroll
* @param[in] scrollStyle The scroll style of %IconListView
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
* @remarks The number of items to be displayed on a screen is calculated based on %IconListView size, item size, item spacing, and margins. @n
- * The %IconListView cannot display more than 256 items on the screen at once.
- * @remarks The actual size of bitmap to be displayed in %IconListView is smaller than the specified size when the border style is ICON_LIST_VIEW_ITEM_BORDER_STYLE_SHADOW.
+ * %IconListView cannot display more than @c 256 items on the screen at once.
+ * @remarks The actual size of bitmap to be displayed in %IconListView is smaller than the specified size when the border style is @c ICON_LIST_VIEW_ITEM_BORDER_STYLE_SHADOW.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, const Tizen::Graphics::FloatDimension& itemBitmapSize, IconListViewStyle style = ICON_LIST_VIEW_STYLE_NORMAL, IconListViewScrollDirection direction = ICON_LIST_VIEW_SCROLL_DIRECTION_VERTICAL, IconListViewScrollStyle scrollStyle = ICON_LIST_SCROLL_STYLE_FADE_OUT);
* @param[in] provider The item provider to create and delete items
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks If an item provider is not set for the %IconListView, it does not work. @n
+ * @remarks If an item provider is not set for %IconListView, it does not work. @n
* The specified @c provider should be allocated in heap memory.
*/
result SetItemProvider(IIconListViewItemProvider& provider);
void RemoveScrollEventListener(IScrollEventListenerF& listener);
/**
- * Sets the background bitmap of the %IconListView.
+ * Sets the background bitmap of %IconListView.
*
* @since 2.0
*
* @param[in] pBitmap The background bitmap
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks When @c pBitmap is null, %IconListView does not have a background bitmap. The default value for the background bitmap is @c null.
+ * @remarks When @c pBitmap is @c null, %IconListView does not have a background bitmap. The default value for the background bitmap is @c null.
* @remarks The background bitmap has priority over the background color. When both the background bitmap and the background color are specified,
* only the bitmap is displayed.
*/
* @return An error code
* @param[in] color The background color
* @exception E_SUCCESS The method is successful.
- * @remarks The method sets the alpha value of the specified color to 255, when a device does not support 32 bit color space.
+ * @remarks This method sets the alpha value of the specified color to @c 255, when a device does not support @c 32 bit color space.
* @remarks The background bitmap has priority over the background color. When both the background bitmap and the background color are specified,
* only the bitmap is displayed.
*/
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The number of items to be displayed on a screen is calculated based on %IconListView size, item size, item spacing, and
- * margins. The %IconListView cannot display more than 256 items on screen at once.
+ * margins. %IconListView cannot display more than @c 256 items on screen at once.
*/
result SetMargin(MarginType type, int value);
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
* @remarks The number of items to be displayed on a screen is calculated based on %IconListView size, item size, item spacing, and
- * margins. The %IconListView cannot display more than 256 items on screen at once.
+ * margins. %IconListView cannot display more than @c 256 items on screen at once.
*/
result SetItemSpacing(int horizontalSpacing, int verticalSpacing);
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_RANGE The specified @c index is out of range.
* @remarks This method can only be used when the style of the list allows selection.
- * @remarks The method only changes the state of the list item. %IconListView needs to be redrawn to reflect the change on the screen.
- * @remarks This method should be called only after list items are created. If this method needs to be called early in the lifecycle of the IconListView, then UpdateList() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
+ * @remarks This method only changes the state of the list item. %IconListView needs to be redrawn to reflect the change on the screen.
*/
result SetItemChecked(int index, bool check);
/**
- * Checks whether the specified item is checked.
+ * Checks whether the specified @c item is checked.
*
* @since 2.0
*
- * @return @c true if the specified item is checked, @n
+ * @return @c true if the specified @c item is checked, @n
* else @c false
* @param[in] index The index of the item
* @remarks This method can only be used when the style of the list allows selection.
- * @remarks This method should be called only after list items are created. If this method needs to be called early in the lifecycle of the IconListView, then UpdateList() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
*/
bool IsItemChecked(int index) const;
* @since 2.0
*
* @return The index of the item, @n
- * else @c -1 when there is no list item at the specified position or when the %IconListView instance is invalid
+ * else @c -1 if there is no list item at the specified position or if the %IconListView instance is invalid
* @param[in] x The x position of a point
* @param[in] y The y position of a point
*/
int GetItemIndexFromPosition(int x, int y) const;
/**
- * Gets the index of the item at the specified position.
+ * Gets the index of the item at the specified @c position.
*
* @since 2.1
*
* @return The index of the item, @n
- * else @c -1 when there is no list item at the specified position or when the %IconListView instance is invalid
+ * else @c -1 if there is no list item at the specified position or if the %IconListView instance is invalid
* @param[in] x The x position of a point
* @param[in] y The y position of a point
*/
* @since 2.0
*
* @return The index of the item, @n
- * else @c -1 if there is no list item at the specified position or when the %IconListView instance is invalid
+ * else @c -1 if there is no list item at the specified @c position or if the %IconListView instance is invalid
* @param[in] position The position of a point
*/
int GetItemIndexFromPosition(const Tizen::Graphics::Point& position) const;
* @since 2.1
*
* @return The index of the item, @n
- * else @c -1 if there is no list item at the specified position or when the %IconListView instance is invalid
+ * else @c -1 if there is no list item at the specified @c position or if the %IconListView instance is invalid
* @param[in] position The position of a point
*/
int GetItemIndexFromPosition(const Tizen::Graphics::FloatPoint& position) const;
* @since 2.0
*
* @return The horizontal alignment of the text, @n
- * else ALIGNMENT_LEFT when the %IconListView instance is invalid
+ * else @c ALIGNMENT_LEFT when the %IconListView instance is invalid
*/
HorizontalAlignment GetTextHorizontalAlignment(void) const;
* @since 2.0
*
* @return The vertical alignment of the text of an item, @n
- * else ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_INSIDE_TOP when the %IconListView is invalid
+ * else @c ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_INSIDE_TOP when the %IconListView instance is invalid
*/
IconListViewItemTextVerticalAlignment GetTextVerticalAlignment(void) const;
*
* @since 2.0
*
- * @return The size of the text of the %IconListView control, else @c -1 if the instance is invalid
+ * @return The size of the text of the %IconListView control, @n
+ * else @c -1 if the instance is invalid
*/
int GetItemTextSize(void) const;
*
* @since 2.1
*
- * @return The size of the text of the %IconListView control, else @c -1.0f if the instance is invalid
+ * @return The size of the text of the %IconListView control, @n
+ * else @c -1 if the instance is invalid
*/
float GetItemTextSizeF(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] position The position of the checkbox of the %IconListView
+ * @param[in] position The position of the checkbox of the %IconListView control
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * That is, %IconListView cannot get the position of the checkbox when the style is ICON_LIST_VIEW_STYLE_NORMAL.
+ * That is, %IconListView cannot get the position of the checkbox when the style is @c ICON_LIST_VIEW_STYLE_NORMAL.
* @exception E_SYSTEM A system error has occurred.
* @remarks This method changes the position of the checkbox image displayed for the "selected" item(s),
- * when the style of %IconListView is either ICON_LIST_VIEW_STYLE_RADIO and ICON_LIST_VIEW_STYLE_MARK.
+ * when the style of %IconListView is either @c ICON_LIST_VIEW_STYLE_RADIO or @c ICON_LIST_VIEW_STYLE_MARK.
*/
result SetCheckBoxPosition(IconListViewCheckBoxPosition position);
* @since 2.0
*
* @return The position of the checkbox
- * @remarks The method returns @c ICON_LIST_VIEW_CHECK_BOX_POSITION_TOP_LEFT when the style of %IconListView is ICON_LIST_VIEW_STYLE_NORMAL or
- * ICON_LIST_VIEW_STYLE_DIVIDE_TEXT.
+ * @remarks This method returns @c ICON_LIST_VIEW_CHECK_BOX_POSITION_TOP_LEFT when the style of %IconListView is @c ICON_LIST_VIEW_STYLE_NORMAL or
+ * @c ICON_LIST_VIEW_STYLE_DIVIDE_TEXT.
*/
IconListViewCheckBoxPosition GetCheckBoxPosition(void) const;
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks If you want to use a separate selected bitmap, the animation effect must be disabled.
- * @remarks In case that a touch animation disabled, the normal bitmap of %IconListViewItem is displayed in response to touch interaction if the
+ * @remarks In case a touch animation is disabled, the normal bitmap of IconListViewItem is displayed in response to touch interaction if the
* selected bitmap of %IconListViewItem is @c null.
*/
result SetTouchAnimationEnabled(bool enable);
* @since 2.0
*
* @return @c true if touch animation is enabled, @n
- * else @c false if touch animation is disabled or when the instance is invalid
+ * else @c false if touch animation is disabled or if the instance is invalid
*/
bool IsTouchAnimationEnabled(void) const;
/**
- * Scrolls the list contents to the specified index.
+ * Scrolls the list contents to the specified @c index.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_RANGE The specified @c index is out of range.
- * @remarks This method should be called only after list items are created. If this method needs to be called early in the lifecycle of the IconListView, then UpdateList() method should be called explicitly (e.g. during Tizen::Ui::Control::OnInitializing()).
*/
result ScrollToItem(int index);
/*
* Scrolls the list contents with the amount of pixels.
*
- * @since 2.0
+ * @since 2.1
*
* @return An error code
* @param[in] pixel The amount of pixels to scroll
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c pixel is out of range.
- * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
- * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE.
+ * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return @c E_OUT_OF_RANGE.
+ * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return @c E_OUT_OF_RANGE.
*/
result ScrollByPixel(int pixel);
* @param[in] pixel The amount of pixels to scroll
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The specified @c pixel is out of range.
- * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return E_OUT_OF_RANGE.
- * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return E_OUT_OF_RANGE.
+ * @remarks If you call ScrollByPixel() with negative @c pixel when position of scroll is already top of contents then it will return @c E_OUT_OF_RANGE.
+ * Likewise, in case of positive @c pixel on the bottom position of scroll it will also return @c E_OUT_OF_RANGE.
*/
result ScrollByPixel(float pixel);
* @since 2.0
*
* @return The number of item lines for the magnetic scroll of %IconListView, @n
- * else @c -1 when the instance is invalid
+ * else @c -1 if the instance is invalid
*/
int GetMagneticScrollSize(void) const;
*
* @return The number of items to be displayed per axis, @n
* else @c -1 if the instance is invalid
- * @remarks The axis represents "row" when the scroll style is ICON_LIST_VIEW_SCROLLSDIRECTION_HORIZONTAL, while it represents "column" when the
- * scroll style is ICON_LIST_VIEW_SCROLLDIRECTION_VERTICAL.
+ * @remarks The axis represents "row" when the scroll style is @c ICON_LIST_VIEW_SCROLLSDIRECTION_HORIZONTAL, while it represents "column" when the
+ * scroll style is @c ICON_LIST_VIEW_SCROLLDIRECTION_VERTICAL.
*/
int GetItemCountPerAxis(void) const;
result EndReorderingMode(void);
/**
- * Checks whether the %IconListView is in reordering mode.
+ * Checks whether %IconListView is in reordering mode.
*
* @since 2.0
*
- * @return @c true if the %IconListView is in reordering mode, @n
+ * @return @c true if %IconListView is in reordering mode, @n
* else @c false
*/
bool IsInReorderingMode(void) const;
projects / platform / framework / native / uifw.git / blobdiff