Merge "fix klocwork issue" into tizen_2.2
[platform/framework/native/uifw.git] / inc / FUiCtrlListItemBase.h
index 2790b09..45fce40 100644 (file)
@@ -2,14 +2,14 @@
 // 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.
@@ -112,9 +112,10 @@ public:
         * @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  If the context item is not set, ListView() or GroupedListView() does not display the context item and an item sweep event is generated when an
-        *                      item is swept. @n
-        *          The specified @c pItem should be deleted by the applications when it is no longer used.
+        * @remarks
+        *                      - If the context item is not set, ListView() or GroupedListView() does not display the context item and an item sweep event is generated when an
+        *                      item is swept.
+        *                      - The specified @c pItem should be deleted by the applications when it is no longer used.
         */
        result SetContextItem(const ListContextItem* pItem);
 
@@ -143,41 +144,26 @@ public:
        result SetDescriptionTextColor(const Tizen::Graphics::Color& color);
 
        /**
-        * Sets the progress value of a list item.
-        *
-        * @since   2.0
-        *
-        * @return  An error code
-        * @param[in] value             The progress value of the list item @n
-        *                              The valid values are integers from @c 0 to @c 100.
-        * @exception E_SUCCESS         The method is successful.
-        * @exception E_SYSTEM          A system error has occurred.
-        */
-       result SetProgressValue(int value);
-
-       /**
-        * Sets the margin of the progress bar.
+        * Gets the width of the annex area.
         *
-        * @since   2.0
+        * @since       2.0
         *
-        * @return  An error code
-        * @param[in] leftMargin        The left margin of the progress bar
-        * @param[in] rightMargin       The right margin of the progress bar
-        * @exception E_SUCCESS         The method is successful.
-        * @exception E_SYSTEM          A system error has occurred.
+        * @return  The width of the annex
+        * @param[in] style             The style of the annex
+        * @remarks  The width of the annex area is different among annex styles.
         */
-       result SetProgressMargins(int leftMargin, int rightMargin);
+       static int GetAnnexWidth(ListAnnexStyle style);
 
        /**
         * Gets the width of the annex area.
         *
-        * @since       2.0
+        * @since       2.1
         *
         * @return  The width of the annex
         * @param[in] style             The style of the annex
         * @remarks  The width of the annex area is different among annex styles.
         */
-       static int GetAnnexWidth(ListAnnexStyle style);
+       static float GetAnnexWidthF(ListAnnexStyle style);
 
 protected:
        friend class _ListItemBaseImpl;
@@ -204,6 +190,20 @@ protected:
        result Construct(const Tizen::Graphics::Dimension& itemSize, ListAnnexStyle style);
 
        //
+       // Initializes this instance of ListItem with the specified parameter.
+       //
+       // @since   2.1
+       //
+       // @return  An error code
+       //
+       // @param[in] itemSize          The size of the item
+       // @param[in] style             The style of Annex
+       // @exception E_SUCCESS         The method is successful.
+       // @exception E_SYSTEM          A system error has occurred.
+       //
+       result Construct(const Tizen::Graphics::FloatDimension& itemSize, ListAnnexStyle style);
+
+       //
        // The following methods are reserved and may change its name at any time without prior notice.
        //
        virtual void ListItemBase_Reserved1(void) {}