-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
using System;
using System.ComponentModel;
{
//"Please do not use! this will be deprecated"
+ /// <summary>
+ /// Simple class for passing around pairs of small unsigned integers.<br />
+ /// Use this for integer dimensions and points with limited range such as image
+ /// sizes and pixel coordinates where a pair of floating point numbers is
+ /// inefficient and illogical (i.e.the data is inherently integer).<br />
+ /// One of these can be passed in a single 32 bit integer register on
+ /// common architectures.<br />
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public class Uint16Pair : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>swigCMemOwn.</summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool swigCMemOwn;
internal Uint16Pair(global::System.IntPtr cPtr, bool cMemoryOwn)
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
- //A Flat to check if it is already disposed.
+ /// <summary>
+ /// A Flat to check if it is already disposed.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected bool disposed = false;
-
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
~Uint16Pair()
{
if (!isDisposeQueued)
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
//Throw excpetion if Dispose() is called in separate thread.
}
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected virtual void Dispose(DisposeTypes type)
{
if (disposed)
disposed = true;
}
-
+ /// <summary>
+ /// Less than comparison operator for storing in collections (not geometrically meaningful).
+ /// </summary>
+ /// <param name="arg1">A reference for comparison.</param>
+ /// <param name="arg2">A reference for comparison</param>
+ /// <return>True if arg1 less than arg2</return>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator <(Uint16Pair arg1, Uint16Pair arg2)
{
return arg1.LessThan(arg2);
}
+ /// <summary>
+ /// More than comparison operator for storing in collections (not geometrically meaningful).
+ /// </summary>
+ /// <param name="arg1">A reference for comparison.</param>
+ /// <param name="arg2">A reference for comparison</param>
+ /// <return>True if arg1 > arg2</return>
+ /// <since_tizen> 3 </since_tizen>
public static bool operator >(Uint16Pair arg1, Uint16Pair arg2)
{
return arg1.GreaterThan(arg2);
}
+ /// <summary>
+ /// Default constructor for the(0, 0) tuple.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair() : this(NDalicPINVOKE.new_Uint16Pair__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Default constructor for the(0, 0) tuple.
+ /// </summary>
+ /// <param name="width">The width or X dimension of the tuple. Make sure it is less than 65536.</param>
+ /// <param name="height">The height or Y dimension of the tuple.Make sure it is less than 65536.</param>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair(uint width, uint height) : this(NDalicPINVOKE.new_Uint16Pair__SWIG_1(width, height), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Constructor taking separate x and y (width and height) parameters.
+ /// </summary>
+ /// <param name="rhs">A reference to assign.</param>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair(Uint16Pair rhs) : this(NDalicPINVOKE.new_Uint16Pair__SWIG_2(Uint16Pair.getCPtr(rhs)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the width.
+ /// </summary>
+ /// <param name="width">The x dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetWidth(ushort width)
{
NDalicPINVOKE.Uint16Pair_SetWidth(swigCPtr, width);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the width.
+ /// </summary>
+ /// <return>
+ /// The x dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetWidth()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetWidth(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the height.
+ /// </summary>
+ /// <param name="height">The y dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetHeight(ushort height)
{
NDalicPINVOKE.Uint16Pair_SetHeight(swigCPtr, height);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the height.
+ /// </summary>
+ /// <return>
+ /// The y dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetHeight()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetHeight(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the x dimension.
+ /// </summary>
+ /// <param name="x">The x dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetX(ushort x)
{
NDalicPINVOKE.Uint16Pair_SetX(swigCPtr, x);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the x dimension.
+ /// </summary>
+ /// <return>
+ /// The x dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetX()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetX(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Sets the y dimension.
+ /// </summary>
+ /// <param name="y">The y dimension to be stored in this 2-tuple.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetY(ushort y)
{
NDalicPINVOKE.Uint16Pair_SetY(swigCPtr, y);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Get the y dimension.
+ /// </summary>
+ /// <return>
+ /// The y dimension stored in this 2-tuple.
+ /// </return>
+ /// <since_tizen> 3 </since_tizen>
public ushort GetY()
{
ushort ret = NDalicPINVOKE.Uint16Pair_GetY(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Constructor taking separate x and y (width and height) parameters.
+ /// </summary>
+ /// <param name="rhs">A reference to assign.</param>
+ /// <return>The created object.</return>
+ /// <since_tizen> 3 </since_tizen>
public Uint16Pair Assign(Uint16Pair rhs)
{
Uint16Pair ret = new Uint16Pair(NDalicPINVOKE.Uint16Pair_Assign(swigCPtr, Uint16Pair.getCPtr(rhs)), false);
projects / platform / core / csapi / tizenfx.git / blobdiff