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  */
  60 class DALI_IMPORT_API RadioButton: public Button
  61 {
  62  public:
  63   /**
  64    * @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New().
  65    *
  66    * Calling member functions with an uninitialized Dali::Object is not allowed.
  67    */
  68   RadioButton();
  69
  70   /**
  71    * @brief Copy constructor.
  72    */
  73   RadioButton( const RadioButton& radioButton );
  74
  75   /**
  76    * @brief Assignment operator.
  77    */
  78   RadioButton& operator=( const RadioButton& radioButton );
  79
  80   /**
  81    * @brief Destructor
  82    *
  83    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  84    */
  85   ~RadioButton();
  86
  87   /**
  88    * @brief Create an initialized RadioButton.
  89    *
  90    * @return A handle to a newly allocated Dali resource.
  91    */
  92   static RadioButton New();
  93
  94   /**
  95    * @brief Create an initialized RadioButton with given label.
  96    *
  97    * @param[in] label The button label.
  98    *
  99    * @return A handle to a newly allocated Dali resource.
 100    */
 101   static RadioButton New( const std::string& label );
 102
 103   /**
 104    * @brief Downcast an Object handle to RadioButton.
 105    *
 106    * If handle points to a RadioButton the downcast produces valid
 107    * handle. If not the returned handle is left uninitialized.
 108    *
 109    * @param[in] handle Handle to an object
 110    * @return handle to a RadioButton or an uninitialized handle
 111    */
 112   static RadioButton DownCast( BaseHandle handle );
 113
 114  public: // Not intended for application developers
 115
 116   /**
 117    * @brief Creates a handle using the Toolkit::Internal implementation.
 118    *
 119    * @param[in]  implementation  The Control implementation.
 120    */
 121   DALI_INTERNAL RadioButton( Internal::RadioButton& implementation );
 122
 123   /**
 124    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 125    *
 126    * @param[in]  internal  A pointer to the internal CustomActor.
 127    */
 128   DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
 129 };
 130
 131 /**
 132  * @}
 133  */
 134 } // namespace Toolkit
 135
 136 } // namespace Dali
 137
 138 #endif // __DALI_TOOLKIT_RADIO_BUTTON_H__