Moved PushButton::SetButtonImage etc to Button base class.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / buttons / push-button.h
index dfc3409..a74610a 100644 (file)
@@ -2,7 +2,7 @@
 #define __DALI_TOOLKIT_PUSH_BUTTON_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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.
@@ -121,15 +121,15 @@ public:
    */
   static PushButton DownCast( BaseHandle handle );
 
-  /**
-   * @brief Sets the button image.
-   *
-   * @param[in] image The button image.
-   */
-  void SetButtonImage( Image image );
+  using Button::SetButtonImage;
 
   /**
-   * @copydoc SetButtonImage( Image image )
+   * @brief SetButtonImage
+   *
+   * @param[in] image The Actor to be used as the button image.
+   *
+   * The natural size of the button would be the size of this Actor
+   * if it's larger than the background and label
    */
   void SetButtonImage( Actor image );
 
@@ -140,15 +140,15 @@ public:
    */
   Actor GetButtonImage() const;
 
-  /**
-   * @brief Sets the background image.
-   *
-   * @param[in] image The background image.
-   */
-  void SetBackgroundImage( Image image );
+  using Button::SetBackgroundImage;
 
   /**
-   * @copydoc SetBackgroundImage( Image image )
+   * @brief SetBackgroundImage
+   *
+   * @param[in] image The Actor to be used as the background image.
+   *
+   * The natural size of the button would be the size of this Actor
+   * if it's larger than the button and label
    */
   void SetBackgroundImage( Actor image );
 
@@ -159,12 +159,7 @@ public:
    */
   Actor GetBackgroundImage() const;
 
-  /**
-   * @brief Sets the selected image.
-   *
-   * @param[in] image The selected image.
-   */
-  void SetSelectedImage( Image image );
+  using Button::SetSelectedImage;
 
   /**
    * @copydoc SetSelectedImage( Image image )
@@ -178,12 +173,21 @@ public:
    */
   Actor GetSelectedImage() const;
 
+  using Button::SetSelectedBackgroundImage;
+
+  /**
+   * @copydoc SetSelectedBackgroundImage( Image image )
+   */
+  void SetSelectedBackgroundImage( Actor image );
+
   /**
-   * @brief Sets the disabled background image.
+   * @brief Gets the selected background image.
    *
-   * @param[in] image The disabled background image.
+   * @return An actor with the selected background image.
    */
-  void SetDisabledBackgroundImage( Image image );
+  Actor GetSelectedBackgroundImage() const;
+
+  using Button::SetDisabledBackgroundImage;
 
   /**
    * @copydoc SetDisabledBackgroundImage( Image image )
@@ -197,12 +201,7 @@ public:
    */
   Actor GetDisabledBackgroundImage() const;
 
-  /**
-   * @brief Sets the disabled button image.
-   *
-   * @param[in] image The disabled button image.
-   */
-  void SetDisabledImage( Image image );
+  using Button::SetDisabledImage;
 
   /**
    * @copydoc SetDisabledImage( Image image )