namespace Tizen.NUI
{
+ /// <summary>
+ /// CustomView provides some common functionality required by all views.
+ /// </summary>
public class CustomView : ViewWrapper
{
public CustomView(string typeName, CustomViewBehaviour behaviour) : base(typeName, new ViewWrapperImpl(behaviour))
SetStyleName(this.GetType().Name);
}
- /**
- * @brief Set the background with a property map.
- *
- * @param[in] map The background property map.
- */
+ /// <summary>
+ /// Set the background with a property map.
+ /// </summary>
+ /// <param name="map">The background property map</param>
public void SetBackground(Tizen.NUI.PropertyMap map)
{
viewWrapperImpl.SetBackground(map);
viewWrapperImpl.DisableGestureDetection(type);
}
- /**
- * @brief Sets whether this control supports two dimensional
- * keyboard navigation (i.e. whether it knows how to handle the
- * keyboard focus movement between its child actors).
- *
- * The control doesn't support it by default.
- * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
- */
-
+ /// <summary>
+ /// Sets whether this control supports two dimensional keyboard navigation
+ /// (i.e. whether it knows how to handle the keyboard focus movement between its child actors).
+ /// The control doesn't support it by default.
+ /// </summary>
+ /// <param name="isSupported">Whether this control supports two dimensional keyboard navigation.</param>
public bool FocusNavigationSupport
{
get
}
+ /// <summary>
+ /// Sets or Gets whether this control is a focus group for keyboard navigation.
+ /// </summary>
+ /// <returns>true if this control is set as a focus group for keyboard navigation</returns>
public bool FocusGroup
{
get
viewWrapperImpl.AccessibilityActivate();
}
- /**
- * @brief Called by the KeyboardFocusManager.
- */
+ /// <summary>
+ /// Called by the KeyboardFocusManager.
+ /// </summary>
public void KeyboardEnter()
{
viewWrapperImpl.KeyboardEnter();
}
- /**
- * @brief Called by the KeyInputFocusManager to emit key event signals.
- *
- * @param[in] key The key event.
- * @return True if the event was consumed.
- */
+ /// <summary>
+ /// Called by the KeyInputFocusManager to emit key event signals.
+ /// </summary>
+ /// <param name="key">The key event</param>
+ /// <returns>True if the event was consumed</returns>
public bool EmitKeyEventSignal(Key key)
{
return viewWrapperImpl.EmitKeyEventSignal(key);
namespace Tizen.NUI
{
+ /// <summary>
+ /// An angle in degrees.
+ /// This reduces ambiguity when using methods which accept angles in degrees or radians.
+ /// </summary>
public class Degree : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
public Degree() : this(NDalicPINVOKE.new_Degree__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Creates an angle in degrees.
+ /// </summary>
+ /// <param name="value">The initial value in degrees</param>
public Degree(float value) : this(NDalicPINVOKE.new_Degree__SWIG_1(value), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Creates an angle in degrees from a Radian.
+ /// </summary>
+ /// <param name="value">The initial value in Radians</param>
public Degree(Radian value) : this(NDalicPINVOKE.new_Degree__SWIG_2(Radian.getCPtr(value)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Enumeration for the instance of child properties belonging to the FlexContainer class.
+ /// </summary>
public class ChildProperty : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
+ /// <summary>
+ /// Creates a FlexContainer handle.
+ /// Calling member functions with an uninitialized handle is not allowed.
+ /// </summary>
public FlexContainer() : this(NDalicPINVOKE.FlexContainer_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
RowReverse
}
+ /// <summary>
+ /// Enumeration for the primary direction in which content is ordered in the flex container
+ /// and on which sides the ?\9cstart??and ?\9cend??are.
+ /// </summary>
public enum ContentDirectionType
{
Inherit,
namespace Tizen.NUI
{
+ /// <summary>
+ /// Base structure for different gestures that an application can receive.
+ /// A gesture is an event that is produced from a combination of several touch events
+ /// in a particular order or within a certain time frame (e.g pinch).
+ /// </summary>
public class Gesture : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
+ /// <summary>
+ /// The gesture type.
+ /// </summary>
public Gesture.GestureType Type
{
get
}
}
+ /// <summary>
+ /// The gesture state.
+ /// </summary>
public Gesture.StateType State
{
get
}
}
+ /// <summary>
+ /// The time the gesture took place.
+ /// </summary>
public uint Time
{
get
}
}
+ /// <summary>
+ /// Copy constructor.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle</param>
public Gesture(Gesture rhs) : this(NDalicPINVOKE.new_Gesture(Gesture.getCPtr(rhs)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Assignment operator.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle</param>
+ /// <returns>A reference to this</returns>
public Gesture Assign(Gesture rhs)
{
Gesture ret = new Gesture(NDalicPINVOKE.Gesture_Assign(swigCPtr, Gesture.getCPtr(rhs)), false);
}
}
+ /// <summary>
+ /// Enumeration for type of gesture
+ /// </summary>
public enum GestureType
{
Pinch = 1 << 0,
LongPress = 1 << 3
}
+ /// <summary>
+ /// Enumeration for state of the gesture.
+ /// </summary>
public enum StateType
{
Clear,
namespace Tizen.NUI
{
+ /// <summary>
+ /// Hover events are a collection of points at a specific moment in time.
+ /// When a multi event occurs, each point represents the points that are currently being
+ /// hovered or the points where a hover has stopped.
+ /// </summary>
public class Hover : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return ret;
}
+ /// <summary>
+ /// The time (in ms) that the hover event occurred.
+ /// </summary>
public uint Time
{
get
}
}
+ /// <summary>
+ /// Returns the ID of the device used for the Point specified.
+ /// Each point has a unique device ID which specifies the device used for that
+ /// point. This is returned by this method.
+ /// </summary>
+ /// <param name="point">The point required</param>
+ /// <returns>The Device ID of this poin</returns>
public int GetDeviceId(uint point)
{
if (point < points.Count)
return -1;
}
+ /// <summary>
+ /// Retrieves the State of the point specified.
+ /// </summary>
+ /// <param name="point">The point required</param>
+ /// <returns>The state of the point specified</returns>
public PointStateType GetState(uint point)
{
if (point < points.Count)
return PointStateType.Finished;
}
+ /// <summary>
+ /// Retrieves the actor that was underneath the point specified.
+ /// </summary>
+ /// <param name="point">The point required</param>
+ /// <returns>The actor that was underneath the point specified</returns>
public Actor GetHitActor(uint point)
{
if (point < points.Count)
}
}
+ /// <summary>
+ /// Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified.
+ /// </summary>
+ /// <param name="point">The point required</param>
+ /// <returns>The co-ordinates relative to the top-left of the hit-actor of the point specified</returns>
public Vector2 GetLocalPosition(uint point)
{
if (point < points.Count)
return new Vector2(0.0f, 0.0f);
}
+ /// <summary>
+ /// Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
+ /// </summary>
+ /// <param name="point">The point required</param>
+ /// <returns>The co-ordinates relative to the top-left of the screen of the point specified</returns>
public Vector2 GetScreenPosition(uint point)
{
if (point < points.Count)
return new Vector2(0.0f, 0.0f);
}
+ /// <summary>
+ /// Default constructor.
+ /// </summary>
public Hover() : this(NDalicPINVOKE.new_Hover__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <param name="time">The time the event occurred</param>
public Hover(uint time) : this(NDalicPINVOKE.new_Hover__SWIG_1(time), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
}
+ /// <summary>
+ /// Returns the total number of points.
+ /// </summary>
+ /// <returns>Total number of Points</returns>
public uint GetPointCount()
{
uint ret = NDalicPINVOKE.Hover_GetPointCount(swigCPtr);
namespace Tizen.NUI
{
+ /// <summary>
+ /// ImageView is a class for displaying an image resource.
+ /// An instance of ImageView can be created using a URL or an Image instance.
+ /// </summary>
public class ImageView : View
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
+ /// <summary>
+ /// Creates an initialized ImageView.
+ /// </summary>
public ImageView() : this(NDalicPINVOKE.ImageView_New__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Creates an initialized ImageView from an URL to an image resource.
+ /// If the string is empty, ImageView will not display anything.
+ /// </summary>
+ /// <param name="url">The url of the image resource to display</param>
public ImageView(string url) : this(NDalicPINVOKE.ImageView_New__SWIG_2(url), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Downcasts a handle to ImageView handle.
+ /// If handle points to a ImageView, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
+ /// </summary>
+ /// <param name="handle">Handle to an object</param>
+ /// <returns>Handle to a ImageView or an uninitialized handle</returns>
public new static ImageView DownCast(BaseHandle handle)
{
ImageView ret = new ImageView(NDalicPINVOKE.ImageView_DownCast(BaseHandle.getCPtr(handle)), true);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Sets this ImageView from the given URL.
+ /// If the URL is empty, ImageView will not display anything.
+ /// </summary>
+ /// <param name="url">The URL to the image resource to display</param>
public void SetImage(string url)
{
NDalicPINVOKE.ImageView_SetImage__SWIG_1(swigCPtr, url);
ANIMATABLE_PROPERTY_END_INDEX = PropertyRanges.ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000
}
+ /// <summary>
+ /// ImageView ResourceUrl, type string
+ /// </summary>
public string ResourceUrl
{
get
SetProperty(ImageView.Property.RESOURCE_URL, new Tizen.NUI.PropertyValue(value));
}
}
+ /// <summary>
+ /// ImageView ImageMap, type PropertyMap : string if it is a url, map otherwise
+ /// </summary>
public PropertyMap ImageMap
{
get
SetProperty(ImageView.Property.IMAGE, new Tizen.NUI.PropertyValue(value));
}
}
+ /// <summary>
+ /// ImageView PreMultipliedAlpha, type Boolean
+ /// Image must be initialized.
+ /// </summary>
public bool PreMultipliedAlpha
{
get
SetProperty(ImageView.Property.PRE_MULTIPLIED_ALPHA, new Tizen.NUI.PropertyValue(value));
}
}
+ /// <summary>
+ /// ImageView PixelArea, type Vector4 (Animatable property)
+ /// Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
+ /// </summary>
public Vector4 PixelArea
{
get
namespace Tizen.NUI
{
+ /// <summary>
+ /// The key structure is used to store a key press.
+ /// </summary>
public class Key : global::System.IDisposable
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return ret;
}
+ /// <summary>
+ /// Name given to the key pressed
+ /// </summary>
public string KeyPressedName
{
get
}
*/
+ /// <summary>
+ /// Keycode for the key pressed.
+ /// </summary>
public int KeyCode
{
get
}
}
+ /// <summary>
+ /// Special keys like shift, alt and control which modify the next key pressed.
+ /// </summary>
public int KeyModifier
{
get
}
}
+ /// <summary>
+ /// The time (in ms) that the key event occurred.
+ /// </summary>
public uint Time
{
get
}
}
+ /// <summary>
+ /// State of the key event.
+ /// </summary>
public Key.StateType State
{
get
}
}
+ /// <summary>
+ /// Default Constructor.
+ /// </summary>
public Key() : this(NDalicPINVOKE.new_Key__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <param name="keyName">The name of the key pressed or command from the IMF, if later then the some following parameters will be needed</param>
+ /// <param name="keyString">A string of input characters or key pressed</param>
+ /// <param name="keyCode">The unique key code for the key pressed</param>
+ /// <param name="keyModifier">The key modifier for special keys like shift and alt</param>
+ /// <param name="timeStamp">The time (in ms) that the key event occurred</param>
+ /// <param name="keyState">The state of the key event</param>
public Key(string keyName, string keyString, int keyCode, int keyModifier, uint timeStamp, Key.StateType keyState) : this(NDalicPINVOKE.new_Key__SWIG_1(keyName, keyString, keyCode, keyModifier, timeStamp, (int)keyState), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Checks to see if Shift key modifier has been supplied.
+ /// </summary>
+ /// <returns>True if shift modifier</returns>
public bool IsShiftModifier()
{
bool ret = NDalicPINVOKE.Key_IsShiftModifier(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Checks to see if Ctrl (control) key modifier has been supplied.
+ /// </summary>
+ /// <returns>True if ctrl modifier</returns>
public bool IsCtrlModifier()
{
bool ret = NDalicPINVOKE.Key_IsCtrlModifier(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Checks to see if Alt key modifier has been supplied.
+ /// </summary>
+ /// <returns>True if alt modifier</returns>
public bool IsAltModifier()
{
bool ret = NDalicPINVOKE.Key_IsAltModifier(swigCPtr);
}
}
+ /// <summary>
+ /// Enumeration for specifying the state of the key event.
+ /// </summary>
public enum StateType
{
Down,
namespace Tizen.NUI
{
+ /// <summary>
+ /// A set of key frames for a property that can be animated using Dali Animation.
+ /// This allows the generation of key frame objects from individual Property::Values.
+ /// </summary>
public class KeyFrames : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
+ /// <summary>
+ /// Adds a key frame.
+ /// </summary>
+ /// <param name="progress">A progress value between 0.0 and 1.0</param>
+ /// <param name="value">A value</param>
public void Add(float progress, object value)
{
dynamic obj = value;
Add(progress, new PropertyValue(obj));
}
+ /// <summary>
+ /// Adds a key frame.
+ /// </summary>
+ /// <param name="progress">A progress value between 0.0 and 1.0</param>
+ /// <param name="value">A value</param>
+ /// <param name="alpha">The alpha function used to blend to the next keyframe</param>
public void Add(float progress, object value, AlphaFunction alpha)
{
dynamic obj = value;
Add(progress, new PropertyValue(obj), alpha);
}
-
+ /// <summary>
+ /// Creates an initialized KeyFrames handle.
+ /// </summary>
public KeyFrames() : this(NDalicPINVOKE.KeyFrames_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Downcasts a handle to KeyFrames handle.
+ /// If handle points to a KeyFrames object, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
+ /// </summary>
+ /// <param name="handle">Handle to an object</param>
+ /// <returns>Handle to a KeyFrames object or an uninitialized handle</returns>
public static KeyFrames DownCast(BaseHandle handle)
{
KeyFrames ret = new KeyFrames(NDalicPINVOKE.KeyFrames_DownCast(BaseHandle.getCPtr(handle)), true);
return ret;
}
+ /// <summary>
+ /// Gets the type of the key frame.
+ /// </summary>
+ /// <returns>The key frame property type</returns>
public PropertyType GetType()
{
PropertyType ret = (PropertyType)NDalicPINVOKE.KeyFrames_GetType(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Adds a key frame.
+ /// </summary>
+ /// <param name="progress">A progress value between 0.0 and 1.0</param>
+ /// <param name="value">A value</param>
public void Add(float progress, PropertyValue value)
{
NDalicPINVOKE.KeyFrames_Add__SWIG_0(swigCPtr, progress, PropertyValue.getCPtr(value));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Adds a key frame.
+ /// </summary>
+ /// <param name="progress">A progress value between 0.0 and 1.0</param>
+ /// <param name="value">A value</param>
+ /// <param name="alpha">The alpha function used to blend to the next keyframe</param>
public void Add(float progress, PropertyValue value, AlphaFunction alpha)
{
NDalicPINVOKE.KeyFrames_Add__SWIG_1(swigCPtr, progress, PropertyValue.getCPtr(value), AlphaFunction.getCPtr(alpha));
namespace Tizen.NUI
{
+ /// <summary>
+ /// Layers provide a mechanism for overlaying groups of actors on top of each other.
+ /// </summary>
public class Layer : Actor
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
}
+ /// <summary>
+ /// Creates a Layer object.
+ /// </summary>
public Layer() : this(NDalicPINVOKE.Layer_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Downcasts a handle to Layer handle.
+ /// If handle points to a Layer, the downcast produces valid handle.
+ /// If not, the returned handle is left uninitialized.
+ /// </summary>
+ /// <param name="handle">Handle to an object</param>
+ /// <returns>Handle to a Layer or an uninitialized handle</returns>
public new static Layer DownCast(BaseHandle handle)
{
Layer ret = new Layer(NDalicPINVOKE.Layer_DownCast(BaseHandle.getCPtr(handle)), true);
return ret;
}
+ /// <summary>
+ /// Queries the depth of the layer.
+ /// 0 is the bottom most layer, higher number is on top.
+ /// </summary>
public uint Depth
{
get
return ret;
}
+ /// <summary>
+ /// Increments the depth of the layer.
+ /// </summary>
public void Raise()
{
NDalicPINVOKE.Layer_Raise(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Decrements the depth of the layer.
+ /// </summary>
public void Lower()
{
NDalicPINVOKE.Layer_Lower(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Raises the layer to the top.
+ /// </summary>
public void RaiseToTop()
{
NDalicPINVOKE.Layer_RaiseToTop(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Lowers the layer to the bottom.
+ /// </summary>
public void LowerToBottom()
{
NDalicPINVOKE.Layer_LowerToBottom(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Moves the layer directly above the given layer.
+ /// After the call, this layers depth will be immediately above target.
+ /// </summary>
+ /// <param name="target">Layer to get on top of</param>
public void MoveAbove(Layer target)
{
NDalicPINVOKE.Layer_MoveAbove(swigCPtr, Layer.getCPtr(target));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Moves the layer directly below the given layer
+ /// After the call, this layers depth will be immediately below target.
+ /// </summary>
+ /// <param name="target">Layer to get below of</param>
public void MoveBelow(Layer target)
{
NDalicPINVOKE.Layer_MoveBelow(swigCPtr, Layer.getCPtr(target));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the clipping box of a layer, in window coordinates.
+ /// The contents of the layer will not be visible outside this box, when clipping is
+ /// enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
+ /// </summary>
+ /// <param name="box">The clipping box</param>
public void SetClippingBox(Rectangle box)
{
NDalicPINVOKE.Layer_SetClippingBox__SWIG_1(swigCPtr, Rectangle.getCPtr(box));
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Retrieves the clipping box of a layer in window coordinates.
+ /// </summary>
+ /// <returns>The clipping box</returns>
public Rectangle GetClippingBox()
{
Rectangle ret = new Rectangle(NDalicPINVOKE.Layer_GetClippingBox(swigCPtr), true);
return ret;
}
+ /// <summary>
+ /// Enumeration for the behavior of the layer.
+ /// </summary>
public enum LayerBehavior
{
Layer2D,
TREE_DEPTH_MULTIPLIER = 10000
}
+ /// <summary>
+ /// Layer ClippingEnable, type bool
+ /// </summary>
public bool ClippingEnable
{
get
SetProperty(Layer.Property.CLIPPING_ENABLE, new Tizen.NUI.PropertyValue(value));
}
}
+ /// <summary>
+ /// Layer ClippingBox, type Rectangle
+ /// </summary>
public Rectangle ClippingBox
{
get
SetProperty(Layer.Property.CLIPPING_BOX, new Tizen.NUI.PropertyValue(value));
}
}
+ /// <summary>
+ /// Layer Behavior, type String(Layer.LayerBehavior)
+ /// </summary>
public Layer.LayerBehavior Behavior
{
get
namespace Tizen.NUI
{
+ /// <summary>
+ /// A LongPressGesture is emitted when the user holds the screen with the stated number of fingers.
+ /// Long press gesture finishes when all touches have been released.
+ /// </summary>
public class LongPressGesture : Gesture
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return ret;
}
+ /// <summary>
+ /// The number of touch points in this long press gesture, i.e. the number of fingers the user had
+ /// on the screen to generate the long press gesture.
+ /// </summary>
public uint NumberOfTouches
{
get
}
}
+ /// <summary>
+ /// This is the point, in screen coordinates, where the long press occurred.
+ /// If a multi-touch long press, then this is the centroid of all the touch points.
+ /// </summary>
public Vector2 ScreenPoint
{
get
}
}
+ /// <summary>
+ /// This is the point, in local actor coordinates, where the long press occurred.
+ /// If a multi-touch long press, then this is the centroid of all the touch points.
+ /// </summary>
public Vector2 LocalPoint
{
get
}
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <param name="state">The state of the gesture</param>
public LongPressGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_LongPressGesture__SWIG_0((int)state), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Copy constructor.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle</param>
public LongPressGesture(LongPressGesture rhs) : this(NDalicPINVOKE.new_LongPressGesture__SWIG_1(LongPressGesture.getCPtr(rhs)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Assignment operator.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle</param>
+ /// <returns>A reference to this</returns>
public LongPressGesture Assign(LongPressGesture rhs)
{
LongPressGesture ret = new LongPressGesture(NDalicPINVOKE.LongPressGesture_Assign(swigCPtr, LongPressGesture.getCPtr(rhs)), false);
namespace Tizen.NUI
{
+ /// <summary>
+ /// A PanGesture is emitted when the user moves one or more fingers in a particular direction.
+ /// A pan gesture will end in the following ways:
+ /// - User releases the primary finger (the first touch).
+ /// - User has more fingers on the screen than the maximum specified.
+ /// - User has less fingers on the screen than the minimum specified.
+ /// - Cancelled by the system.
+ /// A pan gesture will continue to be sent to the actor under than initial pan until it ends.
+ /// </summary>
public class PanGesture : Gesture
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return ret;
}
+ /// <summary>
+ /// The velocity at which the user is moving their fingers.
+ /// This is represented as a Vector2 and is the pixel movement per millisecond.
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
+ /// A positive y value shows that the user is panning downwards, a negative y values means upwards.
+ /// </summary>
public Vector2 Velocity
{
get
}
}
+ /// <summary>
+ /// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
+ /// if the gesture has just started, then the amount panned since the user touched the screen.
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
+ /// A positive y value shows that the user is panning downwards, a negative y value means upwards.
+ /// </summary>
public Vector2 Displacement
{
get
}
}
+ /// <summary>
+ /// This current touch position of the primary touch point in local actor coordinates.
+ /// </summary>
public Vector2 Position
{
get
}
}
+ /// <summary>
+ /// The velocity at which the user is moving their fingers.
+ /// This is represented as a Vector2 and is the pixel movement per millisecond.
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
+ /// A positive y value shows that the user is panning downwards, a negative y values means upwards.
+ /// This value represents the screen coordinates.
+ /// </summary>
public Vector2 ScreenVelocity
{
get
}
}
+ /// <summary>
+ /// This is a Vector2 showing how much the user has panned (dragged) since the last pan gesture or,
+ /// if the gesture has just started, then the amount panned since the user touched the screen.
+ /// A positive x value shows that the user is panning to the right, a negative x value means the opposite.
+ /// A positive y value shows that the user is panning downwards, a negative y value means upwards.
+ /// This value is in screen coordinates.
+ /// </summary>
public Vector2 ScreenDisplacement
{
get
}
}
+ /// <summary>
+ /// This current touch position of the primary touch point in screen coordinates.
+ /// </summary>
public Vector2 ScreenPosition
{
get
}
}
+ /// <summary>
+ /// The total number of fingers touching the screen in a pan gesture.
+ /// </summary>
public uint NumberOfTouches
{
get
}
}
+ /// <summary>
+ /// Default Constructor.
+ /// </summary>
public PanGesture() : this(NDalicPINVOKE.new_PanGesture__SWIG_0(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Constructor.
+ /// </summary>
+ /// <param name="state">The state of the gesture</param>
public PanGesture(Gesture.StateType state) : this(NDalicPINVOKE.new_PanGesture__SWIG_1((int)state), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Copy constructor.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle</param>
public PanGesture(PanGesture rhs) : this(NDalicPINVOKE.new_PanGesture__SWIG_2(PanGesture.getCPtr(rhs)), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Assignment operator.
+ /// </summary>
+ /// <param name="rhs">A reference to the copied handle</param>
+ /// <returns>A reference to this</returns>
public PanGesture Assign(PanGesture rhs)
{
PanGesture ret = new PanGesture(NDalicPINVOKE.PanGesture_Assign(swigCPtr, PanGesture.getCPtr(rhs)), false);
}
}
+ /// <summary>
+ /// Returns the speed at which the user is moving their fingers.
+ /// This is the pixel movement per millisecond.
+ /// </summary>
+ /// <returns>The speed of the pan (in pixels per millisecond)</returns>
public float GetSpeed()
{
float ret = NDalicPINVOKE.PanGesture_GetSpeed(swigCPtr);
return ret;
}
+ /// <summary>
+ /// This returns the distance the user has panned (dragged) since the last pan gesture or,
+ /// if the gesture has just started, then the distance moved since the user touched the screen.
+ /// This is always a positive value.
+ /// </summary>
+ /// <returns>The distance, as a float, a user's finger has panned</returns>
public float GetDistance()
{
float ret = NDalicPINVOKE.PanGesture_GetDistance(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Returns the speed at which the user is moving their fingers relative to screen coordinates.
+ /// This is the pixel movement per millisecond.
+ /// </summary>
+ /// <returns>The speed of the pan (in pixels per millisecond)</returns>
public float GetScreenSpeed()
{
float ret = NDalicPINVOKE.PanGesture_GetScreenSpeed(swigCPtr);
return ret;
}
+ /// <summary>
+ /// This returns the distance the user has panned (dragged) since the last pan gesture in screen
+ /// coordinates or, if the gesture has just started, then the distance in screen coordinates moved
+ /// since the user touched the screen.
+ /// This is always a positive value.
+ /// </summary>
+ /// <returns>The distance, as a float, a user's finger has panned</returns>
public float GetScreenDistance()
{
float ret = NDalicPINVOKE.PanGesture_GetScreenDistance(swigCPtr);
projects / platform / core / csapi / nui.git / commitdiff