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 Button::SetUnselectedImage, Button::SetBackgroundImage,
  47  * Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
  48  * Button::SetDisabledImage, and Button::SetDisabledSelectedImage.
  49  *
  50  * 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
  51  * \e background image when the box is selected (\e background image is not replaced by \e selected image).
  52  *
  53  * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.
  54  *
  55  * @SINCE_1_0.0
  56  */
  57 class DALI_IMPORT_API CheckBoxButton : public Button
  58 {
  59 public:
  60
  61   /**
  62    * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
  63    * Calling member functions with an uninitialized Dali::Object is not allowed.
  64    * @SINCE_1_0.0
  65    */
  66   CheckBoxButton();
  67
  68   /**
  69    * @brief Copy constructor.
  70    * @SINCE_1_0.0
  71    */
  72   CheckBoxButton( const CheckBoxButton& checkBox );
  73
  74   /**
  75    * @brief Assignment operator.
  76    * @SINCE_1_0.0
  77    */
  78   CheckBoxButton& operator=( const CheckBoxButton& checkBox );
  79
  80   /**
  81    * @brief Destructor
  82    *
  83    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  84    * @SINCE_1_0.0
  85    */
  86   ~CheckBoxButton();
  87
  88   /**
  89    * @brief Create an initialized CheckBoxButton.
  90    * @SINCE_1_0.0
  91    * @return A handle to a newly allocated Dali resource.
  92    */
  93   static CheckBoxButton New();
  94
  95   /**
  96    * @brief Downcast a handle to CheckBoxButton handle.
  97    *
  98    * If handle points to a CheckBoxButton the
  99    * downcast produces valid handle. If not the returned handle is left uninitialized.
 100    * @SINCE_1_0.0
 101    * @param[in] handle Handle to an object
 102    * @return handle to a CheckBoxButton or an uninitialized handle
 103    */
 104   static CheckBoxButton DownCast( BaseHandle handle );
 105
 106 public: // Not intended for application developers
 107
 108   /// @cond internal
 109   /**
 110    * @brief Creates a handle using the Toolkit::Internal implementation.
 111    * @SINCE_1_0.0
 112    * @param[in]  implementation  The Control implementation.
 113    */
 114   DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
 115
 116   /**
 117    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 118    * @SINCE_1_0.0
 119    * @param[in]  internal  A pointer to the internal CustomActor.
 120    */
 121   DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
 122   /// @endcond
 123 };
 124
 125 /**
 126  * @}
 127  */
 128 } // namespace Toolkit
 129
 130 } // namespace Dali
 131
 132 #endif // __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__