X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=base%2Fdali-toolkit%2Fpublic-api%2Fcontrols%2Fbuttons%2Fcheck-box-button.h;h=e321ce42f85f00bf0cf95925ffeff868ef95cedb;hp=545d224cf45cfb738eb9f422a9368de12aab6ac4;hb=refs%2Ftags%2Fsubmit%2Ftizen%2F20150205.132635;hpb=d5e3ed5f5b1c8fdba3ae97ead8729620f54b3836 diff --git a/base/dali-toolkit/public-api/controls/buttons/check-box-button.h b/base/dali-toolkit/public-api/controls/buttons/check-box-button.h index 545d224..e321ce4 100644 --- a/base/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/base/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -21,7 +21,7 @@ // INTERNAL INCLUDES #include -namespace Dali DALI_IMPORT_API +namespace Dali { namespace Toolkit @@ -40,26 +40,22 @@ class CheckBoxButton; * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to checked or unchecked. * * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage, - * CheckBoxButton::SetCheckedImage, CheckBoxButton::SetDimmedBackgroundImage and CheckBoxButton::SetDimmedCheckedImage. + * CheckBoxButton::SetCheckedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledCheckedImage. * - * When the button is not dimmed, if it's not checked it only shows the \e background image. The \e checked image is shown over the + * When the button is not disabled, if it's not checked it only shows the \e background image. The \e checked image is shown over the * \e background image when the box is checked (\e background image is not replaced by \e checked image). * - * When the button is dimmed, \e background image and \e checked image are replaced by \e dimmed images. + * When the button is disabled, \e background image and \e checked 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. */ -class CheckBoxButton : public Button +class DALI_IMPORT_API CheckBoxButton : public Button { public: //Action Names static const char* const ACTION_CHECK_BOX_BUTTON_CLICK; - // Properties - static const std::string USE_FADE_ANIMATION_PROPERTY_NAME; - static const std::string USE_CHECK_ANIMATION_PROPERTY_NAME; - public: /** @@ -79,10 +75,11 @@ public: CheckBoxButton& operator=( const CheckBoxButton& checkBox ); /** - * Virtual destructor. - * Dali::Object derived classes typically do not contain member data. + * @brief Destructor + * + * This is non-virtual since derived Handle types must not contain data or virtual methods. */ - virtual ~CheckBoxButton(); + ~CheckBoxButton(); /** * Create an initialized CheckBoxButton. @@ -101,7 +98,7 @@ public: /** * Sets the button as checked or unchecked. * - * Emits a Button::ClickedSignal() signal if the checkbox is not dimmed and the new state, + * Emits a Button::ClickedSignal() signal if the checkbox is not disabled and the new state, * given in the \e checked param, is different than the previous one. * * @param[in] checked state. @@ -150,40 +147,40 @@ public: Actor GetCheckedImage() const; /** - * Sets the dimmed background image. + * Sets the disabled background image. * - * @param[in] image The dimmed background image. + * @param[in] image The disabled background image. */ - void SetDimmedBackgroundImage( Image image ); + void SetDisabledBackgroundImage( Image image ); /** - * @copydoc SetDimmedBackgroundImage( Image image ) + * @copydoc SetDisabledBackgroundImage( Image image ) */ - void SetDimmedBackgroundImage( Actor image ); + void SetDisabledBackgroundImage( Actor image ); /** - * Gets the dimmed background image. - * @return An actor with the dimmed background image. + * Gets the disabled background image. + * @return An actor with the disabled background image. */ - Actor GetDimmedBackgroundImage() const; + Actor GetDisabledBackgroundImage() const; /** - * Sets the dimmed checked image. + * Sets the disabled checked image. * - * @param[in] image The dimmed checked image. + * @param[in] image The disabled checked image. */ - void SetDimmedCheckedImage( Image image ); + void SetDisabledCheckedImage( Image image ); /** - * @copydoc SetDimmedCheckedImage( Image image ) + * @copydoc SetDisabledCheckedImage( Image image ) */ - void SetDimmedCheckedImage( Actor image ); + void SetDisabledCheckedImage( Actor image ); /** - * Gets the dimmed checked image. - * @return An actor with the dimmed checked image. + * Gets the disabled checked image. + * @return An actor with the disabled checked image. */ - Actor GetDimmedCheckedImage() const; + Actor GetDisabledCheckedImage() const; public: // Not intended for application developers @@ -191,13 +188,13 @@ public: // Not intended for application developers * Creates a handle using the Toolkit::Internal implementation. * @param[in] implementation The Control implementation. */ - CheckBoxButton( Internal::CheckBoxButton& implementation ); + DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation ); /** * Allows the creation of this Control from an Internal::CustomActor pointer. * @param[in] internal A pointer to the internal CustomActor. */ - CheckBoxButton( Dali::Internal::CustomActor* internal ); + DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal ); }; } // namespace Toolkit