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 namespace Tizen.NUI.UIComponents
  19 {
  20
  21     /// <summary>
  22     /// The CheckBoxButton provides a checkbox button which the user can check or uncheck.<br />
  23     /// By default, the CheckBoxButton emits a Button.Clicked event when the button changes its state to selected or unselected.<br />
  24     /// The button's appearance could be modified by Button.UnselectedImage, Button.BackgroundImage, Button.SelectedImage, Button.SelectedBackgroundImage, Button.DisabledBackgroundImage, Button.DisabledImage, and Button.DisabledSelectedImage.<br />
  25     /// When the button is not disabled, if it's not selected, it only shows the background image.<br />
  26     /// The selected image is shown over the background image when the box is selected (background image is not replaced by \e selected image).<br />
  27     /// When the button is disabled, the background image and the selected image are replaced by disabled images.<br />
  28     /// /// </summary>
  29     /// <since_tizen> 3 </since_tizen>
  30     public class CheckBoxButton : Button
  31     {
  32         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  33
  34         internal CheckBoxButton(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.CheckBoxButton_SWIGUpcast(cPtr), cMemoryOwn)
  35         {
  36             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  37         }
  38
  39         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(CheckBoxButton obj)
  40         {
  41             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  42         }
  43
  44
  45         /// <summary>
  46         /// To dispose the CheckBoxButton instance.
  47         /// </summary>
  48         /// <since_tizen> 3 </since_tizen>
  49         protected override void Dispose(DisposeTypes type)
  50         {
  51             if (disposed)
  52             {
  53                 return;
  54             }
  55
  56             if(type == DisposeTypes.Explicit)
  57             {
  58                 //Called by User
  59                 //Release your own managed resources here.
  60                 //You should release all of your own disposable objects here.
  61             }
  62
  63             //Release your own unmanaged resources here.
  64             //You should not access any managed member here except static instance.
  65             //because the execution order of Finalizes is non-deterministic.
  66
  67             if (swigCPtr.Handle != global::System.IntPtr.Zero)
  68             {
  69                 if (swigCMemOwn)
  70                 {
  71                     swigCMemOwn = false;
  72                     NDalicPINVOKE.delete_CheckBoxButton(swigCPtr);
  73                 }
  74                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
  75             }
  76
  77             base.Dispose(type);
  78         }
  79
  80         /// <summary>
  81         /// Creates an initialized CheckBoxButton.
  82         /// </summary>
  83         /// <since_tizen> 3 </since_tizen>
  84         public CheckBoxButton() : this(NDalicPINVOKE.CheckBoxButton_New(), true)
  85         {
  86             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  87
  88         }
  89
  90     }
  91
  92 }