dali-toolkit/public-api/controls/buttons/check-box-button.h

   1 #ifndef __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
   2 #define __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/buttons/button.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 // Forward declarations
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class CheckBoxButton;
  35 }
  36 /**
  37  * @addtogroup dali_toolkit_controls_buttons
  38  * @{
  39  */
  40
  41 /**
  42  * @brief CheckBoxButton provides a check box button which user can check or uncheck.
  43  *
  44  * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
  45  *
  46  * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage,
  47  * CheckBoxButton::SetSelectedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledSelectedImage.
  48  *
  49  * 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
  50  * \e background image when the box is selected (\e background image is not replaced by \e selected image).
  51  *
  52  * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.
  53  *
  54  * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
  55  * and a CheckBoxButton could be used instead.
  56  * @SINCE_1_0.0
  57  */
  58 class DALI_IMPORT_API CheckBoxButton : public Button
  59 {
  60 public:
  61
  62   /**
  63    * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
  64    * Calling member functions with an uninitialized Dali::Object is not allowed.
  65    * @SINCE_1_0.0
  66    */
  67   CheckBoxButton();
  68
  69   /**
  70    * @brief Copy constructor.
  71    * @SINCE_1_0.0
  72    */
  73   CheckBoxButton( const CheckBoxButton& checkBox );
  74
  75   /**
  76    * @brief Assignment operator.
  77    * @SINCE_1_0.0
  78    */
  79   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
  80
  81   /**
  82    * @brief Destructor
  83    *
  84    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  85    * @SINCE_1_0.0
  86    */
  87   ~CheckBoxButton();
  88
  89   /**
  90    * @brief Create an initialized CheckBoxButton.
  91    * @SINCE_1_0.0
  92    * @return A handle to a newly allocated Dali resource.
  93    */
  94   static CheckBoxButton New();
  95
  96   /**
  97    * @brief Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
  98    * downcast produces valid handle. If not the returned handle is left uninitialized.
  99    * @SINCE_1_0.0
 100    * @param[in] handle Handle to an object
 101    * @return handle to a CheckBoxButton or an uninitialized handle
 102    */
 103   static CheckBoxButton DownCast( BaseHandle handle );
 104
 105 public: // Not intended for application developers
 106
 107   /**
 108    * @brief Creates a handle using the Toolkit::Internal implementation.
 109    * @SINCE_1_0.0
 110    * @param[in]  implementation  The Control implementation.
 111    */
 112   DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
 113
 114   /**
 115    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 116    * @SINCE_1_0.0
 117    * @param[in]  internal  A pointer to the internal CustomActor.
 118    */
 119   DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
 120 };
 121
 122 /**
 123  * @}
 124  */
 125 } // namespace Toolkit
 126
 127 } // namespace Dali
 128
 129 #endif // __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__