#define __DALI_TOOLKIT_PUSH_BUTTON_H__
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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.
* {
* PushButton button = PushButton::New();
* button.SetParentOrigin( ParentOrigin::CENTER );
- * button.SetLabelText( "Press" );
+ * button.SetProperty( Button::Property::LABEL, "Press" );
* Stage::GetCurrent().Add( button );
*
* // Connect to button signals emitted by the button
*/
struct Property
{
+ /**
+ * @brief An enumeration 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
};
/**
* @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 );
*/
static PushButton DownCast( BaseHandle handle );
-
+ ///////////////////////////////////////////////////////////////////////////
// Deprecated API
using Button::SetButtonImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetButtonImage( Actor image );
+ void SetButtonImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetBackgroundImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetBackgroundImage( Actor image );
+ void SetBackgroundImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetSelectedImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetSelectedImage( Actor image );
+ void SetSelectedImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetSelectedBackgroundImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetSelectedBackgroundImage( Actor image );
+ void SetSelectedBackgroundImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetDisabledBackgroundImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetDisabledBackgroundImage( Actor image );
+ void SetDisabledBackgroundImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetDisabledImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetDisabledImage( Actor image );
+ void SetDisabledImage( Actor image ) DALI_DEPRECATED_API;
using Button::SetDisabledSelectedImage;
* @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
- void SetDisabledSelectedImage( Actor image );
+ void SetDisabledSelectedImage( Actor image ) DALI_DEPRECATED_API;
public: // Not intended for application developers