dali-toolkit/public-api/controls/buttons/radio-button.h

   1 #ifndef __DALI_TOOLKIT_RADIO_BUTTON_H__
   2 #define __DALI_TOOLKIT_RADIO_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 "button.h"
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 // Forward declarations
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 // Forward declarations
  35
  36 class RadioButton;
  37 }
  38 /**
  39  * @addtogroup dali_toolkit_controls_buttons
  40  * @{
  41  */
  42
  43 /**
  44  * @brief A RadioButton provides a radio button which two states \e selected or \e unselected.
  45  *
  46  * Radio buttons are designed to select one of many option at the same time.
  47  *
  48  * Every button have its own \e label and \e state, which can be modified by RadioButton::SetLabel and Button::SetSelected.
  49  *
  50  * RadioButton can change its current state using Button::SetSelected.
  51  *
  52  * RadioButtons can be grouped.
  53  * Two or more RadioButtons are in one group when they have this same parent.
  54  * In each groups only one RadioButton can be \e selected at a given time.
  55  * So when RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected.
  56  * When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected.
  57  *
  58  * A Button::StateChangedSignal() is emitted when the RadioButton change its state to \e selected or \e unselected.
  59  * @SINCE_1_0.0
  60  */
  61 class DALI_IMPORT_API RadioButton: public Button
  62 {
  63  public:
  64   /**
  65    * @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New().
  66    *
  67    * Calling member functions with an uninitialized Dali::Object is not allowed.
  68    * @SINCE_1_0.0
  69    */
  70   RadioButton();
  71
  72   /**
  73    * @brief Copy constructor.
  74    * @SINCE_1_0.0
  75    */
  76   RadioButton( const RadioButton& radioButton );
  77
  78   /**
  79    * @brief Assignment operator.
  80    * @SINCE_1_0.0
  81    */
  82   RadioButton& operator=( const RadioButton& radioButton );
  83
  84   /**
  85    * @brief Destructor
  86    *
  87    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  88    * @SINCE_1_0.0
  89    */
  90   ~RadioButton();
  91
  92   /**
  93    * @brief Create an initialized RadioButton.
  94    *
  95    * @SINCE_1_0.0
  96    * @return A handle to a newly allocated Dali resource.
  97    */
  98   static RadioButton New();
  99
 100   /**
 101    * @brief Create an initialized RadioButton with given label.
 102    *
 103    * @SINCE_1_0.0
 104    * @param[in] label The button label.
 105    *
 106    * @return A handle to a newly allocated Dali resource.
 107    */
 108   static RadioButton New( const std::string& label );
 109
 110   /**
 111    * @brief Downcast an Object handle to RadioButton.
 112    *
 113    * If handle points to a RadioButton the downcast produces valid
 114    * handle. If not the returned handle is left uninitialized.
 115    *
 116    * @SINCE_1_0.0
 117    * @param[in] handle Handle to an object
 118    * @return handle to a RadioButton or an uninitialized handle
 119    */
 120   static RadioButton DownCast( BaseHandle handle );
 121
 122  public: // Not intended for application developers
 123
 124   /**
 125    * @brief Creates a handle using the Toolkit::Internal implementation.
 126    *
 127    * @SINCE_1_0.0
 128    * @param[in]  implementation  The Control implementation.
 129    */
 130   DALI_INTERNAL RadioButton( Internal::RadioButton& implementation );
 131
 132   /**
 133    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 134    *
 135    * @SINCE_1_0.0
 136    * @param[in]  internal  A pointer to the internal CustomActor.
 137    */
 138   DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
 139 };
 140
 141 /**
 142  * @}
 143  */
 144 } // namespace Toolkit
 145
 146 } // namespace Dali
 147
 148 #endif // __DALI_TOOLKIT_RADIO_BUTTON_H__