src/Tizen.NUI/src/public/UIComponents/RadioButton.cs

   1 /*
   2  * Copyright(c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 using System;
  19 using System.ComponentModel;
  20
  21 namespace Tizen.NUI.UIComponents
  22 {
  23     /// <summary>
  24     /// A RadioButton provides a radio button with two states, \e selected or \e unselected.<br />
  25     /// Radio buttons are designed to select one of the many options at the same time.<br />
  26     /// A RadioButton can change its current state using the selected.<br />
  27     /// <br />
  28     /// RadioButtons can be grouped.<br />
  29     /// Two or more RadioButtons are in one group when they have this same parent.<br />
  30     /// In each groups only one RadioButton can be \e selected at a given time.<br />
  31     /// So when a RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected.<br />
  32     /// When \e selected RadioButton is set to \e unselected, no other RadioButtons in this group are set to \e selected.<br />
  33     /// <br />
  34     /// The StateChanged event is emitted when the RadioButton change its state to \e selected or \e unselected.<br />
  35     /// </summary>
  36     /// <since_tizen> 3 </since_tizen>
  37     /// This will be deprecated
  38     [Obsolete("Deprecated in API6; Will be removed in API9. Please use Tizen.NUI.Components")]
  39     [EditorBrowsable(EditorBrowsableState.Never)]
  40     public class RadioButton : Button
  41     {
  42
  43         /// <summary>
  44         /// Creates an uninitialized RadioButton.
  45         /// </summary>
  46         /// <since_tizen> 3 </since_tizen>
  47         /// This will be deprecated
  48         [Obsolete("Deprecated in API6; Will be removed in API9. Please use Tizen.NUI.Components")]
  49         [EditorBrowsable(EditorBrowsableState.Never)]
  50         public RadioButton() : this(Interop.RadioButton.New(), true)
  51         {
  52             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  53         }
  54
  55         /// <summary>
  56         /// Creates an uninitialized RadioButton with the label.
  57         /// </summary>
  58         /// <param name="label">The label text.</param>
  59         /// <since_tizen> 3 </since_tizen>
  60         /// This will be deprecated
  61         [Obsolete("Deprecated in API6; Will be removed in API9. Please use Tizen.NUI.Components")]
  62         [EditorBrowsable(EditorBrowsableState.Never)]
  63         public RadioButton(string label) : this(Interop.RadioButton.New(label), true)
  64         {
  65             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  66         }
  67
  68         internal RadioButton(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
  69         {
  70         }
  71
  72
  73         /// This will not be public opened.
  74         [EditorBrowsable(EditorBrowsableState.Never)]
  75         protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
  76         {
  77             Interop.RadioButton.DeleteRadioButton(swigCPtr);
  78         }
  79     }
  80 }