Doxygen grouping

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / buttons / check-box-button.h

diff --git a/dali-toolkit/public-api/controls/buttons/check-box-button.h b/dali-toolkit/public-api/controls/buttons/check-box-button.h
index e321ce4..357c3e1 100644 (file)
--- a/dali-toolkit/public-api/controls/buttons/check-box-button.h
+++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h
@@ -2,7 +2,7 @@
 #define __DALI_TOOLKIT_CHECK_BOX_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.
@@ -33,19 +33,23 @@ namespace Internal DALI_INTERNAL
 {
 class CheckBoxButton;
 }
+/**
+ * @addtogroup dali-toolkit-controls-buttons
+ * @{
+ */
 
 /**
  * CheckBoxButton provides a check box button which user can check or uncheck.
  *
- * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to checked or unchecked.
+ * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
  *
  * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage,
- * CheckBoxButton::SetCheckedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledCheckedImage.
+ * CheckBoxButton::SetSelectedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledSelectedImage.
  *
- * When the button is not disabled, if it's not checked it only shows the \e background image. The \e checked image is shown over the
- * \e background image when the box is checked (\e background image is not replaced by \e checked image).
+ * When the button is not disabled, if it's not selected it only shows the \e background image. The \e selected image is shown over the
+ * \e background image when the box is selected (\e background image is not replaced by \e selected image).
  *
- * When the button is disabled, \e background image and \e checked image are replaced by \e disabled images.
+ * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.
  *
  * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
  * and a CheckBoxButton could be used instead.
@@ -53,10 +57,6 @@ class CheckBoxButton;
 class DALI_IMPORT_API CheckBoxButton : public Button
 {
 public:
-  //Action Names
-  static const char* const ACTION_CHECK_BOX_BUTTON_CLICK;
-
-public:
 
   /**
    * Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
@@ -95,93 +95,6 @@ public:
    */
   static CheckBoxButton DownCast( BaseHandle handle );
 
-  /**
-   * Sets the button as checked or unchecked.
-   *
-   * Emits a Button::ClickedSignal() signal if the checkbox is not disabled and the new state,
-   * given in the \e checked param, is different than the previous one.
-   *
-   * @param[in] checked state.
-   */
-  void SetChecked( bool checked );
-
-  /**
-   * @return \e true if the button is checked.
-   */
-  bool IsChecked() const;
-
-  /**
-   * Sets the background image.
-   *
-   * @param[in] image The background image.
-   */
-  void SetBackgroundImage( Image image );
-
-  /**
-   * @copydoc SetBackgroundImage( Image image )
-   */
-  void SetBackgroundImage( Actor image );
-
-  /**
-   * Gets the background image.
-   * @return An actor with the background image.
-   */
-  Actor GetBackgroundImage() const;
-
-  /**
-   * Sets the checked image.
-   *
-   * @param[in] image The checked image.
-   */
-  void SetCheckedImage( Image image );
-
-  /**
-   * @copydoc SetCheckedImage( Image image )
-   */
-  void SetCheckedImage( Actor image );
-
-  /**
-   * Gets the checked image.
-   * @return An actor with the checked image.
-   */
-  Actor GetCheckedImage() const;
-
-  /**
-   * Sets the disabled background image.
-   *
-   * @param[in] image The disabled background image.
-   */
-  void SetDisabledBackgroundImage( Image image );
-
-  /**
-   * @copydoc SetDisabledBackgroundImage( Image image )
-   */
-  void SetDisabledBackgroundImage( Actor image );
-
-  /**
-   * Gets the disabled background image.
-   * @return An actor with the disabled background image.
-   */
-  Actor GetDisabledBackgroundImage() const;
-
-  /**
-   * Sets the disabled checked image.
-   *
-   * @param[in] image The disabled checked image.
-   */
-  void SetDisabledCheckedImage( Image image );
-
-  /**
-   * @copydoc SetDisabledCheckedImage( Image image )
-   */
-  void SetDisabledCheckedImage( Actor image );
-
-  /**
-   * Gets the disabled checked image.
-   * @return An actor with the disabled checked image.
-   */
-  Actor GetDisabledCheckedImage() const;
-
 public: // Not intended for application developers
 
   /**
@@ -197,6 +110,9 @@ public: // Not intended for application developers
   DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali