src/Tizen.NUI/src/public/UIComponents/CheckBoxButton.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     /// The CheckBoxButton provides a checkbox button which the user can check or uncheck.<br />
  25     /// By default, the CheckBoxButton emits a Button.Clicked event when the button changes its state to selected or unselected.<br />
  26     /// The button's appearance could be modified by Button.UnselectedImage, Button.BackgroundImage, Button.SelectedImage, Button.SelectedBackgroundImage, Button.DisabledBackgroundImage, Button.DisabledImage, and Button.DisabledSelectedImage.<br />
  27     /// When the button is not disabled, if it's not selected, it only shows the background image.<br />
  28     /// The selected image is shown over the background image when the box is selected (background image is not replaced by \e selected image).<br />
  29     /// When the button is disabled, the background image and the selected image are replaced by disabled images.<br />
  30     /// /// </summary>
  31     /// <since_tizen> 3 </since_tizen>
  32     /// This will be deprecated
  33     [Obsolete("Deprecated in API6; Will be removed in API9. Please use Tizen.NUI.Components")]
  34     [EditorBrowsable(EditorBrowsableState.Never)]
  35     public class CheckBoxButton : Button
  36     {
  37
  38         /// <summary>
  39         /// Creates an initialized CheckBoxButton.
  40         /// </summary>
  41         /// <since_tizen> 3 </since_tizen>
  42         /// This will be deprecated
  43         [Obsolete("Deprecated in API6; Will be removed in API9. Please use Tizen.NUI.Components")]
  44         [EditorBrowsable(EditorBrowsableState.Never)]
  45         public CheckBoxButton() : this(Interop.CheckBoxButton.CheckBoxButton_New(), true)
  46         {
  47             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  48         }
  49
  50         internal CheckBoxButton(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.CheckBoxButton.CheckBoxButton_SWIGUpcast(cPtr), cMemoryOwn)
  51         {
  52         }
  53
  54         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(CheckBoxButton obj)
  55         {
  56             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  57         }
  58
  59         /// This will not be public opened.
  60         [EditorBrowsable(EditorBrowsableState.Never)]
  61         protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
  62         {
  63             Interop.CheckBoxButton.delete_CheckBoxButton(swigCPtr);
  64         }
  65     }
  66 }