Merge "Added default styles for ToggleButton" into devel/master

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control.h

diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h
index 0cbb6ec..e837858 100644 (file)
--- a/dali-toolkit/public-api/controls/control.h
+++ b/dali-toolkit/public-api/controls/control.h
@@ -2,7 +2,7 @@
 #define __DALI_TOOLKIT_CONTROL_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -89,6 +89,10 @@ public:
    */
   struct Property
   {
+    /**
+     * @brief An enumeration of properties belonging to the Control class.
+     * @SINCE_1_0.0
+     */
     enum
     {
       /**
@@ -99,14 +103,14 @@ public:
       STYLE_NAME = PROPERTY_START_INDEX,
       /**
        * @DEPRECATED_1_1.3
-       * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND,  type Vector4
+       * @brief name "backgroundColor", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND,  type Vector4
        * @SINCE_1_0.0
        * @see SetStyleName
        */
       BACKGROUND_COLOR,
       /**
        * @DEPRECATED_1_1.3
-       * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND,  type Map
+       * @brief name "backgroundImage", mutually exclusive with BACKGROUND_COLOR & BACKGROUND,  type Map
        * @SINCE_1_0.0
        */
       BACKGROUND_IMAGE,
@@ -117,7 +121,7 @@ public:
        */
       KEY_INPUT_FOCUS,
       /**
-       * @brief name "background",       mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE,                   type Map
+       * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL
        * @SINCE_1_1.3
        */
       BACKGROUND,
@@ -130,12 +134,18 @@ public:
    */
   struct KeyboardFocus
   {
+    /**
+     * @brief Keyboard focus direction
+     * @SINCE_1_0.0
+     */
     enum Direction
     {
       LEFT,   ///< Move keyboard focus towards the left direction @SINCE_1_0.0
       RIGHT,  ///< Move keyboard focus towards the right direction @SINCE_1_0.0
       UP,     ///< Move keyboard focus towards the up direction @SINCE_1_0.0
-      DOWN    ///< Move keyboard focus towards the down direction @SINCE_1_0.0
+      DOWN,    ///< Move keyboard focus towards the down direction @SINCE_1_0.0
+      PAGE_UP,     ///< Move keyboard focus towards the previous page direction @SINCE_1_2.14
+      PAGE_DOWN    ///< Move keyboard focus towards the next page direction @SINCE_1_2.14
     };
   };
 
@@ -322,17 +332,17 @@ public:
    * @SINCE_1_0.0
    * @return The background color of the control.
    */
-  Vector4 GetBackgroundColor() const;
+  Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
 
   /**
-   * @DEPRECATED_1_2.8, use Property::BACKGROUND instead
+   * @DEPRECATED_1_2_8, use Property::BACKGROUND instead
    *
    * @brief Sets an image as the background of the control.
    *
    * @SINCE_1_0.0
    * @param[in] image The image to set as the background.
    */
-  void SetBackgroundImage( Image image );
+  void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
 
   /**
    * @brief Clears the background.