#define __DALI_TOOLKIT_CHECK_BOX_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.
/**
* @brief 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 selected or unselected.
+ * 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 Button::SetUnselectedImage, Button::SetBackgroundImage,
* Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
* {
* CheckBoxButton button = CheckBoxButton::New();
* button.SetParentOrigin( ParentOrigin::CENTER );
- * button.SetLabelText( "Check" );
+ * button.SetProperty( Button::Property::LABEL, "Check" );
* button.SetSize( 200, 40 );
* button.SetBackgroundColor( Color::WHITE );
* Stage::GetCurrent().Add( button );
public:
/**
- * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
+ * @brief Creates an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
* Calling member functions with an uninitialized Dali::Object is not allowed.
* @SINCE_1_0.0
*/
CheckBoxButton& operator=( const CheckBoxButton& checkBox );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~CheckBoxButton();
/**
- * @brief Create an initialized CheckBoxButton.
+ * @brief Creates an initialized CheckBoxButton.
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static CheckBoxButton New();
/**
- * @brief Downcast a handle to CheckBoxButton handle.
+ * @brief Downcasts a handle to CheckBoxButton handle.
*
- * If handle points to a CheckBoxButton the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a CheckBoxButton, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a CheckBoxButton or an uninitialized handle
+ * @return Handle to a CheckBoxButton or an uninitialized handle
*/
static CheckBoxButton DownCast( BaseHandle handle );
/**
* @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 CheckBoxButton( Internal::CheckBoxButton& 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 CheckBoxButton( Dali::Internal::CustomActor* internal );
/// @endcond