public class BaseHandle : Element, global::System.IDisposable
{
/// <summary>
- /// Event which is occurred when a property is set
+ /// Event when a property is set.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
/// <summary>
/// Gets the the hash code of this baseHandle.
/// </summary>
- /// <returns>The Hash Code.</returns>
+ /// <returns>The hash code.</returns>
/// <since_tizen> 5 </since_tizen>
public override int GetHashCode()
{
if (type == DisposeTypes.Explicit)
{
- //Called by User
+ //Called by User.
//Release your own managed resources here.
//You should release all of your own disposable objects here.
}
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
+ //Because the execution order of Finalizes is non-deterministic.
if (swigCPtr.Handle != global::System.IntPtr.Zero)
{
private static readonly FontClient instance = FontClient.Get();
/// <summary>
- /// Gets the singleton of the FontClient object.
+ /// Gets the singleton pattern of the FontClient object.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public static FontClient Instance
/// Whether the given character is supported by the font.
/// </summary>
/// <param name="fontId">The id of the font.</param>
- /// <param name="character">The character.</param>
+ /// <param name="character">The character in a font.</param>
/// <returns>True if the character is supported by the font.</returns>
/// <since_tizen> 5 </since_tizen>
public bool IsCharacterSupportedByFont(uint fontId, uint character)
}
/// <summary>
- /// Find the default font for displaying a UTF-32 character.
+ /// Finds the default font for displaying a UTF-32 character.
/// </summary>
/// <param name="charcode">The character for which a font is needed.</param>
- /// <param name="requestedPointSize">The point size in 26.6 fractional points; the default point size is 12*64.</param>
+ /// <param name="requestedPointSize">The point size in 26.6 fractional points. The default point size is 12*64.</param>
/// <param name="preferColor">True if a color font is preferred.</param>
- /// <returns>A valid font identifier, or zero if the font does not exist.</returns>
+ /// <returns>A valid font identifier. Zero if the font does not exist.</returns>
/// <since_tizen> 5 </since_tizen>
public uint FindDefaultFont(uint charcode, uint requestedPointSize, bool preferColor)
{
/// Find the default font for displaying a UTF-32 character.
/// </summary>
/// <param name="charcode">The character for which a font is needed.</param>
- /// <param name="requestedPointSize">The point size in 26.6 fractional points; the default point size is 12*64.</param>
- /// <returns>A valid font identifier, or zero if the font does not exist.</returns>
+ /// <param name="requestedPointSize">The point size in 26.6 fractional points. The default point size is 12*64.</param>
+ /// <returns>A valid font identifier. Zero if the font does not exist.</returns>
/// <since_tizen> 5 </since_tizen>
public uint FindDefaultFont(uint charcode, uint requestedPointSize)
{
/// Find the default font for displaying a UTF-32 character.
/// </summary>
/// <param name="charcode">The character for which a font is needed.</param>
- /// <returns>A valid font identifier, or zero if the font does not exist.</returns>
+ /// <returns>A valid font identifier. Zero if the font does not exist.</returns>
/// <since_tizen> 5 </since_tizen>
public uint FindDefaultFont(uint charcode)
{
}
/// <summary>
- /// Retrieve the unique identifier for a font..
+ /// Retrieve the unique identifier for a font.
/// </summary>
/// <param name="path">The path to a font file.</param>
- /// <param name="requestedPointSize">The point size in 26.6 fractional points; the default point size is 12*64.</param>
+ /// <param name="requestedPointSize">The point size in 26.6 fractional points. The default point size is 12*64.</param>
/// <param name="faceIndex">The index of the font face.</param>
- /// <returns>A valid font identifier, or zero if the font does not exist.</returns>
+ /// <returns>A valid font identifier. Zero if the font does not exist.</returns>
/// <since_tizen> 5 </since_tizen>
public uint GetFontId(string path, uint requestedPointSize, uint faceIndex)
{
}
/// <summary>
- /// Retrieve the unique identifier for a font..
+ /// Retrieve the unique identifier for a font.
/// </summary>
/// <param name="path">The path to a font file.</param>
- /// <param name="requestedPointSize">The point size in 26.6 fractional points; the default point size is 12*64.</param>
- /// <returns>A valid font identifier, or zero if the font does not exist.</returns>
+ /// <param name="requestedPointSize">The point size in 26.6 fractional points. The default point size is 12*64.</param>
+ /// <returns>A valid font identifier. Zero if the font does not exist.</returns>
/// <since_tizen> 5 </since_tizen>
public uint GetFontId(string path, uint requestedPointSize)
{
}
/// <summary>
- /// Retrieve the unique identifier for a font..
+ /// Retrieve the unique identifier for a font.
/// </summary>
/// <param name="path">The path to a font file.</param>
- /// <returns>A valid font identifier, or zero if the font does not exist.</returns>
+ /// <returns>A valid font identifier. Zero if the font does not exist.</returns>
/// <since_tizen> 5 </since_tizen>
public uint GetFontId(string path)
{
/// <summary>
/// Check to see if a font is scalable.
/// </summary>
- /// <param name="path">Path The path to a font file.</param>
+ /// <param name="path">The path where the font file is located.</param>
/// <returns>True if scalable.</returns>
/// <since_tizen> 5 </since_tizen>
public bool IsScalable(string path)
}
/// <summary>
- /// Add custom fonts directory.
+ /// Adds custom fonts directory.
/// </summary>
/// <param name="path">Path to the fonts directory.</param>
/// <returns>True if the fonts can be added.</returns>
/// Loading an image.
/// </summary>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public class ImageLoading
{
/// <param name="orientationCorrection">Reorient the image to respect any orientation metadata in its header.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case loading failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
{
/// <param name="fittingMode">The method used to fit the shape of the image before loading to the shape defined by the size parameter.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case loading failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer LoadImageFromFile(string url, Size2D size, FittingModeType fittingMode)
{
/// <param name="size">The width and height to fit the loaded image to, 0.0 means whole image.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case loading failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer LoadImageFromFile(string url, Size2D size)
{
/// <param name="url">The URL of the image file to load.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case loading failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer LoadImageFromFile(string url)
{
/// Determine the size of an image that LoadImageFromFile will provide when given the same image loading parameters.
/// </summary>
/// <param name="filename">The name of the image.</param>
- /// <param name="size">The requested size for the image</param>
+ /// <param name="size">The requested size for the image.</param>
/// <param name="fittingMode">The method to use to map the source image to the desired dimensions.</param>
/// <param name="samplingMode">The image filter to use if the image needs to be downsampled to the requested size.</param>
- /// <param name="orientationCorrection">Whether to use image metadata to rotate or flip the image, e.g., from portrait to landscape.</param>
+ /// <param name="orientationCorrection">Whether to use image metadata to rotate or flip the image, for example, from portrait to landscape.</param>
/// <returns>Dimensions that image will have if it is loaded with given parameters.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
{
/// <param name="samplingMode">The image filter to use if the image needs to be downsampled to the requested size.</param>
/// <returns>Dimensions that image will have if it is loaded with given parameters.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode)
{
/// <param name="fittingMode">The method to use to map the source image to the desired dimensions.</param>
/// <returns>Dimensions that image will have if it is loaded with given parameters.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static Size2D GetClosestImageSize(string filename, Size2D size, FittingModeType fittingMode)
{
/// <param name="size">The requested size for the image</param>
/// <returns>Dimensions that image will have if it is loaded with given parameters.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static Size2D GetClosestImageSize(string filename, Size2D size)
{
/// <param name="filename">The name of the image.</param>
/// <returns>Dimensions that image will have if it is loaded with given parameters.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static Size2D GetClosestImageSize(string filename)
{
/// <param name="orientationCorrection">Reorient the image to respect any orientation metadata in its header.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode, bool orientationCorrection)
{
/// <param name="samplingMode">The filtering method used when sampling pixels from the input image while fitting it to desired size.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode, SamplingModeType samplingMode)
{
/// <param name="fittingMode">The method used to fit the shape of the image before loading to the shape defined by the size parameter.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size, FittingModeType fittingMode)
{
/// <param name="size">The width and height to fit the loaded image to, 0.0 means whole image.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer DownloadImageSynchronously(string url, Size2D size)
{
/// <param name="url">The URL of the image file to load.</param>
/// <returns>Handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelBuffer DownloadImageSynchronously(string url)
{
/// </summary>
/// <param name="size">The maximum texture size to set.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static void SetMaxTextureSize(uint size)
{
/// </summary>
/// <returns>The maximum texture size.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static uint GetMaxTextureSize()
{
}
/// <summary>
- /// Dispose
+ /// Dispose.
/// </summary>
/// <param name="type">Dispose Type</param>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Destroy the context of the IMF.<br/>
+ /// Destroys the context of the IMF.<br/>
/// </summary>
/// <since_tizen> 5 </since_tizen>
public void DestroyContext()
namespace Tizen.NUI
{
/// <summary>
- /// Specifically manages the input method framework which enables the virtual or hardware keyboards.
+ /// Specifically manages the input method framework (IMF) that enables the virtual or hardware keyboards.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public class InputMethodContext : BaseHandle
if (type == DisposeTypes.Explicit)
{
- //Called by User
+ //Called by User.
//Release your own managed resources here.
//You should release all of your own disposable objects here.
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
+ //Because the execution order of Finalizes is non-deterministic.
if (_keyboardTypeChangedEventCallback != null)
{
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, IntPtr.Zero) : obj.swigCPtr;
}
- //A Flag to check who called Dispose(). (By User or DisposeQueue)
+ //A flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
/// <summary>
- /// A Flat to check if it is already disposed.
+ /// A flag to check if it is already disposed.
/// </summary>
/// <since_tizen> 5 </since_tizen>
protected bool disposed = false;
if (type == DisposeTypes.Explicit)
{
- //Called by User
+ //Called by User.
//Release your own managed resources here.
//You should release all of your own disposable objects here.
//A Flag to check who called Dispose(). (By User or DisposeQueue)
private bool isDisposeQueued = false;
/// <summary>
- /// A Flat to check if it is already disposed.
+ /// A Flag to check if it is already disposed.
/// </summary>
/// <since_tizen> 5 </since_tizen>
protected bool disposed = false;
if (type == DisposeTypes.Explicit)
{
- //Called by User
+ //Called by User.
//Release your own managed resources here.
//You should release all of your own disposable objects here.
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
+ //Because the execution order of Finalizes is non-deterministic.
if (swigCPtr.Handle != IntPtr.Zero)
{
}
/// <summary>
- /// The current text string.
+ /// The current cursor position.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public int CursorPosition
}
/// <summary>
- /// Flags if preedit reset is required.
+ /// Flags if the pre-edit reset is required.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public bool PreeditResetRequired
}
/// <summary>
- /// Destroy the context of the IMF.<br/>
+ /// Destroys the context of the IMF.<br/>
/// </summary>
/// <since_tizen> 5 </since_tizen>
public void DestroyContext()
}
/// <summary>
- /// Destroy the context of the IMF.<br/>
+ /// Destroys the context of the IMF.<br/>
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// Please do not use! This will be deprecated, instead please USE Tizen.NUI.InputMethodContext.Instance.DestroyContext()!
/// <summary>
/// Activates the IMF.<br/>
- /// It means that the text editing is started somewhere.<br/>
- /// If the hardware keyboard isn't connected, then it will show the virtual keyboard.
+ /// It means that the text editing has started.<br/>
+ /// If the hardware keyboard is not connected, then it shows the virtual keyboard.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public void Activate()
/// <summary>
/// Deactivates the IMF.<br/>
- /// It means that the text editing is finished somewhere.
+ /// It means that the text editing is complete.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public void Deactivate()
}
/// <summary>
- /// Gets the restoration status which controls if the keyboard is restored after the focus is lost and then regained.<br/>
- /// If true, then the keyboard will be restored (activated) after focus is regained.
+ /// Gets the restoration status, which controls if the keyboard is restored after the focus is lost and then regained.<br/>
+ /// If true, then the keyboard will be restored (activated) after the focus is regained.
/// </summary>
/// <returns>The restoration status.</returns>
/// <since_tizen> 5 </since_tizen>
/// <summary>
/// Sets the status whether the IMF has to restore the keyboard after losing focus.
/// </summary>
- /// <param name="toggle">True means that keyboard should be restored after the focus is lost and regained.</param>
+ /// <param name="toggle">True means that keyboard must be restored after the focus is lost and regained.</param>
/// <since_tizen> 5 </since_tizen>
public void SetRestoreAfterFocusLost(bool toggle)
{
}
/// <summary>
- /// Sends a message reset to the preedit state or the IMF module.
+ /// Sends a message reset to the pre-edit state or the IMF module.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public new void Reset()
}
/// <summary>
- /// Notifies the IMF context that the cursor position has changed, required for features like auto-capitalization.
+ /// Notifies the IMF context that the cursor position has changed, required for features such as auto-capitalization.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public void NotifyCursorPosition()
}
/// <summary>
- /// Returns the text direction of the keyboard's current input language.
+ /// Returns the text direction of the current input language of the keyboard.
/// </summary>
/// <returns>The direction of the text.</returns>
/// <since_tizen> 5 </since_tizen>
/// The position is relative to whether the keyboard is visible or not.<br/>
/// If the keyboard is not visible, then the position will be off the screen.<br/>
/// If the keyboard is not being shown when this method is called, the keyboard is partially setup (IMFContext) to get/>
- /// the values then taken down. So ideally, GetInputMethodArea() should be called after Show().
+ /// the values then taken down. So ideally, GetInputMethodArea() must be called after Show().
/// </summary>
- /// <returns>Rectangle which is keyboard panel x, y, width, height.</returns>
+ /// <returns>Rectangle which is keyboard panel x, y, width, and height.</returns>
/// <since_tizen> 5 </since_tizen>
public Rectangle GetInputMethodArea()
{
}
/// <summary>
- /// Sets up the input-panel specific data.
+ /// Sets up the input panel specific data.
/// </summary>
/// <param name="text">The specific data to be set to the input panel.</param>
/// <since_tizen> 5 </since_tizen>
/// <summary>
/// Sets the return key on the input panel to be visible or invisible.<br/>
- /// The default is true.
+ /// The default value is true.
/// </summary>
/// <param name="visible">True if the return key is visible (enabled), false otherwise.</param>
/// <since_tizen> 5 </since_tizen>
/// <summary>
/// Gets the current language locale of the input panel.<br/>
- /// For example, en_US, en_GB, en_PH, fr_FR, ...
+ /// For example, en_US, en_GB, en_PH, fr_FR, and so on.
/// </summary>
/// <returns>The current language locale of the input panel.</returns>
/// <since_tizen> 5 </since_tizen>
}
/// <summary>
- /// Gets/Sets whether the IM context allow to use the text prediction.
+ /// Gets or sets whether the IM context allows to use the text prediction.
/// </summary>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// InputMethodContext event received event arguments.
+ /// InputMethodContext event receives event arguments.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public class EventReceivedEventArgs : EventArgs
}
/// <summary>
- /// EventData
+ /// EventData.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public EventData EventData
public class StatusChangedEventArgs : EventArgs
{
/// <summary>
- /// InputMethodContext status
+ /// InputMethodContext status.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public bool StatusChanged
}
/// <summary>
- /// InputMethodContext resized event.
+ /// InputMethodContext resized event arguments.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public class ResizedEventArgs : EventArgs
}
/// <summary>
- /// InputMethodContext language changed event args.
+ /// InputMethodContext language changed event arguments.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public class LanguageChangedEventArgs : EventArgs
{
/// <summary>
- /// language changed.
+ /// Language changed.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public int LanguageChanged
public class KeyboardTypeChangedEventArgs : EventArgs
{
/// <summary>
- /// InputMethodContext keyboard type
+ /// InputMethodContext keyboard type.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public KeyboardType KeyboardType
/// <since_tizen> 5 </since_tizen>
Void,
/// <summary>
- /// Pre-Edit changed.
+ /// Pre-edit changed.
/// </summary>
/// <since_tizen> 5 </since_tizen>
Preedit,
private LongPressGesture _longPressGesture;
/// <summary>
- /// View - the attached view.
+ /// View the attached view.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
{
lock (this)
{
- // Restricted to only one listener
+ // Restricted to only one listener.
if (_longPressGestureEventHandler == null)
{
_longPressGestureEventHandler += value;
{
DetectedEventArgs e = new DetectedEventArgs();
- // Populate all members of "e" (LongPressGestureEventArgs) with real data
+ // Populate all members of "e" (LongPressGestureEventArgs) with real data.
e.View = Registry.GetManagedBaseHandleFromNativePtr(actor) as View;
e.LongPressGesture = Tizen.NUI.LongPressGesture.GetLongPressGestureFromPtr(longPressGesture);
if (_longPressGestureEventHandler != null)
{
- //here we send all data to user event handlers
+ //Here we send all data to user event handlers.
_longPressGestureEventHandler(this, e);
}
/// Creates an initialized LongPressGestureDetector with the number of touches required.<br />
/// A long press gesture will be emitted from this detector if the number of fingers touching the screen is equal to the touches required.<br />
/// </summary>
- /// <param name="touchesRequired">The number of touches required</param>
+ /// <param name="touchesRequired">The number of touches required.</param>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public LongPressGestureDetector(uint touchesRequired) : this(NDalicPINVOKE.LongPressGestureDetector_New__SWIG_1(touchesRequired), true)
/// Creates an initialized LongPressGestureDetector with the minimum and maximum number of touches required.<br />
/// A long press gesture will be emitted from this detector if the number of fingers touching the screen falls between the minimum and maximum touches set.<br />
/// </summary>
- /// <param name="minTouches">The minimum number of touches required</param>
- /// <param name="maxTouches">The maximum number of touches required</param>
+ /// <param name="minTouches">The minimum number of touches required.</param>
+ /// <param name="maxTouches">The maximum number of touches required.</param>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public LongPressGestureDetector(uint minTouches, uint maxTouches) : this(NDalicPINVOKE.LongPressGestureDetector_New__SWIG_2(minTouches, maxTouches), true)
/// <summary>
/// Sets the number of touches required.<br />
- /// The number of touches corresponds to the number of fingers a user has on the screen. The default is 1.<br />
+ /// The number of touches corresponds to the number of fingers a user has on the screen. The default value is 1.<br />
/// </summary>
/// <param name="touches">Touches required</param>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
/// <summary>
/// Sets the minimum and maximum touches required.
/// </summary>
- /// <param name="minTouches">Minimum Touches required</param>
- /// <param name="maxTouches">Maximum Touches required</param>
+ /// <param name="minTouches">Minimum touches required.</param>
+ /// <param name="maxTouches">Maximum touches required.</param>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void SetTouchesRequired(uint minTouches, uint maxTouches)
private Size2D _windowSize2D = null;
private Position2D _windowPosition2D = null;
/// <summary>
- /// The constructor with window size and position
+ /// The constructor with window size and position.
/// </summary>
- /// <param name="windowSize">The window size</param>
- /// <param name="windowPosition">The window position</param>
+ /// <param name="windowSize">The window size.</param>
+ /// <param name="windowPosition">The window position.</param>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// The constructor with a stylesheet, window size and position
+ /// The constructor with a stylesheet, window size, and position.
/// </summary>
- /// <param name="styleSheet">The styleSheet url.</param>
- /// <param name="windowSize">The window size</param>
- /// <param name="windowPosition">The window position</param>
+ /// <param name="styleSheet">The styleSheet URL.</param>
+ /// <param name="windowSize">The window size.</param>
+ /// <param name="windowPosition">The window position.</param>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// The constructor with a stylesheet, window mode, window size and position
+ /// The constructor with a stylesheet, window mode, window size, and position.
/// </summary>
- /// <param name="styleSheet">The styleSheet url</param>
- /// <param name="windowMode">The windowMode</param>
- /// <param name="windowSize">The window size</param>
- /// <param name="windowPosition">The window position</param>
+ /// <param name="styleSheet">The styleSheet URL.</param>
+ /// <param name="windowMode">The windowMode.</param>
+ /// <param name="windowSize">The window size.</param>
+ /// <param name="windowPosition">The window position.</param>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Specifies the Release Policy types <br />
- /// Decides if the image should be cached in different conditions
+ /// Specifies the release policy types.<br />
+ /// Decides if the image should be cached in different conditions.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public enum ReleasePolicyType
{
/// <summary>
- /// Image is released when visual detached from scene
+ /// Image is released when visual detached from scene.
/// </summary>
Detached = 0,
/// <summary>
- /// Image is only released when visual is destroyed
+ /// Image is only released when visual is destroyed.
/// </summary>
Destroyed,
/// <summary>
}
/// <summary>
- /// Specifies the Load Policy types <br />
- /// Decides when the image texture should be loaded
+ /// Specifies the load policy types.<br />
+ /// Decides when the image texture should be loaded.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public enum LoadPolicyType
}
/// <summary>
- /// The values of this enum determine how the visual should be fit to the view.
+ /// The values of this enum determines how the visual should fit into the view.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
/// </summary>
Text,
/// <summary>
- /// Renders an n-patch image.
+ /// Renders an NPatch image.
/// </summary>
NPatch,
/// <summary>
/// <since_tizen> 4 </since_tizen>
public static readonly int FrameDelay = NDalic.IMAGE_VISUAL_FRAME_DELAY;
/// <summary>
- /// The number of times the AnimatedImageVisual will be looped
- /// Default -1. if less than 0, loop unlimited. else, loop loopCount times.
+ /// The number of times the AnimatedImageVisual will be looped.
+ /// The default is -1. If the value is less than 0, loop unlimited. Otherwise, loop loopCount times.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public static readonly int LoopCount = NDalic.IMAGE_VISUAL_LOOP_COUNT;
/// <summary>
- /// The policy to determine when an image should no longer be cached
+ /// The policy to determine when an image should no longer be cached.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public static readonly int ReleasePolicy = NDalic.IMAGE_VISUAL_RELEASE_POLICY;
/// <summary>
- /// The policy to determine when an image should be loaded
+ /// The policy to determine when an image should be loaded.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public static readonly int LoadPolicy = NDalic.IMAGE_VISUAL_LOAD_POLICY;
/// <summary>
- /// Determines if image orientation should be corrected so the image displays as it was intended
+ /// Determines if image orientation should be corrected so that the image displays as it was intended.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public static readonly int OrientationCorrection = NDalic.IMAGE_VISUAL_ORIENTATION_CORRECTION;
}
/// <summary>
- /// An enum of text direction.
+ /// An enum of text directions.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public enum TextDirection
}
/// <summary>
- /// An enum of vertical line alignment.
+ /// An enum of vertical line alignments.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public enum VerticalLineAlignment
}
/// <summary>
- /// Enumeration type for the glyph type
+ /// Enumeration type for the glyph type.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public enum GlyphType
/// <summary>
- /// Event arguments that passed via the PanGestureEvent signal.
+ /// Event arguments that are passed via the PanGestureEvent signal.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
+ //Because the execution order of Finalizes is non-deterministic.
if (swigCPtr.Handle != global::System.IntPtr.Zero)
{
DetectedEventArgs e = new DetectedEventArgs();
- // Populate all members of "e" (DetectedEventArgs) with real data
+ // Populate all members of "e" (DetectedEventArgs) with real data.
e.View = Registry.GetManagedBaseHandleFromNativePtr(actor) as View;
e.PinchGesture = Tizen.NUI.PinchGesture.GetPinchGestureFromPtr(pinchGesture);
if (_pinchGestureEventHandler != null)
{
- //here we send all data to user event handlers
+ //Here we send all data to user event handlers.
_pinchGestureEventHandler(this, e);
}
/// <summary>
/// The PixelBuffer object holds a pixel buffer.
- /// The PixelBuffer keeps ownership of it's initial buffer however, the
- /// user is free to modify the pixel data, either directly, or via image operations.
+ /// The PixelBuffer keeps ownership of its initial buffer. However, the
+ /// user is free to modify the pixel data, either directly or via image operations.
///
- /// In order to upload the pixel data to texture memory, there are two
- /// possibilities - either convert it back to a PixelData object, which
+ /// In order to upload the pixel data to the texture memory, there are two
+ /// possibilities, either convert it back to a PixelData object, which
/// releases the PixelBuffer object, leaving the user with an empty handle
- /// (ideal for one-time indirect image manipulation), or create a new
+ /// (ideal for one-time indirect image manipulation) or create a new
/// PixelData object from this object, leaving the buffer intact (ideal
- /// for continuous manipulation)
+ /// for continuous manipulation).
/// </summary>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public class PixelBuffer : BaseHandle
{
if (type == DisposeTypes.Explicit)
{
- //Called by User
+ //Called by User.
//Release your own managed resources here.
//You should release all of your own disposable objects here.
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
+ //Because the execution order of Finalizes is non-deterministic.
if (swigCPtr.Handle != global::System.IntPtr.Zero)
{
if (swigCMemOwn)
}
/// <summary>
- /// Create a PixelBuffer with it's own data buffer.
+ /// Create a PixelBuffer with its own data buffer.
/// </summary>
- /// <param name="width">The pixel buffer width</param>
- /// <param name="height">The pixel buffer height</param>
- /// <param name="pixelFormat">The pixel format</param>
+ /// <param name="width">The pixel buffer width.</param>
+ /// <param name="height">The pixel buffer height.</param>
+ /// <param name="pixelFormat">The pixel format.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public PixelBuffer(uint width, uint height, PixelFormat pixelFormat) : this(NDalicPINVOKE.PixelBuffer_New(width, height, (int)pixelFormat), true)
{
}
/// <summary>
- /// Convert to a pixel data and release the pixelBuffer's object.
+ /// Convert to a pixel data and release the object of the pixelBuffer.
/// This handle is left empty.
/// Any other handles that keep a reference to this object
- /// will be left with no buffer, trying to access it will return NULL.
+ /// will be left with no buffer. Trying to access it will return NULL.
/// </summary>
- /// <param name="pixelBuffer">A pixel buffer</param>
- /// <returns>A new PixelData which takes ownership of the PixelBuffer's buffer.</returns>
+ /// <param name="pixelBuffer">A pixel buffer.</param>
+ /// <returns>A new PixelData that takes ownership of the buffer of the pixelBuffer.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public static PixelData Convert(PixelBuffer pixelBuffer)
{
/// </summary>
/// <returns>The pixel data.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public PixelData CreatePixelData()
{
/// </summary>
/// <returns>The width of the buffer in pixels.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public uint GetWidth()
{
/// </summary>
/// <returns>The height of the buffer in pixels.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public uint GetHeight()
{
/// </summary>
/// <returns>The pixel format.</returns>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public PixelFormat GetPixelFormat()
{
}
/// <summary>
- /// Apply the mask to this pixel data, and return a new pixel data containing
- /// the masked image. If this PixelBuffer doesn't have an alpha channel, then
+ /// Apply the mask to this pixel data and return a new pixel data that contains
+ /// the masked image. If this PixelBuffer does not have an alpha channel, then
/// the resultant PixelBuffer will be converted to a format that supports at
/// least the width of the color channels and the alpha channel from the mask.
///
- /// If cropToMask is set to true, then the contentScale is applied first to
+ /// If cropToMask is set to <c>true</c>, then the contentScale is applied first to
/// this buffer, and the target buffer is cropped to the size of the mask. If
- /// it's set to false, then the mask is scaled to match this buffer's size
+ /// it is set to <c>false</c>, then the mask is scaled to match the size of this buffer
/// before the mask is applied.
/// </summary>
/// <param name="mask">The mask to apply.</param>
/// <param name="contentScale">The scaling factor to apply to the content.</param>
/// <param name="cropToMask">Whether to crop the output to the mask size (true) or scale the mask to the content size (false).</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void ApplyMask(PixelBuffer mask, float contentScale, bool cropToMask)
{
}
/// <summary>
- /// Apply the mask to this pixel data, and return a new pixel data containing
- /// the masked image. If this PixelBuffer doesn't have an alpha channel, then
+ /// Apply the mask to this pixel data and return a new pixel data containing
+ /// the masked image. If this PixelBuffer does not have an alpha channel, then
/// the resultant PixelBuffer will be converted to a format that supports at
/// least the width of the color channels and the alpha channel from the mask.
///
- /// If cropToMask is set to true, then the contentScale is applied first to
+ /// If cropToMask is set to <c>true</c>, then the contentScale is applied first to
/// this buffer, and the target buffer is cropped to the size of the mask. If
- /// it's set to false, then the mask is scaled to match this buffer's size
+ /// it is set to <c>false</c>, then the mask is scaled to match the size of this buffer
/// before the mask is applied.
/// </summary>
/// <param name="mask">The mask to apply.</param>
/// <param name="contentScale">The scaling factor to apply to the content.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void ApplyMask(PixelBuffer mask, float contentScale)
{
}
/// <summary>
- /// Apply the mask to this pixel data, and return a new pixel data containing
- /// the masked image. If this PixelBuffer doesn't have an alpha channel, then
+ /// Apply the mask to this pixel data and return a new pixel data containing
+ /// the masked image. If this PixelBuffer does not have an alpha channel, then
/// the resultant PixelBuffer will be converted to a format that supports at
/// least the width of the color channels and the alpha channel from the mask.
///
- /// If cropToMask is set to true, then the contentScale is applied first to
+ /// If cropToMask is set to <c>true</c>, then the contentScale is applied first to
/// this buffer, and the target buffer is cropped to the size of the mask. If
- /// it's set to false, then the mask is scaled to match this buffer's size
+ /// it is set to <c>false</c>, then the mask is scaled to match the size of this buffer
/// before the mask is applied.
/// </summary>
/// <param name="mask">The mask to apply.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void ApplyMask(PixelBuffer mask)
{
/// </summary>
/// <param name="blurRadius">The radius for Gaussian blur. A value of 0 or negative value indicates no blur.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void ApplyGaussianBlur(float blurRadius)
{
/// <param name="width">The crop width.</param>
/// <param name="height">The crop height.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Crop(ushort x, ushort y, ushort width, ushort height)
{
/// <param name="width">The new width.</param>
/// <param name="height">The new height.</param>
/// <since_tizen> 5 </since_tizen>
- /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ /// This will be released at Tizen.NET API Level 5. Therefore, currently this would be used as an in-house API.
[EditorBrowsable(EditorBrowsableState.Never)]
public void Resize(ushort width, ushort height)
{
/// <summary>
/// The PixelData object holds a pixel buffer.<br />
/// The PixelData takes over the ownership of the pixel buffer.<br />
- /// The buffer memory must NOT be released outside of this class, instead,
+ /// The buffer memory must not be released outside of this class, instead,
/// the PixelData object will release it automatically when the reference count falls to zero.
/// </summary>
/// Please DO NOT use! This will be deprecated!
if (type == DisposeTypes.Explicit)
{
- //Called by User
+ //Called by User.
//Release your own managed resources here.
//You should release all of your own disposable objects here.
//Release your own unmanaged resources here.
//You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
+ //Because the execution order of Finalizes is non-deterministic.
if (swigCPtr.Handle != global::System.IntPtr.Zero)
}
/// <summary>
- /// Enumeration for Function to release the pixel buffer.
+ /// Enumeration for function to release the pixel buffer.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
}
/// <summary>
- /// Retrieves a Rotation value.
+ /// Retrieves a rotation value.
/// </summary>
/// <param name="quaternionValue">On return, a rotation value.</param>
/// <returns>Returns true if the value is successfully retrieved, false if the type is not convertible.</returns>
{
StyleChangedEventArgs e = new StyleChangedEventArgs();
- // Populate all members of "e" (StyleChangedEventArgs) with real data
+ // Populate all members of "e" (StyleChangedEventArgs) with real data.
e.StyleManager = Registry.GetManagedBaseHandleFromNativePtr(styleManager) as StyleManager;
e.StyleChange = styleChange;
if (_styleManagerStyleChangedEventHandler != null)
{
- //here we send all data to user event handlers
+ //Here we send all data to user event handlers.
_styleManagerStyleChangedEventHandler(this, e);
}
}
}
/// <summary>
- /// Event arguments that passed via the TapGestureEvent signal.
+ /// Event arguments that are passed via the TapGestureEvent signal.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
}
/// <summary>
- /// Get mouse device's button value (ex: right/left button)
+ /// Get mouse device's button value (for example, right or left button)
/// </summary>
- /// <param name="point">The point required</param>
+ /// <param name="point">The point required.</param>
/// <returns></returns>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
}
/// <summary>
- /// Mouse device button type
+ /// Mouse device button type.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
public enum MouseButton
{
/// <summary>
- /// No mouse button event or invalid data
+ /// No mouse button event or invalid data.
/// </summary>
/// <since_tizen> 5 </since_tizen>
Invalid = -1,
/// <summary>
- /// Primary(Left) mouse button
+ /// Primary(Left) mouse button.
/// </summary>
/// <since_tizen> 5 </since_tizen>
Primary = 1,
/// <summary>
- /// Secondary(Right) mouse button
+ /// Secondary(Right) mouse button.
/// </summary>
/// <since_tizen> 5 </since_tizen>
Secondary = 3,
/// <summary>
- /// Center(Wheel) mouse button
+ /// Center(Wheel) mouse button.
/// </summary>
/// <since_tizen> 5 </since_tizen>
Tertiary = 2,
/// <summary>
/// The fitting mode of the visual.
- /// The default is defined by the type of visual (if it's suitable to be stretched or not).
+ /// The default is defined by the type of visual (if it is suitable to be stretched or not).
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
}
/// <summary>
- /// Overlays the auxiliary iamge on top of an NPatch image.
+ /// Overlays the auxiliary image on top of an NPatch image.
/// The resulting visual image will be at least as large as the smallest possible n-patch or the auxiliary image, whichever is larger.
/// </summary>
/// <since_tizen> 5 </since_tizen>
}
/// <summary>
- /// Get or set the Image Visual release policy<br />
- /// It decides if a texture should be released from the cache or kept to reduce loading time <br />
+ /// Gets or sets the Image Visual release policy.<br/>
+ /// It decides if a texture should be released from the cache or kept to reduce the loading time.<br/>
/// </summary>
/// <since_tizen> 5 </since_tizen>
public ReleasePolicyType ReleasePolicy
/// <summary>
- /// Get or set the Image Visual image loading policy<br />
- /// It decides if a texture should be loaded immediately after source set or only after visual is added to window <br />
+ /// Gets or sets the Image Visual image loading policy.<br />
+ /// It decides if a texture should be loaded immediately after source set or only after the visual is added to the window.<br />
/// </summary>
/// <since_tizen> 5 </since_tizen>
public LoadPolicyType LoadPolicy
}
/// <summary>
- /// Get or set whether to automatically correct the orientation based on exif data.<br />
+ /// Gets or sets whether to automatically correct the orientation based on the Exchangeable Image File (EXIF) data.<br />
/// If not specified, the default is true.<br />
/// For JPEG images only.<br />
/// Optional.
}
/// <summary>
- /// Whether to use the texture atlas.
+ /// Whether to use the texture atlas or not.
/// Optional. By default atlasing is off.
/// </summary>
/// <since_tizen> 5 </since_tizen>
}
/// <summary>
- /// Gets or sets the Underline parameters.
+ /// Gets or sets the underline parameters.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
}
/// <summary>
- /// Gets or sets the Outline parameters.
+ /// Gets or sets the outline parameters.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
}
/// <summary>
- /// Gets or sets the Background parameters.
+ /// Gets or sets the background parameters.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
/// <summary>
/// Gets or sets whether to render if the MixColor is transparent.
- /// By default it's false, i.e. ColorVisual will not render if the MIX_COLOR is transparent.
+ /// By default it is false, which means that the ColorVisual will not render if the MIX_COLOR is transparent.
/// </summary>
/// <since_tizen> 5 </since_tizen>
/// This will be public opened in tizen_5.0 after ACR done. Before ACR, need to be hidden as inhouse API.
}
/// <summary>
- /// Gets and Sets the number of times the AnimatedImageVisual will be looped.
- /// Default -1. if less than 0, loop unlimited. else, loop loopCount times.
+ /// Gets and sets the number of times the AnimatedImageVisual will be looped.
+ /// The default is -1. If the number is less than 0 then it loops unlimited,otherwise loop loopCount times.
/// </summary>
/// <since_tizen> 5 </since_tizen>
public float LoopCount
}
/// <summary>
- /// Sets keyboard repeat information.
+ /// Sets the keyboard repeat information.
/// </summary>
- /// <param name="rate">The key repeat rate value in seconds</param>
- /// <param name="delay">The key repeat delay value in seconds</param>
+ /// <param name="rate">The key repeat rate value in seconds.</param>
+ /// <param name="delay">The key repeat delay value in seconds.</param>
/// <returns>True if setting the keyboard repeat succeeds.</returns>
/// <since_tizen> 5 </since_tizen>
public bool SetKeyboardRepeatInfo(float rate, float delay)
}
/// <summary>
- /// Gets keyboard repeat information.
+ /// Gets the keyboard repeat information.
/// </summary>
- /// <param name="rate">The key repeat rate value in seconds</param>
- /// <param name="delay">The key repeat delay value in seconds</param>
+ /// <param name="rate">The key repeat rate value in seconds.</param>
+ /// <param name="delay">The key repeat delay value in seconds.</param>
/// <returns>True if setting the keyboard repeat succeeds.</returns>
/// <since_tizen> 5 </since_tizen>
public bool GetKeyboardRepeatInfo(out float rate, out float delay)
/// <summary>
/// Sets whether the window is transparent or not.
/// </summary>
- /// <param name="transparent">Whether the window is transparent.</param>
+ /// <param name="transparent">Whether the window is transparent or not.</param>
/// <since_tizen> 5 </since_tizen>
public void SetTransparency(bool transparent) {
NDalicManualPINVOKE.SetTransparency(swigCPtr, transparent);
}
/// <summary>
- /// Feed a key-event into the window.
+ /// Feeds a key event into the window.
/// </summary>
/// <param name="keyEvent">The key event to feed.</param>
/// <since_tizen> 5 </since_tizen>
projects / platform / core / csapi / tizenfx.git / commitdiff