Updated all header files to new format
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / buttons / check-box-button-impl.h
index cb5e08c..ffae507 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_CHECK_BOX_BUTTON_H__
-#define __DALI_TOOLKIT_INTERNAL_CHECK_BOX_BUTTON_H__
+#ifndef DALI_TOOLKIT_INTERNAL_CHECK_BOX_BUTTON_H
+#define DALI_TOOLKIT_INTERNAL_CHECK_BOX_BUTTON_H
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
  *
  */
 
-// INTERNAL INCLUDES
+// EXTERNAL INCLUDES
 #include <dali/public-api/common/dali-vector.h>
 
+// INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/buttons/check-box-button.h>
 
 #include "button-impl.h"
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Internal
 {
-
 /**
  * CheckBoxButton implementation class.
  *
@@ -42,171 +40,13 @@ namespace Internal
 class CheckBoxButton : public Button
 {
 public:
-
   /**
    * Create a new CheckBoxButton.
    * @return A smart-pointer to the newly allocated CheckBoxButton.
    */
   static Dali::Toolkit::CheckBoxButton New();
 
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetChecked( bool checked )
-   */
-  void SetChecked( bool checked );
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::IsChecked()
-   */
-  bool IsChecked() const;
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetBackgroundImage( Image image )
-   */
-  void SetBackgroundImage( Image image );
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetBackgroundImage( Actor image )
-   */
-  void SetBackgroundImage( Actor image );
-
-  /**
-   * Used by the painter only.
-   * @return A reference to the background image.
-   */
-  Actor& GetBackgroundImage();
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::GetBackgroundImage()
-   */
-  Actor GetBackgroundImage() const;
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetCheckedImage( Image image )
-   */
-  void SetCheckedImage( Image image );
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetCheckedImage( Actor image )
-   */
-  void SetCheckedImage( Actor image );
-
-  /**
-   * Used by the painter only.
-   * @return A reference to the checked image.
-   */
-  Actor& GetCheckedImage();
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::GetCheckedImage()
-   */
-  Actor GetCheckedImage() const;
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetDisabledBackgroundImage( Image image )
-   */
-  void SetDisabledBackgroundImage( Image image );
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetDisabledBackgroundImage( Actor image )
-   */
-  void SetDisabledBackgroundImage( Actor image );
-
-  /**
-   * Used by the painter only.
-   * @return A reference to the disabled background image.
-   */
-  Actor& GetDisabledBackgroundImage();
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::GetDisabledBackgroundImage()
-   */
-  Actor GetDisabledBackgroundImage() const;
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetDisabledCheckedImage( Image image )
-   */
-  void SetDisabledCheckedImage( Image image );
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::SetDisabledCheckedImage( Actor image )
-   */
-  void SetDisabledCheckedImage( Actor image );
-
-  /**
-   * Used by the painter only.
-   * @return A reference to the disabled checked image.
-   */
-  Actor& GetDisabledCheckedImage();
-
-  /**
-   * @copydoc Dali::Toolkit::CheckBoxButton::GetDisabledCheckedImage()
-   */
-  Actor GetDisabledCheckedImage() const;
-
-  /**
-   * Used by the painter only.
-   * @return A reference to the background image that is fading out.
-   */
-  Actor& GetFadeOutBackgroundImage();
-
-  /**
-   * Used by the painter only.
-   * @return A reference to the checked image that is fading out.
-   */
-  Actor& GetFadeOutCheckedImage();
-
-protected: // From Control
-
-  /**
-   * Respond the activate notification.
-   */
-  virtual void OnActivated();
-
 private:
-
-  /**
-   * Perform the click action to click the button.
-   * @param[in] attributes The attributes to perfrom this action.
-   */
-  void DoClickAction(const PropertyValueContainer& attributes);
-
-public:
-  /**
-   * Performs actions as requested using the action name.
-   * @param[in] object The object on which to perform the action.
-   * @param[in] actionName The action to perform.
-   * @param[in] attributes The attributes with which to perfrom this action.
-   * @return true if action has been accepted by this control
-   */
-  static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes);
-
-protected: // From Button
-
-  /**
-   * Registers properties
-   */
-  virtual void OnButtonInitialize();
-
-  /**
-   * Emits signals and notifies the painter accordingly with the set button
-   * properties when the button is released.
-   */
-  virtual void OnButtonUp();
-
-  /**
-   * Sets the push button animation time.
-   * @param animationTime The animation time in seconds.
-   */
-  virtual void OnAnimationTimeSet( float animationTime );
-
-  /**
-   * Retrieves the animation time.
-   * @return The animation time in seconds.
-   */
-  virtual float OnAnimationTimeRequested() const;
-
-protected:
-
   /**
    * Construct a new CheckBoxButton.
    */
