-#ifndef __DALI_TOOLKIT_PUSH_BUTTON_H__
-#define __DALI_TOOLKIT_PUSH_BUTTON_H__
+#ifndef DALI_TOOLKIT_PUSH_BUTTON_H
+#define DALI_TOOLKIT_PUSH_BUTTON_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
/**
* @brief A PushButton changes its appearance when is pressed and returns to its original when is released.
*
- * By default a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked
+ * By default, a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked.
* and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button.
*
- * See Button for more detail on signals and modifying appearance via properties.
+ * Usage example: -
+ *
+ * @code
+ * // in Creating a DALi Application
+ * void HelloWorldExample::Create( Application& application )
+ * {
+ * PushButton button = PushButton::New();
+ * button.SetParentOrigin( ParentOrigin::CENTER );
+ * button.SetProperty( Button::Property::LABEL, "Press" );
+ * Stage::GetCurrent().Add( button );
+ *
+ * // Connect to button signals emitted by the button
+ * button.ClickedSignal().Connect( this, &HelloWorldExample::OnButtonClicked );
+ * button.PressedSignal().Connect( this, &HelloWorldExample::OnButtonPressed );
+ * button.ReleasedSignal().Connect( this, &HelloWorldExample::OnButtonReleased );
+ * }
+ *
+ * bool HelloWorldExample::OnButtonClicked( Button button )
+ * {
+ * // Do something when the button is clicked
+ * return true;
+ * }
+ *
+ * bool HelloWorldExample::OnButtonPressed( Button button )
+ * {
+ * // Do something when the button is pressed
+ * return true;
+ * }
+ *
+ * bool HelloWorldExample::OnButtonReleased( Button button )
+ * {
+ * // Do something when the button is released
+ * return true;
+ * }
+ * @endcode
+ *
+ * See Button for more details on signals and modifying appearance via properties.
* @SINCE_1_0.0
*/
-class DALI_IMPORT_API PushButton : public Button
+class DALI_TOOLKIT_API PushButton : public Button
{
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the PushButton class.
+ * @brief Enumeration for the instance of properties belonging to the PushButton class.
* @SINCE_1_0.0
*/
struct Property
{
+ /**
+ * @brief Enumeration for the instance of properties belonging to the PushButton class.
+ * @SINCE_1_0.0
+ */
enum
{
- UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string @SINCE_1_0.0
- SELECTED_ICON, ///< Property, name "selectedIcon", type std::string @SINCE_1_0.0
- ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string @SINCE_1_0.0
+ UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string @SINCE_1_0.0 @DEPRECATED_1_2.XX Button::Property::UNSELECTED_VISUAL
+ SELECTED_ICON, ///< Property, name "selectedIcon", type std::string @SINCE_1_0.0 @DEPRECATED_1_2.XX Button::Property::SELECTED_VISUAL
+ ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string @SINCE_1_0.0 @DEPRECATED_1_2.XX Use Button::Property::LABEL_RELATIVE_ALIGNMENT
LABEL_PADDING, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0
ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0
};
public:
/**
- * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New().
+ * @brief Creates an uninitialized PushButton; this can be initialized with PushButton::New().
*
* Calling member functions with an uninitialized Dali::Object is not allowed.
* @SINCE_1_0.0
/**
* @brief Copy constructor.
* @SINCE_1_0.0
+ * @param[in] pushButton Handle to an object
*/
PushButton( const PushButton& pushButton );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
+ * @param[in] pushButton Handle to an object
+ * @return A reference to this
*/
PushButton& operator=( const PushButton& pushButton );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~PushButton();
/**
- * @brief Create an initialized PushButton.
+ * @brief Creates an initialized PushButton.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static PushButton New();
/**
- * @brief Downcast an Object handle to PushButton.
+ * @brief Downcasts a handle to PushButton handle.
*
- * If handle points to a PushButton the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If handle points to a PushButton, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
*/
static PushButton DownCast( BaseHandle handle );
-
+ ///////////////////////////////////////////////////////////////////////////
// Deprecated API
using Button::SetButtonImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetUnselectedImage.
*
* @brief Sets the unselected image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetButtonImage( Actor image );
+ void SetButtonImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetBackgroundImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetBackgroundImage.
*
* @brief Sets the background image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetBackgroundImage( Actor image );
+ void SetBackgroundImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetSelectedImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedImage( const std::string& filename ).
*
* @brief Sets the selected image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetSelectedImage( Actor image );
+ void SetSelectedImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetSelectedBackgroundImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedBackgroundImage.
*
* @brief Sets the selected background image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetSelectedBackgroundImage( Actor image );
+ void SetSelectedBackgroundImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetDisabledBackgroundImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledBackgroundImage.
*
* @brief Sets the disabled background image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetDisabledBackgroundImage( Actor image );
+ void SetDisabledBackgroundImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetDisabledImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledImage.
*
* @brief Sets the disabled image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetDisabledImage( Actor image );
+ void SetDisabledImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetDisabledSelectedImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledSelectedImage.
*
* @brief Sets the disabled selected image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
- void SetDisabledSelectedImage( Actor image );
+ void SetDisabledSelectedImage( Actor image ) DALI_DEPRECATED_API;
public: // Not intended for application developers
+ /// @cond internal
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL PushButton( Internal::PushButton& implementation );
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
* @SINCE_1_0.0
- * @param[in] internal A pointer to the internal CustomActor.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal );
+ /// @endcond
};
/**
} // namespace Dali
-#endif // __DALI_TOOLKIT_PUSH_BUTTON_H__
+#endif // DALI_TOOLKIT_PUSH_BUTTON_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff