#ifndef __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
#define __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
// INTERNAL INCLUDES
#include <dali-toolkit/public-api/controls/buttons/button.h>
-namespace Dali DALI_IMPORT_API
+namespace Dali
{
namespace Toolkit
* 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:
/**
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.
/**
* 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.
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
* 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