@@ -217,53 +57,53 @@ protected:
    */
   virtual ~CheckBoxButton();
 
-private:
+private: // From Button
+  /**
+   * @copydoc Toolkit::Internal::Button::OnInitialize
+   */
+  void OnInitialize() override;
 
+private:
   // Undefined
-  CheckBoxButton( const CheckBoxButton& );
+  CheckBoxButton(const CheckBoxButton&);
 
   // Undefined
-  CheckBoxButton& operator=( const CheckBoxButton& );
-
+  CheckBoxButton& operator=(const CheckBoxButton&);
 
-private:
-  bool  mChecked;                 ///< Stores the check state.
-
-  Actor mBackgroundImage;         ///< Stores the background image.
-  Actor mCheckedImage;            ///< Stores the checked image.
-  Actor mDisabledCheckedImage;    ///< Stores the disabled checked image.
-  Actor mDisabledBackgroundImage; ///< Stores the disabled background image.
-  Actor mFadeOutBackgroundImage;  ///< Stores a background image, which is in a fade out animation, to be removed when the animation finishes.
-  Actor mFadeOutCheckedImage;     ///< Stores a foreground image, which is in a fade out animation, to be removed when the animation finishes.
+protected:
+  struct AccessibleImpl : public Button::AccessibleImpl
+  {
+    using Button::AccessibleImpl::AccessibleImpl;
 
-  // Actions
-  bool mClickActionPerforming;
+    Dali::Accessibility::States CalculateStates() override;
+  };
+  void OnStateChange(State newState) override;
 };
 
 } // namespace Internal
 
 // Helpers for public-api forwarding methods
 
-inline Toolkit::Internal::CheckBoxButton& GetImplementation( Toolkit::CheckBoxButton& button )
+inline Toolkit::Internal::CheckBoxButton& GetImplementation(Toolkit::CheckBoxButton& button)
 {
-  DALI_ASSERT_ALWAYS( button );
+  DALI_ASSERT_ALWAYS(button);
 
   Dali::RefObject& handle = button.GetImplementation();
 
-  return static_cast<Toolkit::Internal::CheckBoxButton&>( handle );
+  return static_cast<Toolkit::Internal::CheckBoxButton&>(handle);
 }
 
-inline const Toolkit::Internal::CheckBoxButton& GetImplementation( const Toolkit::CheckBoxButton& button )
+inline const Toolkit::Internal::CheckBoxButton& GetImplementation(const Toolkit::CheckBoxButton& button)
 {
-  DALI_ASSERT_ALWAYS( button );
+  DALI_ASSERT_ALWAYS(button);
 
   const Dali::RefObject& handle = button.GetImplementation();
 
-  return static_cast<const Toolkit::Internal::CheckBoxButton&>( handle );
+  return static_cast<const Toolkit::Internal::CheckBoxButton&>(handle);
 }
 
 } // namespace Toolkit
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_CHECK_BOX_BUTTON_H__
+#endif // DALI_TOOLKIT_INTERNAL_CHECK_BOX_BUTTON_H