diff options
author | Jeonghyun Yun <jh0506.yun@samsung.com> | 2017-03-21 21:05:27 -0700 |
---|---|---|
committer | Gerrit Code Review <gerrit@review.vlan103.tizen.org> | 2017-03-21 21:05:27 -0700 |
commit | 48b9652f5a242cfa5496f9589a593f527e6bc48c (patch) | |
tree | bff6a2a26e0b82e6dc9fd59777bd2b5ea37555bf | |
parent | 4823b3969c7e9d6991d655103415fb76c26d784e (diff) | |
parent | b1c6fd241dff13f224cddad58047520ec51d3e1a (diff) | |
download | elm-sharp-48b9652f5a242cfa5496f9589a593f527e6bc48c.tar.gz elm-sharp-48b9652f5a242cfa5496f9589a593f527e6bc48c.tar.bz2 elm-sharp-48b9652f5a242cfa5496f9589a593f527e6bc48c.zip |
Merge "Add comments For EvasObject/EvasObjectEvent/FlipSelector/FlipSelectorItem/FloatingButton." into tizen
-rwxr-xr-x[-rw-r--r--] | ElmSharp/ElmSharp/EvasObject.cs | 154 | ||||
-rwxr-xr-x[-rw-r--r--] | ElmSharp/ElmSharp/EvasObjectEvent.cs | 175 | ||||
-rwxr-xr-x[-rw-r--r--] | ElmSharp/ElmSharp/FlipSelector.cs | 60 | ||||
-rwxr-xr-x[-rw-r--r--] | ElmSharp/ElmSharp/FlipSelectorItem.cs | 13 | ||||
-rwxr-xr-x | ElmSharp/ElmSharp/FloatingButton.cs | 55 |
5 files changed, 449 insertions, 8 deletions
diff --git a/ElmSharp/ElmSharp/EvasObject.cs b/ElmSharp/ElmSharp/EvasObject.cs index 732370b..f9cf919 100644..100755 --- a/ElmSharp/ElmSharp/EvasObject.cs +++ b/ElmSharp/ElmSharp/EvasObject.cs @@ -20,6 +20,9 @@ using System.Diagnostics; namespace ElmSharp { + /// <summary> + /// The EcasObject is a base class for other widget class + /// </summary> public abstract class EvasObject { private IntPtr _realHandle = IntPtr.Zero; @@ -46,12 +49,19 @@ namespace ElmSharp readonly HashSet<IInvalidatable> _eventStore = new HashSet<IInvalidatable>(); + /// <summary> + /// Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter. + /// </summary> + /// <param name="parent">Parent EvasObject class </param> protected EvasObject(EvasObject parent) : this() { Debug.Assert(parent == null || parent.IsRealized); Realize(parent); } + /// <summary> + /// Creates and initializes a new instance of the EvasObject class. + /// </summary> protected EvasObject() { OnInstantiated(); @@ -65,28 +75,51 @@ namespace ElmSharp // Unrealize(); //} + /// <summary> + /// Deleted will be triggered when widght is deleted + /// </summary> public event EventHandler Deleted; + /// <summary> + /// KeyUp will be triggered when key is loose + /// </summary> public event EventHandler<EvasKeyEventArgs> KeyUp; + /// <summary> + /// KeyDown will be triggered when key is preesd down + /// </summary> public event EventHandler<EvasKeyEventArgs> KeyDown; + /// <summary> + /// Moved will be triggered when widght is moved + /// </summary> public event EventHandler Moved { add { _moved.On += value; } remove { _moved.On -= value; } } + /// <summary> + /// Current widget's size Resized Event Handler + /// </summary> public event EventHandler Resized { add { _resized.On += value; } remove { _resized.On -= value; } } - + /// <summary> + /// Current widget RenderPost Event Handler + /// </summary> public event EventHandler RenderPost { add { _renderPost.On += value; } remove { _renderPost.On -= value; } } + /// <summary> + /// Get widget's status of Realized or not. + /// </summary> public bool IsRealized { get { return Handle != IntPtr.Zero; } } + /// <summary> + /// Gets the current class's Name. + /// </summary> public string ClassName { get @@ -95,6 +128,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the horizontal pointer hints for an object's weight. + /// </summary> public double WeightX { get @@ -107,6 +143,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the vertical pointer hints for an object's weight. + /// </summary> public double WeightY { get @@ -119,6 +158,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the horizontal alignment hint of an object's alignment. + /// </summary> public virtual double AlignmentX { get @@ -131,6 +173,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the vertical alignment hint of an object's alignment. + /// </summary> public virtual double AlignmentY { get @@ -143,6 +188,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the Width hints for an object's minimum size. + /// </summary> public int MinimumWidth { get @@ -158,6 +206,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the Height hints for an object's minimum size. + /// </summary> public int MinimumHeight { get @@ -173,6 +224,9 @@ namespace ElmSharp } } + /// <summary> + /// Gets the visible state of the given Evas object. + /// </summary> public bool IsVisible { get @@ -181,6 +235,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the position and (rectangular) size of the given Evas object. + /// </summary> public Rect Geometry { get @@ -196,6 +253,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the general or main color of the given Evas object. + /// </summary> public virtual Color Color { get @@ -210,6 +270,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets the map enabled state. + /// </summary> public bool IsMapEnabled { get @@ -222,6 +285,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets current object transformation map. + /// </summary> public EvasMap EvasMap { get @@ -235,6 +301,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets whether an object is to repeat events. + /// </summary> public bool RepeatEvents { get @@ -247,6 +316,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets whether events on a smart object's member should get propagated up to its parent. + /// </summary> public bool PropagateEvents { get @@ -259,6 +331,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets whether an object is set to pass (ignore) events. + /// </summary> public bool PassEvents { get @@ -271,46 +346,83 @@ namespace ElmSharp } } + /// <summary> + /// Clips one object to another. + /// </summary> + /// <param name="clip">The object to clip object by</param> public void SetClip(EvasObject clip) { Interop.Evas.evas_object_clip_set(Handle, clip); } + /// <summary> + /// Sets the hints for an object's alignment. + /// </summary> + /// <param name="x">The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 </param> + /// <param name="y">The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 </param> public void SetAlignment(double x, double y) { Interop.Evas.evas_object_size_hint_align_set(Handle, x, y); } + /// <summary> + /// Sets the hints for an object's weight. + /// </summary> + /// <param name="x">The non-negative double value to use as horizontal weight hint</param> + /// <param name="y">The non-negative double value to use as vertical weight hint</param> public void SetWeight(double x, double y) { Interop.Evas.evas_object_size_hint_weight_set(Handle, x, y); } + /// <summary> + /// Makes the current object visible. + /// </summary> public void Show() { Interop.Evas.evas_object_show(Handle); } + /// <summary> + /// Makes the current object invisible. + /// </summary> public void Hide() { Interop.Evas.evas_object_hide(Handle); } + /// <summary> + /// Changes the size of the current object. + /// </summary> + /// <param name="w">The new width</param> + /// <param name="h">The new height</param> public void Resize(int w, int h) { Interop.Evas.evas_object_resize(Handle, w, h); } + /// <summary> + /// Moves the current object to the given location. + /// </summary> + /// <param name="x">The X position to move the object to.</param> + /// <param name="y">The Y position to move the object to.</param> public void Move(int x, int y) { Interop.Evas.evas_object_move(Handle, x, y); } + /// <summary> + /// Lowers obj to the bottom of its layer. + /// </summary> public void Lower() { Interop.Evas.evas_object_lower(Handle); } + /// <summary> + /// Define IntPtr operator + /// </summary> + /// <param name="obj">Parent object</param> public static implicit operator IntPtr(EvasObject obj) { if (obj == null) @@ -318,39 +430,70 @@ namespace ElmSharp return obj.Handle; } + /// <summary> + /// Requests keyname key events be directed to current obj. + /// </summary> + /// <param name="keyname">The key to request events for</param> + /// <param name="exclusive">Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE</param> + /// <returns>If the call succeeded is true,otherwise is false</returns> public bool KeyGrab(string keyname, bool exclusive) { return Interop.Evas.evas_object_key_grab(Handle, keyname, 0, 0, exclusive); } + /// <summary> + /// Removes the grab on keyname key events. + /// </summary> + /// <param name="keyname">The key the grab is set for</param> public void KeyUngrab(string keyname) { Interop.Evas.evas_object_key_ungrab(Handle, keyname, 0, 0); } + /// <summary> + /// Mark smart object as changed. + /// </summary> public void MarkChanged() { Interop.Evas.evas_object_smart_changed(RealHandle); } + /// <summary> + /// The callback of Invalidate Event + /// </summary> protected virtual void OnInvalidate() { } + /// <summary> + /// The callback of Instantiated Event + /// </summary> protected virtual void OnInstantiated() { } - + /// <summary> + /// The callback of Realized Event + /// </summary> protected virtual void OnRealized() { } - + /// <summary> + /// The callback of Unrealize Event + /// </summary> protected virtual void OnUnrealize() { } - + /// <summary> + /// Creates a widget handle. + /// </summary> + /// <param name="parent">Parent EvasObject</param> + /// <returns>Handle IntPtr</returns> protected abstract IntPtr CreateHandle(EvasObject parent); + /// <summary> + /// For this object bind Parent object.Init handle and all kinds of EvasObjectEvent. + /// </summary> + /// <param name="parent">Parent object</param> public void Realize(EvasObject parent) { if (!IsRealized) @@ -375,6 +518,9 @@ namespace ElmSharp } } + /// <summary> + /// Removes current object relationship with others. + /// </summary> public void Unrealize() { if (IsRealized) diff --git a/ElmSharp/ElmSharp/EvasObjectEvent.cs b/ElmSharp/ElmSharp/EvasObjectEvent.cs index e10220c..c638a2d 100644..100755 --- a/ElmSharp/ElmSharp/EvasObjectEvent.cs +++ b/ElmSharp/ElmSharp/EvasObjectEvent.cs @@ -26,48 +26,170 @@ namespace ElmSharp void MakeInvalidate(); } + /// <summary> + /// Enumeration for EvasObjectCallbackType + /// </summary> public enum EvasObjectCallbackType { + /// <summary> + /// Mouse In Event CallbackType. + /// </summary> MouseIn, + /// <summary> + /// Mouse Out Event CallbackType + /// </summary> MouseOut, + /// <summary> + /// Mouse Button Down Event CallbackType + /// </summary> MouseDown, + /// <summary> + /// Mouse Button Up Event CallbackType + /// </summary> MouseUp, + /// <summary> + /// Mouse Move Event CallbackType + /// </summary> MouseMove, + /// <summary> + /// Mouse Wheel Event CallbackType + /// </summary> MouseWheel, + /// <summary> + /// Multi-touch Down Event CallbackType + /// </summary> MultiDown, + /// <summary> + /// Multi-touch Up Event CallbackType + /// </summary> MultiUp, + /// <summary> + /// Multi-touch Move Event CallbackType + /// </summary> MultiMove, + /// <summary> + /// Object Being Freed (Called after Del) + /// </summary> Free, + /// <summary> + /// Key Press Event CallbackType + /// </summary> KeyDown, + /// <summary> + /// Key Release Event CallbackType + /// </summary> KeyUp, + /// <summary> + /// Focus In Event CallbackType + /// </summary> FocusIn, + /// <summary> + /// Focus Out Event CallbackType + /// </summary> FocusOut, + /// <summary> + /// Show Event CallbackType + /// </summary> Show, + /// <summary> + /// Hide Event CallbackType + /// </summary> Hide, + /// <summary> + /// Move Event CallbackType + /// </summary> Move, + /// <summary> + /// Resize Event CallbackType + /// </summary> Resize, + /// <summary> + /// Restack Event CallbackType + /// </summary> Restack, + /// <summary> + /// Object Being Deleted (called before Free) + /// </summary> Del, + /// <summary> + /// Hold Event CallbackType, Informational purpose event to indicate something + /// </summary> Hold, + /// <summary> + /// Size hints changed Event CallbackType + /// </summary> ChangedSizeHints, + /// <summary> + /// Image has been preloaded + /// </summary> ImagePreloaded, + /// <summary> + /// Canvas got focus as a whole + /// </summary> CanvasFocusIn, + /// <summary> + /// Canvas lost focus as a whole + /// </summary> CanvasFocusOut, + /// <summary> + /// Called just before rendering is updated on the canvas target + /// </summary> RenderFlushPre, + /// <summary> + /// Called just after rendering is updated on the canvas target + /// </summary> RenderFlushPost, + /// <summary> + /// Canvas object got focus + /// </summary> CanvasObjectFocusIn, + /// <summary> + /// Canvas object lost focus + /// </summary> CanvasObjectFocusOut, + /// <summary> + /// Image data has been unloaded (by some mechanism in Evas that throw out original image data) + /// </summary> ImageUnloaded, + /// <summary> + /// Called just before rendering starts on the canvas target + /// </summary> RenderPre, + /// <summary> + /// Called just after rendering stops on the canvas target + /// </summary> RenderPost, + /// <summary> + /// Image size is changed + /// </summary> ImageResize, + /// <summary> + /// Devices added, removed or changed on canvas + /// </summary> DeviceChanged, + /// <summary> + /// Axis is changed + /// </summary> AxisUpdate, + /// <summary> + /// Canvas Viewport size is changed + /// </summary> CanvasViewportResize } + /// <summary> + /// Event class for EvasObject + /// </summary> + /// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam> public class EvasObjectEvent<TEventArgs> : IInvalidatable where TEventArgs : EventArgs { + /// <summary> + /// SmartEventInfoParser delegate of EvasObjectEvent class + /// </summary> + /// <param name="data">data</param> + /// <param name="obj">obj</param> + /// <param name="info">info</param> + /// <returns></returns> public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info); private bool _disposed = false; @@ -77,10 +199,22 @@ namespace ElmSharp private readonly SmartEventInfoParser _parser; private readonly List<NativeCallback> _nativeCallbacks = new List<NativeCallback>(); + /// <summary> + /// Creates and initializes a new instance of the EvasObjectEvent. + /// </summary> + /// <param name="sender">EvasObject class belong to</param> + /// <param name="type">EvasObjectCallbackType</param> + /// <param name="parser">SmartEventInfoParser</param> public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type, SmartEventInfoParser parser) : this(sender, sender.Handle, type, parser) { } - + /// <summary> + /// Creates and initializes a new instance of the EvasObjectEvent. + /// </summary> + /// <param name="sender">EvasObject class belong to</param> + /// <param name="handle">EvasObject class's handle</param> + /// <param name="type">EvasObjectCallbackType</param> + /// <param name="parser">SmartEventInfoParser</param> [EditorBrowsableAttribute(EditorBrowsableState.Never)] public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type, SmartEventInfoParser parser) { @@ -90,7 +224,11 @@ namespace ElmSharp _parser = parser; sender.AddToEventLifeTracker(this); } - + /// <summary> + /// Creates and initializes a new instance of the EvasObjectEvent. + /// </summary> + /// <param name="sender">EvasObject class belong with</param> + /// <param name="type">SmartEventInfoParser</param> public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, type, null) { } @@ -106,6 +244,9 @@ namespace ElmSharp public EventHandler<TEventArgs> eventHandler; } + /// <summary> + /// On Event Handler of EvasObjectEvent + /// </summary> public event EventHandler<TEventArgs> On { add @@ -160,12 +301,18 @@ namespace ElmSharp } } + /// <summary> + /// Destroy Current Obj + /// </summary> public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } + /// <summary> + /// Make current instance invalidate + /// </summary> public void MakeInvalidate() { _sender = null; @@ -173,16 +320,29 @@ namespace ElmSharp } } + /// <summary> + /// Event class for EvasObject + /// </summary> public class EvasObjectEvent : IInvalidatable { private EvasObjectEvent<EventArgs> _evasObjectEvent; private event EventHandler _handlers; private bool _disposed = false; + /// <summary> + /// Creates and initializes a new instance of the EvasObjectEvent. + /// </summary> + /// <param name="sender">EvasObject class belong to</param> + /// <param name="type">EvasObjectCallbackType</param> public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, sender.Handle, type) { } - + /// <summary> + /// Creates and initializes a new instance of the EvasObjectEvent. + /// </summary> + /// <param name="sender">EvasObject class belong to</param> + /// <param name="handle">EvasObject class's handle</param> + /// <param name="type">EvasObjectCallbackTypes</param> [EditorBrowsableAttribute(EditorBrowsableState.Never)] public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type) { @@ -194,6 +354,9 @@ namespace ElmSharp Dispose(false); } + /// <summary> + /// On Event Handler of EvasObjectEvent + /// </summary> public event EventHandler On { add @@ -232,12 +395,18 @@ namespace ElmSharp } } + /// <summary> + /// Destroy Current Obj + /// </summary> public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } + /// <summary> + /// Make current instance invalidate + /// </summary> public void MakeInvalidate() { _evasObjectEvent.MakeInvalidate(); diff --git a/ElmSharp/ElmSharp/FlipSelector.cs b/ElmSharp/ElmSharp/FlipSelector.cs index 3a58f8e..bffb713 100644..100755 --- a/ElmSharp/ElmSharp/FlipSelector.cs +++ b/ElmSharp/ElmSharp/FlipSelector.cs @@ -19,12 +19,19 @@ using System.Collections.Generic; namespace ElmSharp { + /// <summary> + /// A flip selector is a widget to show a set of text items,one at a time.with the same sheet switching style as the clock widget, when one changes the current displaying sheet. + /// </summary> public class FlipSelector : Layout { SmartEvent _selected; SmartEvent _overflowed; SmartEvent _underflowed; + /// <summary> + /// Creates and initializes a new instance of the FlipSelector. + /// </summary> + /// <param name="parent">Parent EvasObject </param> public FlipSelector(EvasObject parent) : base(parent) { _selected = new SmartEvent(this, Handle, "selected"); @@ -36,10 +43,22 @@ namespace ElmSharp _underflowed.On += UnderflowedChanged; } + /// <summary> + /// Selected will be triggered when be Selected + /// </summary> public event EventHandler Selected; + /// <summary> + /// Overflowed will be triggered when Overflowed + /// </summary> public event EventHandler Overflowed; + /// <summary> + /// Underflowed will be triggered when be Underflowed + /// </summary> public event EventHandler Underflowed; + /// <summary> + /// Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget. + /// </summary> public double Interval { get @@ -52,6 +71,10 @@ namespace ElmSharp } } + + /// <summary> + /// Gets the currently selected item in a flip selector widget. + /// </summary> public FlipSelectorItem SelectedItem { get @@ -61,6 +84,9 @@ namespace ElmSharp } } + /// <summary> + /// Gets the first item in the given flip selector widget's list of items. + /// </summary> public FlipSelectorItem FirstItem { get @@ -70,6 +96,9 @@ namespace ElmSharp } } + /// <summary> + /// Gets the last item in the given flip selector widget's list of items. + /// </summary> public FlipSelectorItem LastItem { get @@ -79,6 +108,16 @@ namespace ElmSharp } } + /// <summary> + /// Appends a (text) item to a flip selector widget. + /// </summary> + /// <param name="text">text value</param> + /// <returns> + /// A handle to the item added or NULL, on errors + /// </returns> + /// <remarks> + /// The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. + /// </remarks> public FlipSelectorItem Append(string text) { FlipSelectorItem item = new FlipSelectorItem(text); @@ -86,6 +125,14 @@ namespace ElmSharp return item; } + /// <summary> + /// Prepend a (text) item to a flip selector widget. + /// </summary> + /// <param name="text">Prepend text</param> + /// <returns>A handle to the item added or NULL, on errors</returns> + /// <remarks> + /// The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. + /// </remarks> public FlipSelectorItem Prepend(string text) { FlipSelectorItem item = new FlipSelectorItem(text); @@ -93,17 +140,30 @@ namespace ElmSharp return item; } + /// <summary> + /// To remove the given item. + /// </summary> + /// <param name="item">FlipSelector's item</param> public void Remove(FlipSelectorItem item) { if (item as FlipSelectorItem != null) item.Delete(); } + /// <summary> + /// Programmatically select the next item of a flip selector widget. + /// </summary> + /// <remarks> + /// The selection will be animated. Also, if it reaches the beginning of its list of member items, it will continue with the last one backwards. + /// </remarks> public void Next() { Interop.Elementary.elm_flipselector_flip_next(Handle); } + /// <summary> + /// Programmatically select the previous item of a flip selector widget. + /// </summary> public void Prev() { Interop.Elementary.elm_flipselector_flip_prev(Handle); diff --git a/ElmSharp/ElmSharp/FlipSelectorItem.cs b/ElmSharp/ElmSharp/FlipSelectorItem.cs index a957acf..3210e3b 100644..100755 --- a/ElmSharp/ElmSharp/FlipSelectorItem.cs +++ b/ElmSharp/ElmSharp/FlipSelectorItem.cs @@ -18,12 +18,25 @@ using System; namespace ElmSharp { + /// <summary> + /// Iterm class of FlipSelector + /// </summary> public class FlipSelectorItem : ItemObject { + /// <summary> + /// Sets or gets the Text of FlipSelectorItem + /// </summary> public string Text { get; private set; } + /// <summary> + /// Selected will be triggered when Selected + /// </summary> public event EventHandler Selected; + /// <summary> + /// Creates and initializes a new instance of the FlipSelectorItem. + /// </summary> + /// <param name="text">FlipSelectorItem's text</param> public FlipSelectorItem(string text) : base(IntPtr.Zero) { Text = text; diff --git a/ElmSharp/ElmSharp/FloatingButton.cs b/ElmSharp/ElmSharp/FloatingButton.cs index f712bf1..37b157a 100755 --- a/ElmSharp/ElmSharp/FloatingButton.cs +++ b/ElmSharp/ElmSharp/FloatingButton.cs @@ -18,18 +18,30 @@ using System; namespace ElmSharp { + /// <summary> + /// The FloatingButton is a widget that to add floating area for buttons. + /// </summary> public class FloatingButton : Layout { SmartEvent _clicked; - + /// <summary> + /// Creates and initializes a new instance of the FloatingButton class. + /// </summary> + /// <param name="parent">Created on this parent container..</param> public FloatingButton(EvasObject parent) : base(parent) { _clicked = new SmartEvent(this, Handle, "clicked"); _clicked.On += (s, e) => Clicked?.Invoke(this, EventArgs.Empty); } + /// <summary> + /// Clicked will be triggered when clicked + /// </summary> public event EventHandler Clicked; + /// <summary> + /// Sets or gets floatingbutton mode. + /// </summary> public FloatingButtonMode Mode { get @@ -42,6 +54,9 @@ namespace ElmSharp } } + /// <summary> + /// Gets floatingbutton Position. + /// </summary> public FloatingButtonPosition Position { get @@ -50,6 +65,9 @@ namespace ElmSharp } } + /// <summary> + /// Sets or gets movability for a given floatingbutton widget. + /// </summary> public bool MovementBlock { get @@ -62,6 +80,9 @@ namespace ElmSharp } } + /// <summary> + /// Get Opacity's value of the given FloatingButton. + /// </summary> public override int Opacity { get @@ -75,6 +96,11 @@ namespace ElmSharp } } + /// <summary> + /// Set the floatingbutton position with animation or not. + /// </summary> + /// <param name="position">Button position</param> + /// <param name="animated">Animat flag</param> public void SetPosition(FloatingButtonPosition position, bool animated) { if (animated) @@ -93,18 +119,45 @@ namespace ElmSharp } } + /// <summary> + /// Enumeration for FloatingButtonMode + /// </summary> public enum FloatingButtonMode { + /// <summary> + /// Allows all positions + /// </summary> All, + /// <summary> + /// Allows LEFT and RIGHT positions only + /// </summary> LeftRightOnly, } + /// <summary> + /// Enumeration for FloatingButtonPosition + /// </summary> public enum FloatingButtonPosition { + /// <summary> + /// Hides in the left, but small handler will show only + /// </summary> LeftOut, + /// <summary> + /// Shows all of buttons, but lies on the left + /// </summary> Left, + /// <summary> + /// Shows all of buttons, but lies on the center + /// </summary> Center, + /// <summary> + /// Shows all of buttons, but lies on the right + /// </summary> Right, + /// <summary> + /// Hides in the right, but small handler will show only + /// </summary> RightOut, } }
\ No newline at end of file |