#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.
{
class CheckBoxButton;
}
+/**
+ * @addtogroup dali_toolkit_controls_buttons
+ * @{
+ */
/**
- * CheckBoxButton provides a check box button which user can check or uncheck.
+ * @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.
*
- * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage,
- * CheckBoxButton::SetSelectedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledSelectedImage.
+ * The button's appearance could be modified by Button::SetUnselectedImage, Button::SetBackgroundImage,
+ * Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
+ * Button::SetDisabledImage, and Button::SetDisabledSelectedImage.
*
* 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 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.
+ * Usage example: -
+ *
+ * @code
+ * // in Creating a DALi Application
+ * void HelloWorldExample::Create( Application& application )
+ * {
+ * CheckBoxButton button = CheckBoxButton::New();
+ * button.SetParentOrigin( ParentOrigin::CENTER );
+ * button.SetLabelText( "Check" );
+ * button.SetSize( 200, 40 );
+ * button.SetBackgroundColor( Color::WHITE );
+ * Stage::GetCurrent().Add( button );
+ *
+ * // Connect to a button signal emitted by the button
+ * button.StateChangedSignal().Connect( this, &HelloWorldExample::OnButtonStateChanged );
+ * }
+ *
+ * bool HelloWorldExample::OnButtonStateChanged( Button button )
+ * {
+ * // Do something when the button state is changed
+ * // You can get the state using button.IsSelected() call
+ * return true;
+ * }
+ * @endcode
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API CheckBoxButton : public Button
{
public:
/**
- * Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
+ * @brief Create 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();
/**
- * Copy constructor.
+ * @brief Copy constructor.
+ * @SINCE_1_0.0
*/
CheckBoxButton( const CheckBoxButton& checkBox );
/**
- * Assignment operator.
+ * @brief Assignment operator.
+ * @SINCE_1_0.0
*/
CheckBoxButton& operator=( const CheckBoxButton& checkBox );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~CheckBoxButton();
/**
- * Create an initialized CheckBoxButton.
+ * @brief Create an initialized CheckBoxButton.
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali resource.
*/
static CheckBoxButton New();
/**
- * Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
+ * @brief Downcast a handle to CheckBoxButton handle.
+ *
+ * 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
*/
static CheckBoxButton DownCast( BaseHandle handle );
- /**
- * 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 selected image.
- *
- * @param[in] image The selected image.
- */
- void SetSelectedImage( Image image );
-
- /**
- * @copydoc SetSelectedImage( Image image )
- */
- void SetSelectedImage( Actor image );
-
- /**
- * Gets the selected image.
- * @return An actor with the selected image.
- */
- Actor GetSelectedImage() 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 selected image.
- *
- * @param[in] image The disabled selected image.
- */
- void SetDisabledSelectedImage( Image image );
-
- /**
- * @copydoc SetDisabledSelectedImage( Image image )
- */
- void SetDisabledSelectedImage( Actor image );
-
- /**
- * Gets the disabled selected image.
- * @return An actor with the disabled selected image.
- */
- Actor GetDisabledSelectedImage() const;
-
public: // Not intended for application developers
+ /// @cond internal
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @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.
*/
DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
+ /// @endcond
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff