From 464ec54d20520dbaeded105e2761888a92450b95 Mon Sep 17 00:00:00 2001 From: Piotr Szydelko Date: Tue, 31 Oct 2017 09:01:15 +0100 Subject: [PATCH] [ElmSharp] Mark ElmSharp API as API Level: preview Signed-off-by: Piotr Szydelko Change-Id: I49763cd7ac1d22e227085d762a92928eff93e2d0 --- .../ElmSharp.Wearable/CircleDatetimeSelector.cs | 11 ++++ .../ElmSharp.Wearable/CircleGenList.cs | 15 +++++ .../ElmSharp.Wearable/CircleProgressBar.cs | 23 +++++++ .../ElmSharp.Wearable/CircleScroller.cs | 22 +++++++ .../ElmSharp.Wearable/CircleSlider.cs | 26 ++++++++ .../ElmSharp.Wearable/CircleSpinner.cs | 12 ++++ .../ElmSharp.Wearable/CircleSurface.cs | 7 ++ .../ElmSharp.Wearable/ICircleWidget.cs | 4 ++ .../ElmSharp.Wearable/MoreOption.cs | 11 ++++ .../ElmSharp.Wearable/MoreOptionItem.cs | 6 ++ .../ElmSharp.Wearable/MoreOptionItemEventArgs.cs | 2 + .../ElmSharp.Wearable/RotaryEventManager.cs | 13 ++++ .../ElmSharp.Wearable/RotarySelector.cs | 8 +++ .../ElmSharp.Wearable/RotarySelectorItem.cs | 19 ++++++ .../RotarySelectorItemEventArgs.cs | 2 + src/ElmSharp/ElmSharp/AccessRole.cs | 1 + src/ElmSharp/ElmSharp/AccessibleObject.cs | 6 ++ src/ElmSharp/ElmSharp/AccessibleRelation.cs | 57 ++++++++++++++++ src/ElmSharp/ElmSharp/AccessibleUtil.cs | 3 + src/ElmSharp/ElmSharp/Background.cs | 8 +++ src/ElmSharp/ElmSharp/Box.cs | 18 +++++ src/ElmSharp/ElmSharp/Button.cs | 12 ++++ src/ElmSharp/ElmSharp/Calendar.cs | 28 ++++++++ src/ElmSharp/ElmSharp/Check.cs | 5 ++ .../ElmSharp/CheckStateChangedEventArgs.cs | 4 ++ src/ElmSharp/ElmSharp/Color.cs | 37 +++++++++++ src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs | 4 ++ src/ElmSharp/ElmSharp/ColorSelector.cs | 11 ++++ src/ElmSharp/ElmSharp/ColorSelectorItem.cs | 2 + src/ElmSharp/ElmSharp/Conformant.cs | 3 + src/ElmSharp/ElmSharp/Container.cs | 8 +++ src/ElmSharp/ElmSharp/ContextPopup.cs | 16 +++++ src/ElmSharp/ElmSharp/ContextPopupItem.cs | 4 ++ src/ElmSharp/ElmSharp/DateChangedEventArgs.cs | 4 ++ src/ElmSharp/ElmSharp/DateTimeSelector.cs | 14 ++++ .../ElmSharp/DisplayedMonthChangedEventArgs.cs | 4 ++ src/ElmSharp/ElmSharp/EcoreAnimator.cs | 4 ++ src/ElmSharp/ElmSharp/EcoreEvent.cs | 20 ++++++ src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs | 4 ++ src/ElmSharp/ElmSharp/EcoreMainloop.cs | 9 +++ .../ElmSharp/EcoreSynchronizationContext.cs | 5 ++ src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs | 10 +++ src/ElmSharp/ElmSharp/EdjeObject.cs | 17 +++++ src/ElmSharp/ElmSharp/EffectBase.cs | 2 + src/ElmSharp/ElmSharp/Elementary.cs | 31 +++++++++ src/ElmSharp/ElmSharp/ElmScrollConfig.cs | 2 + src/ElmSharp/ElmSharp/Entry.cs | 77 ++++++++++++++++++++++ src/ElmSharp/ElmSharp/EvasCanvas.cs | 9 +++ src/ElmSharp/ElmSharp/EvasImage.cs | 19 ++++++ src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs | 8 +++ src/ElmSharp/ElmSharp/EvasMap.cs | 11 ++++ src/ElmSharp/ElmSharp/EvasObject.cs | 73 ++++++++++++++++++++ src/ElmSharp/ElmSharp/EvasObjectEvent.cs | 19 ++++++ src/ElmSharp/ElmSharp/FlipSelector.cs | 15 +++++ src/ElmSharp/ElmSharp/FlipSelectorItem.cs | 4 ++ src/ElmSharp/ElmSharp/FloatingButton.cs | 10 +++ src/ElmSharp/ElmSharp/GenGrid.cs | 40 +++++++++++ src/ElmSharp/ElmSharp/GenGridItem.cs | 13 ++++ src/ElmSharp/ElmSharp/GenItem.cs | 17 +++++ src/ElmSharp/ElmSharp/GenItemClass.cs | 25 +++++++ src/ElmSharp/ElmSharp/GenList.cs | 55 ++++++++++++++++ src/ElmSharp/ElmSharp/GenListItem.cs | 22 +++++++ src/ElmSharp/ElmSharp/GestureLayer.cs | 70 ++++++++++++++++++++ src/ElmSharp/ElmSharp/Hoversel.cs | 17 +++++ src/ElmSharp/ElmSharp/HoverselItem.cs | 3 + src/ElmSharp/ElmSharp/IAccessibleObject.cs | 13 ++++ src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs | 37 +++++++++++ src/ElmSharp/ElmSharp/Icon.cs | 7 ++ src/ElmSharp/ElmSharp/Image.cs | 37 +++++++++++ src/ElmSharp/ElmSharp/Index.cs | 18 +++++ src/ElmSharp/ElmSharp/IndexItem.cs | 5 ++ src/ElmSharp/ElmSharp/ItemObject.cs | 20 ++++++ src/ElmSharp/ElmSharp/ItemObjectExtension.cs | 3 + src/ElmSharp/ElmSharp/Label.cs | 13 ++++ src/ElmSharp/ElmSharp/Layout.cs | 29 ++++++++ src/ElmSharp/ElmSharp/List.cs | 19 ++++++ src/ElmSharp/ElmSharp/ListItem.cs | 4 ++ src/ElmSharp/ElmSharp/MultiButtonEntry.cs | 29 ++++++++ src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs | 6 ++ src/ElmSharp/ElmSharp/NamedHint.cs | 3 + src/ElmSharp/ElmSharp/NaviItem.cs | 7 ++ src/ElmSharp/ElmSharp/Naviframe.cs | 20 ++++++ src/ElmSharp/ElmSharp/Panel.cs | 10 +++ src/ElmSharp/ElmSharp/Panes.cs | 12 ++++ src/ElmSharp/ElmSharp/Point.cs | 9 +++ src/ElmSharp/ElmSharp/Point3D.cs | 10 +++ src/ElmSharp/ElmSharp/Polygon.cs | 6 ++ src/ElmSharp/ElmSharp/Popup.cs | 18 +++++ src/ElmSharp/ElmSharp/PopupItem.cs | 3 + src/ElmSharp/ElmSharp/ProgressBar.cs | 16 +++++ src/ElmSharp/ElmSharp/Radio.cs | 7 ++ src/ElmSharp/ElmSharp/ReadingInfoType.cs | 1 + src/ElmSharp/ElmSharp/Rect.cs | 18 +++++ src/ElmSharp/ElmSharp/Rectangle.cs | 3 + src/ElmSharp/ElmSharp/Scroller.cs | 46 +++++++++++++ src/ElmSharp/ElmSharp/Size.cs | 10 +++ src/ElmSharp/ElmSharp/Slider.cs | 19 ++++++ src/ElmSharp/ElmSharp/SmartEvent.cs | 16 +++++ src/ElmSharp/ElmSharp/Spinner.cs | 20 ++++++ src/ElmSharp/ElmSharp/Table.cs | 11 ++++ src/ElmSharp/ElmSharp/Toolbar.cs | 29 ++++++++ src/ElmSharp/ElmSharp/ToolbarItem.cs | 9 +++ src/ElmSharp/ElmSharp/Transit.cs | 21 ++++++ src/ElmSharp/ElmSharp/TransitEffect.cs | 37 +++++++++++ src/ElmSharp/ElmSharp/Utility.cs | 12 ++++ src/ElmSharp/ElmSharp/Widget.cs | 33 ++++++++++ src/ElmSharp/ElmSharp/Window.cs | 61 +++++++++++++++++ src/ElmSharp/ElmSharp/WrapType.cs | 1 + 108 files changed, 1749 insertions(+) diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs index 475c7c1..0f5c017 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs @@ -24,6 +24,7 @@ namespace ElmSharp.Wearable /// The Circle DateTime Selector is a widget to display and handle datetime value by rotary event /// Inherits /// + /// preview public class CircleDateTimeSelector : DateTimeSelector, IRotaryActionWidget { IntPtr _circleHandle; @@ -34,6 +35,7 @@ namespace ElmSharp.Wearable /// /// The parent of new Circle DateTime instance /// The surface for drawing circle features for this widget. + /// preview public CircleDateTimeSelector(EvasObject parent, CircleSurface surface) : base() { Debug.Assert(parent == null || surface == null || parent.IsRealized); @@ -45,6 +47,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the Circle DateTimeSelector class. /// /// The parent of new Circle CircleDateTimeSelector instance + /// preview [Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")] [EditorBrowsable(EditorBrowsableState.Never)] public CircleDateTimeSelector(EvasObject parent) : this(parent, CircleSurface.CreateCircleSurface(parent)) @@ -55,16 +58,19 @@ namespace ElmSharp.Wearable /// /// Gets the handle for Circle Widget. /// + /// preview public virtual IntPtr CircleHandle => _circleHandle; /// /// Gets the handle for Circle Surface used in this widget /// + /// preview public virtual CircleSurface CircleSurface => _surface; /// /// Sets or gets disabled state of this widget. /// + /// preview [Obsolete("Use IsEnabled")] [EditorBrowsable(EditorBrowsableState.Never)] public bool Disabled @@ -76,6 +82,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public override bool IsEnabled { get @@ -91,6 +98,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the color of the marker /// + /// preview public Color MarkerColor { get @@ -108,6 +116,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the line width of the marker /// + /// preview public int MarkerLineWidth { get @@ -123,6 +132,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the radius at which the center of the marker lies /// + /// preview public double MarkerRadius { get @@ -140,6 +150,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { var handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs index 813c4c6..fd4d13a 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs @@ -24,6 +24,7 @@ namespace ElmSharp.Wearable /// The Circle GenList Selector is a widget to display and handle genlist items by rotary event /// Inherits /// + /// preview public class CircleGenList : GenList, IRotaryActionWidget { IntPtr _circleHandle; @@ -34,6 +35,7 @@ namespace ElmSharp.Wearable /// /// The parent of new Circle GenList instance /// The surface for drawing circle features for this widget. + /// preview public CircleGenList(EvasObject parent, CircleSurface surface) : base() { Debug.Assert(parent == null || surface == null || parent.IsRealized); @@ -45,6 +47,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the Circle GenList class. /// /// The parent of new Circle CircleGenList instance + /// preview [Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")] [EditorBrowsable(EditorBrowsableState.Never)] public CircleGenList(EvasObject parent) : this(parent, CircleSurface.CreateCircleSurface(parent)) @@ -55,16 +58,19 @@ namespace ElmSharp.Wearable /// /// Gets the handle for Circle Widget. /// + /// preview public virtual IntPtr CircleHandle => _circleHandle; /// /// Gets the handle for Circle Surface used in this widget /// + /// preview public virtual CircleSurface CircleSurface => _surface; /// /// Sets or gets disabled state of this widget. /// + /// preview [Obsolete("Use IsEnabled")] [EditorBrowsable(EditorBrowsableState.Never)] public bool Disabled @@ -76,6 +82,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public override bool IsEnabled { get @@ -91,6 +98,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the color of the scroll background /// + /// preview public Color VerticalScrollBackgroundColor { get @@ -108,6 +116,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the line width of the scroll background /// + /// preview public int VerticalScrollBackgroundLineWidth { get @@ -123,6 +132,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the redius of the scroll background /// + /// preview public double VerticalScrollBackgroundRadius { get @@ -138,6 +148,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the color of the scroll bar /// + /// preview public Color VerticalScrollBarColor { get @@ -155,6 +166,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the line width of the scroll bar /// + /// preview public int VerticalScrollBarLineWidth { get @@ -170,6 +182,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the redius of the scroll bar /// + /// preview public double VerticalScrollBarRadius { get @@ -189,6 +202,7 @@ namespace ElmSharp.Wearable /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public ScrollBarVisiblePolicy VerticalScrollBarVisiblePolicy { get @@ -210,6 +224,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { var handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleProgressBar.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleProgressBar.cs index 843b8aa..ff97d0e 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleProgressBar.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleProgressBar.cs @@ -24,6 +24,7 @@ namespace ElmSharp.Wearable /// /// The Circle ProgressBar is a widget for visually representing the progress status of a given job/task with the circular design. /// + /// preview public class CircleProgressBar : Widget, ICircleWidget { CircleSurface _surface; @@ -33,6 +34,7 @@ namespace ElmSharp.Wearable /// /// The parent of new Circle Progressbar instance /// The surface for drawing circle features for this widget. + /// preview public CircleProgressBar(EvasObject parent, CircleSurface surface) : base() { Debug.Assert(parent == null || surface == null || parent.IsRealized); @@ -44,6 +46,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the Circle Progressbar class. /// /// The parent of new Circle Progressbar instance + /// preview [Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")] [EditorBrowsable(EditorBrowsableState.Never)] public CircleProgressBar(EvasObject parent) : this(parent, CircleSurface.CreateCircleSurface(parent)) @@ -53,16 +56,19 @@ namespace ElmSharp.Wearable /// /// Gets the handle for Circle Widget. /// + /// preview public virtual IntPtr CircleHandle => Handle; /// /// Gets the handle for Circle Surface used in this widget /// + /// preview public virtual CircleSurface CircleSurface => _surface; /// /// Sets or gets disabled state of this widget. /// + /// preview [Obsolete("Use IsEnabled")] [EditorBrowsable(EditorBrowsableState.Never)] public bool Disabled @@ -74,6 +80,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public override bool IsEnabled { get @@ -89,6 +96,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the value of ProgressBar. /// + /// preview public double Value { get @@ -104,6 +112,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the maximum value of ProgressBar. /// + /// preview public double Maximum { get @@ -123,6 +132,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the minimum value of ProgressBar. /// + /// preview public double Minimum { get @@ -142,6 +152,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the angle value of ProgressBar. /// + /// preview public double BarAngle { get @@ -157,6 +168,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the angle value of Background ProgressBar. /// + /// preview public double BackgroundAngle { get @@ -172,6 +184,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the angle offset value of ProgressBar. /// + /// preview public double BarAngleOffset { get @@ -187,6 +200,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the angle offset value of Background ProgressBar. /// + /// preview public double BackgroundAngleOffset { get @@ -202,6 +216,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the maximum angle value of ProgressBar. /// + /// preview public double BarAngleMaximum { get @@ -221,6 +236,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the minimum angle value of ProgressBar. /// + /// preview public double BarAngleMinimum { get @@ -240,6 +256,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of ProgressBar. /// + /// preview public Color BarColor { get @@ -260,6 +277,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of Background ProgressBar. /// + /// preview public override Color BackgroundColor { get @@ -280,6 +298,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets line width of ProgressBar. /// + /// preview public int BarLineWidth { get @@ -295,6 +314,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets line width of Background ProgressBar. /// + /// preview public int BackgroundLineWidth { get @@ -310,6 +330,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets radius of ProgressBar. /// + /// preview public double BarRadius { get @@ -325,6 +346,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets radius of Background ProgressBar. /// + /// preview public double BackgroundRadius { get @@ -342,6 +364,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Eext.eext_circle_object_progressbar_add(parent, CircleSurface.Handle); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs index 7ce56f8..278d05f 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs @@ -23,6 +23,7 @@ namespace ElmSharp.Wearable /// /// Circle scroller provides scrollbar with circular movement and is scrolled by rotary event. /// + /// preview public class CircleScroller : Scroller, IRotaryActionWidget { IntPtr _circleHandle; @@ -33,6 +34,7 @@ namespace ElmSharp.Wearable /// /// The to which the new CircleScroller will be attached as a child. /// The surface for drawing circle features for this widget. + /// preview public CircleScroller(EvasObject parent, CircleSurface surface) : base() { Debug.Assert(parent == null || surface == null || parent.IsRealized); @@ -44,6 +46,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the Circle Scroller class. /// /// The parent of new Circle CircleScroller instance + /// preview [Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")] [EditorBrowsable(EditorBrowsableState.Never)] public CircleScroller(EvasObject parent) : this(parent, CircleSurface.CreateCircleSurface(parent)) @@ -54,16 +57,19 @@ namespace ElmSharp.Wearable /// /// Gets the handle for Circle Widget. /// + /// preview public virtual IntPtr CircleHandle => _circleHandle; /// /// Gets the handle for Circle Surface used in this widget /// + /// preview public virtual CircleSurface CircleSurface => _surface; /// /// Sets or gets disabled state of this widget. /// + /// preview [Obsolete("Use IsEnabled")] [EditorBrowsable(EditorBrowsableState.Never)] public bool Disabled @@ -75,6 +81,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public override bool IsEnabled { get @@ -94,6 +101,7 @@ namespace ElmSharp.Wearable /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public override ScrollBarVisiblePolicy HorizontalScrollBarVisiblePolicy { get @@ -116,6 +124,7 @@ namespace ElmSharp.Wearable /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public override ScrollBarVisiblePolicy VerticalScrollBarVisiblePolicy { get @@ -134,6 +143,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of the vertical scroll bar. /// + /// preview public Color VerticalScrollBarColor { get @@ -154,6 +164,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of the horizontal scroll bar. /// + /// preview public Color HorizontalScrollBarColor { get @@ -174,6 +185,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of the vertical scroll background. /// + /// preview public Color VerticalScrollBackgroundColor { get @@ -194,6 +206,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of the horizontal scroll background. /// + /// preview public Color HorizontalScrollBackgroundColor { get @@ -214,6 +227,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets line width of the vertical scroll bar. /// + /// preview public int VerticalScrollBarLineWidth { get @@ -229,6 +243,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets line width of the horizontal scroll bar. /// + /// preview public int HorizontalScrollBarLineWidth { get @@ -244,6 +259,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets line width of the vertical scroll background. /// + /// preview public int VerticalScrollBackgroundLineWidth { get @@ -259,6 +275,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets line width of the horizontal scroll background. /// + /// preview public int HorizontalScrollBackgroundLineWidth { get @@ -274,6 +291,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets radius of the vertical scroll bar. /// + /// preview public double VerticalScrollBarRadius { get @@ -289,6 +307,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets radius of the horizontal scroll bar. /// + /// preview public double HorizontalScrollBarRadius { get @@ -304,6 +323,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets radius of the vertical scroll background. /// + /// preview public double VerticalScrollBackgroundRadius { get @@ -319,6 +339,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets radius of the horizontal scroll background. /// + /// preview public double HorizontalScrollBackgroundRadius { get @@ -336,6 +357,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs index 61959e0..f2e20d2 100755 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs @@ -23,6 +23,7 @@ namespace ElmSharp.Wearable /// /// Circle slider is circular designed widget to select a value in a range by rotary event. /// + /// preview public class CircleSlider : Widget, IRotaryActionWidget { SmartEvent _changedEvent; @@ -33,6 +34,7 @@ namespace ElmSharp.Wearable /// /// The EvasObject to which the new CircleSlider will be attached as a child. /// The surface for drawing circle features for this widget. + /// preview public CircleSlider(EvasObject parent, CircleSurface surface) : base() { Debug.Assert(parent == null || surface == null || parent.IsRealized); @@ -44,6 +46,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the Circle Slider class. /// /// The parent of new Circle CircleSlider instance + /// preview [Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")] [EditorBrowsable(EditorBrowsableState.Never)] public CircleSlider(EvasObject parent) : this(parent, CircleSurface.CreateCircleSurface(parent)) @@ -54,16 +57,19 @@ namespace ElmSharp.Wearable /// /// Changed will be triggered when the circle slider value changes. /// + /// preview public event EventHandler ValueChanged; /// /// Gets the handle for Circle Widget. /// + /// preview public virtual IntPtr CircleHandle => RealHandle; /// /// Gets the handle for Circle Surface used in this widget /// + /// preview public virtual CircleSurface CircleSurface => _surface; /// @@ -73,6 +79,7 @@ namespace ElmSharp.Wearable /// This value is used when circle slider value is changed by an drag or rotary event /// The value of the slider is increased/decreased by the step value. /// + /// preview public double Step { get @@ -88,6 +95,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets disabled state of this widget. /// + /// preview [Obsolete("Use IsEnabled")] [EditorBrowsable(EditorBrowsableState.Never)] public bool Disabled @@ -99,6 +107,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public override bool IsEnabled { get @@ -114,6 +123,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of the circle slider bar. /// + /// preview public Color BarColor { get @@ -134,6 +144,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets color of the circle slider background. /// + /// preview public override Color BackgroundColor { get @@ -154,6 +165,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the line with of the circle slider bar. /// + /// preview public int BarLineWidth { get @@ -169,6 +181,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the line with of the circle slider background. /// + /// preview public int BackgroundLineWidth { get @@ -184,6 +197,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the angle in degree of the circle slider bar. /// + /// preview public double BarAngle { get @@ -199,6 +213,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the angle in degree of the circle slider background. /// + /// preview public double BackgroundAngle { get @@ -215,6 +230,7 @@ namespace ElmSharp.Wearable /// Sets or gets the angle offset for the slider bar. /// offset value means start position of the slider bar. /// + /// preview public double BarAngleOffset { get @@ -231,6 +247,7 @@ namespace ElmSharp.Wearable /// Sets or gets the angle offset for the circle slider background. /// offset value means start position of the slider background. /// + /// preview public double BackgroundAngleOffset { get @@ -246,6 +263,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the minimum angle of the circle slider bar. /// + /// preview public double BarAngleMinimum { get @@ -265,6 +283,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the maximum angle of the circle slider bar. /// + /// preview public double BarAngleMaximum { get @@ -289,6 +308,7 @@ namespace ElmSharp.Wearable /// If the actual value is less than min, it is updated to min. /// Actual value can be obtained with Value.By default, min is equal to 0.0. /// + /// preview public double Minimum { get @@ -314,6 +334,7 @@ namespace ElmSharp.Wearable /// Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. /// Maximum must be greater than minimum, otherwise the behavior is undefined. /// + /// preview public double Maximum { get @@ -336,6 +357,7 @@ namespace ElmSharp.Wearable /// /// The value must to be between Minimum and Maximum values. /// + /// preview public double Value { get @@ -351,6 +373,7 @@ namespace ElmSharp.Wearable /// /// Gets or sets the radius value for the circle slider bar. /// + /// preview public double BarRadius { get @@ -366,6 +389,7 @@ namespace ElmSharp.Wearable /// /// Gets or sets the radius value for the circle slider background. /// + /// preview public double BackgroundRadius { get @@ -381,6 +405,7 @@ namespace ElmSharp.Wearable /// /// The callback of Realized Event /// + /// preview protected override void OnRealized() { base.OnRealized(); @@ -393,6 +418,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Eext.eext_circle_object_slider_add(parent, CircleSurface.Handle); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs index 0c62a7c..c0ca700 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs @@ -25,6 +25,7 @@ namespace ElmSharp.Wearable /// The Circle Spinner is a widget to display and handle spinner value by rotary event /// Inherits . /// + /// preview public class CircleSpinner : Spinner, IRotaryActionWidget { IntPtr _circleHandle; @@ -36,6 +37,7 @@ namespace ElmSharp.Wearable /// /// The parent of new Circle Spinner instance /// The surface for drawing circle features for this widget. + /// preview public CircleSpinner(EvasObject parent, CircleSurface surface) : base() { Debug.Assert(parent == null || surface == null || parent.IsRealized); @@ -47,6 +49,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the Circle Spinner class. /// /// The parent of new Circle CircleSpinner instance + /// preview [Obsolete("It is not safe for guess circle surface from parent and create new surface by every new widget")] [EditorBrowsable(EditorBrowsableState.Never)] public CircleSpinner(EvasObject parent) : this(parent, CircleSurface.CreateCircleSurface(parent)) @@ -57,16 +60,19 @@ namespace ElmSharp.Wearable /// /// Gets the handle for Circle Widget. /// + /// preview public virtual IntPtr CircleHandle => _circleHandle; /// /// Gets the handle for Circle Surface used in this widget /// + /// preview public virtual CircleSurface CircleSurface => _surface; /// /// Sets or gets the circle spinner angle per each spinner value. /// + /// preview public double AngleRatio { get @@ -83,6 +89,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets disabled state of this widget. /// + /// preview [Obsolete("Use IsEnabled")] [EditorBrowsable(EditorBrowsableState.Never)] public bool Disabled @@ -94,6 +101,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public override bool IsEnabled { get @@ -109,6 +117,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the line width of the marker /// + /// preview public int MarkerLineWidth { get @@ -124,6 +133,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the color of the marker /// + /// preview public Color MarkerColor { get @@ -141,6 +151,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the radius at which the center of the marker lies /// + /// preview public double MarkerRadius { get @@ -158,6 +169,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSurface.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSurface.cs index c8e574a..c36cef9 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSurface.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSurface.cs @@ -7,6 +7,7 @@ namespace ElmSharp.Wearable /// /// The CircleSurface presents a surface for drawing circular feature of circle widgets /// + /// preview public class CircleSurface { IntPtr _handle; @@ -15,6 +16,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the CircleSurface class with surface on the Conformant widget. /// /// Conformant widget to create a surface. + /// preview public CircleSurface(Conformant conformant) { _handle = Interop.Eext.eext_circle_surface_conformant_add(conformant); @@ -24,6 +26,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the CircleSurface class with surface on the Layout widget. /// /// Layout widget to create a surface. + /// preview public CircleSurface(Layout layout) { _handle = Interop.Eext.eext_circle_surface_layout_add(layout); @@ -33,6 +36,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of the CircleSurface class with surface on the Naviframe widget. /// /// Naviframe widget to create a surface. + /// preview public CircleSurface(Naviframe naviframe) { _handle = Interop.Eext.eext_circle_surface_naviframe_add(naviframe); @@ -41,6 +45,7 @@ namespace ElmSharp.Wearable /// /// Creates and initializes a new instance of the CircleSurface class with no surface /// + /// preview public CircleSurface() { _handle = IntPtr.Zero; @@ -49,11 +54,13 @@ namespace ElmSharp.Wearable /// /// Gets the handle for CircleSurface /// + /// preview public IntPtr Handle => _handle; /// /// Delete the given CirclrSurface /// + /// preview public void Delete() { if (Handle != IntPtr.Zero) diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/ICircleWidget.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/ICircleWidget.cs index 17cdf42..2f0a89c 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/ICircleWidget.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/ICircleWidget.cs @@ -7,22 +7,26 @@ namespace ElmSharp.Wearable /// /// The ICircleWidget is the interface for a widget to display and handle with circle surface /// + /// preview public interface ICircleWidget { /// /// Gets the handle for Circle Widget. /// + /// preview IntPtr CircleHandle { get; } /// /// Gets the CircleSurface used in this widget /// + /// preview CircleSurface CircleSurface { get; } } /// /// The IRotaryActionWidget is the interface for a widget has action by rotary event /// + /// preview public interface IRotaryActionWidget : ICircleWidget { } diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs index e27b780..af8163d 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs @@ -24,28 +24,34 @@ namespace ElmSharp.Wearable /// The MoreOption is a widget composed of the toggle(cue button) and more option view, and MoreOption can change a visibility through the toggle. /// Inherits Layout /// + /// preview public class MoreOption : Layout { /// /// Sets or gets the list of more option item /// + /// preview public IList Items { get; private set; } /// /// Selected will be triggered when the user selects an item. /// + /// preview public event EventHandler Selected; /// /// Clicked will be triggered when the user selects the already selected item again or selects a selector. /// + /// preview public event EventHandler Clicked; /// /// Opened will be triggered when more option view is shown. /// + /// preview public event EventHandler Opened; /// /// Closed will be triggered when more option view is hidden. /// + /// preview public event EventHandler Closed; SmartEvent _selectedEvent; @@ -57,6 +63,7 @@ namespace ElmSharp.Wearable /// Creates and initializes a new instance of MoreOption class. /// /// The parent is a given container which will be attached by MoreOption as a child. It's type. + /// preview public MoreOption(EvasObject parent) : base(parent) { Items = new MoreOptionList(this); @@ -88,6 +95,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Eext.eext_more_option_add(parent); @@ -96,6 +104,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the direction of more option. /// + /// preview public MoreOptionDirection Direction { get @@ -113,6 +122,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the visibility of more option view. /// + /// preview public bool IsOpened { get @@ -130,6 +140,7 @@ namespace ElmSharp.Wearable /// /// Enumeration for More Option Direction type. /// + /// preview public enum MoreOptionDirection { /// diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItem.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItem.cs index d6b4933..c6d68dd 100755 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItem.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItem.cs @@ -23,6 +23,7 @@ namespace ElmSharp.Wearable /// /// The MoreOptionItem is a item of MoreOption widget. /// + /// preview public class MoreOptionItem { const string MainTextPartName = "selector,main_text"; @@ -37,6 +38,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the more option item handle. /// + /// preview public IntPtr Handle { get @@ -59,6 +61,7 @@ namespace ElmSharp.Wearable /// /// Creates and initializes a new instance of MoreOptionItem class. /// + /// preview public MoreOptionItem() { _icon = null; @@ -67,6 +70,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the main text of a more option object. /// + /// preview public string MainText { set @@ -88,6 +92,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the sub text of a more option object. /// + /// preview public string SubText { set @@ -109,6 +114,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the icon image /// + /// preview public Image Icon { set diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItemEventArgs.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItemEventArgs.cs index baee453..7bc7857 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItemEventArgs.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionItemEventArgs.cs @@ -22,11 +22,13 @@ namespace ElmSharp.Wearable /// The MoreOptionItemEventArgs is a event args class for MoreOptionItem. /// Inherits EventArgs /// + /// preview public class MoreOptionItemEventArgs : EventArgs { /// /// Sets or gets the more option item /// + /// preview public MoreOptionItem Item { get; set; } } } diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotaryEventManager.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotaryEventManager.cs index f413ae4..7fc06ab 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotaryEventManager.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotaryEventManager.cs @@ -24,6 +24,7 @@ namespace ElmSharp.Wearable /// /// RotaryEventManager serve functions for global Rotary event like Galaxy Gear. /// + /// preview public static class RotaryEventManager { static Dictionary s_rotaryEventHandlers = new Dictionary(); @@ -31,6 +32,7 @@ namespace ElmSharp.Wearable /// /// Rotated will triggered when rotatable device like Galaxy Gear Bezel is rotated. /// + /// preview public static event RotaryEventHandler Rotated { add @@ -67,6 +69,7 @@ namespace ElmSharp.Wearable /// /// RotaryEventManager serve extension functions for Rotary event to EvasObject on device like Galaxy Gear. /// + /// preview public static class RotaryEventExtensions { static Dictionary s_rotaryObjectEventHandlers = new Dictionary(); @@ -77,6 +80,7 @@ namespace ElmSharp.Wearable /// /// Target EvasObject /// Event handler for Rotary event + /// preview public static void AddRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler) { EnableRotaryEventHandler(obj); @@ -96,6 +100,7 @@ namespace ElmSharp.Wearable /// /// Target EvasObject /// Event handler for Rotary event + /// preview public static void RemoveRotaryEventHandler(this EvasObject obj, RotaryEventHandler handler) { if (s_rotaryObjectEventHandlers.ContainsKey(obj)) @@ -113,6 +118,7 @@ namespace ElmSharp.Wearable /// Activate this circle widget can take Rotary event. /// /// Target circle widget + /// preview public static void Activate(this IRotaryActionWidget widget) { Interop.Eext.eext_rotary_object_event_activated_set(widget.CircleHandle, true); @@ -122,6 +128,7 @@ namespace ElmSharp.Wearable /// Deactivate this circle widget is blocked from Rotary event. /// /// Target circle widget + /// preview public static void Deactivate(this IRotaryActionWidget widget) { Interop.Eext.eext_rotary_object_event_activated_set(widget.CircleHandle, false); @@ -131,6 +138,7 @@ namespace ElmSharp.Wearable /// Activate this object can take Rotary event. /// /// Target object + /// preview public static void Activate(this EvasObject obj) { Interop.Eext.eext_rotary_object_event_activated_set(obj, true); @@ -140,6 +148,7 @@ namespace ElmSharp.Wearable /// Deactivate this object is blocked from Rotary event. /// /// Target object + /// preview public static void Deactivate(this EvasObject obj) { Interop.Eext.eext_rotary_object_event_activated_set(obj, false); @@ -188,21 +197,25 @@ namespace ElmSharp.Wearable /// Handler for Rotary event /// /// Rotary event information + /// preview public delegate void RotaryEventHandler(RotaryEventArgs args); /// /// RotaryEventArgs serve information for triggered rotary event. /// + /// preview public class RotaryEventArgs : EventArgs { /// /// IsClockwise is true when Rotary device rotated clockwise direction or false on counter clockwise. /// + /// preview public bool IsClockwise { get; set; } /// /// Timestamp of rotary event /// + /// preview public uint Timestamp { get; set; } } } diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs index 5f56be9..0e99f2f 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs @@ -26,6 +26,7 @@ namespace ElmSharp.Wearable /// And an item can be selected by rotary event or user item click. /// Inherits . /// + /// preview public class RotarySelector : Layout { const string IconPartName = "selector,icon"; @@ -38,11 +39,13 @@ namespace ElmSharp.Wearable /// /// Selected will be triggered when selected an item. /// + /// preview public event EventHandler Selected; /// /// Clicked will be triggered when selecting again the alredy selected item or selecting a selector. /// + /// preview public event EventHandler Clicked; SmartEvent _selectedEvent; @@ -52,12 +55,14 @@ namespace ElmSharp.Wearable /// /// Gets the rotary selector item list of a rotary selector object. /// + /// preview public IList Items { get; private set; } /// /// Creates and initializes a new instance of the Rotary Selector class. /// /// The parent of new Rotary Selector instance + /// preview public RotarySelector(EvasObject parent) : base(parent) { Items = new RotarySelectorList(this); @@ -80,6 +85,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the selected item of a rotary selector object. /// + /// preview public RotarySelectorItem SelectedItem { get @@ -118,6 +124,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the background image of a rotary selector object. /// + /// preview public Image BackgroundImage { set => setPart(ref _normalBgImage, BgPartName, State.Normal, value); get => _normalBgImage; } /// @@ -125,6 +132,7 @@ namespace ElmSharp.Wearable /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr ptr = Interop.Eext.eext_rotary_selector_add(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItem.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItem.cs index 38e46cb..6d792f8 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItem.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItem.cs @@ -23,6 +23,7 @@ namespace ElmSharp.Wearable /// /// A instance to the Rotary Selector Item added. And an item can be selected by rotary event or user item click. /// + /// preview public class RotarySelectorItem { const string MainTextPartName = "selector,main_text"; @@ -59,6 +60,7 @@ namespace ElmSharp.Wearable /// /// Sets or gets the handle of a rotary selector item object. /// + /// preview public IntPtr Handle { set @@ -153,86 +155,103 @@ namespace ElmSharp.Wearable /// /// Sets or gets the main text of a rotary selector item object. /// + /// preview public string MainText { set => setPart(ref _mainText, MainTextPartName, value); get => _mainText; } /// /// Sets or gets the sub text of a rotary selector item object. /// + /// preview public string SubText { set => setPart(ref _subText, SubTextPartName, value); get => _subText; } /// /// Sets or gets the sub text color of a rotary selector item object. /// + /// preview public Color MainTextColor { set => setPart(ref _mainTextColor, MainTextPartName, ItemState.Normal, value); get => _mainTextColor; } /// /// Sets or gets the sub text color of a rotary selector item object. /// + /// preview public Color SubTextColor { set => setPart(ref _subTextColor, SubTextPartName, ItemState.Normal, value); get => _subTextColor; } /// /// Sets or gets the normal icon image of a rotary selector item object. /// + /// preview public Image NormalIconImage { set => setPart(ref _normalIconImage, IconPartName, ItemState.Normal, value); get => _normalIconImage; } /// /// Sets or gets the press icon image of a rotary selector item object. /// + /// preview public Image PressedIconImage { set => setPart(ref _pressedIconImage, IconPartName, ItemState.Pressed, value); get => _pressedIconImage; } /// /// Sets or gets the disable icon image of a rotary selector item object. /// + /// preview public Image DisabledIconImage { set => setPart(ref _disabledIconImage, IconPartName, ItemState.Disabled, value); get => _disabledIconImage; } /// /// Sets or gets the selected icon image of a rotary selector item object. /// + /// preview public Image SelectedIconImage { set => setPart(ref _selectedIconImage, IconPartName, ItemState.Selected, value); get => _selectedIconImage; } /// /// Sets or gets the normal background image of a rotary selector item object. /// + /// preview public Image NormalBackgroundImage { set => setPart(ref _normalBgImage, BgPartName, ItemState.Normal, value); get => _normalBgImage; } /// /// Sets or gets the pressed background image of a rotary selector item object. /// + /// preview public Image PressedBackgroundImage { set => setPart(ref _pressedBgImage, BgPartName, ItemState.Pressed, value); get => _pressedBgImage; } /// /// Sets or gets the disabled background image of a rotary selector item object. /// + /// preview public Image DisabledBackgroundImage { set => setPart(ref _disabledBgImage, BgPartName, ItemState.Disabled, value); get => _disabledBgImage; } /// /// Sets or gets the selected background image of a rotary selector item object. /// + /// preview public Image SelectedBackgroundImage { set => setPart(ref _selectedBgImage, BgPartName, ItemState.Selected, value); get => _selectedBgImage; } /// /// Sets or gets the normal background color of a rotary selector item object. /// + /// preview public Color NormalBackgroundColor { set => setPart(ref _normalBgColor, BgPartName, ItemState.Normal, value); get => _normalBgColor; } /// /// Sets or gets the pressed background color of a rotary selector item object. /// + /// preview public Color PressedBackgroundColor { set => setPart(ref _pressedBgColor, BgPartName, ItemState.Pressed, value); get => _pressedBgColor; } /// /// Sets or gets the disabled background color of a rotary selector item object. /// + /// preview public Color DisabledBackgroundColor { set => setPart(ref _disabledBgColor, BgPartName, ItemState.Disabled, value); get => _disabledBgColor; } /// /// Sets or gets the selected background color of a rotary selector item object. /// + /// preview public Color SelectedBackgroundColor { set => setPart(ref _selectedBgColor, BgPartName, ItemState.Selected, value); get => _selectedBgColor; } /// /// Sets or gets the selector icon image of a rotary selector item object. /// + /// preview public Image SelectorIconImage { set => setPart(ref _selectorIconImage, SelectorIconPartName, ItemState.Normal, value); get => _selectorIconImage; } internal enum ItemState diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItemEventArgs.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItemEventArgs.cs index 22630d9..011dc20 100755 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItemEventArgs.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelectorItemEventArgs.cs @@ -24,11 +24,13 @@ namespace ElmSharp.Wearable /// and events of RotarySelector contain RotarySelectorItemEventArgs as a parameter. /// Inherits . /// + /// preview public class RotarySelectorItemEventArgs : EventArgs { /// /// Sets or gets the rotary selector item. /// + /// preview public RotarySelectorItem Item { get; set; } } } diff --git a/src/ElmSharp/ElmSharp/AccessRole.cs b/src/ElmSharp/ElmSharp/AccessRole.cs index b49b2a2..0d7311d 100755 --- a/src/ElmSharp/ElmSharp/AccessRole.cs +++ b/src/ElmSharp/ElmSharp/AccessRole.cs @@ -20,6 +20,7 @@ namespace ElmSharp.Accessible /// /// Enumeration for AccessRole. /// + /// preview public enum AccessRole { /// diff --git a/src/ElmSharp/ElmSharp/AccessibleObject.cs b/src/ElmSharp/ElmSharp/AccessibleObject.cs index 08eedcb..18ea109 100755 --- a/src/ElmSharp/ElmSharp/AccessibleObject.cs +++ b/src/ElmSharp/ElmSharp/AccessibleObject.cs @@ -23,6 +23,7 @@ namespace ElmSharp.Accessible /// /// The sender obj. /// Return information for Name or Description. + /// preview public delegate string AccessibleInfoProvider (AccessibleObject obj); /// @@ -30,6 +31,7 @@ namespace ElmSharp.Accessible /// It provides available definitions for the screen reader, such as , , , etc. /// There's many the relationship between two accessible objects, like , , , , etc. /// + /// preview public abstract class AccessibleObject : EvasObject, IAccessibleObject { @@ -196,6 +198,7 @@ namespace ElmSharp.Accessible /// Creates and initializes a new instance of the AccessibleObject class with parent EvasObject class parameter. /// /// Parent EvasObject class + /// preview public AccessibleObject(EvasObject parent) : base(parent) { } @@ -203,6 +206,7 @@ namespace ElmSharp.Accessible /// /// Creates and initializes a new instance of the AccessibleObject class. /// + /// preview public AccessibleObject() : base() { } @@ -232,6 +236,7 @@ namespace ElmSharp.Accessible /// /// Highlights accessible widget. /// + /// preview public void Highlight() { Interop.Elementary.elm_atspi_component_highlight_grab(RealHandle); @@ -240,6 +245,7 @@ namespace ElmSharp.Accessible /// /// Clears highlight of accessible widget. /// + /// preview public void Unhighlight() { Interop.Elementary.elm_atspi_component_highlight_clear(RealHandle); diff --git a/src/ElmSharp/ElmSharp/AccessibleRelation.cs b/src/ElmSharp/ElmSharp/AccessibleRelation.cs index 0c88422..488cf80 100755 --- a/src/ElmSharp/ElmSharp/AccessibleRelation.cs +++ b/src/ElmSharp/ElmSharp/AccessibleRelation.cs @@ -20,33 +20,39 @@ namespace ElmSharp.Accessible /// /// IAccessibleRelation is a interface which defines the relationship between two accessible objects. /// + /// preview public interface IAccessibleRelation { /// /// Gets or sets the target object. /// + /// preview AccessibleObject Target { get; set; } /// /// Gets the type. /// + /// preview int Type { get; } } /// /// To define label info for accessible object. /// + /// preview public class LabelledBy : IAccessibleRelation { /// /// Gets or sets the target object which is LabelledBy. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the LabelledBy type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_LABELLED_BY; } @@ -56,16 +62,19 @@ namespace ElmSharp.Accessible /// /// To define label info for accessible object. /// + /// preview public class LabelFor : IAccessibleRelation { /// /// Gets or sets the target object which is LabelFor. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the LabelFor type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_LABEL_FOR; } @@ -75,16 +84,19 @@ namespace ElmSharp.Accessible /// /// To define control relationship for accessible object. /// + /// preview public class ControllerFor : IAccessibleRelation { /// /// Gets or sets the target object which is ControllerFor. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the ControllerFor type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_CONTROLLER_FOR; } @@ -94,16 +106,19 @@ namespace ElmSharp.Accessible /// /// To define control relationship for accessible object. /// + /// preview public class ControlledBy : IAccessibleRelation { /// /// Gets or sets the target object which is ControlledBy. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the ControlledBy type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_CONTROLLED_BY; } @@ -113,16 +128,19 @@ namespace ElmSharp.Accessible /// /// To define member relationship for accessible object. /// + /// preview public class MemberOf : IAccessibleRelation { /// /// Gets or sets the target object which is MemberOf. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the MemberOf type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_MEMBER_OF; } @@ -132,16 +150,19 @@ namespace ElmSharp.Accessible /// /// To define tooltip for accessible object. /// + /// preview public class TooltipFor : IAccessibleRelation { /// /// Gets or sets the target object which is TooltipFor. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the TooltipFor type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_TOOLTIP_FOR; } @@ -151,16 +172,19 @@ namespace ElmSharp.Accessible /// /// To define child for accessible object. /// + /// preview public class ChildOf : IAccessibleRelation { /// /// Gets or sets the target object which is ChildOf. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the ChildOf type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_NODE_CHILD_OF; } @@ -170,16 +194,19 @@ namespace ElmSharp.Accessible /// /// To define parent for accessible object. /// + /// preview public class ParentOf : IAccessibleRelation { /// /// Gets or sets the target object which is ParentOf. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the ParentOf type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_NODE_PARENT_OF; } @@ -189,16 +216,19 @@ namespace ElmSharp.Accessible /// /// To define extend for accessible object. /// + /// preview public class Extended : IAccessibleRelation { /// /// Gets or sets the target object which is Extended. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the Extended type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_EXTENDED; } @@ -208,16 +238,19 @@ namespace ElmSharp.Accessible /// /// To define the custom reading order. /// + /// preview public class FlowsTo : IAccessibleRelation { /// /// Gets or sets the target object which is FlowsTo. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the FlowsTo type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_FLOWS_TO; } @@ -227,16 +260,19 @@ namespace ElmSharp.Accessible /// /// To define the custom reading order. /// + /// preview public class FlowsFrom : IAccessibleRelation { /// /// Gets or sets the target object which is FlowsFrom. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the FlowsFrom type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_FLOWS_FROM; } @@ -246,16 +282,19 @@ namespace ElmSharp.Accessible /// /// To define subwindow for accessible object. /// + /// preview public class SubwindowOf : IAccessibleRelation { /// /// Gets or sets the target object which is SubwindowOf. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the SubwindowOf type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_SUBWINDOW_OF; } @@ -265,16 +304,19 @@ namespace ElmSharp.Accessible /// /// To define embed for accessible object. /// + /// preview public class Embeds : IAccessibleRelation { /// /// Gets or sets the target object which is Embeds. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the Embeds type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_EMBEDS; } @@ -284,16 +326,19 @@ namespace ElmSharp.Accessible /// /// To define embed for accessible object. /// + /// preview public class EmbeddedBy : IAccessibleRelation { /// /// Gets or sets the target object which is EmbeddedBy. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the EmbeddedBy type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_EMBEDDED_BY; } @@ -303,16 +348,19 @@ namespace ElmSharp.Accessible /// /// To define popup for accessible object. /// + /// preview public class PopupFor : IAccessibleRelation { /// /// Gets or sets the target object which is PopupFor. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the PopupFor type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_POPUP_FOR; } @@ -322,16 +370,19 @@ namespace ElmSharp.Accessible /// /// To define parent window for accessible object. /// + /// preview public class ParentWindowOf : IAccessibleRelation { /// /// Gets or sets the target object which is ParentWindowOf. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the ParentWindowOf type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_PARENT_WINDOW_OF; } @@ -341,16 +392,19 @@ namespace ElmSharp.Accessible /// /// To define description for accessible object. /// + /// preview public class DescriptionFor : IAccessibleRelation { /// /// Gets or sets the target object which is DescriptionFor. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the DescriptionFor type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_DESCRIPTION_FOR; } @@ -360,16 +414,19 @@ namespace ElmSharp.Accessible /// /// To define description for accessible object. /// + /// preview public class DescribedBy : IAccessibleRelation { /// /// Gets or sets the target object which is DescribedBy. /// + /// preview public AccessibleObject Target { get; set; } /// /// Gets the DescribedBy type. /// + /// preview public int Type { get { return (int)Interop.Elementary.Elm_Atspi_Relation_Type.ELM_ATSPI_RELATION_DESCRIBED_BY; } diff --git a/src/ElmSharp/ElmSharp/AccessibleUtil.cs b/src/ElmSharp/ElmSharp/AccessibleUtil.cs index 720fca4..0be2e91 100755 --- a/src/ElmSharp/ElmSharp/AccessibleUtil.cs +++ b/src/ElmSharp/ElmSharp/AccessibleUtil.cs @@ -23,6 +23,7 @@ namespace ElmSharp.Accessible /// /// Enumeration for ReadingStatus. /// + /// preview public enum ReadingStatus { /// @@ -46,6 +47,7 @@ namespace ElmSharp.Accessible /// /// AccessibleUtil provides a method to set the reading information. /// + /// preview public static class AccessibleUtil { @@ -79,6 +81,7 @@ namespace ElmSharp.Accessible /// The reading text. /// If true, reading can be discarded by subsequent reading requests, if false the reading must finish before next reading request can be started. /// Return a task with reading status. + /// preview public static Task Say(string text, bool discardable) { var tcs = new TaskCompletionSource(); diff --git a/src/ElmSharp/ElmSharp/Background.cs b/src/ElmSharp/ElmSharp/Background.cs index 29362af..9f2e955 100755 --- a/src/ElmSharp/ElmSharp/Background.cs +++ b/src/ElmSharp/ElmSharp/Background.cs @@ -22,12 +22,14 @@ namespace ElmSharp /// The Background is a widget that use for setting (solid) background decorations to a window (unless it has transparency enabled) /// or to any container object. /// + /// preview public class Background : Layout { /// /// Creates and initializes a new instance of the Background class. /// /// The EvasObject to which the new Background will be attached as a child. + /// preview public Background(EvasObject parent) : base(parent) { Style = "transparent"; @@ -36,6 +38,7 @@ namespace ElmSharp /// /// Sets or gets color to Background. /// + /// preview public override Color Color { get @@ -66,6 +69,7 @@ namespace ElmSharp /// /// Sets or gets image to Background. /// + /// preview public string File { get @@ -86,6 +90,7 @@ namespace ElmSharp /// This will only work if the File was previously set with an image file on obj. /// The image can be display tiled, scaled, centered or stretched. scaled by default. /// + /// preview public BackgroundOptions BackgroundOption { get @@ -106,6 +111,7 @@ namespace ElmSharp /// /// The new width of the image pixmap representation. /// The new height of the image pixmap representation. + /// preview public void SetFileLoadSize(int w, int h) { if (File != null) @@ -123,6 +129,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); @@ -138,6 +145,7 @@ namespace ElmSharp /// /// Enumeration for the background type. /// + /// preview public enum BackgroundOptions { /// diff --git a/src/ElmSharp/ElmSharp/Box.cs b/src/ElmSharp/ElmSharp/Box.cs index ea928c9..19a5a9b 100755 --- a/src/ElmSharp/ElmSharp/Box.cs +++ b/src/ElmSharp/ElmSharp/Box.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The Box is a container used to arranges UI components in a linear order. /// + /// preview public class Box : Container { private Interop.Elementary.BoxLayoutCallback _layoutCallback; @@ -29,6 +30,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Box class. /// /// The EvasObject to which the new Box will be attached as a child. + /// preview public Box(EvasObject parent) : base(parent) { } @@ -36,6 +38,7 @@ namespace ElmSharp /// /// Sets or gets IsHorizontal value which describe pack direction, vertical is default. /// + /// preview public bool IsHorizontal { get @@ -51,6 +54,7 @@ namespace ElmSharp /// /// Sets or gets whether the box to arrange its children homogeneously. /// + /// preview public bool IsHomogeneous { get @@ -73,6 +77,7 @@ namespace ElmSharp /// depending if the Box is vertical or horizontal, respectively. /// /// The oject be packed + /// preview public void PackEnd(EvasObject content) { Interop.Elementary.elm_box_pack_end(RealHandle, content); @@ -89,6 +94,7 @@ namespace ElmSharp /// depending if the Box is vertical or horizontal, respectively. /// /// The object to be packed. + /// preview public void PackStart(EvasObject content) { Interop.Elementary.elm_box_pack_start(RealHandle, content); @@ -105,6 +111,7 @@ namespace ElmSharp /// /// The object will be added in Box /// The object has been added in Box + /// preview public void PackAfter(EvasObject content, EvasObject after) { Interop.Elementary.elm_box_pack_after(RealHandle, content, after); @@ -121,6 +128,7 @@ namespace ElmSharp /// /// The object will be added in Box /// The object has been added in Box + /// preview public void PackBefore(EvasObject content, EvasObject before) { Interop.Elementary.elm_box_pack_before(RealHandle, content, before); @@ -131,6 +139,7 @@ namespace ElmSharp /// Remove the "content" oject from Box without deleting it. /// /// The object to unpack + /// preview public void UnPack(EvasObject content) { Interop.Elementary.elm_box_unpack(RealHandle, content); @@ -140,6 +149,7 @@ namespace ElmSharp /// /// Removes all objects from Box container. /// + /// preview public void UnPackAll() { Interop.Elementary.elm_box_unpack_all(RealHandle); @@ -151,6 +161,7 @@ namespace ElmSharp /// the function cb will be called to determine what the layout of the children will be. /// /// The callback function used for layout + /// preview public void SetLayoutCallback(Action action) { _layoutCallback = (obj, priv, data) => @@ -165,6 +176,7 @@ namespace ElmSharp /// /// The name of part class, it could be 'bg', 'elm.swllow.content'. /// The color value. + /// preview public override void SetPartColor(string part, Color color) { Interop.Elementary.elm_object_color_class_color_set(Handle, part, color.R * color.A / 255, @@ -178,6 +190,7 @@ namespace ElmSharp /// /// The name of part class, it could be 'bg', 'elm.swllow.content'. /// + /// preview public override Color GetPartColor(string part) { int r, g, b, a; @@ -190,6 +203,7 @@ namespace ElmSharp /// If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration. /// While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so. /// + /// preview public void Recalculate() { Interop.Elementary.elm_box_recalculate(RealHandle); @@ -199,6 +213,7 @@ namespace ElmSharp /// Clear the box of all children. /// Remove all the elements contained by the box, deleting the respective objects. /// + /// preview public void Clear() { Interop.Elementary.elm_box_clear(RealHandle); @@ -210,6 +225,7 @@ namespace ElmSharp /// /// Horizontal alignment /// Vertical alignment + /// preview public void SetBoxAlignment(double horizontal, double vertical) { Interop.Elementary.elm_box_align_set(RealHandle, horizontal, vertical); @@ -220,6 +236,7 @@ namespace ElmSharp /// /// Horizontal padding /// vertical padding + /// preview public void SetPadding(int horizontal, int vertical) { Interop.Elementary.elm_box_padding_set(RealHandle, horizontal, vertical); @@ -230,6 +247,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Button.cs b/src/ElmSharp/ElmSharp/Button.cs index 6fe2ae5..9f6c80b 100755 --- a/src/ElmSharp/ElmSharp/Button.cs +++ b/src/ElmSharp/ElmSharp/Button.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The Button is a widget works as a clickable input element to trigger events. /// + /// preview public class Button : Layout { private SmartEvent _clicked; @@ -34,6 +35,7 @@ namespace ElmSharp /// /// The EvasObject to which the new Button will be attached as a child. /// + /// preview public Button(EvasObject parent) : base(parent) { _clicked = new SmartEvent(this, this.RealHandle, "clicked"); @@ -65,21 +67,25 @@ namespace ElmSharp /// /// Clicked will be triggered when Button is clicked. /// + /// preview public event EventHandler Clicked; /// /// Repeated will be triggered when Button is pressed without releasing it. /// + /// preview public event EventHandler Repeated; /// /// Pressed will be triggered when the Button is pressed. /// + /// preview public event EventHandler Pressed; /// /// Released will be triggered when the Button is released after being pressed. /// + /// preview public event EventHandler Released; /// @@ -92,6 +98,7 @@ namespace ElmSharp /// The time it takes until it starts triggering Repeated is given by AutoRepeatInitialTime, /// and the time between each new emission is given by AutoRepeatGapTimeout. /// + /// preview public bool AutoRepeat { get @@ -107,6 +114,7 @@ namespace ElmSharp /// /// Sets or gets the initial timeout before the Repeat event is generated. /// + /// preview public double AutoRepeatInitialTime { get @@ -122,6 +130,7 @@ namespace ElmSharp /// /// Sets or gets the interval between each generated Repeat event. /// + /// preview public double AutoRepeatGapTimeout { get @@ -138,6 +147,7 @@ namespace ElmSharp /// Delete the object color class. /// /// The color class to be deleted. + /// preview [Obsolete("DeleteColorClass is obsolete, please use EdjeObject.DeleteColorClass(string)")] public void DeleteColorClass(string part) { @@ -147,6 +157,7 @@ namespace ElmSharp /// /// Sets or gets the BackgroundColor of a given Button in normal and pressed status. /// + /// preview public override Color BackgroundColor { set @@ -172,6 +183,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_button_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Calendar.cs b/src/ElmSharp/ElmSharp/Calendar.cs index 7a20c70..5f3f18b 100755 --- a/src/ElmSharp/ElmSharp/Calendar.cs +++ b/src/ElmSharp/ElmSharp/Calendar.cs @@ -24,6 +24,7 @@ namespace ElmSharp /// /// Enumeration for event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added. /// + /// preview public enum CalendarMarkRepeatType { /// @@ -60,6 +61,7 @@ namespace ElmSharp /// /// Enumeration for the mode, which determine how user could select a day. /// + /// preview public enum CalendarSelectMode { /// @@ -86,6 +88,7 @@ namespace ElmSharp /// /// Enumeration used to define which fields of a tm struct will be taken into account /// + /// preview [Flags] public enum CalendarSelectable { @@ -110,6 +113,7 @@ namespace ElmSharp /// /// The CalendarMark is a Item for marking a Calendar's type,date and repeat type. /// + /// preview public class CalendarMark { internal IntPtr Handle; @@ -117,16 +121,19 @@ namespace ElmSharp /// /// A string used to define the type of mark. /// + /// preview public string Type; /// /// A time struct to represent the date of inclusion of the mark. /// + /// preview public DateTime Date; /// /// Repeat the event following this periodicity. /// + /// preview public CalendarMarkRepeatType Repeat; /// @@ -135,6 +142,7 @@ namespace ElmSharp /// Type of mark /// Date of inclusion of the mark /// Repeat type + /// preview public CalendarMark(string type, DateTime date, CalendarMarkRepeatType repeat) { Handle = IntPtr.Zero; @@ -147,6 +155,7 @@ namespace ElmSharp /// /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year and month. /// + /// preview public class Calendar : Layout { SmartEvent _changed; @@ -163,6 +172,7 @@ namespace ElmSharp /// /// The EvasObject to which the new Calendar will be attached as a child. /// + /// preview public Calendar(EvasObject parent) : base(parent) { _changed = new SmartEvent(this, this.RealHandle, "changed"); @@ -187,11 +197,13 @@ namespace ElmSharp /// /// DateChanged will be triggered when the date in the calendar is changed. /// + /// preview public event EventHandler DateChanged; /// /// DisplayedMonthChanged will be triggered when the current month displayed in the calendar is changed. /// + /// preview public event EventHandler DisplayedMonthChanged; /// @@ -199,11 +211,13 @@ namespace ElmSharp /// /// DateTime /// + /// preview public delegate string DateFormatDelegate(DateTime time); /// /// Sets or gets the minimum for year. /// + /// preview public int MinimumYear { get @@ -229,6 +243,7 @@ namespace ElmSharp /// /// Sets or gets the maximum for the year. /// + /// preview public int MaximumYear { get @@ -250,6 +265,7 @@ namespace ElmSharp /// /// Sets or gets the first day of week, who are used on Calendar. /// + /// preview public DateTime DisplayedTime { get @@ -275,6 +291,7 @@ namespace ElmSharp /// /// Sets or gets the first day of week, who are used on Calendar. /// + /// preview public DayOfWeek FirstDayOfWeek { get @@ -295,6 +312,7 @@ namespace ElmSharp /// weekDayNames = new List() { "S", "M", "T", "W", "T", "F", "S" };]]> /// Calendar.WeekDayNames = weekDayNames; /// + /// preview public IReadOnlyList WeekDayNames { get @@ -319,6 +337,7 @@ namespace ElmSharp /// /// Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar. /// + /// preview public DateTime SelectedDate { get @@ -343,6 +362,7 @@ namespace ElmSharp /// Sets or gets the interval on time updates for an user mouse button /// hold on calendar widgets' month/year selection. /// + /// preview public double Interval { get @@ -358,6 +378,7 @@ namespace ElmSharp /// /// Gets or sets the select day mode used. /// + /// preview public CalendarSelectMode SelectMode { get @@ -373,6 +394,7 @@ namespace ElmSharp /// /// Gets or sets fields of a datetime will be taken into account, when SelectedDate set is invoked. /// + /// preview public CalendarSelectable Selectable { get @@ -388,6 +410,7 @@ namespace ElmSharp /// /// Gets or sets date format the string that will be used to display month and year. /// + /// preview public DateFormatDelegate DateFormat { get @@ -415,6 +438,7 @@ namespace ElmSharp /// A time struct to represent the date of inclusion of the mark. For marks that repeats it will just be displayed after the inclusion date in the calendar. /// Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually. /// Item for a calendar mark. + /// preview public CalendarMark AddMark(string type, DateTime date, CalendarMarkRepeatType repeat) { CalendarMark mark = new CalendarMark(type, date, repeat); @@ -429,6 +453,7 @@ namespace ElmSharp /// Delete mark from the calendar. /// /// Item for a calendar mark + /// preview public void DeleteMark(CalendarMark mark) { Interop.Elementary.elm_calendar_mark_del(mark.Handle); @@ -437,6 +462,7 @@ namespace ElmSharp /// /// Draw calendar marks. /// + /// preview public void DrawMarks() { Interop.Elementary.elm_calendar_marks_draw(RealHandle); @@ -445,6 +471,7 @@ namespace ElmSharp /// /// Remove all calendar's marks. /// + /// preview public void ClearMarks() { Interop.Elementary.elm_calendar_marks_clear(RealHandle); @@ -455,6 +482,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Check.cs b/src/ElmSharp/ElmSharp/Check.cs index 6636bb1..b864cbe 100755 --- a/src/ElmSharp/ElmSharp/Check.cs +++ b/src/ElmSharp/ElmSharp/Check.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The check is a widget allows for toggling a value between true and false. /// + /// preview public class Check : Layout { private SmartEvent _changed; @@ -32,6 +33,7 @@ namespace ElmSharp /// /// The EvasObject to which the new Check will be attached as a child. /// + /// preview public Check(EvasObject parent) : base(parent) { _changed = new SmartEvent(this, this.RealHandle, "changed"); @@ -44,6 +46,7 @@ namespace ElmSharp /// /// StateChanged will be triggered when the IsChecked in the Check is changed. /// + /// preview public event EventHandler StateChanged; /// @@ -52,6 +55,7 @@ namespace ElmSharp /// /// When object is checked, the value will set to true, Conversely will set to false. /// + /// preview public bool IsChecked { get @@ -70,6 +74,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs b/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs index 461798f..fc8bb4b 100755 --- a/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/CheckStateChangedEventArgs.cs @@ -23,16 +23,19 @@ namespace ElmSharp /// The CheckStateChangedEventArgs is EventArgs to record Check's state. /// Include old state and new state. /// + /// preview public class CheckStateChangedEventArgs : EventArgs { /// /// Gets the OldState property.The return type is bool. /// + /// preview public bool OldState { get; private set; } /// /// Gets the NewState property.The return type is bool. /// + /// preview public bool NewState { get; private set; } /// @@ -40,6 +43,7 @@ namespace ElmSharp /// /// Old state of Check which to use this CheckStateChangedEventArgs. /// New state of Check which to use this CheckStateChangedEventArgs. + /// preview public CheckStateChangedEventArgs(bool oldState, bool newState) { this.OldState = oldState; diff --git a/src/ElmSharp/ElmSharp/Color.cs b/src/ElmSharp/ElmSharp/Color.cs index 49c48f2..1295a38 100644 --- a/src/ElmSharp/ElmSharp/Color.cs +++ b/src/ElmSharp/ElmSharp/Color.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// The Color is a struct to record Check's state. /// + /// preview public struct Color { readonly int _a; @@ -43,6 +44,7 @@ namespace ElmSharp /// /// In default Color instance,Mode type is Default,RGBA all set as -1. /// + /// preview public static Color Default { get { return new Color(-1, -1, -1, -1, Mode.Default); } @@ -52,6 +54,7 @@ namespace ElmSharp /// Gets whether the Color instance's mode is default or not. /// Return type is bool. /// + /// preview public bool IsDefault { get { return _mode == Mode.Default; } @@ -61,6 +64,7 @@ namespace ElmSharp /// Gets A value of RGBA. /// A means the Alpha in color. /// + /// preview public int A { get { return _a; } @@ -70,6 +74,7 @@ namespace ElmSharp /// Gets R value of RGBA. /// R means the Red in color. /// + /// preview public int R { get { return _r; } @@ -79,6 +84,7 @@ namespace ElmSharp /// Gets G value of RGBA. /// G means the Green in color. /// + /// preview public int G { get { return _g; } @@ -88,6 +94,7 @@ namespace ElmSharp /// Gets B value of RGBA. /// B means the Blue in color. /// + /// preview public int B { get { return _b; } @@ -100,6 +107,7 @@ namespace ElmSharp /// Red of RGB /// Green of RGB /// Blue of RGB + /// preview public Color(int r, int g, int b) : this(r, g, b, 255) { } @@ -112,6 +120,7 @@ namespace ElmSharp /// Green of RGBA /// Blue of RGBA /// Alpha of RGBA + /// preview public Color(int r, int g, int b, int a) : this(r, g, b, a, Mode.Rgb) { } @@ -136,6 +145,7 @@ namespace ElmSharp /// Returns the hash code for this instance. /// /// A 32-bit signed integer hash code. + /// preview public override int GetHashCode() { int hashcode = _r.GetHashCode(); @@ -153,6 +163,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public override bool Equals(object obj) { if (obj is Color) @@ -170,6 +181,7 @@ namespace ElmSharp /// The result whether two instance is same or not. /// Return type is bool.If they are same, return true. /// + /// preview public static bool operator ==(Color a, Color b) { if (ReferenceEquals(a, b)) @@ -189,6 +201,7 @@ namespace ElmSharp /// The result whether two instance is different or not. /// Return type is bool.If they are different, return true. /// + /// preview public static bool operator !=(Color a, Color b) { return !(a == b); @@ -205,6 +218,7 @@ namespace ElmSharp /// Returns the fully qualified type name of this instance. /// /// The fully qualified type name. + /// preview public override string ToString() { return string.Format(CultureInfo.InvariantCulture, "[Color: R={0}, G={1}, B={2}, A={3}]", R, G, B, A); @@ -215,6 +229,7 @@ namespace ElmSharp /// /// Hexadecimal string. /// New instance of Color struct. + /// preview public static Color FromHex(string hex) { hex = hex.Replace("#", ""); @@ -238,6 +253,7 @@ namespace ElmSharp /// /// Unsigned integer indicates RGBA. /// New instance of Color struct. + /// preview public static Color FromUint(uint argb) { return FromRgba((byte)((argb & 0x00ff0000) >> 0x10), (byte)((argb & 0x0000ff00) >> 0x8), (byte)(argb & 0x000000ff), (byte)((argb & 0xff000000) >> 0x18)); @@ -251,6 +267,7 @@ namespace ElmSharp /// Blue in RGBA. /// Alpha in RGBA. /// New instance of Color struct. + /// preview public static Color FromRgba(int r, int g, int b, int a) { return new Color(r, g, b, a); @@ -263,6 +280,7 @@ namespace ElmSharp /// Green in RGB. /// Blue in RGB. /// New instance of Color struct. + /// preview public static Color FromRgb(int r, int g, int b) { return FromRgba(r, g, b, 255); @@ -277,78 +295,97 @@ namespace ElmSharp /// /// The Tansparent is a predefined Color, it's rgba value is (0, 0, 0, 0). /// + /// preview public static readonly Color Transparent = FromRgba(0, 0, 0, 0); /// /// The Aqua is a predefined Color instance, it's rgb value is (0, 255, 255). /// + /// preview public static readonly Color Aqua = FromRgb(0, 255, 255); /// /// The Black is a predefined Color instance, it's rgb value is (0, 0, 0). /// + /// preview public static readonly Color Black = FromRgb(0, 0, 0); /// /// The Blue is a predefined Color instance, it's rgb value is (0, 0, 255). /// + /// preview public static readonly Color Blue = FromRgb(0, 0, 255); /// /// The Fuchsia is a predefined Color instance, it's rgb value is (255, 0, 255). /// + /// preview public static readonly Color Fuchsia = FromRgb(255, 0, 255); /// /// The Gray is a predefined Color instance, it's rgb value is (128, 128, 128). /// + /// preview public static readonly Color Gray = FromRgb(128, 128, 128); /// /// The Green is a predefined Color instance, it's rgb value is (0, 128, 0). /// + /// preview public static readonly Color Green = FromRgb(0, 128, 0); /// /// The Lime is a predefined Color instance, it's rgb value is (0, 255, 0). /// + /// preview public static readonly Color Lime = FromRgb(0, 255, 0); /// /// The Maroon is a predefined Color instance, it's rgb value is (128, 0, 0). /// + /// preview public static readonly Color Maroon = FromRgb(128, 0, 0); /// /// The Navy is a predefined Color instance, it's rgb value is (0, 0, 128). /// + /// preview public static readonly Color Navy = FromRgb(0, 0, 128); /// /// The Olive is a predefined Color instance, it's rgb value is (128, 128, 0). /// + /// preview public static readonly Color Olive = FromRgb(128, 128, 0); /// /// The Orange is a predefined Color instance, it's rgb value is (255, 165, 0). /// + /// preview public static readonly Color Orange = FromRgb(255, 165, 0); /// /// The Purple is a predefined Color instance, it's rgb value is (128, 0, 128). /// + /// preview public static readonly Color Purple = FromRgb(128, 0, 128); /// /// The Pink is a predefined Color instance, it's rgb value is (255, 102, 255). /// + /// preview public static readonly Color Pink = FromRgb(255, 102, 255); /// /// The Red is a predefined Color instance, it's rgb value is (255, 0, 0). /// + /// preview public static readonly Color Red = FromRgb(255, 0, 0); /// /// The Silver is a predefined Color instance, it's rgb value is (192, 192, 192). /// + /// preview public static readonly Color Silver = FromRgb(192, 192, 192); /// /// The Teal is a predefined Color instance, it's rgb value is (0, 128, 128). /// + /// preview public static readonly Color Teal = FromRgb(0, 128, 128); /// /// The White is a predefined Color instance, it's rgb value is (255, 255, 255). /// + /// preview public static readonly Color White = FromRgb(255, 255, 255); /// /// The Yellow is a predefined Color instance, it's rgb value is (255, 255, 0). /// + /// preview public static readonly Color Yellow = FromRgb(255, 255, 0); #endregion } diff --git a/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs b/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs index b1090de..5311a1a 100755 --- a/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/ColorChangedEventArgs.cs @@ -23,16 +23,19 @@ namespace ElmSharp /// Event ColorChanged of ColorSelector contain ColorChangedEventArgs as a parameter. /// Refer to type. /// + /// preview public class ColorChangedEventArgs : EventArgs { /// /// Gets old color in color changed event. /// + /// preview public Color OldColor { get; private set; } /// /// Gets new color in color changed event. /// + /// preview public Color NewColor { get; private set; } /// @@ -40,6 +43,7 @@ namespace ElmSharp /// /// old color /// new color + /// preview public ColorChangedEventArgs(Color oldColor, Color newColor) { this.OldColor = oldColor; diff --git a/src/ElmSharp/ElmSharp/ColorSelector.cs b/src/ElmSharp/ElmSharp/ColorSelector.cs index c499a90..1ea8f5d 100755 --- a/src/ElmSharp/ElmSharp/ColorSelector.cs +++ b/src/ElmSharp/ElmSharp/ColorSelector.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for mode of ColorSelector /// + /// preview public enum ColorSelectorMode { /// @@ -68,6 +69,7 @@ namespace ElmSharp /// The colors can be picked by user from the color set by clicking on individual /// color item on the palette or by selecting it from selector. /// + /// preview public class ColorSelector : Layout { private readonly SmartEvent _changed; @@ -77,6 +79,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the ColorSelector class. /// /// + /// preview public ColorSelector(EvasObject parent) : base(parent) { _changed = new SmartEvent(this, "changed", (data, obj, info) => @@ -88,6 +91,7 @@ namespace ElmSharp /// /// ColorChanged will be triggered when the SelectedColor changed. /// + /// preview public event EventHandler ColorChanged { add { _changed.On += value; } @@ -97,6 +101,7 @@ namespace ElmSharp /// /// Gets or sets color of colorselector. /// + /// preview public Color SelectedColor { get @@ -116,6 +121,7 @@ namespace ElmSharp /// /// Gets Alpha of a default Color Class(Value is -1). /// + /// preview public override int Opacity { get @@ -132,6 +138,7 @@ namespace ElmSharp /// /// Gets or sets Colorselector's mode. /// + /// preview public ColorSelectorMode Mode { get @@ -150,6 +157,7 @@ namespace ElmSharp /// /// Get or set current palette's name. /// + /// preview public string PaletteName { get @@ -167,6 +175,7 @@ namespace ElmSharp /// /// Color item to add /// A new color palette Item. + /// preview public ColorSelectorItem AddPaletteColor(Color color) { ColorSelectorItem item = new ColorSelectorItem(); @@ -177,6 +186,7 @@ namespace ElmSharp /// /// Clear the palette items. /// + /// preview public void ClearPalette() { Interop.Elementary.elm_colorselector_palette_clear(Handle); @@ -187,6 +197,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_colorselector_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/ColorSelectorItem.cs b/src/ElmSharp/ElmSharp/ColorSelectorItem.cs index 10205e2..075c92f 100755 --- a/src/ElmSharp/ElmSharp/ColorSelectorItem.cs +++ b/src/ElmSharp/ElmSharp/ColorSelectorItem.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// A instance to the ColorSelector item added. /// + /// preview public class ColorSelectorItem : ItemObject { internal ColorSelectorItem() : base(IntPtr.Zero) @@ -30,6 +31,7 @@ namespace ElmSharp /// /// Gets or sets the Palette item's color /// + /// preview public Color Color { get diff --git a/src/ElmSharp/ElmSharp/Conformant.cs b/src/ElmSharp/ElmSharp/Conformant.cs index e27838b..c40cc87 100755 --- a/src/ElmSharp/ElmSharp/Conformant.cs +++ b/src/ElmSharp/ElmSharp/Conformant.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// to account for space taken up by the indicator, /// virtual keypad & softkey windows when running the illume2 module of E17. /// + /// preview public class Conformant : Widget { /// @@ -30,6 +31,7 @@ namespace ElmSharp /// /// The parent is a given container which will be attached by Conformant /// as a child.It's type. + /// preview public Conformant(Window parent) : base(parent) { Interop.Evas.evas_object_size_hint_weight_set(Handle, 1.0, 1.0); @@ -42,6 +44,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_conformant_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Container.cs b/src/ElmSharp/ElmSharp/Container.cs index b7e0e33..20aee3a 100755 --- a/src/ElmSharp/ElmSharp/Container.cs +++ b/src/ElmSharp/ElmSharp/Container.cs @@ -25,6 +25,7 @@ namespace ElmSharp /// Other class inherits it to Elementary is about displaying /// its widgets in a nice layout. /// + /// preview public abstract class Container : Widget { HashSet _children = new HashSet(); @@ -34,6 +35,7 @@ namespace ElmSharp /// /// The parent is a given object which will be attached by Container /// as a child.It's type. + /// preview public Container(EvasObject parent) : base(parent) { } @@ -41,6 +43,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of Container class. /// + /// preview protected Container() : base() { } @@ -48,6 +51,7 @@ namespace ElmSharp /// /// Sets the background color of a given Container. /// + /// preview public override Color BackgroundColor { set @@ -67,12 +71,14 @@ namespace ElmSharp /// /// Gets the collection of child EvasObject of the Container. /// + /// preview protected IEnumerable Children => _children; /// /// Add an EvasObject object as a child of Container. /// /// The EvasObject object to be added + /// preview protected void AddChild(EvasObject obj) { _children.Add(obj); @@ -83,6 +89,7 @@ namespace ElmSharp /// Remove an EvasObject object as a child of Container. /// /// The EvasObject object to be removed + /// preview protected void RemoveChild(EvasObject obj) { _children.Remove(obj); @@ -91,6 +98,7 @@ namespace ElmSharp /// /// Clear all children of the Container. /// + /// preview protected void ClearChildren() { _children.Clear(); diff --git a/src/ElmSharp/ElmSharp/ContextPopup.cs b/src/ElmSharp/ElmSharp/ContextPopup.cs index b947694..06e9dce 100755 --- a/src/ElmSharp/ElmSharp/ContextPopup.cs +++ b/src/ElmSharp/ElmSharp/ContextPopup.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// Enumeration of ContextPopup direction type. /// + /// preview public enum ContextPopupDirection { /// @@ -50,6 +51,7 @@ namespace ElmSharp /// It inherits . /// The ContextPopup is a widget that when it shown, pops up a list of items. /// + /// preview public class ContextPopup : Layout { HashSet _children = new HashSet(); @@ -61,6 +63,7 @@ namespace ElmSharp /// /// The parent is a given container which will be attached by ContextPopup /// as a child.It's type. + /// preview public ContextPopup(EvasObject parent) : base(parent) { _dismissed = new SmartEvent(this, this.RealHandle, "dismissed"); @@ -81,6 +84,7 @@ namespace ElmSharp /// /// Outside of ContextPopup was clicked or it's parent area is changed or the language is changed. and then ContextPopup is dismissed. /// + /// preview public event EventHandler Dismissed; /// @@ -89,6 +93,7 @@ namespace ElmSharp /// /// Once the ContextPopup showed up, the direction would be determined. /// + /// preview public ContextPopupDirection Direction { get @@ -101,6 +106,7 @@ namespace ElmSharp /// Gets or sets the value of current ContextPopup object's orientation. /// True for horizontal mode, False for vertical mode (or errors) /// + /// preview public bool IsHorizontal { get @@ -120,6 +126,7 @@ namespace ElmSharp /// /// Default value of AutoHide is False. /// + /// preview public bool AutoHide { get @@ -135,6 +142,7 @@ namespace ElmSharp /// /// Clears all items in the given ContextPopup object. /// + /// preview public void Clear() { Interop.Elementary.elm_ctxpopup_clear(Handle); @@ -147,6 +155,7 @@ namespace ElmSharp /// 2nd priority of direction /// 3th priority of direction /// 4th priority of direction + /// preview public void SetDirectionPriorty(ContextPopupDirection first, ContextPopupDirection second, ContextPopupDirection third, ContextPopupDirection fourth) { Interop.Elementary.elm_ctxpopup_direction_priority_set(RealHandle, (int)first, (int)second, (int)third, (int)fourth); @@ -159,6 +168,7 @@ namespace ElmSharp /// 2nd priority of direction to be returned /// 2nd priority of direction to be returned /// 4th priority of direction to be returned + /// preview public void GetDirectionPriority(out ContextPopupDirection first, out ContextPopupDirection second, out ContextPopupDirection third, out ContextPopupDirection fourth) { int firstOut, secondOut, thirdOut, fourthOut; @@ -176,6 +186,7 @@ namespace ElmSharp /// /// A ContextPopupItem added or NULL, on errors /// + /// preview public ContextPopupItem Append(string label) { return Append(label, null); @@ -187,6 +198,7 @@ namespace ElmSharp /// The Label of the new item /// Icon to be set on new item /// A ContextPopupItem added or NULL, on errors + /// preview public ContextPopupItem Append(string label, EvasObject icon) { ContextPopupItem item = new ContextPopupItem(label, icon); @@ -198,6 +210,7 @@ namespace ElmSharp /// /// Dismiss a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted. /// + /// preview public void Dismiss() { Interop.Elementary.elm_ctxpopup_dismiss(RealHandle); @@ -210,6 +223,7 @@ namespace ElmSharp /// /// Get false if you cannot put it in the direction. Gets true if it's possible. /// + /// preview public bool IsAvailableDirection(ContextPopupDirection direction) { return Interop.Elementary.elm_ctxpopup_direction_available_get(RealHandle, (int)direction); @@ -218,6 +232,7 @@ namespace ElmSharp /// /// Gets Alpha of a default Color Class. /// + /// preview public override int Opacity { get @@ -236,6 +251,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_ctxpopup_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/ContextPopupItem.cs b/src/ElmSharp/ElmSharp/ContextPopupItem.cs index 35c908b..7767892 100755 --- a/src/ElmSharp/ElmSharp/ContextPopupItem.cs +++ b/src/ElmSharp/ElmSharp/ContextPopupItem.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// It inherits . /// A instance to the ContextPopup item added. /// + /// preview public class ContextPopupItem : ItemObject { internal ContextPopupItem(string text, EvasObject icon) : base(IntPtr.Zero) @@ -33,16 +34,19 @@ namespace ElmSharp /// /// Gets the Text property of the given ContextPopupItem. /// + /// preview public string Text { get; internal set; } /// /// Gets the Icon(type is ) property of the given ContextPopupItem. /// + /// preview public EvasObject Icon { get; internal set; } /// /// Selected will be triggered when the ContextPopupItem is Selected. /// + /// preview public event EventHandler Selected; internal void SendSelected() diff --git a/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs b/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs index 25d622c..939bd43 100755 --- a/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/DateChangedEventArgs.cs @@ -23,16 +23,19 @@ namespace ElmSharp /// The DateChanged event in Calendar and DateTimeChanged event in DateTimeSelector. /// contain DateChangedEventArgs as a parameter. /// + /// preview public class DateChangedEventArgs : EventArgs { /// /// Gets the OldDate property of the given DateChangedEventArgs. /// + /// preview public DateTime OldDate { get; private set; } /// /// Gets the NewDate property of the given DateChangedEventArgs. /// + /// preview public DateTime NewDate { get; private set; } /// @@ -44,6 +47,7 @@ namespace ElmSharp /// /// New date when DateChanged event or DateTimeChanged event triggered /// + /// preview public DateChangedEventArgs(DateTime oldDate, DateTime newDate) { this.OldDate = oldDate; diff --git a/src/ElmSharp/ElmSharp/DateTimeSelector.cs b/src/ElmSharp/ElmSharp/DateTimeSelector.cs index c159804..9559037 100755 --- a/src/ElmSharp/ElmSharp/DateTimeSelector.cs +++ b/src/ElmSharp/ElmSharp/DateTimeSelector.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration of datetime field types for DateTimeSelector. /// + /// preview public enum DateTimeFieldType { /// @@ -55,6 +56,7 @@ namespace ElmSharp /// This widget displays date and time as per the system's locale settings /// (Date includes Day, Month & Year along with the defined separators and Time includes Hour, Minute & AM/PM fields. Separator for AM/PM field is ignored. /// + /// preview public class DateTimeSelector : Layout { SmartEvent _changed; @@ -65,6 +67,7 @@ namespace ElmSharp /// /// The parent is a given container which will be attached by DateTimeSelector ///as a child.It's type. + /// preview public DateTimeSelector(EvasObject parent) : base(parent) { } @@ -72,6 +75,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of DateTimeSelector class. /// + /// preview protected DateTimeSelector() : base() { } @@ -79,6 +83,7 @@ namespace ElmSharp /// /// ItemSelected is raised when Datetime field value changed. /// + /// preview public event EventHandler DateTimeChanged; /// @@ -87,6 +92,7 @@ namespace ElmSharp /// /// format is a combination of allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p". /// + /// preview public string Format { get @@ -102,6 +108,7 @@ namespace ElmSharp /// /// Gets or sets the upper boundary of DateTime field. /// + /// preview public DateTime MaximumDateTime { get @@ -120,6 +127,7 @@ namespace ElmSharp /// /// Gets or sets the lower boundary of DateTime field. /// + /// preview public DateTime MinimumDateTime { get @@ -138,6 +146,7 @@ namespace ElmSharp /// /// Gets or sets the current value of DateTime field. /// + /// preview public DateTime DateTime { get @@ -162,6 +171,7 @@ namespace ElmSharp /// The field is visible or not. /// Type is bool.If visible, return true. /// + /// preview public bool IsFieldVisible(DateTimeFieldType type) { return Interop.Elementary.elm_datetime_field_visible_get(RealHandle, (int)type); @@ -173,6 +183,7 @@ namespace ElmSharp /// Enumeration /// minimum limit /// maximum limit + /// preview public void SetFieldLimit(DateTimeFieldType type, int minimum, int maximum) { Interop.Elementary.elm_datetime_field_limit_set(RealHandle, (int)type, minimum, maximum); @@ -183,6 +194,7 @@ namespace ElmSharp /// /// Enumeration /// When set as true, the field type visible. + /// preview public void SetFieldVisible(DateTimeFieldType type, bool visible) { Interop.Elementary.elm_datetime_field_visible_set(RealHandle, (int)type, visible); @@ -191,6 +203,7 @@ namespace ElmSharp /// /// The callback of Realized Event /// + /// preview protected override void OnRealized() { base.OnRealized(); @@ -208,6 +221,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs b/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs index 8407f6d..0a2be88 100755 --- a/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs +++ b/src/ElmSharp/ElmSharp/DisplayedMonthChangedEventArgs.cs @@ -23,16 +23,19 @@ namespace ElmSharp /// The DisplayedMonthChangedEvent in Calendar contain /// DisplayedMonthChangedEventArgs as a parameter. /// + /// preview public class DisplayedMonthChangedEventArgs : EventArgs { /// /// Gets the OldMonth property of the given DisplayedMonthChangedEventArgs. /// + /// preview public int OldMonth { get; private set; } /// /// Gets the NewMonth property of the given DisplayedMonthChangedEventArgs. /// + /// preview public int NewMonth { get; private set; } /// @@ -44,6 +47,7 @@ namespace ElmSharp /// /// new month of date when DisplayedMonthChangedEvent triggered. /// + /// preview public DisplayedMonthChangedEventArgs(int oldMonth, int newMonth) { this.OldMonth = oldMonth; diff --git a/src/ElmSharp/ElmSharp/EcoreAnimator.cs b/src/ElmSharp/ElmSharp/EcoreAnimator.cs index 64a548d..06c9a1c 100755 --- a/src/ElmSharp/ElmSharp/EcoreAnimator.cs +++ b/src/ElmSharp/ElmSharp/EcoreAnimator.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// EcoreAnimator is a helper class, it provides functions to manager animations. /// + /// preview public static class EcoreAnimator { static readonly Dictionary> _taskMap = new Dictionary>(); @@ -39,6 +40,7 @@ namespace ElmSharp /// Gets current system time as a floating point value in seconds. /// /// Current system time + /// preview public static double GetCurrentTime() { return Interop.Ecore.ecore_time_get(); @@ -49,6 +51,7 @@ namespace ElmSharp /// /// The function to call when it ticks off /// A handle to the new animator + /// preview public static IntPtr AddAnimator(Func handler) { int id = RegistHandler(handler); @@ -59,6 +62,7 @@ namespace ElmSharp /// Removes the specified animator from the animator list. /// /// The specified animator handle + /// preview public static void RemoveAnimator(IntPtr anim) { int taskId = (int)Interop.Ecore.ecore_animator_del(anim); diff --git a/src/ElmSharp/ElmSharp/EcoreEvent.cs b/src/ElmSharp/ElmSharp/EcoreEvent.cs index 577ec71..16e7b0e 100755 --- a/src/ElmSharp/ElmSharp/EcoreEvent.cs +++ b/src/ElmSharp/ElmSharp/EcoreEvent.cs @@ -25,43 +25,53 @@ namespace ElmSharp /// The EcoreEventType is type of EcoreEvent. /// It includes some predefined instance. /// + /// preview public class EcoreEventType { /// /// Key down Ecore event type. /// + /// preview public static readonly EcoreEventType KeyDown = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_KEY_DOWN"); /// /// Key Up Ecore event type. /// + /// preview public static readonly EcoreEventType KeyUp = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_KEY_UP"); /// /// Mouse Button Down Ecore event type. /// + /// preview public static readonly EcoreEventType MouseButtonDown = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_BUTTON_DOWN"); /// /// Mouse Button Up Ecore event type. /// + /// preview public static readonly EcoreEventType MouseButtonUp = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_BUTTON_UP"); /// /// Mouse Button Cancel Ecore event type. /// + /// preview public static readonly EcoreEventType MouseButtonCancel = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_BUTTON_CANCEL"); /// /// Mouse Move Ecore event type. /// + /// preview public static readonly EcoreEventType MouseMove = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_MOVE"); /// /// Mouse Wheel Ecore event type. /// + /// preview public static readonly EcoreEventType MouseWheel = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_WHEEL"); /// /// Mouse In Ecore event type. /// + /// preview public static readonly EcoreEventType MouseIn = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_IN"); /// /// Mouse Out Ecore event type. /// + /// preview public static readonly EcoreEventType MouseOut = new EcoreEventType(Interop.Libraries.EcoreInput, "ECORE_EVENT_MOUSE_OUT"); private string _lib; @@ -79,6 +89,7 @@ namespace ElmSharp /// Gets the value associated with the specified type. /// /// The value of type. + /// preview public int GetValue() { if (_typeValue < 0) @@ -102,6 +113,7 @@ namespace ElmSharp /// The EcoreEvent is a class to help to create events are being notified of events. /// /// Kinds of EventArgs + /// preview public class EcoreEvent : IDisposable where TEventArgs : EventArgs { /// @@ -111,6 +123,7 @@ namespace ElmSharp /// EcoreEventType /// IntPtr /// + /// preview public delegate TEventArgs EventInfoParser(IntPtr data, EcoreEventType type, IntPtr info); private bool _disposed = false; @@ -122,6 +135,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the EcoreEvent class. /// /// EcoreEventType + /// preview public EcoreEvent(EcoreEventType type) : this(type, null) { } @@ -131,6 +145,7 @@ namespace ElmSharp /// /// EcoreEventType /// EventInfoParser + /// preview public EcoreEvent(EcoreEventType type, EventInfoParser parser) { _eventType = type; @@ -155,6 +170,7 @@ namespace ElmSharp /// /// On Event Handler of EcoreEvent. /// + /// preview public event EventHandler On { add @@ -186,6 +202,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -206,6 +223,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -216,12 +234,14 @@ namespace ElmSharp /// /// Event class for EcoreEvent /// + /// preview public class EcoreEvent : EcoreEvent { /// /// Creates and initializes a new instance of the EcoreEvent class. /// /// EcoreEventType + /// preview public EcoreEvent(EcoreEventType type) : base(type) { } diff --git a/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs b/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs index d057716..64ee150 100755 --- a/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs +++ b/src/ElmSharp/ElmSharp/EcoreKeyEventArgs.cs @@ -23,15 +23,18 @@ namespace ElmSharp /// It inherits System.EventArgs. /// The EcoreKeyEventArgs is a EventArgs to record Ecore event's key name and key code. /// + /// preview public class EcoreKeyEventArgs : EventArgs { /// /// Gets the KeyName property.The return type is string. /// + /// preview public string KeyName { get; private set; } /// /// Gets the KeyCode property.The return type is int. /// + /// preview public int KeyCode { get; private set; } /// @@ -41,6 +44,7 @@ namespace ElmSharp /// type /// information /// new instance of the EcoreKeyEventArgs class + /// preview public static EcoreKeyEventArgs Create(IntPtr data, EcoreEventType type, IntPtr info) { var evt = Marshal.PtrToStructure(info); diff --git a/src/ElmSharp/ElmSharp/EcoreMainloop.cs b/src/ElmSharp/ElmSharp/EcoreMainloop.cs index 505e2c0..b15658f 100755 --- a/src/ElmSharp/ElmSharp/EcoreMainloop.cs +++ b/src/ElmSharp/ElmSharp/EcoreMainloop.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// EcoreMainloop is a helper class, it provide functions relative Ecore's main loop. /// + /// preview public static class EcoreMainloop { static readonly Dictionary> _taskMap = new Dictionary>(); @@ -41,11 +42,13 @@ namespace ElmSharp /// Checks if you are calling this function from the main thread. /// /// True is the calling function is the same thread, false otherwise. + /// preview public static bool IsMainThread => Interop.Eina.eina_main_loop_is(); /// /// Runs the application main loop. /// + /// preview public static void Begin() { Interop.Ecore.ecore_main_loop_begin(); @@ -54,6 +57,7 @@ namespace ElmSharp /// /// Quits the main loop once all the events currently on the queue have been processed. /// + /// preview public static void Quit() { Interop.Ecore.ecore_main_loop_quit(); @@ -63,6 +67,7 @@ namespace ElmSharp /// Adds an idler handler. /// /// The action to call when idling + /// preview public static void Post(Action task) { int id = RegistHandler(() => { task(); return false; }); @@ -73,6 +78,7 @@ namespace ElmSharp /// Calls callback asynchronously in the main loop. /// /// The action wanted to be called + /// preview public static void PostAndWakeUp(Action task) { int id = RegistHandler(() => { task(); return false; }); @@ -83,6 +89,7 @@ namespace ElmSharp /// Calls callback synchronously in the main loop. /// /// The action wanted to be called + /// preview public static void Send(Action task) { int id = RegistHandler(() => { task(); return false; }); @@ -95,6 +102,7 @@ namespace ElmSharp /// The interval in seconds. /// The given function. /// A timer object handler on success, NULL on failure. + /// preview public static IntPtr AddTimer(double interval, Func handler) { int id = RegistHandler(handler); @@ -105,6 +113,7 @@ namespace ElmSharp /// Removes the specified timer from the timer list. /// /// The specified timer handler + /// preview public static void RemoveTimer(IntPtr id) { int taskId = (int)Interop.Ecore.ecore_timer_del(id); diff --git a/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs b/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs index 0fa013b..eae11c1 100755 --- a/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs +++ b/src/ElmSharp/ElmSharp/EcoreSynchronizationContext.cs @@ -22,11 +22,13 @@ namespace ElmSharp /// /// Provides a synchronization context for the efl application. /// + /// preview public class EcoreSynchronizationContext : SynchronizationContext { /// /// Initializes a new instance of the EcoreSynchronizationContext class. /// + /// preview public EcoreSynchronizationContext() { } @@ -40,6 +42,7 @@ namespace ElmSharp /// SetSynchronizationContext(new EcoreSynchronizationContext()); /// /// + /// preview public static void Initialize() { SetSynchronizationContext(new EcoreSynchronizationContext()); @@ -51,6 +54,7 @@ namespace ElmSharp /// The SendOrPostCallback delegate to call. /// The object passed to the delegate. /// The Post method starts an asynchronous request to post a message. + /// preview public override void Post(SendOrPostCallback d, object state) { EcoreMainloop.PostAndWakeUp(() => @@ -66,6 +70,7 @@ namespace ElmSharp /// The object passed to the delegate. /// /// The Send method starts a synchronous request to send a message. + /// preview public override void Send(SendOrPostCallback d, object state) { EcoreMainloop.Send(() => diff --git a/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs b/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs index b5a86f8..5343230 100644 --- a/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs +++ b/src/ElmSharp/ElmSharp/EcoreTimelineAnimator.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// EcoreTimelineAnimator is a helper class, it provides functions to manager animations. /// + /// preview public class EcoreTimelineAnimator { double _runtime; @@ -32,6 +33,7 @@ namespace ElmSharp /// /// It occurs when the animator is complete. /// + /// preview public event EventHandler Finished; /// @@ -39,6 +41,7 @@ namespace ElmSharp /// /// The time to run in seconds /// Functions called at each time line + /// preview public EcoreTimelineAnimator(double runtime, Action timelineCallback) { _runtime = runtime; @@ -50,16 +53,19 @@ namespace ElmSharp /// /// Gets whether the animation is running. /// + /// preview public bool IsRunning { get; private set; } /// /// Gets the current position of the animation. /// + /// preview public double Position => _position; /// /// Starts an animator that runs for a limited time.for a limited time. /// + /// preview public void Start() { IsRunning = true; @@ -69,6 +75,7 @@ namespace ElmSharp /// /// Stops an animator that running. /// + /// preview public void Stop() { IsRunning = false; @@ -78,6 +85,7 @@ namespace ElmSharp /// /// Suspends the specified animator. /// + /// preview public void Freeze() { Interop.Ecore.ecore_animator_freeze(_animator); @@ -86,6 +94,7 @@ namespace ElmSharp /// /// Restores execution of the specified animator. /// + /// preview public void Thaw() { Interop.Ecore.ecore_animator_thaw(_animator); @@ -94,6 +103,7 @@ namespace ElmSharp /// /// Callback that is called when ticks off /// + /// preview protected void OnTimeline() { _timelineCallback(); diff --git a/src/ElmSharp/ElmSharp/EdjeObject.cs b/src/ElmSharp/ElmSharp/EdjeObject.cs index b01bc9f..9e04e87 100644 --- a/src/ElmSharp/ElmSharp/EdjeObject.cs +++ b/src/ElmSharp/ElmSharp/EdjeObject.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// /// The EdjeObject is a class that evas object exist in /// + /// preview public class EdjeObject { IntPtr _edjeHandle; @@ -40,6 +41,7 @@ namespace ElmSharp /// This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj. /// The part's name to check for existence in obj's group /// TRUE, if the edje part exists in obj's group, otherwise FALSE + /// preview public EdjeTextPartObject this[string part] { get @@ -57,6 +59,7 @@ namespace ElmSharp /// /// The signal's "emission" string /// The signal's "source" string + /// preview public void EmitSignal(string emission, string source) { Interop.Elementary.edje_object_signal_emit(_edjeHandle, emission, source); @@ -68,6 +71,7 @@ namespace ElmSharp /// /// Deleting the color class defined in the theme file. /// The color class to be deleted + /// preview public void DeleteColorClass(string part) { Interop.Elementary.edje_object_color_class_del(_edjeHandle, part); @@ -90,6 +94,7 @@ namespace ElmSharp /// The shadow Blue value. /// The shadow Alpha value. /// True if succeed, otherwise False + /// preview public bool SetColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha, int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha) { @@ -114,6 +119,7 @@ namespace ElmSharp /// The shadow Blue value. /// The shadow Alpha value. /// True if succeed, otherwise False + /// preview public bool GetColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue, out int outlineAlpha, out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha) { @@ -128,6 +134,7 @@ namespace ElmSharp /// Font name. /// Font size. /// True if succeed, otherwise False + /// preview public bool SetTextClass(string textClass, string font, int fontSize) { return Interop.Elementary.edje_object_text_class_set(_edjeHandle, textClass, font, fontSize); @@ -140,6 +147,7 @@ namespace ElmSharp /// Font name. /// Font size. /// True if succeed, otherwise False + /// preview public bool GetTextClass(string textClass, out string font, out int fontSize) { return Interop.Elementary.edje_object_text_class_get(_edjeHandle, textClass, out font, out fontSize); @@ -151,6 +159,7 @@ namespace ElmSharp /// The signal's "emission" string /// The signal's "source" string /// The action to be executed when the signal is emitted + /// preview public void AddSignalAction(string emission, string source, Action action) { if (emission != null && source != null && action != null) @@ -175,6 +184,7 @@ namespace ElmSharp /// The signal's "emission" string /// The signal's "source" string /// The action to be executed when the signal is emitted + /// preview public void DeleteSignalAction(string emission, string source, Action action) { if (emission != null && source != null && action != null) @@ -237,6 +247,7 @@ namespace ElmSharp /// /// An EdjeTextPartObject is a class dealing with parts of type text. /// + /// preview public class EdjeTextPartObject { string _part; @@ -251,11 +262,13 @@ namespace ElmSharp /// /// Gets the name of the EdjeTextPartObject /// + /// preview public string Name { get { return _part; } } /// /// Gets or sets the text for an object part. /// + /// preview public string Text { get @@ -271,6 +284,7 @@ namespace ElmSharp /// /// Sets or gets the style of the object part. /// + /// preview public string TextStyle { get @@ -293,6 +307,7 @@ namespace ElmSharp /// /// Gets the geometry of a given edje part, in a given edje object's group definition, relative to the object's area. /// + /// preview public Rect Geometry { get @@ -306,6 +321,7 @@ namespace ElmSharp /// /// Gets the native width and height. /// + /// preview public Size TextBlockNativeSize { get @@ -321,6 +337,7 @@ namespace ElmSharp /// /// Gets the formatted width and height. /// + /// preview public Size TextBlockFormattedSize { get diff --git a/src/ElmSharp/ElmSharp/EffectBase.cs b/src/ElmSharp/ElmSharp/EffectBase.cs index 19eddb0..362e60d 100755 --- a/src/ElmSharp/ElmSharp/EffectBase.cs +++ b/src/ElmSharp/ElmSharp/EffectBase.cs @@ -21,11 +21,13 @@ namespace ElmSharp /// /// EffectBase class for the TransitEffect /// + /// preview public abstract class EffectBase { /// /// EffectEneded event will be triggered when be effect ended. /// + /// preview public event EventHandler EffectEnded; internal abstract IntPtr CreateEffect(IntPtr transit); diff --git a/src/ElmSharp/ElmSharp/Elementary.cs b/src/ElmSharp/ElmSharp/Elementary.cs index dc32fdf..ef66745 100755 --- a/src/ElmSharp/ElmSharp/Elementary.cs +++ b/src/ElmSharp/ElmSharp/Elementary.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// /// Focus Autoscroll Mode /// + /// preview public enum FocusAutoScrollMode { /// @@ -44,6 +45,7 @@ namespace ElmSharp /// /// The Elementary is a General Elementary,a VERY SIMPLE toolkit. /// + /// preview public static class Elementary { private static readonly string _themeFilePath = "/usr/share/elm-sharp/elm-sharp-theme.edj"; @@ -51,6 +53,7 @@ namespace ElmSharp /// /// Gets or sets the configured finger size. /// + /// preview public static int FingerSize { get @@ -66,6 +69,7 @@ namespace ElmSharp /// /// Gets or sets the enable status of the focus highlight animation /// + /// preview public static bool IsFocusHighlightAnimation { get @@ -82,6 +86,7 @@ namespace ElmSharp /// Gets or sets the system mirrored mode. /// This determines the default mirrored mode of widgets. /// + /// preview public static bool IsMirrored { get @@ -97,6 +102,7 @@ namespace ElmSharp /// /// Gets or sets the enable status of the focus highlight. /// + /// preview public static bool CanFocusHighlight { get @@ -112,6 +118,7 @@ namespace ElmSharp /// /// Gets or sets the base scale of the application. /// + /// preview public static double AppBaseScale { get @@ -127,6 +134,7 @@ namespace ElmSharp /// /// Gets or sets the global scaling factor. /// + /// preview public static double Scale { get @@ -142,6 +150,7 @@ namespace ElmSharp /// /// Gets or sets the amount of inertia a scroller imposes during region bring animations. /// + /// preview public static double BringInScrollFriction { get @@ -157,6 +166,7 @@ namespace ElmSharp /// /// Gets of sets focus auto scroll mode. /// + /// preview public static FocusAutoScrollMode FocusAutoScrollMode { get @@ -172,6 +182,7 @@ namespace ElmSharp /// /// Initializes Elementary. /// + /// preview public static void Initialize() { Interop.Elementary.elm_init(0, null); @@ -180,6 +191,7 @@ namespace ElmSharp /// /// Shuts down Elementary. /// + /// preview public static void Shutdown() { Interop.Elementary.elm_shutdown(); @@ -188,6 +200,7 @@ namespace ElmSharp /// /// Runs Elementary's main loop. /// + /// preview public static void Run() { Interop.Elementary.elm_run(); @@ -196,6 +209,7 @@ namespace ElmSharp /// /// Prepends a theme overlay to the list of overlays /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static void ThemeOverlay() { @@ -209,6 +223,7 @@ namespace ElmSharp /// Prepends a theme overlay to the list of overlays /// /// The Edje file path to be used. + /// preview public static void AddThemeOverlay(string filePath) { Interop.Elementary.elm_theme_overlay_add(IntPtr.Zero, filePath); @@ -218,6 +233,7 @@ namespace ElmSharp /// Delete a theme overlay from the list of overlays /// /// The name of the theme overlay. + /// preview public static void DeleteThemeOverlay(string filePath) { Interop.Elementary.elm_theme_overlay_del(IntPtr.Zero, filePath); @@ -226,6 +242,7 @@ namespace ElmSharp /// /// Free a theme /// + /// preview public static void FreeTheme() { Interop.Elementary.elm_theme_free(IntPtr.Zero); @@ -236,6 +253,7 @@ namespace ElmSharp /// /// Theme search string /// This sets the search string for the theme in path-notation from first theme to search, to last, delimited by the : character. Example:"shiny:/path/to/file.edj:default" + /// preview public static void SetTheme(string theme) { Interop.Elementary.elm_theme_set(IntPtr.Zero, theme); @@ -244,6 +262,7 @@ namespace ElmSharp /// /// Flush the current theme. /// + /// preview public static void FlushTheme() { Interop.Elementary.elm_theme_flush(IntPtr.Zero); @@ -252,6 +271,7 @@ namespace ElmSharp /// /// This flushes all themes (default and specific ones). /// + /// preview public static void FlushAllThemes() { Interop.Elementary.elm_theme_full_flush(); @@ -261,6 +281,7 @@ namespace ElmSharp /// Deletes a theme extension from the list of extensions. /// /// The name of the theme extension. + /// preview public static void DeleteThemeExtention(string item) { Interop.Elementary.elm_theme_extension_del(IntPtr.Zero, item); @@ -269,6 +290,7 @@ namespace ElmSharp /// /// Gets the amount of inertia a scroller imposes during region bring animations. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static double GetSystemScrollFriction() { @@ -278,6 +300,7 @@ namespace ElmSharp /// /// Sets the amount of inertia a scroller imposes during region bring animations. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static void SetSystemScrollFriction(double timeSet) @@ -288,6 +311,7 @@ namespace ElmSharp /// /// Get Elementary's profile in use /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static string GetProfile() { @@ -297,6 +321,7 @@ namespace ElmSharp /// /// Set the global scaling factor /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static void SetScale(double scale) { @@ -306,6 +331,7 @@ namespace ElmSharp /// /// Get the global scaling factor /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static double GetScale() { @@ -316,6 +342,7 @@ namespace ElmSharp /// Flush all caches. /// Frees all data that was in cache and is not currently being used to reduce memory usage. This frees Edje's, Evas' and Eet's cache. /// + /// preview public static void FlushAllCashe() { Interop.Elementary.elm_cache_all_flush(); @@ -325,6 +352,7 @@ namespace ElmSharp /// Changes the language of the current application. /// /// The language to set, must be the full name of the locale. + /// preview public static void SetLanguage(string language) { Interop.Elementary.elm_language_set(language); @@ -336,6 +364,7 @@ namespace ElmSharp /// The policy identifier /// The policy value, which depends on the identifier /// + /// preview public static bool SetPolicy(uint policy, int value) { return Interop.Elementary.elm_policy_set(policy, value); @@ -344,6 +373,7 @@ namespace ElmSharp /// /// Reload Elementary's configuration, bounded to current selected profile. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static void ReloadConfig() { @@ -353,6 +383,7 @@ namespace ElmSharp /// /// Flushes all config settings and then applies those settings to all applications using elementary on the current display. /// + /// preview public static void FlushAllConfig() { Interop.Elementary.elm_config_all_flush(); diff --git a/src/ElmSharp/ElmSharp/ElmScrollConfig.cs b/src/ElmSharp/ElmSharp/ElmScrollConfig.cs index c3079e2..f54c103 100755 --- a/src/ElmSharp/ElmSharp/ElmScrollConfig.cs +++ b/src/ElmSharp/ElmSharp/ElmScrollConfig.cs @@ -22,11 +22,13 @@ namespace ElmSharp /// /// The ElmScrollConfig is a scrollable views's config /// + /// preview public static class ElmScrollConfig { /// /// Gets or sets the amount of inertia a scroller imposes during region bring animations. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public static double BringInScrollFriction { diff --git a/src/ElmSharp/ElmSharp/Entry.cs b/src/ElmSharp/ElmSharp/Entry.cs index 92f57b5..d5f8c06 100755 --- a/src/ElmSharp/ElmSharp/Entry.cs +++ b/src/ElmSharp/ElmSharp/Entry.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// /// Enumeration for describing InputPanel layout type. /// + /// preview public enum InputPanelLayout { /// @@ -99,6 +100,7 @@ namespace ElmSharp /// /// Enumeration that defines the "Return" key types on the input panel (virtual keyboard). /// + /// preview public enum InputPanelReturnKeyType { /// @@ -150,6 +152,7 @@ namespace ElmSharp /// /// Enumeration that defines the autocapitalization types. /// + /// preview public enum AutoCapital { /// @@ -176,6 +179,7 @@ namespace ElmSharp /// /// Enumeration that defines the entry's copy and paste policy. /// + /// preview public enum CopyAndPasteMode { /// @@ -197,6 +201,7 @@ namespace ElmSharp /// /// Enumeration that defines the text format types. /// + /// preview public enum TextFormat { /// @@ -213,6 +218,7 @@ namespace ElmSharp /// /// Enumeration that defines the types of Input Hints. /// + /// preview public enum InputHints { /// @@ -234,6 +240,7 @@ namespace ElmSharp /// /// Enumeration that defines the input panel (virtual keyboard) language modes. /// + /// preview public enum InputPanelLanguage { /// @@ -250,6 +257,7 @@ namespace ElmSharp /// /// The entry is a convenience widget that shows a box in which the user can enter text. /// + /// preview public class Entry : Layout { SmartEvent _clicked; @@ -264,6 +272,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Entry class. /// /// The EvasObject to which the new Entry will be attached as a child. + /// preview public Entry(EvasObject parent) : base(parent) { _clicked = new SmartEvent(this, this.RealHandle, "clicked"); @@ -282,26 +291,31 @@ namespace ElmSharp /// /// Activated will be triggered when the entry in Activated stated. /// + /// preview public event EventHandler Activated; /// /// Clicked will be triggered when the entry is clicked. /// + /// preview public event EventHandler Clicked; /// /// ChangedByUser will be triggered when the entry changed by user. /// + /// preview public event EventHandler ChangedByUser; /// /// CursorChanged will be triggered when the Cursor in the entry is changed. /// + /// preview public event EventHandler CursorChanged; /// /// Sets or gets the entry to the single line mode. /// + /// preview public bool IsSingleLine { get @@ -317,6 +331,7 @@ namespace ElmSharp /// /// Sets or gets the entry to the password mode. /// + /// preview public bool IsPassword { get @@ -332,6 +347,7 @@ namespace ElmSharp /// /// Sets or gets whether the entry is editable. /// + /// preview public bool IsEditable { get @@ -347,6 +363,7 @@ namespace ElmSharp /// /// Sets or gets whether the entry is empty. /// + /// preview public bool IsEmpty { get @@ -358,6 +375,7 @@ namespace ElmSharp /// /// Sets or gets text currently shown in the object entry. /// + /// preview public override string Text { get @@ -374,6 +392,7 @@ namespace ElmSharp /// Sets or gets the style on the top of the user style stack. /// /// If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold'). + /// preview public string TextStyle { get @@ -389,6 +408,7 @@ namespace ElmSharp /// /// Sets or gets the current position of the cursor in the entry. /// + /// preview public int CursorPosition { get @@ -404,6 +424,7 @@ namespace ElmSharp /// /// Sets or gets the scrollable state of the entry. /// + /// preview public bool Scrollable { get @@ -426,6 +447,7 @@ namespace ElmSharp /// /// Sets or Gets the autocapitalization type on the immodule. /// + /// preview public AutoCapital AutoCapital { get @@ -441,6 +463,7 @@ namespace ElmSharp /// /// Sets or Gets the entry object's 'autosave' status. /// + /// preview public bool IsAutoSave { get @@ -456,6 +479,7 @@ namespace ElmSharp /// /// Sets or Gets entry text paste/drop mode. /// + /// preview public CopyAndPasteMode CopyAndPasteMode { get @@ -471,6 +495,7 @@ namespace ElmSharp /// /// Gets the geometry of the cursor. /// + /// preview public Rect CursorGeometry { get @@ -484,6 +509,7 @@ namespace ElmSharp /// /// Gets whether a format node exists at the current cursor position. /// + /// preview public bool IsCursorFormat { get @@ -495,6 +521,7 @@ namespace ElmSharp /// /// Gets if the current cursor position holds a visible format node. /// + /// preview public bool IsCursorVisibelFormat { get @@ -506,6 +533,7 @@ namespace ElmSharp /// /// Sets or Gets the value of input hint. /// + /// preview public InputHints InputHint { get @@ -521,6 +549,7 @@ namespace ElmSharp /// /// Sets or gets the language mode of the input panel. /// + /// preview public InputPanelLanguage InputPanelLanguage { get @@ -536,6 +565,7 @@ namespace ElmSharp /// /// Sets or gets the input panel layout variation of the entry. /// + /// preview public int InputPanelVariation { get @@ -551,6 +581,7 @@ namespace ElmSharp /// /// Sets or gets the line wrap type to use on multi-line entries. /// + /// preview public WrapType LineWrapType { get @@ -566,6 +597,7 @@ namespace ElmSharp /// /// Sets or gets whether the entry should allow to use the text prediction. /// + /// preview public bool PredictionAllowed { get @@ -581,6 +613,7 @@ namespace ElmSharp /// /// Sets or gets whether the return key on the input panel should be disabled or not. /// + /// preview public bool InputPanelReturnKeyDisabled { get @@ -598,6 +631,7 @@ namespace ElmSharp /// It doesn't request to show the input panel even though it has focus. /// If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.) /// + /// preview public bool InputPanelShowByOnDemand { get @@ -615,6 +649,7 @@ namespace ElmSharp /// /// The path to the file to load and save /// The file format + /// preview public void SetFile(string file, TextFormat textFormat) { Interop.Elementary.elm_entry_file_set(RealHandle, file, (Interop.Elementary.TextFormat)textFormat); @@ -625,6 +660,7 @@ namespace ElmSharp /// /// The string (in markup) to be converted /// The converted string (in UTF-8) + /// preview public static string ConvertMarkupToUtf8(string markup) { return Interop.Elementary.elm_entry_markup_to_utf8(markup); @@ -634,6 +670,7 @@ namespace ElmSharp /// Moves the cursor by one position to the right within the entry. /// /// + /// preview public bool MoveCursorNext() { return Interop.Elementary.elm_entry_cursor_next(RealHandle); @@ -643,6 +680,7 @@ namespace ElmSharp /// Moves the cursor one place to the left within the entry. /// /// TRUE on success, otherwise FALSE on failure + /// preview public bool MoveCursorPrev() { return Interop.Elementary.elm_entry_cursor_prev(RealHandle); @@ -652,6 +690,7 @@ namespace ElmSharp /// Moves the cursor one line up within the entry. /// /// TRUE on success, otherwise FALSE on failure + /// preview public bool MoveCursorUp() { return Interop.Elementary.elm_entry_cursor_up(RealHandle); @@ -661,6 +700,7 @@ namespace ElmSharp /// Moves the cursor one line down within the entry. /// /// TRUE on success, otherwise FALSE on failure + /// preview public bool MoveCursorDown() { return Interop.Elementary.elm_entry_cursor_down(RealHandle); @@ -669,6 +709,7 @@ namespace ElmSharp /// /// Moves the cursor to the beginning of the entry. /// + /// preview public void MoveCursorBegin() { Interop.Elementary.elm_entry_cursor_begin_set(RealHandle); @@ -677,6 +718,7 @@ namespace ElmSharp /// /// Moves the cursor to the end of the entry. /// + /// preview public void MoveCursorEnd() { Interop.Elementary.elm_entry_cursor_end_set(RealHandle); @@ -685,6 +727,7 @@ namespace ElmSharp /// /// Moves the cursor to the beginning of the current line. /// + /// preview public void MoveCursorLineBegin() { Interop.Elementary.elm_entry_cursor_line_begin_set(RealHandle); @@ -693,6 +736,7 @@ namespace ElmSharp /// /// Moves the cursor to the end of the current line. /// + /// preview public void MoveCursorLineEnd() { Interop.Elementary.elm_entry_cursor_line_end_set(RealHandle); @@ -702,6 +746,7 @@ namespace ElmSharp /// Sets the input panel layout of the entry. /// /// The layout type + /// preview public void SetInputPanelLayout(InputPanelLayout layout) { Interop.Elementary.elm_entry_input_panel_layout_set(RealHandle, (Interop.Elementary.InputPanelLayout)layout); @@ -711,6 +756,7 @@ namespace ElmSharp /// Sets the attribute to show the input panel automatically. /// /// If true the input panel appears when the entry is clicked or has focus, otherwise false + /// preview public void SetInputPanelEnabled(bool enabled) { Interop.Elementary.elm_entry_input_panel_enabled_set(RealHandle, enabled); @@ -720,6 +766,7 @@ namespace ElmSharp /// Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel. /// /// The type of "return" key on the input panel + /// preview public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType) { Interop.Elementary.elm_entry_input_panel_return_key_type_set(RealHandle, (Interop.Elementary.ReturnKeyType)keyType); @@ -732,6 +779,7 @@ namespace ElmSharp /// Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. /// This API can be used in case of manually controlling by using SetInputPanelEnabled(false). /// + /// preview public void HideInputPanel() { Interop.Elementary.elm_entry_input_panel_hide(RealHandle); @@ -740,6 +788,7 @@ namespace ElmSharp /// /// Selects all the text within the entry. /// + /// preview public void SelectAll() { Interop.Elementary.elm_entry_select_all(RealHandle); @@ -748,6 +797,7 @@ namespace ElmSharp /// /// Drops any existing text selection within the entry. /// + /// preview public void SelectNone() { Interop.Elementary.elm_entry_select_none(RealHandle); @@ -756,6 +806,7 @@ namespace ElmSharp /// /// Forces calculation of the entry size and text layouting. /// + /// preview public void ForceCalculation() { Interop.Elementary.elm_entry_calc_force(RealHandle); @@ -765,6 +816,7 @@ namespace ElmSharp /// Gets the string by the cursor at its current position. /// /// + /// preview public string GetCursorContent() { return Interop.Elementary.elm_entry_cursor_content_get(RealHandle); @@ -773,6 +825,7 @@ namespace ElmSharp /// /// Begins a selection within the entry as though the user were holding down the mouse button to make a selection. /// + /// preview public void BeginCursorSelection() { Interop.Elementary.elm_entry_cursor_selection_begin(RealHandle); @@ -782,6 +835,7 @@ namespace ElmSharp /// Appends the text of the entry. /// /// The text to be displayed + /// preview public void AppendText(string text) { Interop.Elementary.elm_entry_entry_append(RealHandle, text); @@ -794,6 +848,7 @@ namespace ElmSharp /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public virtual ScrollBarVisiblePolicy HorizontalScrollBarVisiblePolicy { get @@ -816,6 +871,7 @@ namespace ElmSharp /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public virtual ScrollBarVisiblePolicy VerticalScrollBarVisiblePolicy { get @@ -838,6 +894,7 @@ namespace ElmSharp /// This is enabled by default for both axis. /// This API will set if it is enabled for the given axis with the boolean parameters for each axis. /// + /// preview public bool VerticalBounce { get @@ -860,6 +917,7 @@ namespace ElmSharp /// This is enabled by default for both axis. /// This API will set if it is enabled for the given axis with the boolean parameters for each axis. /// + /// preview public bool HorizontalBounce { get @@ -879,6 +937,7 @@ namespace ElmSharp /// Inserts the given text into the entry at the current cursor position. /// /// + /// preview public void InsertTextToCursor(string text) { Interop.Elementary.elm_entry_entry_insert(RealHandle, text); @@ -887,6 +946,7 @@ namespace ElmSharp /// /// Ends a selection within the entry as though the user had just released the mouse button while making a selection. /// + /// preview public void EndCursorSelection() { Interop.Elementary.elm_entry_cursor_selection_end(RealHandle); @@ -895,6 +955,7 @@ namespace ElmSharp /// /// Writes any changes made to the file that is set by File. /// + /// preview public void SaveFile() { Interop.Elementary.elm_entry_file_save(RealHandle); @@ -907,6 +968,7 @@ namespace ElmSharp /// Note that input panel is shown or hidden automatically according to the focus state of entry widget. /// This API can be used in the case of manually controlling by using SetInputPanelEnabled(false). /// + /// preview public void ShowInputPanel() { Interop.Elementary.elm_entry_input_panel_show(RealHandle); @@ -916,6 +978,7 @@ namespace ElmSharp /// This appends a custom item provider to the list for that entry. /// /// This function is used to provide items. + /// preview public void AppendItemProvider(Func func) { if (func != null) @@ -938,6 +1001,7 @@ namespace ElmSharp /// This prepends a custom item provider to the list for that entry. /// /// This function is used to provide items. + /// preview public void PrependItemProvider(Func func) { if (!_itemsProvider.ContainsKey(func)) @@ -957,6 +1021,7 @@ namespace ElmSharp /// This removes a custom item provider to the list for that entry. /// /// This function is used to provide items. + /// preview public void RemoveItemProvider(Func func) { if (_itemsProvider.ContainsKey(func)) @@ -973,6 +1038,7 @@ namespace ElmSharp /// Append a markup filter function for text inserted in the entry. /// /// This function type is used by entry filters to modify text. + /// preview public void AppendMarkUpFilter(Func filter) { if (!_textFilters.ContainsKey(filter)) @@ -998,6 +1064,7 @@ namespace ElmSharp /// Prepend a markup filter function for text inserted in the entry. /// /// This function type is used by entry filters to modify text. + /// preview public void PrependMarkUpFilter(Func filter) { if (!_textFilters.ContainsKey(filter)) @@ -1023,6 +1090,7 @@ namespace ElmSharp /// Remove a markup filter /// /// This function type is used by entry filters to modify text. + /// preview public void RemoveMarkUpFilter(Func filter) { if (_textFilters.ContainsKey(filter)) @@ -1038,6 +1106,7 @@ namespace ElmSharp /// /// This executes a "copy" action on the selected text in the entry. /// + /// preview public void CopySelection() { Interop.Elementary.elm_entry_selection_copy(RealHandle); @@ -1046,6 +1115,7 @@ namespace ElmSharp /// /// This executes a "cut" action on the selected text in the entry. /// + /// preview public void CutSelection() { Interop.Elementary.elm_entry_selection_cut(RealHandle); @@ -1054,6 +1124,7 @@ namespace ElmSharp /// /// This executes a "paste" action in the entry. /// + /// preview public void PasteSelection() { Interop.Elementary.elm_entry_selection_paste(RealHandle); @@ -1063,6 +1134,7 @@ namespace ElmSharp /// This disabled the entry's selection. /// /// If true, the selection are disabled. + /// preview public void DisableSelection(bool disable) { Interop.Elementary.elm_entry_selection_handler_disabled_set(RealHandle, disable); @@ -1072,6 +1144,7 @@ namespace ElmSharp /// Get any selected text within the entry. /// /// Selection's value + /// preview public string GetSelection() { return Interop.Elementary.elm_entry_selection_get(RealHandle); @@ -1082,6 +1155,7 @@ namespace ElmSharp /// /// The starting position. /// The end position. + /// preview public void SetSelectionRegion(int start, int end) { Interop.Elementary.elm_entry_select_region_set(RealHandle, start, end); @@ -1091,6 +1165,7 @@ namespace ElmSharp /// Sets the visibility of the left-side widget of the entry /// /// true if the object should be displayed, false if not. + /// preview public void SetIconVisible(bool isDisplay) { Interop.Elementary.elm_entry_icon_visible_set(RealHandle, isDisplay); @@ -1100,6 +1175,7 @@ namespace ElmSharp /// Set whether the return key on the input panel is disabled automatically when entry has no text. /// /// If enabled is true, the return key is automatically disabled when the entry has no text. + /// preview public void SetInputPanelReturnKeyAutoEnable(bool enable) { Interop.Elementary.elm_entry_input_panel_return_key_autoenabled_set(RealHandle, enable); @@ -1110,6 +1186,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_entry_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/EvasCanvas.cs b/src/ElmSharp/ElmSharp/EvasCanvas.cs index 869a3b1..c536ec0 100755 --- a/src/ElmSharp/ElmSharp/EvasCanvas.cs +++ b/src/ElmSharp/ElmSharp/EvasCanvas.cs @@ -29,6 +29,7 @@ namespace ElmSharp /// Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them.Thus, you'll be looking at this section only if you're building low level stuff. /// The groups within present you functions that deal with the canvas directly, too, and not yet with its objects.They are the functions you need to use at a minimum to get a working canvas. /// + /// preview public class EvasCanvas { IntPtr _handle = IntPtr.Zero; @@ -43,6 +44,7 @@ namespace ElmSharp /// Gets the current known default pointer coordinates. /// This function returns the current known canvas unit coordinates of the mouse pointer. /// + /// preview public Point Pointer { get @@ -57,6 +59,7 @@ namespace ElmSharp /// Gets or sets the image cache. /// This function returns the image cache size of canvas in bytes. /// + /// preview public int ImageCacheSize { get @@ -72,6 +75,7 @@ namespace ElmSharp /// /// Flush the image cache of the canvas. /// + /// preview public void FlushImageCache() { Interop.Evas.evas_image_cache_flush(_handle); @@ -84,6 +88,7 @@ namespace ElmSharp /// The rectangle's top left corner's vertical coordinate. /// The rectangle's width. /// The rectangle's height. + /// preview public void AddDamageRectangle(int x, int y, int width, int height) { Interop.Evas.evas_damage_rectangle_add(_handle, x, y, width, height); @@ -96,6 +101,7 @@ namespace ElmSharp /// The rectangle's top left corner's vertical coordinate. /// The rectangle's width. /// The rectangle's height. + /// preview public void AddObscuredRectangle(int x, int y, int width, int height) { Interop.Evas.evas_obscured_rectangle_add(_handle, x, y, width, height); @@ -104,6 +110,7 @@ namespace ElmSharp /// /// Remove all "obscured regions" from an Evas canvas. /// + /// preview public void ClearObscuredRectangle() { Interop.Evas.evas_obscured_clear(_handle); @@ -114,6 +121,7 @@ namespace ElmSharp /// /// The type of event that triggers /// The action to be called when the event is triggered + /// preview public void AddEventAction(EvasObjectCallbackType type, Action action) { if (action != null) @@ -134,6 +142,7 @@ namespace ElmSharp /// /// The type of event that triggers /// The action to be called when the event is triggered + /// preview public void DeleteEventAction(EvasObjectCallbackType type, Action action) { if (action != null) diff --git a/src/ElmSharp/ElmSharp/EvasImage.cs b/src/ElmSharp/ElmSharp/EvasImage.cs index 870cbfb..6e823ed 100755 --- a/src/ElmSharp/ElmSharp/EvasImage.cs +++ b/src/ElmSharp/ElmSharp/EvasImage.cs @@ -25,6 +25,7 @@ namespace ElmSharp /// /// This group provides functions for image objects. /// + /// preview public class EvasImage : EvasObject { EvasObject _source = null; @@ -34,6 +35,7 @@ namespace ElmSharp /// Creates and initializes a new instance of EvasImage class. /// /// The parent is a given container which will be attached by EvasImage as a child. It's type. + /// preview public EvasImage(EvasObject parent) : base(parent) { } @@ -47,6 +49,7 @@ namespace ElmSharp /// /// Sets or gets the source file from where an image object must fetch the real image data /// + /// preview public string File { get @@ -64,6 +67,7 @@ namespace ElmSharp /// /// Sets or gets the source object to be visible. /// + /// preview public bool IsSourceVisible { get @@ -79,6 +83,7 @@ namespace ElmSharp /// /// Sets or gets whether an object is clipped by source object's clipper. /// + /// preview public bool IsSourceClipped { get @@ -99,6 +104,7 @@ namespace ElmSharp /// This function sets if the center part of the scaled image is to be drawn or left completely blank, or forced to be solid. /// Very useful for frames and decorations. /// + /// preview public ImageBorderFillMode BorderCenterFillMode { get @@ -114,6 +120,7 @@ namespace ElmSharp /// /// Sets or gets whether the image object's fill property should track the object's size. /// + /// preview public bool IsFilled { get @@ -129,6 +136,7 @@ namespace ElmSharp /// /// Sets or gets the scaling factor (multiplier) for the borders of an image object. /// + /// preview public double BorderScale { get @@ -144,6 +152,7 @@ namespace ElmSharp /// /// Sets or gets the size of the given image object. /// + /// preview public Size Size { get @@ -161,6 +170,7 @@ namespace ElmSharp /// /// Gets the row stride of the given image object. /// + /// preview public int Stride { get @@ -172,6 +182,7 @@ namespace ElmSharp /// /// Sets or gets whether alpha channel data is being used on the given image object. /// + /// preview public bool IsOpaque { get @@ -187,6 +198,7 @@ namespace ElmSharp /// /// Sets or gets whether to use high-quality image scaling algorithm on the given image object. /// + /// preview public bool IsSmoothScaled { get @@ -203,6 +215,7 @@ namespace ElmSharp /// Sets how to fill an image object's drawing rectangle given the (real) image bound to it. /// /// + /// preview public void SetFill(Rect geometry) { Interop.Evas.evas_object_image_fill_set(RealHandle, geometry.X, geometry.Y, geometry.Width, geometry.Height); @@ -213,6 +226,7 @@ namespace ElmSharp /// /// The image file path /// The image key in file (if its an Eet one), otherwise set null + /// preview public void SetFile(string file, string key) { Interop.Evas.evas_object_image_file_set(RealHandle, file, key); @@ -222,6 +236,7 @@ namespace ElmSharp /// Sets the data for an image from memory to be loaded. /// /// memory stream + /// preview public void SetStream(Stream stream) { if (stream == null) @@ -245,6 +260,7 @@ namespace ElmSharp /// /// The proxy (image) object /// true if the source object is set successfully, ortherwise false on error + /// preview public bool SetSource(EvasObject source) { bool result = false; @@ -259,6 +275,7 @@ namespace ElmSharp /// Set the native surface of a given image of the canvas /// /// The surface. + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public void SetNativeSurface(IntPtr surface) { @@ -272,6 +289,7 @@ namespace ElmSharp /// The border's right width /// The border's top width /// The border's bottom width + /// preview public void SetBorder(int left, int right, int top, int bottom) { Interop.Evas.evas_object_image_border_set(RealHandle, left, right, top, bottom); @@ -282,6 +300,7 @@ namespace ElmSharp /// /// The parent is a given container which will be attached by Image as a child. It's type. /// The new object, otherwise null if it cannot be created + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return _handle != IntPtr.Zero ? _handle : Interop.Evas.evas_object_image_add(Interop.Evas.evas_object_evas_get(parent.Handle)); diff --git a/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs b/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs index 953953a..af12a72 100755 --- a/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs +++ b/src/ElmSharp/ElmSharp/EvasKeyEventArgs.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// The EvasKeyEventArgs is an EvasKey EventArgs /// + /// preview public class EvasKeyEventArgs : EventArgs { IntPtr _nativeEventInfo; @@ -29,26 +30,31 @@ namespace ElmSharp /// /// BackButton name in Platform /// + /// preview public const string PlatformBackButtonName = "XF86Back"; /// /// MenuButton name in Platform /// + /// preview public const string PlatformMenuButtonName = "XF86Menu"; /// /// HomeButton name in Platform /// + /// preview public const string PlatformHomeButtonName = "XF86Home"; /// /// Gets the name of Key /// + /// preview public string KeyName { get; private set; } /// /// Sets or gets the flags. /// + /// preview public EvasEventFlag Flags { get @@ -77,6 +83,7 @@ namespace ElmSharp /// object /// information /// EvasKey eventArgs + /// preview static public EvasKeyEventArgs Create(IntPtr data, IntPtr obj, IntPtr info) { return new EvasKeyEventArgs(info); @@ -145,6 +152,7 @@ namespace ElmSharp /// /// Flags for Events /// + /// preview [Flags] public enum EvasEventFlag { diff --git a/src/ElmSharp/ElmSharp/EvasMap.cs b/src/ElmSharp/ElmSharp/EvasMap.cs index 03f5ea3..4d55a2d 100755 --- a/src/ElmSharp/ElmSharp/EvasMap.cs +++ b/src/ElmSharp/ElmSharp/EvasMap.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The EvasMap is an opaque handle to map points. /// + /// preview public class EvasMap { IntPtr _evasMap; @@ -30,6 +31,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the EvasMap class. /// /// The number of points in the map + /// preview public EvasMap(int count) { _evasMap = Interop.Evas.evas_map_new(count); @@ -64,6 +66,7 @@ namespace ElmSharp /// /// Gets or sets the flag of the object move synchronization for map rendering. /// + /// preview public bool IsMoveSync { get @@ -80,6 +83,7 @@ namespace ElmSharp /// Populates source and destination map points to exactly match the object. /// /// The object to use unmapped geometry to populate map coordinates + /// preview public void PopulatePoints(EvasObject obj) { Interop.Evas.evas_map_util_points_populate_from_object_full(_evasMap, obj, 0); @@ -92,6 +96,7 @@ namespace ElmSharp /// /// The point Z coordinate hint (pre-perspective transform)This value is used for all four points. /// + /// preview public void PopulatePoints(EvasObject obj, int z) { Interop.Evas.evas_map_util_points_populate_from_object_full(_evasMap, obj, z); @@ -102,6 +107,7 @@ namespace ElmSharp /// /// The geometry value contains X coordinate,Y coordinate,the width and height to use to calculate second and third points /// The Z coordinate hint (pre-perspective transform) This value is used for all four points. + /// preview public void PopulatePoints(Rect geometry, int z) { Interop.Evas.evas_map_util_points_populate_from_geometry(_evasMap, geometry.X, geometry.Y, geometry.Width, geometry.Height, z); @@ -113,6 +119,7 @@ namespace ElmSharp /// The abount of degrees from 0.0 to 360.0 to rotate /// rotation's center horizontal position. /// rotation's center vertical position. + /// preview public void Rotate(double degrees, int cx, int cy) { Interop.Evas.evas_map_util_rotate(_evasMap, degrees, cx, cy); @@ -127,6 +134,7 @@ namespace ElmSharp /// The rotation's center horizontal position /// The rotation's center vertical position /// The rotation's center depth position + /// preview public void Rotate3D(double dx, double dy, double dz, int cx, int cy, int cz) { Interop.Evas.evas_map_util_3d_rotate(_evasMap, dx, dy, dz, cx, cy, cz); @@ -137,6 +145,7 @@ namespace ElmSharp /// /// The index of point to change ,this must be smaller than map size. /// 3D Point coordinate + /// preview public void SetPointCoordinate(int idx, Point3D point) { Interop.Evas.evas_map_point_coord_set(_evasMap, idx, point.X, point.Y, point.Z); @@ -147,6 +156,7 @@ namespace ElmSharp /// /// The index of point to change ,this must be smaller than map size. /// The coordinates of the given point in the map. + /// preview public Point3D GetPointCoordinate(int idx) { Point3D point; @@ -161,6 +171,7 @@ namespace ElmSharp /// The vertical zoom to use /// The zooming center horizontal position /// The zooming center vertical position + /// preview public void Zoom(double x, double y, int cx, int cy) { Interop.Evas.evas_map_util_zoom(_evasMap, x, y, cx, cy); diff --git a/src/ElmSharp/ElmSharp/EvasObject.cs b/src/ElmSharp/ElmSharp/EvasObject.cs index 974386f..4f6eb48 100755 --- a/src/ElmSharp/ElmSharp/EvasObject.cs +++ b/src/ElmSharp/ElmSharp/EvasObject.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// /// Enumeration for tooltip orientation. /// + /// preview public enum TooltipOrientation { /// @@ -79,6 +80,7 @@ namespace ElmSharp /// /// Enumeration for aspect control. /// + /// preview public enum AspectControl { /// @@ -110,6 +112,7 @@ namespace ElmSharp /// /// The EcasObject is a base class for other widget class /// + /// preview public abstract class EvasObject { private IntPtr _realHandle = IntPtr.Zero; @@ -125,16 +128,19 @@ namespace ElmSharp /// /// Sets or gets the handle for EvasObject. /// + /// preview public IntPtr Handle { get; protected set; } /// /// Gets the parent object for EvasObject. /// + /// preview public EvasObject Parent { get; private set; } /// /// Sets or gets the real handle for EvasObject. /// + /// preview public IntPtr RealHandle { get @@ -165,6 +171,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter. /// /// Parent EvasObject class + /// preview protected EvasObject(EvasObject parent) : this() { Debug.Assert(parent == null || parent.IsRealized); @@ -174,6 +181,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the EvasObject class. /// + /// preview protected EvasObject() { _backButtonHandler = new Interop.Eext.EextEventCallback((d, o, i) => { _backButtonPressed?.Invoke(this, EventArgs.Empty); }); @@ -198,21 +206,25 @@ namespace ElmSharp /// /// Deleted will be triggered when widght is deleted /// + /// preview public event EventHandler Deleted; /// /// KeyUp will be triggered when key is loose /// + /// preview public event EventHandler KeyUp; /// /// KeyDown will be triggered when key is preesd down /// + /// preview public event EventHandler KeyDown; /// /// BackButtonPressed will be triggered when Back button is pressed /// + /// preview public event EventHandler BackButtonPressed { add @@ -236,6 +248,7 @@ namespace ElmSharp /// /// MoreButtonPressed will be triggered when More button is pressed /// + /// preview public event EventHandler MoreButtonPressed { add @@ -259,6 +272,7 @@ namespace ElmSharp /// /// Moved will be triggered when widght is moved /// + /// preview public event EventHandler Moved { add { _moved.On += value; } @@ -268,6 +282,7 @@ namespace ElmSharp /// /// Current widget's size Resized Event Handler /// + /// preview public event EventHandler Resized { add { _resized.On += value; } @@ -277,6 +292,7 @@ namespace ElmSharp /// /// Current widget RenderPost Event Handler /// + /// preview public event EventHandler RenderPost { add @@ -303,16 +319,19 @@ namespace ElmSharp /// Called back when a widget's tooltip is activated and needs content. /// /// + /// preview public delegate EvasObject GetTooltipContentDelegate(); /// /// Get widget's status of Realized or not. /// + /// preview public bool IsRealized { get { return Handle != IntPtr.Zero; } } /// /// Gets EvasCanvas /// + /// preview public EvasCanvas EvasCanvas { get @@ -326,6 +345,7 @@ namespace ElmSharp /// /// Gets the current class's Name. /// + /// preview public string ClassName { get @@ -337,6 +357,7 @@ namespace ElmSharp /// /// Sets or gets the horizontal pointer hints for an object's weight. /// + /// preview public double WeightX { get @@ -352,6 +373,7 @@ namespace ElmSharp /// /// Sets or gets the vertical pointer hints for an object's weight. /// + /// preview public double WeightY { get @@ -367,6 +389,7 @@ namespace ElmSharp /// /// Sets or gets the horizontal alignment hint of an object's alignment. /// + /// preview public virtual double AlignmentX { get @@ -382,6 +405,7 @@ namespace ElmSharp /// /// Sets or gets the vertical alignment hint of an object's alignment. /// + /// preview public virtual double AlignmentY { get @@ -397,6 +421,7 @@ namespace ElmSharp /// /// Sets or gets the Width hints for an object's minimum size. /// + /// preview public int MinimumWidth { get @@ -415,6 +440,7 @@ namespace ElmSharp /// /// Sets or gets the Height hints for an object's minimum size. /// + /// preview public int MinimumHeight { get @@ -433,6 +459,7 @@ namespace ElmSharp /// /// Gets the visible state of the given Evas object. /// + /// preview public bool IsVisible { get @@ -444,6 +471,7 @@ namespace ElmSharp /// /// Sets or gets the position and (rectangular) size of the given Evas object. /// + /// preview public Rect Geometry { get @@ -462,6 +490,7 @@ namespace ElmSharp /// /// Sets or gets the general or main color of the given Evas object. /// + /// preview public virtual Color Color { get @@ -479,6 +508,7 @@ namespace ElmSharp /// /// Sets or gets the map enabled state. /// + /// preview public bool IsMapEnabled { get @@ -494,6 +524,7 @@ namespace ElmSharp /// /// Sets or gets current object transformation map. /// + /// preview public EvasMap EvasMap { get @@ -510,6 +541,7 @@ namespace ElmSharp /// /// Sets or gets whether an object is to repeat events. /// + /// preview public bool RepeatEvents { get @@ -531,6 +563,7 @@ namespace ElmSharp /// /// Sets or gets whether events on a smart object's member should get propagated up to its parent. /// + /// preview public bool PropagateEvents { get @@ -552,6 +585,7 @@ namespace ElmSharp /// /// Sets or gets whether an object is set to pass (ignore) events. /// + /// preview public bool PassEvents { get @@ -573,6 +607,7 @@ namespace ElmSharp /// /// Sets or Gets style for this object tooltip. /// + /// preview public string TooltipStyle { get @@ -588,6 +623,7 @@ namespace ElmSharp /// /// Sets or gets the orientation of Tooltip. /// + /// preview public TooltipOrientation TooltipOrientation { get @@ -603,6 +639,7 @@ namespace ElmSharp /// /// Sets or gets size restriction state of an object's tooltip. /// + /// preview public bool TooltipWindowMode { get @@ -618,6 +655,7 @@ namespace ElmSharp /// /// Sets the content to be shown in the tooltip object. /// + /// preview public GetTooltipContentDelegate TooltipContentDelegate { get @@ -642,6 +680,7 @@ namespace ElmSharp /// Gets the movement freeze by 1 /// This gets the movement freeze count by one. /// + /// preview public int TooltipMoveFreezeCount { get @@ -653,6 +692,7 @@ namespace ElmSharp /// /// Sets or gets whether an Evas object is to freeze (discard) events. /// + /// preview public bool AllEventsFrozen { get @@ -674,6 +714,7 @@ namespace ElmSharp /// /// Sets or gets the layer of its canvas that the given object will be part of. /// + /// preview public virtual int Layer { get @@ -690,6 +731,7 @@ namespace ElmSharp /// Clips one object to another. /// /// The object to clip object by + /// preview public void SetClip(EvasObject clip) { Interop.Evas.evas_object_clip_set(Handle, clip); @@ -700,6 +742,7 @@ namespace ElmSharp /// /// The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 /// The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 + /// preview public void SetAlignment(double x, double y) { Interop.Evas.evas_object_size_hint_align_set(Handle, x, y); @@ -710,6 +753,7 @@ namespace ElmSharp /// /// The non-negative double value to use as horizontal weight hint /// The non-negative double value to use as vertical weight hint + /// preview public void SetWeight(double x, double y) { Interop.Evas.evas_object_size_hint_weight_set(Handle, x, y); @@ -719,6 +763,7 @@ namespace ElmSharp /// Sets the text for an object's tooltip. /// /// The text value to display inside the tooltip + /// preview public void SetTooltipText(string text) { Interop.Elementary.elm_object_tooltip_text_set(RealHandle, text); @@ -727,6 +772,7 @@ namespace ElmSharp /// /// Unsets an object's tooltip. /// + /// preview public void UnsetTooltip() { Interop.Elementary.elm_object_tooltip_unset(RealHandle); @@ -736,6 +782,7 @@ namespace ElmSharp /// This increments the tooltip movement freeze count by one. /// If the count is more than 0, the tooltip position will be fixed. /// + /// preview public void PushTooltipMoveFreeze() { Interop.Elementary.elm_object_tooltip_move_freeze_push(RealHandle); @@ -744,6 +791,7 @@ namespace ElmSharp /// /// This decrements the tooltip freeze count by one. /// + /// preview public void PopTooltipMoveFreeze() { Interop.Elementary.elm_object_tooltip_move_freeze_pop(RealHandle); @@ -752,6 +800,7 @@ namespace ElmSharp /// /// Force hide tooltip of object. /// + /// preview public void HideTooltip() { Interop.Elementary.elm_object_tooltip_hide(RealHandle); @@ -760,6 +809,7 @@ namespace ElmSharp /// /// Force show tooltip of object. /// + /// preview public void ShowTooltip() { Interop.Elementary.elm_object_tooltip_show(RealHandle); @@ -768,6 +818,7 @@ namespace ElmSharp /// /// Makes the current object visible. /// + /// preview public void Show() { Interop.Evas.evas_object_show(Handle); @@ -776,6 +827,7 @@ namespace ElmSharp /// /// Makes the current object invisible. /// + /// preview public void Hide() { Interop.Evas.evas_object_hide(Handle); @@ -786,6 +838,7 @@ namespace ElmSharp /// /// The new width /// The new height + /// preview public void Resize(int w, int h) { Interop.Evas.evas_object_resize(Handle, w, h); @@ -796,6 +849,7 @@ namespace ElmSharp /// /// The X position to move the object to. /// The Y position to move the object to. + /// preview public void Move(int x, int y) { Interop.Evas.evas_object_move(Handle, x, y); @@ -804,6 +858,7 @@ namespace ElmSharp /// /// Lowers obj to the bottom of its layer. /// + /// preview public void Lower() { Interop.Evas.evas_object_lower(Handle); @@ -813,6 +868,7 @@ namespace ElmSharp /// Define IntPtr operator /// /// Parent object + /// preview public static implicit operator IntPtr(EvasObject obj) { if (obj == null) @@ -826,6 +882,7 @@ namespace ElmSharp /// The key to request events for /// Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE /// If the call succeeded is true,otherwise is false + /// preview public bool KeyGrab(string keyname, bool exclusive) { return Interop.Evas.evas_object_key_grab(Handle, keyname, 0, 0, exclusive); @@ -835,6 +892,7 @@ namespace ElmSharp /// Removes the grab on keyname key events. /// /// The key the grab is set for + /// preview public void KeyUngrab(string keyname) { Interop.Evas.evas_object_key_ungrab(Handle, keyname, 0, 0); @@ -843,6 +901,7 @@ namespace ElmSharp /// /// Mark smart object as changed. /// + /// preview public void MarkChanged() { Interop.Evas.evas_object_smart_changed(RealHandle); @@ -852,6 +911,7 @@ namespace ElmSharp /// Call the calculate smart function immediately. /// This will force immediate calculations needed for renderization of this object. /// + /// preview public void Calculate() { Interop.Evas.evas_object_smart_calculate(RealHandle); @@ -863,6 +923,7 @@ namespace ElmSharp /// The policy or type of aspect ratio to apply to object /// The integer to use as aspect width ratio term /// The integer to use as aspect height ratio term + /// preview public void SetSizeHintAspect(AspectControl aspect, int w, int h) { Interop.Evas.evas_object_size_hint_aspect_set(Handle, (int)aspect, w, h); @@ -874,6 +935,7 @@ namespace ElmSharp /// The policy or type of aspect ratio to apply to object /// The integer to use as aspect width ratio term /// The integer to use as aspect height ratio term + /// preview public void GetSizeHintAspect(out AspectControl aspect, out int w, out int h) { int aspectRatio; @@ -885,6 +947,7 @@ namespace ElmSharp /// Stack immediately below anchor. /// /// The object below which to stack. + /// preview public void StackBelow(EvasObject anchor) { Interop.Evas.evas_object_stack_below(Handle, anchor); @@ -894,6 +957,7 @@ namespace ElmSharp /// Stack immediately above anchor. /// /// The object above which to stack. + /// preview public void StackAbove(EvasObject anchor) { Interop.Evas.evas_object_stack_above(Handle, anchor); @@ -902,6 +966,7 @@ namespace ElmSharp /// /// Raise to the top of its layer. /// + /// preview public void RaiseTop() { Interop.Evas.evas_object_raise(Handle); @@ -916,6 +981,7 @@ namespace ElmSharp /// w coord of the line. /// h coord of the line. /// + /// preview public bool GetTextBlockGeometryByLineNumber(int lineNumber, out int x, out int y, out int w, out int h) { return Interop.Evas.evas_object_textblock_line_number_geometry_get(RealHandle, lineNumber, out x, out y, out w, out h); @@ -939,6 +1005,7 @@ namespace ElmSharp /// /// The callback of Invalidate Event /// + /// preview protected virtual void OnInvalidate() { } @@ -946,6 +1013,7 @@ namespace ElmSharp /// /// The callback of Instantiated Event /// + /// preview protected virtual void OnInstantiated() { } @@ -953,6 +1021,7 @@ namespace ElmSharp /// /// The callback of Realized Event /// + /// preview protected virtual void OnRealized() { } @@ -960,6 +1029,7 @@ namespace ElmSharp /// /// The callback of Unrealize Event /// + /// preview protected virtual void OnUnrealize() { } @@ -969,12 +1039,14 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected abstract IntPtr CreateHandle(EvasObject parent); /// /// For this object bind Parent object.Init handle and all kinds of EvasObjectEvent. /// /// Parent object + /// preview public void Realize(EvasObject parent) { if (!IsRealized) @@ -1001,6 +1073,7 @@ namespace ElmSharp /// /// Removes current object relationship with others. /// + /// preview public void Unrealize() { if (IsRealized) diff --git a/src/ElmSharp/ElmSharp/EvasObjectEvent.cs b/src/ElmSharp/ElmSharp/EvasObjectEvent.cs index eb08d77..2c1cb74 100755 --- a/src/ElmSharp/ElmSharp/EvasObjectEvent.cs +++ b/src/ElmSharp/ElmSharp/EvasObjectEvent.cs @@ -25,17 +25,20 @@ namespace ElmSharp /// IInvalidatable is a interface which can be overrided by its children class. /// Inherits IDisposable /// + /// preview public interface IInvalidatable : IDisposable { /// /// Make current instance invalidate /// + /// preview void MakeInvalidate(); } /// /// Enumeration for EvasObjectCallbackType /// + /// preview public enum EvasObjectCallbackType { /// @@ -223,6 +226,7 @@ namespace ElmSharp /// Event class for EvasObject /// /// Kinds of EventArgs + /// preview public class EvasObjectEvent : IInvalidatable where TEventArgs : EventArgs { /// @@ -232,6 +236,7 @@ namespace ElmSharp /// obj /// info /// delegate handle + /// preview public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info); private bool _disposed = false; @@ -247,6 +252,7 @@ namespace ElmSharp /// EvasObject class belong to /// EvasObjectCallbackType /// SmartEventInfoParser + /// preview public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type, SmartEventInfoParser parser) : this(sender, sender.Handle, type, parser) { } @@ -258,6 +264,7 @@ namespace ElmSharp /// EvasObject handle /// EvasObjectCallbackType /// SmartEventInfoParser + /// preview [EditorBrowsableAttribute(EditorBrowsableState.Never)] public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type, SmartEventInfoParser parser) { @@ -273,6 +280,7 @@ namespace ElmSharp /// /// EvasObject class belong with /// SmartEventInfoParser + /// preview public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, type, null) { } @@ -294,6 +302,7 @@ namespace ElmSharp /// /// On Event Handler of EvasObjectEvent /// + /// preview public event EventHandler On { add @@ -335,6 +344,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -358,6 +368,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -367,6 +378,7 @@ namespace ElmSharp /// /// Make current instance invalidate /// + /// preview public void MakeInvalidate() { _sender = null; @@ -377,6 +389,7 @@ namespace ElmSharp /// /// Event class for EvasObject /// + /// preview public class EvasObjectEvent : IInvalidatable { private EvasObjectEvent _evasObjectEvent; @@ -390,6 +403,7 @@ namespace ElmSharp /// /// EvasObject class belong to /// EvasObjectCallbackType + /// preview public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, sender.Handle, type) { } @@ -400,6 +414,7 @@ namespace ElmSharp /// EvasObject class belong to /// EvasObject handle /// EvasObjectCallbackType + /// preview [EditorBrowsableAttribute(EditorBrowsableState.Never)] public EvasObjectEvent(EvasObject sender, IntPtr handle, EvasObjectCallbackType type) { @@ -417,6 +432,7 @@ namespace ElmSharp /// /// On Event Handler of EvasObjectEvent /// + /// preview public event EventHandler On { add @@ -450,6 +466,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -465,6 +482,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -474,6 +492,7 @@ namespace ElmSharp /// /// Make current instance invalidate /// + /// preview public void MakeInvalidate() { _evasObjectEvent.MakeInvalidate(); diff --git a/src/ElmSharp/ElmSharp/FlipSelector.cs b/src/ElmSharp/ElmSharp/FlipSelector.cs index 58db381..4e98e73 100755 --- a/src/ElmSharp/ElmSharp/FlipSelector.cs +++ b/src/ElmSharp/ElmSharp/FlipSelector.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// 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. /// + /// preview public class FlipSelector : Layout { SmartEvent _selected; @@ -32,6 +33,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the FlipSelector. /// /// Parent EvasObject + /// preview public FlipSelector(EvasObject parent) : base(parent) { _selected = new SmartEvent(this, Handle, "selected"); @@ -46,19 +48,23 @@ namespace ElmSharp /// /// Selected will be triggered when be Selected /// + /// preview public event EventHandler Selected; /// /// Overflowed will be triggered when Overflowed /// + /// preview public event EventHandler Overflowed; /// /// Underflowed will be triggered when be Underflowed /// + /// preview public event EventHandler Underflowed; /// /// Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget. /// + /// preview public double Interval { get @@ -75,6 +81,7 @@ namespace ElmSharp /// /// Gets the currently selected item in a flip selector widget. /// + /// preview public FlipSelectorItem SelectedItem { get @@ -87,6 +94,7 @@ namespace ElmSharp /// /// Gets the first item in the given flip selector widget's list of items. /// + /// preview public FlipSelectorItem FirstItem { get @@ -99,6 +107,7 @@ namespace ElmSharp /// /// Gets the last item in the given flip selector widget's list of items. /// + /// preview public FlipSelectorItem LastItem { get @@ -118,6 +127,7 @@ namespace ElmSharp /// /// 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. /// + /// preview public FlipSelectorItem Append(string text) { FlipSelectorItem item = new FlipSelectorItem(text); @@ -133,6 +143,7 @@ namespace ElmSharp /// /// 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. /// + /// preview public FlipSelectorItem Prepend(string text) { FlipSelectorItem item = new FlipSelectorItem(text); @@ -144,6 +155,7 @@ namespace ElmSharp /// To remove the given item. /// /// FlipSelector's item + /// preview public void Remove(FlipSelectorItem item) { if (item as FlipSelectorItem != null) @@ -156,6 +168,7 @@ namespace ElmSharp /// /// 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. /// + /// preview public void Next() { Interop.Elementary.elm_flipselector_flip_next(Handle); @@ -164,6 +177,7 @@ namespace ElmSharp /// /// Programmatically select the previous item of a flip selector widget. /// + /// preview public void Prev() { Interop.Elementary.elm_flipselector_flip_prev(Handle); @@ -174,6 +188,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_flipselector_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/FlipSelectorItem.cs b/src/ElmSharp/ElmSharp/FlipSelectorItem.cs index 3210e3b..a9bf57f 100755 --- a/src/ElmSharp/ElmSharp/FlipSelectorItem.cs +++ b/src/ElmSharp/ElmSharp/FlipSelectorItem.cs @@ -21,22 +21,26 @@ namespace ElmSharp /// /// Iterm class of FlipSelector /// + /// preview public class FlipSelectorItem : ItemObject { /// /// Sets or gets the Text of FlipSelectorItem /// + /// preview public string Text { get; private set; } /// /// Selected will be triggered when Selected /// + /// preview public event EventHandler Selected; /// /// Creates and initializes a new instance of the FlipSelectorItem. /// /// FlipSelectorItem's text + /// preview public FlipSelectorItem(string text) : base(IntPtr.Zero) { Text = text; diff --git a/src/ElmSharp/ElmSharp/FloatingButton.cs b/src/ElmSharp/ElmSharp/FloatingButton.cs index 2c0251c..64ae3b3 100755 --- a/src/ElmSharp/ElmSharp/FloatingButton.cs +++ b/src/ElmSharp/ElmSharp/FloatingButton.cs @@ -21,12 +21,14 @@ namespace ElmSharp /// /// The FloatingButton is a widget that to add floating area for buttons. /// + /// preview public class FloatingButton : Layout { /// /// Creates and initializes a new instance of the FloatingButton class. /// /// Created on this parent container.. + /// preview public FloatingButton(EvasObject parent) : base(parent) { } @@ -34,6 +36,7 @@ namespace ElmSharp /// /// Sets or gets floatingbutton mode. /// + /// preview public FloatingButtonMode Mode { get @@ -49,6 +52,7 @@ namespace ElmSharp /// /// Gets floatingbutton Position. /// + /// preview public FloatingButtonPosition Position { get @@ -60,6 +64,7 @@ namespace ElmSharp /// /// Sets or gets movability for a given floatingbutton widget. /// + /// preview public bool MovementBlock { get @@ -75,6 +80,7 @@ namespace ElmSharp /// /// Get Opacity's value of the given FloatingButton. /// + /// preview public override int Opacity { get @@ -93,6 +99,7 @@ namespace ElmSharp /// /// Button position /// Animat flag + /// preview public void SetPosition(FloatingButtonPosition position, bool animated) { if (animated) @@ -110,6 +117,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Eext.eext_floatingbutton_add(parent.Handle); @@ -119,6 +127,7 @@ namespace ElmSharp /// /// Enumeration for FloatingButtonMode /// + /// preview public enum FloatingButtonMode { /// @@ -135,6 +144,7 @@ namespace ElmSharp /// /// Enumeration for FloatingButtonPosition /// + /// preview public enum FloatingButtonPosition { /// diff --git a/src/ElmSharp/ElmSharp/GenGrid.cs b/src/ElmSharp/ElmSharp/GenGrid.cs index 146112b..e9ec144 100755 --- a/src/ElmSharp/ElmSharp/GenGrid.cs +++ b/src/ElmSharp/ElmSharp/GenGrid.cs @@ -24,11 +24,13 @@ namespace ElmSharp /// It contains Item which is type. /// All events of GenGrid contain GenGridItemEventArgs as a parameter. /// + /// preview public class GenGridItemEventArgs : EventArgs { /// /// Gets or sets GenGrid item.The return type is . /// + /// preview public GenGridItem Item { get; set; } internal static GenGridItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info) @@ -44,6 +46,7 @@ namespace ElmSharp /// It has two direction in which a given GenGrid widget expands while placing its items, horizontal and vertical. /// The GenGrid items are represented through definition field details. /// + /// preview public class GenGrid : Layout { HashSet _children = new HashSet(); @@ -63,6 +66,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the GenGrid class. /// /// The parent is a given container which will be attached by GenGrid as a child. It's type. + /// preview public GenGrid(EvasObject parent) : base(parent) { InitializeSmartEvent(); @@ -71,51 +75,61 @@ namespace ElmSharp /// /// ItemSelected is raised when a new gengrid item is selected. /// + /// preview public event EventHandler ItemSelected; /// /// ItemUnselected is raised when the gengrid item is Unselected. /// + /// preview public event EventHandler ItemUnselected; /// /// ItemPressed is raised when a new gengrid item is pressed. /// + /// preview public event EventHandler ItemPressed; /// /// ItemReleased is raised when a new gengrid item is released. /// + /// preview public event EventHandler ItemReleased; /// /// ItemActivated is raised when a new gengrid item is double clicked or pressed (enter|return|spacebar). /// + /// preview public event EventHandler ItemActivated; /// /// ItemDoubleClicked is raised when a new gengrid item is double clicked. /// + /// preview public event EventHandler ItemDoubleClicked; /// /// ItemRealized is raised when a gengrid item is implementing through . /// + /// preview public event EventHandler ItemRealized; /// /// ItemUnrealized is raised when the gengrid item is deleted. /// + /// preview public event EventHandler ItemUnrealized; /// /// ItemLongPressed is raised when a gengrid item is pressed for a certain amount of time. By default it's 1 second. /// + /// preview public event EventHandler ItemLongPressed; /// /// Changed is raised when an item is added, removed, resized or moved and when the gengrid is resized or gets "horizontal" property changes. /// + /// preview public event EventHandler Changed; /// @@ -123,6 +137,7 @@ namespace ElmSharp /// Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along x-axis. /// + /// preview public double ItemAlignmentX { get @@ -143,6 +158,7 @@ namespace ElmSharp /// Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along y-axis. /// + /// preview public double ItemAlignmentY { get @@ -162,6 +178,7 @@ namespace ElmSharp /// Gets or sets the manner in which the items grid is filled within a given gengrid widget. /// It is filled if true, otherwise false. /// + /// preview public bool FillItems { get @@ -183,6 +200,7 @@ namespace ElmSharp /// A click on an already selected item unselects it. If interacting via the keyboard, multi-selection is enabled while holding the "Shift" key. /// By default, multi-selection is disabled. /// + /// preview public bool MultipleSelection { get @@ -203,6 +221,7 @@ namespace ElmSharp /// The default width and height just have one finger wide. /// Use this property to force a custom width for your items, making them as big as you wish. /// + /// preview public int ItemWidth { get @@ -226,6 +245,7 @@ namespace ElmSharp /// The default width and height just have one finger wide. /// Use this property to force a custom height for your items, making them as big as you wish. /// + /// preview public int ItemHeight { get @@ -244,6 +264,7 @@ namespace ElmSharp /// /// Gets or sets the gengrid select mode by . /// + /// preview public GenItemSelectionMode SelectionMode { get @@ -263,6 +284,7 @@ namespace ElmSharp /// If true, items are placed in columns from top to bottom and when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally. /// If false, items are placed in rows from left to right, and when the space for a row is filled, another one is started below, thus expanding the grid vertically. /// + /// preview public bool IsHorizontal { get @@ -278,6 +300,7 @@ namespace ElmSharp /// /// Gets or sets whether the gengrid items should be highlighted when an item is selected. /// + /// preview public bool IsHighlight { get @@ -297,6 +320,7 @@ namespace ElmSharp /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public ScrollBarVisiblePolicy HorizontalScrollBarVisiblePolicy { get @@ -319,6 +343,7 @@ namespace ElmSharp /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public ScrollBarVisiblePolicy VerticalScrollBarVisiblePolicy { get @@ -337,6 +362,7 @@ namespace ElmSharp /// /// Gets the first item in a given gengrid widget. /// + /// preview public GenGridItem FirstItem { get @@ -349,6 +375,7 @@ namespace ElmSharp /// /// Gets the last item in a given gengrid widget. /// + /// preview public GenGridItem LastItem { get @@ -361,6 +388,7 @@ namespace ElmSharp /// /// Gets the items count in a given gengrid widget. /// + /// preview public uint ItemCount { get @@ -372,6 +400,7 @@ namespace ElmSharp /// /// Gets the selected item in a given gengrid widget. /// + /// preview public GenGridItem SelectedItem { get @@ -384,6 +413,7 @@ namespace ElmSharp /// /// Gets or sets whether a given gengrid widget is or not able have items reordered. /// + /// preview public bool ReorderMode { get @@ -404,6 +434,7 @@ namespace ElmSharp /// Return a gengrid item that contains data and itemClass. /// /// + /// preview public GenGridItem Append(GenItemClass itemClass, object data) { GenGridItem item = new GenGridItem(data, itemClass); @@ -421,6 +452,7 @@ namespace ElmSharp /// Return a gengrid item that contains data and itemClass. /// /// + /// preview public GenGridItem Prepend(GenItemClass itemClass, object data) { GenGridItem item = new GenGridItem(data, itemClass); @@ -439,6 +471,7 @@ namespace ElmSharp /// Return a gengrid item that contains data and itemClass./> /// /// + /// preview public GenGridItem InsertBefore(GenItemClass itemClass, object data, GenGridItem before) { GenGridItem item = new GenGridItem(data, itemClass); @@ -457,6 +490,7 @@ namespace ElmSharp /// Return a gengrid item that contains data and itemClass. /// /// + /// preview public GenGridItem InsertAfter(GenItemClass itemClass, object data, GenGridItem after) { GenGridItem item = new GenGridItem(data, itemClass); @@ -473,6 +507,7 @@ namespace ElmSharp /// The item data. /// User defined comparison function that defines the sort order based on gengrid item and its data. /// Return a gengrid item that contains data and itemClass. + /// preview public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison comparison) { GenGridItem item = new GenGridItem(data, itemClass); @@ -501,6 +536,7 @@ namespace ElmSharp /// If animated is false, the gengrid shows item by jumping if it's not fully visible. /// /// + /// preview public void ScrollTo(GenGridItem item, ScrollToPosition position, bool animated) { if (animated) @@ -521,6 +557,7 @@ namespace ElmSharp /// /// to update just one item. /// + /// preview public void UpdateRealizedItems() { Interop.Elementary.elm_gengrid_realized_items_update(RealHandle); @@ -533,6 +570,7 @@ namespace ElmSharp /// /// to delete just one item. /// + /// preview public void Clear() { Interop.Elementary.elm_gengrid_clear(RealHandle); @@ -550,6 +588,7 @@ namespace ElmSharp /// -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1). /// /// + /// preview public GenGridItem GetItemByPosition(int x, int y, out int portionX, out int portionY) { IntPtr handle = Interop.Elementary.elm_gengrid_at_xy_item_get(RealHandle, x, y, out portionX, out portionY); @@ -561,6 +600,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/GenGridItem.cs b/src/ElmSharp/ElmSharp/GenGridItem.cs index 13e1abf..79b7464 100755 --- a/src/ElmSharp/ElmSharp/GenGridItem.cs +++ b/src/ElmSharp/ElmSharp/GenGridItem.cs @@ -24,6 +24,7 @@ namespace ElmSharp /// A instance to the gengrid item added. /// It contains Update() method to update a gengrid item which is given. /// + /// preview public class GenGridItem : GenItem { internal GenGridItem(object data, GenItemClass itemClass) : base(data, itemClass) @@ -38,6 +39,7 @@ namespace ElmSharp /// If true, it is selected. /// If false, it is unselected. /// + /// preview public override bool IsSelected { get @@ -53,6 +55,7 @@ namespace ElmSharp /// /// Sets or gets the cursor to be shown when mouse is over the gengrid item. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public override string Cursor { @@ -76,6 +79,7 @@ namespace ElmSharp /// /// Sets or gets the style for this item cursor. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public override string CursorStyle { @@ -92,6 +96,7 @@ namespace ElmSharp /// /// Sets or gets the cursor engine only usage for this item cursor. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public override bool IsUseEngineCursor { @@ -108,6 +113,7 @@ namespace ElmSharp /// /// Sets or gets or sets the style of given gengrid item's tooltip. /// + /// preview public override string TooltipStyle { get @@ -123,6 +129,7 @@ namespace ElmSharp /// /// Get the gengrid item's select mode. /// + /// preview public override GenItemSelectionMode SelectionMode { get @@ -138,6 +145,7 @@ namespace ElmSharp /// /// Gets or sets gengrid item's row position, relative to the whole gengrid's grid area. /// + /// preview public int Row { get @@ -151,6 +159,7 @@ namespace ElmSharp /// /// Gets or sets gengrid item's column position, relative to the whole gengrid's grid area. /// + /// preview public int Column { get @@ -165,6 +174,7 @@ namespace ElmSharp /// Set the text to be shown in the gengrid item. /// /// The text to set. + /// preview public override void SetTooltipText(string tooltip) { Interop.Elementary.elm_gengrid_item_tooltip_text_set(Handle, tooltip); @@ -173,6 +183,7 @@ namespace ElmSharp /// /// Unset tooltip from item. /// + /// preview public override void UnsetTooltip() { Interop.Elementary.elm_gengrid_item_tooltip_unset(Handle); @@ -186,6 +197,7 @@ namespace ElmSharp /// /// to update the contents of all the realized items. /// + /// preview public override void Update() { Interop.Elementary.elm_gengrid_item_update(Handle); @@ -194,6 +206,7 @@ namespace ElmSharp /// /// Set the content to be shown in the tooltip item. /// + /// preview protected override void UpdateTooltipDelegate() { Interop.Elementary.elm_gengrid_item_tooltip_content_cb_set(Handle, diff --git a/src/ElmSharp/ElmSharp/GenItem.cs b/src/ElmSharp/ElmSharp/GenItem.cs index c037d73..18fa72a 100755 --- a/src/ElmSharp/ElmSharp/GenItem.cs +++ b/src/ElmSharp/ElmSharp/GenItem.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for select mode of GenItem. /// + /// preview public enum GenItemSelectionMode { /// @@ -49,6 +50,7 @@ namespace ElmSharp /// A base class for and . /// It contains genitem class and data to display data. /// + /// preview public abstract class GenItem : ItemObject { internal Interop.Elementary.Elm_Tooltip_Item_Content_Cb _tooltipCb; @@ -57,6 +59,7 @@ namespace ElmSharp /// /// The delegate returning the tooltip contents. /// + /// preview public delegate EvasObject GetTooltipContentDelegate(); internal GenItem(object data, GenItemClass itemClass) : base(IntPtr.Zero) @@ -69,11 +72,13 @@ namespace ElmSharp /// /// Gets the item class that defines how to display data. It returns type. /// + /// preview public GenItemClass ItemClass { get; protected set; } /// /// Sets or gets tooltip content delegate. /// + /// preview public GetTooltipContentDelegate TooltipContentDelegate { get @@ -90,57 +95,68 @@ namespace ElmSharp /// /// It's a abstract property. /// + /// preview public abstract GenItemSelectionMode SelectionMode { get; set; } /// /// Sets or gets the cursor to be shown when mouse is over the gengrid item /// + /// preview public abstract string Cursor { get; set; } /// /// Sets or gets the style for this item cursor. /// + /// preview public abstract string CursorStyle { get; set; } /// /// Sets or gets the cursor engine only usage for this item cursor. /// + /// preview public abstract bool IsUseEngineCursor { get; set; } /// /// Gets item data that is added through calling , or methods. /// + /// preview public object Data { get; protected set; } /// /// It's a abstract property. It's implemented by and . /// + /// preview public abstract bool IsSelected { get; set; } /// /// It's a abstract property. It's implemented by and . /// + /// preview public abstract string TooltipStyle { get; set; } /// /// Set tooltip text. /// /// The text to set. + /// preview public abstract void SetTooltipText(string tooltip); /// /// Unset tooltip. /// + /// preview public abstract void UnsetTooltip(); /// /// It's a abstract method. It's implemented by and . /// + /// preview public abstract void Update(); /// /// The override method for delete item class and item data. It's called when the item is deleting. /// + /// preview protected override void OnInvalidate() { ItemClass?.SendItemDeleted(Data); @@ -151,6 +167,7 @@ namespace ElmSharp /// /// Abstract method for updating tooltip content. /// + /// preview protected abstract void UpdateTooltipDelegate(); } } \ No newline at end of file diff --git a/src/ElmSharp/ElmSharp/GenItemClass.cs b/src/ElmSharp/ElmSharp/GenItemClass.cs index 9f1186e..2bd8c70 100755 --- a/src/ElmSharp/ElmSharp/GenItemClass.cs +++ b/src/ElmSharp/ElmSharp/GenItemClass.cs @@ -24,6 +24,7 @@ namespace ElmSharp /// It represents the GenGrid or GenList item class definition field details. /// It has some display styles, such as "default", "full" and "group_index". /// + /// preview public class GenItemClass : IDisposable { static Dictionary s_HandleToEvasObject = new Dictionary(); @@ -34,6 +35,7 @@ namespace ElmSharp /// The item data. /// The part where the data should be shown. /// Return string that should be shown. + /// preview public delegate string GetTextDelegate(object data, string part); /// @@ -42,12 +44,14 @@ namespace ElmSharp /// The item data. /// The part where the data should be shown. /// Return content that should be shown. + /// preview public delegate EvasObject GetContentDelegate(object data, string part); /// /// The delegate to define . /// /// The item data. + /// preview public delegate void DeleteDelegate(object data); /// @@ -57,6 +61,7 @@ namespace ElmSharp /// The part where the data should be shown. /// The content has been added in gengrid. /// Return content that should be shown. + /// preview public delegate EvasObject GetReusableContentDelegate(object data, string part, EvasObject old); ItemClass _itemClass; @@ -67,6 +72,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the GenItemClass. /// /// The item display style. + /// preview public GenItemClass(string style) { _style = style; @@ -94,30 +100,35 @@ namespace ElmSharp /// /// Gets the item style. /// + /// preview public string ItemStyle { get { return _style; } } /// /// Gets or sets the callback that defines how to display item text. /// If get, return . /// + /// preview public GetTextDelegate GetTextHandler { get; set; } /// /// Gets or sets the callback that defines how to display item content. /// If get, return . /// + /// preview public GetContentDelegate GetContentHandler { get; set; } /// /// Gets or sets the callback that defines how to delete item text and content. /// If get, return . /// + /// preview public DeleteDelegate DeleteHandler { get; set; } /// /// Gets or sets the callback that defines how to reuse item content. /// If get, return . /// + /// preview public GetReusableContentDelegate ReusableContentHandler { get; set; } internal IntPtr UnmanagedPtr @@ -140,6 +151,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (_unmanagedPtr != IntPtr.Zero) @@ -152,6 +164,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -168,6 +181,7 @@ namespace ElmSharp /// Create a new genlist item class in a given genlist widget. /// /// The new item class object. + /// preview protected virtual IntPtr CreateItemClass() { return Interop.Elementary.elm_genlist_item_class_new(); @@ -177,6 +191,7 @@ namespace ElmSharp /// Remove an item class in a given genlist widget. /// /// The object to be removed. + /// preview protected virtual void ReleaseItemClass(IntPtr unmanagedPtr) { Interop.Elementary.elm_genlist_item_class_free(unmanagedPtr); @@ -231,12 +246,14 @@ namespace ElmSharp /// /// It represents the GenGrid item class definition field details. /// + /// preview public class GenGridItemClass : GenItemClass { /// /// Create the GenGridItemClass instance. /// /// The item display style. + /// preview public GenGridItemClass(string style) : base(style) { } @@ -245,6 +262,7 @@ namespace ElmSharp /// Add a new gengrid item class in a given gengrid widget. /// /// The new instance. + /// preview protected override IntPtr CreateItemClass() { return Interop.Elementary.elm_gengrid_item_class_new(); @@ -254,6 +272,7 @@ namespace ElmSharp /// Remove an item class in a given gengrid widget. /// /// The object to be removed. + /// preview protected override void ReleaseItemClass(IntPtr unmanagedPtr) { Interop.Elementary.elm_gengrid_item_class_free(unmanagedPtr); @@ -263,16 +282,22 @@ namespace ElmSharp [StructLayout(LayoutKind.Sequential)] internal class ItemClass { + /// preview public delegate string GetTextCallback(IntPtr data, IntPtr obj, IntPtr part); + /// preview public delegate IntPtr GetContentCallback(IntPtr data, IntPtr obj, IntPtr part); + /// preview public delegate int GetStateCallback(IntPtr data, IntPtr obj, IntPtr part); + /// preview public delegate void DelCallback(IntPtr data, IntPtr obj); + /// preview public delegate int FilterCallback(IntPtr data, IntPtr obj, IntPtr key); + /// preview public delegate IntPtr GetReusableContentCallback(IntPtr data, IntPtr obj, IntPtr part, IntPtr old); public int version; diff --git a/src/ElmSharp/ElmSharp/GenList.cs b/src/ElmSharp/ElmSharp/GenList.cs index 600c57b..d3371d5 100755 --- a/src/ElmSharp/ElmSharp/GenList.cs +++ b/src/ElmSharp/ElmSharp/GenList.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// Enumeration for setting genlist item type. /// + /// preview public enum GenListItemType { /// @@ -43,6 +44,7 @@ namespace ElmSharp /// /// Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping. /// + /// preview public enum GenListMode { /// @@ -76,11 +78,13 @@ namespace ElmSharp /// It contains Item which is type. /// All events of GenList contain GenListItemEventArgs as a parameter. /// + /// preview public class GenListItemEventArgs : EventArgs { /// /// Gets or sets GenList item. The return type is . /// + /// preview public GenListItem Item { get; set; } internal static GenListItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info) @@ -93,6 +97,7 @@ namespace ElmSharp /// /// Enumeration that defines where to position the item in the genlist. /// + /// preview public enum ScrollToPosition { /// @@ -128,6 +133,7 @@ namespace ElmSharp /// But the price to pay is more complexity when it comes to usage. /// If all you want is a simple list with icons and a single text, use the widget. /// + /// preview public class GenList : Layout { HashSet _children = new HashSet(); @@ -153,6 +159,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the GenList class. /// /// The parent is a given container which will be attached by GenList as a child. It's type. + /// preview public GenList(EvasObject parent) : base(parent) { } @@ -160,6 +167,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of GenList class. /// + /// preview protected GenList() : base() { } @@ -170,6 +178,7 @@ namespace ElmSharp /// /// If true, the genlist items have same height and width. /// + /// preview public bool Homogeneous { get @@ -195,6 +204,7 @@ namespace ElmSharp /// However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK). /// If so, then some dynamic resizable objects in the genlist would not be diplayed properly. /// + /// preview public GenListMode ListMode { get @@ -210,6 +220,7 @@ namespace ElmSharp /// /// Gets the first item in the genlist. /// + /// preview public GenListItem FirstItem { get @@ -222,6 +233,7 @@ namespace ElmSharp /// /// Gets the last item in the genlist. /// + /// preview public GenListItem LastItem { get @@ -236,6 +248,7 @@ namespace ElmSharp /// After turning on the reorder mode, longpress on a normal item triggers reordering of the item. /// You can move the item up and down. However, reordering does not work with group items. /// + /// preview public bool ReorderMode { get @@ -251,6 +264,7 @@ namespace ElmSharp /// /// Gets or set the maximum number of items within an item block. /// + /// preview public int BlockCount { get @@ -266,6 +280,7 @@ namespace ElmSharp /// /// Gets or sets whether the genlist items should be highlighted when an item is selected. /// + /// preview public bool IsHighlight { get @@ -281,6 +296,7 @@ namespace ElmSharp /// /// Gets or sets the timeout in seconds for the longpress event. /// + /// preview public double LongPressTimeout { get @@ -301,6 +317,7 @@ namespace ElmSharp /// This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. /// Clicking on a focusable widget inside an item will couse this particular item to get focus as usual. /// + /// preview public bool FocusOnSelection { get @@ -316,6 +333,7 @@ namespace ElmSharp /// /// Gets or sets whether enable multi-selection in the genlist. /// + /// preview public bool IsMultiSelection { get @@ -331,6 +349,7 @@ namespace ElmSharp /// /// Gets the selected item in a given genlist widget. /// + /// preview public GenListItem SelectedItem { get @@ -343,6 +362,7 @@ namespace ElmSharp /// /// Gets or sets the genlist select mode by . /// + /// preview public GenItemSelectionMode SelectionMode { get @@ -358,6 +378,7 @@ namespace ElmSharp /// /// Gets count of items in a this genlist widget /// + /// preview public int Count { get @@ -369,74 +390,88 @@ namespace ElmSharp /// /// ItemSelected is raised when a new genlist item is selected. /// + /// preview public event EventHandler ItemSelected; /// /// ItemUnselected is raised when the genlist item is Unselected. /// + /// preview public event EventHandler ItemUnselected; /// /// ItemPressed is raised when a new genlist item is pressed. /// + /// preview public event EventHandler ItemPressed; /// /// ItemReleased is raised when a new genlist item is released. /// + /// preview public event EventHandler ItemReleased; /// /// ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar). /// + /// preview public event EventHandler ItemActivated; /// /// ItemDoubleClicked is raised when a new genlist item is double clicked. /// + /// preview public event EventHandler ItemDoubleClicked; /// /// ItemExpanded is raised when a new genlist item is indicated to expand. /// + /// preview public event EventHandler ItemExpanded; /// /// ItemRealized is raised when a new genlist item is created as a real object. /// + /// preview public event EventHandler ItemRealized; /// /// ItemUnrealized is raised when a new genlist item is unrealized. /// After calling unrealize, the item's content objects are deleted and the item object itself is deleted or is put into a floating cache. /// + /// preview public event EventHandler ItemUnrealized; /// /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second. /// + /// preview public event EventHandler ItemLongPressed; /// /// ItemMoved is raised when a genlist item is moved in the reorder mode. /// + /// preview public event EventHandler ItemMoved; /// /// ItemMovedAfter is raised when a genlist item is moved after another item in the reorder mode. /// To get the relative previous item, use . /// + /// preview public event EventHandler ItemMovedAfter; /// /// ItemMovedBefore is raised when a genlist item is moved before another item in the reorder mode. /// To get the relative next item, use . /// + /// preview public event EventHandler ItemMovedBefore; /// /// Changed is raised when genlist is changed. /// + /// preview public event EventHandler Changed { add { _changed.On += value; } @@ -446,6 +481,7 @@ namespace ElmSharp /// /// ScrollAnimationStarted is raised when scrolling animation has started. /// + /// preview public event EventHandler ScrollAnimationStarted { add { _scrollAnimationStarted.On += value; } @@ -455,6 +491,7 @@ namespace ElmSharp /// /// ScrollAnimationStopped is raised when scrolling animation has stopped. /// + /// preview public event EventHandler ScrollAnimationStopped { add { _scrollAnimationStopped.On += value; } @@ -469,6 +506,7 @@ namespace ElmSharp /// Return a new added genlist item that contains data and itemClass. /// /// + /// preview public GenListItem Append(GenItemClass itemClass, object data) { return Append(itemClass, data, GenListItemType.Normal); @@ -481,6 +519,7 @@ namespace ElmSharp /// The item data. /// The genlist item type. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type) { return Append(itemClass, data, type, null); @@ -494,6 +533,7 @@ namespace ElmSharp /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent) { GenListItem item = new GenListItem(data, itemClass); @@ -509,6 +549,7 @@ namespace ElmSharp /// The itemClass defines how to display the data. /// The item data. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem Prepend(GenItemClass itemClass, object data) { return Prepend(itemClass, data, GenListItemType.Normal); @@ -521,6 +562,7 @@ namespace ElmSharp /// The item data. /// The genlist item type. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type) { return Prepend(itemClass, data, type, null); @@ -534,6 +576,7 @@ namespace ElmSharp /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent) { GenListItem item = new GenListItem(data, itemClass); @@ -551,6 +594,7 @@ namespace ElmSharp /// The item data. /// The item before which to place this new one. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before) { return InsertBefore(itemClass, data, before, GenListItemType.Normal); @@ -565,6 +609,7 @@ namespace ElmSharp /// The item before which to place this new one. /// The genlist item type. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type) { return InsertBefore(itemClass, data, before, type, null); @@ -579,6 +624,7 @@ namespace ElmSharp /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type, GenListItem parent) { GenListItem item = new GenListItem(data, itemClass); @@ -606,6 +652,7 @@ namespace ElmSharp /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a new added genlist item that contains data and itemClass. + /// preview public GenListItem InsertAfter(GenItemClass itemClass, object data, GenListItem after, GenListItemType type, GenListItem parent) { GenListItem item = new GenListItem(data, itemClass); @@ -633,6 +680,7 @@ namespace ElmSharp /// The genlist item type. /// The parent item, otherwise null if there is no parent item. /// Return a genlist item that contains data and itemClass. + /// preview public GenListItem InsertSorted(GenItemClass itemClass, object data, Comparison comparison, GenListItemType type, GenListItem parent) { GenListItem item = new GenListItem(data, itemClass); @@ -666,6 +714,7 @@ namespace ElmSharp /// The item to display. /// The position to show the given item to . /// The animated indicates how to display the item, by scrolling or by jumping. + /// preview public void ScrollTo(GenListItem item, ScrollToPosition position, bool animated) { if (animated) @@ -685,6 +734,7 @@ namespace ElmSharp /// To update just one item, use . /// /// + /// preview public void UpdateRealizedItems() { Interop.Elementary.elm_genlist_realized_items_update(RealHandle); @@ -696,6 +746,7 @@ namespace ElmSharp /// To delete just one item, use . /// /// + /// preview public void Clear() { Interop.Elementary.elm_genlist_clear(RealHandle); @@ -710,6 +761,7 @@ namespace ElmSharp /// -1, 0, or 1, depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1). /// /// + /// preview public GenListItem GetItemByPosition(int x, int y, out int pos) { IntPtr handle = Interop.Elementary.elm_genlist_at_xy_item_get(RealHandle, x, y, out pos); @@ -721,6 +773,7 @@ namespace ElmSharp /// /// The number of the item to grab (0 being the first) /// + /// preview public GenListItem GetItemByIndex(int index) { IntPtr handle = Interop.Elementary.elm_genlist_nth_item_get(RealHandle, index); @@ -730,6 +783,7 @@ namespace ElmSharp /// /// The callback of Unrealize Event /// + /// preview protected override void OnRealized() { base.OnRealized(); @@ -742,6 +796,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/GenListItem.cs b/src/ElmSharp/ElmSharp/GenListItem.cs index b21c550..edd56c3 100755 --- a/src/ElmSharp/ElmSharp/GenListItem.cs +++ b/src/ElmSharp/ElmSharp/GenListItem.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// The type of item's part type. /// + /// preview [Flags] public enum GenListItemFieldType { @@ -56,6 +57,7 @@ namespace ElmSharp /// A instance to the genlist item added. /// It contains Update() method to update a genlist item which is given. /// + /// preview public class GenListItem : GenItem { internal GenListItem(object data, GenItemClass itemClass) : base(data, itemClass) @@ -65,6 +67,7 @@ namespace ElmSharp /// /// Gets or sets whether a given genlist item is selected. /// + /// preview public override bool IsSelected { get @@ -80,6 +83,7 @@ namespace ElmSharp /// /// Gets or sets whether a given genlist item is expanded. /// + /// preview public bool IsExpanded { get @@ -99,6 +103,7 @@ namespace ElmSharp /// To update already realized items, use . /// /// + /// preview public override void Update() { Interop.Elementary.elm_genlist_item_update(Handle); @@ -113,6 +118,7 @@ namespace ElmSharp /// The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content" and so on. It is also used for globbing to match '*', '?', and '.'. It can be used at updating multi fields. /// The type of item's part type. /// + /// preview public void UpdateField(string part, GenListItemFieldType type) { Interop.Elementary.elm_genlist_item_fields_update(Handle, part, (uint)type); @@ -121,6 +127,7 @@ namespace ElmSharp /// /// Demote an item to the end of the list. /// + /// preview public void DemoteItem() { Interop.Elementary.elm_genlist_item_demote(Handle); @@ -129,6 +136,7 @@ namespace ElmSharp /// /// Gets or sets the genlist item's select mode. /// + /// preview public override GenItemSelectionMode SelectionMode { get @@ -145,6 +153,7 @@ namespace ElmSharp /// Gets the next item in a genlist widget's internal list of items. /// /// + /// preview public GenListItem Next { get @@ -161,6 +170,7 @@ namespace ElmSharp /// Get the previous item in a genlist widget's internal list of items. /// /// + /// preview public GenListItem Previous { get @@ -176,6 +186,7 @@ namespace ElmSharp /// /// Sets or gets the content to be shown in the tooltip item /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public override string Cursor { @@ -199,6 +210,7 @@ namespace ElmSharp /// /// Sets or gets the style for this item cursor. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public override string CursorStyle { @@ -215,6 +227,7 @@ namespace ElmSharp /// /// Sets or gets the cursor engine only usage for this item cursor. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public override bool IsUseEngineCursor { @@ -232,6 +245,7 @@ namespace ElmSharp /// Set the text to be shown in the genlist item. /// /// The text to set in the content. + /// preview public override void SetTooltipText(string tooltip) { Interop.Elementary.elm_genlist_item_tooltip_text_set(Handle, tooltip); @@ -240,6 +254,7 @@ namespace ElmSharp /// /// Unset tooltip from item. /// + /// preview public override void UnsetTooltip() { Interop.Elementary.elm_genlist_item_tooltip_unset(Handle); @@ -248,6 +263,7 @@ namespace ElmSharp /// /// Gets or sets the style of given genlist item's tooltip. /// + /// preview public override string TooltipStyle { get @@ -263,6 +279,7 @@ namespace ElmSharp /// /// Gets or sets whether disable size restrictions on an object's tooltip. /// + /// preview public bool IsTooltipWindowMode { get @@ -278,6 +295,7 @@ namespace ElmSharp /// /// Gets the index of the item. It is only valid once displayed. /// + /// preview public int Index { get @@ -289,6 +307,7 @@ namespace ElmSharp /// /// Gets the depth of expanded item. /// + /// preview public int ExpandedItemDepth { get @@ -303,6 +322,7 @@ namespace ElmSharp /// /// This removes all items that are children (and their descendants) of the given item it. /// + /// preview public void ClearSubitems() { Interop.Elementary.elm_genlist_item_subitems_clear(Handle); @@ -314,6 +334,7 @@ namespace ElmSharp /// /// The item class for the item. /// The data for the item. + /// preview public void UpdateItemClass(GenItemClass itemClass, object data) { Data = data; @@ -324,6 +345,7 @@ namespace ElmSharp /// /// Set the content to be shown in the tooltip item. /// + /// preview protected override void UpdateTooltipDelegate() { Interop.Elementary.elm_genlist_item_tooltip_content_cb_set(Handle, diff --git a/src/ElmSharp/ElmSharp/GestureLayer.cs b/src/ElmSharp/ElmSharp/GestureLayer.cs index c6bce6c..bde146f 100644 --- a/src/ElmSharp/ElmSharp/GestureLayer.cs +++ b/src/ElmSharp/ElmSharp/GestureLayer.cs @@ -24,6 +24,7 @@ namespace ElmSharp /// The GestureLayer is used to detect gestures. /// Inherits Widget /// + /// preview public class GestureLayer : Widget { private readonly Interop.Elementary.GestureEventCallback _gestureCallback; @@ -37,6 +38,7 @@ namespace ElmSharp /// Creates and initializes a new instance of GestureLayer class. /// /// The parent is a given container which will be attached by GestureLayer as a child. It's type. + /// preview public GestureLayer(EvasObject parent) : base(parent) { _gestureCallback = new Interop.Elementary.GestureEventCallback(GestureCallbackHandler); @@ -45,6 +47,7 @@ namespace ElmSharp /// /// Enumeration for supported gesture types. /// + /// preview public enum GestureType { /// @@ -96,6 +99,7 @@ namespace ElmSharp /// /// Enumeration for gesture states. /// + /// preview public enum GestureState { /// @@ -129,6 +133,7 @@ namespace ElmSharp /// /// Sets or gets the repeat-events setting. /// + /// preview public bool HoldEvents { get @@ -144,6 +149,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer continues enable of an object /// + /// preview public bool Continues { get @@ -159,6 +165,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer finger-size for taps. /// + /// preview public int TapFingerSize { get @@ -174,6 +181,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer long tap start timeout of an object /// + /// preview public double LongTapTimeout { get @@ -189,6 +197,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer double tap timeout of an object /// + /// preview public double DoubleTapTimeout { get @@ -204,6 +213,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer flick time limit (in ms) of an object /// + /// preview public int FlickTimeLimit { get @@ -219,6 +229,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer line min length of an object /// + /// preview public int MinimumLineLength { get @@ -234,6 +245,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer line angular tolerance of an object /// + /// preview public double LineAngularTolerance { get @@ -249,6 +261,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer line distance tolerance of an object /// + /// preview public int LineDistanceTolerance { get @@ -264,6 +277,7 @@ namespace ElmSharp /// /// Sets or gets step-value for rotate action. /// + /// preview public double RotateStep { get @@ -279,6 +293,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer rotate angular tolerance of an object /// + /// preview public double RotateAngularTolerance { get @@ -294,6 +309,7 @@ namespace ElmSharp /// /// Sets or gets control step value for zoom action. /// + /// preview public double ZoomStep { get @@ -309,6 +325,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer zoom distance tolerance of an object /// + /// preview public int ZoomDistanceTolerance { get @@ -324,6 +341,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer zoom finger factor of an object /// + /// preview public double ZoomFingerFactor { get @@ -339,6 +357,7 @@ namespace ElmSharp /// /// Sets or gets the gesture layer zoom wheel factor of an object /// + /// preview public double ZoomWheelFactor { get @@ -358,6 +377,7 @@ namespace ElmSharp /// A gesture layer's target may be any Evas object. This object will be used to listen to mouse and key events. /// /// The object to attach. + /// preview public void Attach(EvasObject target) { Interop.Elementary.elm_gesture_layer_attach(Handle, target.Handle); @@ -370,6 +390,7 @@ namespace ElmSharp /// The gesture you want to track state of. /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetGestureCallback(GestureType type, GestureState state, Action action) { lock (_handlers) @@ -412,6 +433,7 @@ namespace ElmSharp /// /// clear the gesture state change callback. /// + /// preview public void ClearCallbacks() { lock (_handlers) @@ -438,6 +460,7 @@ namespace ElmSharp /// The gesture you want to track state of. /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetTapCallback(GestureType type, GestureState state, Action action) { SetCallback(type, state, action); @@ -448,6 +471,7 @@ namespace ElmSharp /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetMomentumCallback(GestureState state, Action action) { SetCallback(GestureType.Momentum, state, action); @@ -458,6 +482,7 @@ namespace ElmSharp /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetLineCallback(GestureState state, Action action) { SetCallback(GestureType.Line, state, action); @@ -468,6 +493,7 @@ namespace ElmSharp /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetFlickCallback(GestureState state, Action action) { SetCallback(GestureType.Flick, state, action); @@ -478,6 +504,7 @@ namespace ElmSharp /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetZoomCallback(GestureState state, Action action) { SetCallback(GestureType.Zoom, state, action); @@ -488,6 +515,7 @@ namespace ElmSharp /// /// The event the callback tracks (START, MOVE, END, ABORT). /// The callback itself. + /// preview public void SetRotateCallback(GestureState state, Action action) { SetCallback(GestureType.Rotate, state, action); @@ -500,6 +528,7 @@ namespace ElmSharp /// /// The gesture layer's parent widget. /// + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_gesture_layer_add(parent); @@ -508,6 +537,7 @@ namespace ElmSharp /// /// clear the gesture state change callback. /// + /// preview protected override void OnUnrealize() { ClearCallbacks(); @@ -566,17 +596,20 @@ namespace ElmSharp /// /// The struct of TapData /// + /// preview [StructLayout(LayoutKind.Sequential)] public struct TapData { /// /// The x coordinate of the center point. /// + /// preview public Int32 X; /// /// The y coordinate of the center point. /// + /// preview public Int32 Y; #pragma warning disable 3003 @@ -584,11 +617,13 @@ namespace ElmSharp /// /// The number of fingers tapped. /// + /// preview public UInt32 FingersCount; /// /// The timestamp. /// + /// preview public UInt32 Timestamp; #pragma warning restore 3003 @@ -597,27 +632,32 @@ namespace ElmSharp /// /// The struct of MomentumData /// + /// preview [StructLayout(LayoutKind.Sequential)] public struct MomentumData { /// /// Final-swipe direction starting point on X. /// + /// preview public Int32 X1; /// /// Final-swipe direction starting point on Y. /// + /// preview public Int32 Y1; /// /// Final-swipe direction ending point on X. /// + /// preview public Int32 X2; /// /// Final-swipe direction ending point on Y /// + /// preview public Int32 Y2; #pragma warning disable 3003 @@ -625,26 +665,31 @@ namespace ElmSharp /// /// Timestamp of start of final x-swipe. /// + /// preview public UInt32 HorizontalSwipeTimestamp; /// /// Timestamp of start of final y-swipe. /// + /// preview public UInt32 VerticalSwipeTimestamp; /// /// Momentum on X. /// + /// preview public Int32 HorizontalMomentum; /// /// Momentum on Y. /// + /// preview public Int32 VerticalMomentum; /// /// Number of fingers. /// + /// preview public UInt32 FingersCount; #pragma warning restore 3003 @@ -653,27 +698,32 @@ namespace ElmSharp /// /// The struct of LineData /// + /// preview [StructLayout(LayoutKind.Sequential)] public struct LineData { /// /// Final-swipe direction starting point on X. /// + /// preview public Int32 X1; /// /// Final-swipe direction starting point on Y. /// + /// preview public Int32 Y1; /// /// Final-swipe direction ending point on X. /// + /// preview public Int32 X2; /// /// Final-swipe direction ending point on Y /// + /// preview public Int32 Y2; #pragma warning disable 3003 @@ -681,26 +731,31 @@ namespace ElmSharp /// /// Timestamp of start of final x-swipe. /// + /// preview public UInt32 HorizontalSwipeTimestamp; /// /// Timestamp of start of final y-swipe. /// + /// preview public UInt32 VerticalSwipeTimestamp; /// /// Momentum on X. /// + /// preview public Int32 HorizontalMomentum; /// /// Momentum on Y. /// + /// preview public Int32 VerticalMomentum; /// /// Number of fingers. /// + /// preview public UInt32 FingersCount; #pragma warning restore 3003 @@ -708,33 +763,39 @@ namespace ElmSharp /// /// Angle (direction) of lines. /// + /// preview public double Angle; } /// /// The struct of ZoomData /// + /// preview [StructLayout(LayoutKind.Sequential)] public struct ZoomData { /// /// The x coordinate of zoom center point reported to user. /// + /// preview public Int32 X; /// /// The y coordinate of zoom center point reported to user. /// + /// preview public Int32 Y; /// /// The radius (distance) between fingers reported to user. /// + /// preview public Int32 Radius; /// /// The zoom value. 1.0 means no zoom. /// + /// preview public double Zoom; /// @@ -746,32 +807,38 @@ namespace ElmSharp /// /// The struct of RotateData /// + /// preview [StructLayout(LayoutKind.Sequential)] public struct RotateData { /// /// The x coordinate of rotation center point reported to user. /// + /// preview public Int32 X; /// /// The y coordinate of rotation center point reported to user. /// + /// preview public Int32 Y; /// /// The radius (distance) between fingers reported to user. /// + /// preview public Int32 Radius; /// /// The start-angle. /// + /// preview public double BaseAngle; /// /// The rotation value. 0.0 means no rotation. /// + /// preview public double Angle; /// @@ -785,11 +852,13 @@ namespace ElmSharp /// /// Config is a static class, it provides gestureLayer's timeout information. /// + /// preview public static class Config { /// /// Sets or gets the duration for occurring long tap event of gesture layer. /// + /// preview public static double DefaultLongTapTimeout { get @@ -805,6 +874,7 @@ namespace ElmSharp /// /// Sets or gets the duration for occurring double tap event of gesture layer. /// + /// preview public static double DefaultDoubleTapTimeout { get diff --git a/src/ElmSharp/ElmSharp/Hoversel.cs b/src/ElmSharp/ElmSharp/Hoversel.cs index ea6fc64..ec8ec91 100755 --- a/src/ElmSharp/ElmSharp/Hoversel.cs +++ b/src/ElmSharp/ElmSharp/Hoversel.cs @@ -21,11 +21,13 @@ namespace ElmSharp /// /// The HoverselItemEventArgs is an HoverselItem's EventArgs /// + /// preview public class HoverselItemEventArgs : EventArgs { /// /// Hoversel's Item /// + /// preview public HoverselItem Item { get; set; } internal static HoverselItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info) @@ -38,6 +40,7 @@ namespace ElmSharp /// /// The hoversel is a button that pops up a list of items. /// + /// preview public class Hoversel : Layout { SmartEvent _clicked; @@ -50,6 +53,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Hoversel class. /// /// The parent is a given container which will be attached by Hoversel as a child. It's type. + /// preview public Hoversel(EvasObject parent) : base(parent) { _clicked = new SmartEvent(this, "clicked"); @@ -82,26 +86,31 @@ namespace ElmSharp /// /// Clicked will be triggered when Hoversel is clicked /// + /// preview public event EventHandler Clicked; /// /// Expanded will be triggered when Hoversel is activated by clicking the hoversel or by a function /// + /// preview public event EventHandler Expanded; /// /// Dismissed will be triggered when Hoversel Dismissed /// + /// preview public event EventHandler Dismissed; /// /// ItemSelected will be triggered when Hoversel's Item Selected /// + /// preview public event EventHandler ItemSelected; /// /// Gets or sets the status to control whether the hoversel should expand horizontally. /// + /// preview public bool IsHorizontal { get @@ -117,6 +126,7 @@ namespace ElmSharp /// /// Gets or sets the hover parent. /// + /// preview public IntPtr HoverParent { get @@ -132,6 +142,7 @@ namespace ElmSharp /// /// Gets the flag of whether the hoversel is expanded. /// + /// preview public bool IsExpanded { get @@ -143,6 +154,7 @@ namespace ElmSharp /// /// Gets or sets the status of whether update icon and text of hoversel same to those of selected item automatically. /// + /// preview public bool AutoUpdate { get @@ -158,6 +170,7 @@ namespace ElmSharp /// /// This triggers the hoversel popup from code, the same as if the user had clicked the button. /// + /// preview public void HoverBegin() { Interop.Elementary.elm_hoversel_hover_begin(RealHandle); @@ -166,6 +179,7 @@ namespace ElmSharp /// /// This dismisses the hoversel popup as if the user had clicked outside the hover. /// + /// preview public void HoverEnd() { Interop.Elementary.elm_hoversel_hover_end(RealHandle); @@ -174,6 +188,7 @@ namespace ElmSharp /// /// This will remove all the children items from the hoversel. /// + /// preview public void Clear() { Interop.Elementary.elm_hoversel_clear(RealHandle); @@ -185,6 +200,7 @@ namespace ElmSharp /// /// Item's label /// A handle to the added item. + /// preview public HoverselItem AddItem(string label) { HoverselItem item = new HoverselItem(); @@ -198,6 +214,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/HoverselItem.cs b/src/ElmSharp/ElmSharp/HoverselItem.cs index ebdaece..135c683 100755 --- a/src/ElmSharp/ElmSharp/HoverselItem.cs +++ b/src/ElmSharp/ElmSharp/HoverselItem.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The HoverselItem is the Item of Hoversel /// + /// preview public class HoverselItem : ItemObject { internal HoverselItem() : base(IntPtr.Zero) @@ -30,11 +31,13 @@ namespace ElmSharp /// /// HoverselItem's label /// + /// preview public string Label { get; internal set; } /// /// ItemSelected will be triggered when HoverselItem Selected /// + /// preview public event EventHandler ItemSelected; internal void SendItemSelected() diff --git a/src/ElmSharp/ElmSharp/IAccessibleObject.cs b/src/ElmSharp/ElmSharp/IAccessibleObject.cs index c00e036..e8e4bc0 100755 --- a/src/ElmSharp/ElmSharp/IAccessibleObject.cs +++ b/src/ElmSharp/ElmSharp/IAccessibleObject.cs @@ -19,21 +19,25 @@ namespace ElmSharp.Accessible /// /// IAccessibleObject is a interface which defines properties and methods of accessible object. /// + /// preview public interface IAccessibleObject { /// /// Gets or sets the reading information types of an accessible object. /// + /// preview ReadingInfoType ReadingInfoType { get; set; } /// /// Gets or sets the role of the object in accessibility domain. /// + /// preview AccessRole Role { get; set; } /// /// Gets or sets highlightable of given widget. /// + /// preview bool CanHighlight { get; set; } /// @@ -42,26 +46,31 @@ namespace ElmSharp.Accessible /// When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter. /// It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled. /// + /// preview string TranslationDomain { get; set; } /// /// Gets or sets an accessible name of the object. /// + /// preview string Name { get; set; } /// /// Gets or sets contextual information about object. /// + /// preview string Description { get; set; } /// /// Gets or sets the delegate for . /// + /// preview AccessibleInfoProvider NameProvider { get; set; } /// /// Gets or sets the delegate for . /// + /// preview AccessibleInfoProvider DescriptionProvider { get; set; } /// @@ -70,22 +79,26 @@ namespace ElmSharp.Accessible /// AppendRelation API is asymmetric, which means that appending, for example, relation from object A to B, do not append relation from object B to object A. /// /// The relationship between source object and target object of a given type. + /// preview void AppendRelation(IAccessibleRelation relation); /// /// Removes the relationship between two accessible objects. /// /// The relationship between source object and target object of a given type. + /// preview void RemoveRelation(IAccessibleRelation relation); /// /// Highlights accessible widget. /// + /// preview void Highlight(); /// /// Clears highlight of accessible widget. /// + /// preview void Unhighlight(); } } diff --git a/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs b/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs index 8ed3d37..0c83042 100644 --- a/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs +++ b/src/ElmSharp/ElmSharp/IAnimatorMotionMapper.cs @@ -7,22 +7,26 @@ namespace ElmSharp /// /// The AnimatorMotionMapper interface /// + /// preview public interface IAnimatorMotionMapper { /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview double Calculate(double position); } /// /// The LinearMotionMapper class /// + /// preview public class LinearMotionMapper : IAnimatorMotionMapper { /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Linear, 0, 0); @@ -32,11 +36,13 @@ namespace ElmSharp /// /// The AccelerateMotionMapper class /// + /// preview public class AccelerateMotionMapper : IAnimatorMotionMapper { /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Accelerate, 0, 0); @@ -46,11 +52,13 @@ namespace ElmSharp /// /// The DecelerateMotionMapper class /// + /// preview public class DecelerateMotionMapper : IAnimatorMotionMapper { /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Decelerate, 0, 0); @@ -60,11 +68,13 @@ namespace ElmSharp /// /// The SinusoidalMotionMapper class /// + /// preview public class SinusoidalMotionMapper : IAnimatorMotionMapper { /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Sinusoidal, 0, 0); @@ -74,16 +84,19 @@ namespace ElmSharp /// /// The AccelerateFactorMotionMapper class /// + /// preview public class AccelerateFactorMotionMapper : IAnimatorMotionMapper { /// /// The power factor of AccelerateFactorMotionMapper /// + /// preview public double PowerFactor { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.AccelerateFactor, PowerFactor, 0); @@ -93,16 +106,19 @@ namespace ElmSharp /// /// The DecelerateFactorMotionMapper class /// + /// preview public class DecelerateFactorMotionMapper : IAnimatorMotionMapper { /// /// The power factor of DecelerateFactorMotionMapper /// + /// preview public double PowerFactor { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.DecelerateFactor, PowerFactor, 0); @@ -112,16 +128,19 @@ namespace ElmSharp /// /// The SinusoidalFactorMotionMapper class /// + /// preview public class SinusoidalFactorMotionMapper : IAnimatorMotionMapper { /// /// The power factor of SinusoidalFactorMotionMapper /// + /// preview public double PowerFactor { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.SinusoidalFactor, PowerFactor, 0); @@ -131,21 +150,25 @@ namespace ElmSharp /// /// The DivisorInterpolatedMotionMapper class /// + /// preview public class DivisorInterpolatedMotionMapper : IAnimatorMotionMapper { /// /// The Divisor of DivisorInterpolatedMotionMapper /// + /// preview public double Divisor { get; set; } = 0; /// /// The power of DivisorInterpolatedMotionMapper /// + /// preview public double Power { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.DivisorInterp, Divisor, Power); @@ -155,21 +178,25 @@ namespace ElmSharp /// /// The BounceMotionMapper class /// + /// preview public class BounceMotionMapper : IAnimatorMotionMapper { /// /// The bounces of BounceMotionMapper /// + /// preview public int Bounces { get; set; } = 0; /// /// The decay factor of BounceMotionMapper /// + /// preview public double DecayFactor { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Bounce, DecayFactor, Bounces); @@ -179,21 +206,25 @@ namespace ElmSharp /// /// The SpringMotionMapper class /// + /// preview public class SpringMotionMapper : IAnimatorMotionMapper { /// /// The wobbles of SpringMotionMapper /// + /// preview public int Wobbles { get; set; } = 0; /// /// The decat factir of SpringMotionMapper /// + /// preview public double DecayFactor { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { return Interop.Ecore.ecore_animator_pos_map(position, Interop.Ecore.PositionMap.Bounce, DecayFactor, Wobbles); @@ -203,31 +234,37 @@ namespace ElmSharp /// /// The CubicBezierMotionMapper class /// + /// preview public class CubicBezierMotionMapper : IAnimatorMotionMapper { /// /// The X1 of CubicBezierMotionMapper /// + /// preview public double X1 { get; set; } = 0; /// /// The Y1 of CubicBezierMotionMapper /// + /// preview public double Y1 { get; set; } = 0; /// /// The X2 of CubicBezierMotionMapper /// + /// preview public double X2 { get; set; } = 0; /// /// The Y2 of CubicBezierMotionMapper /// + /// preview public double Y2 { get; set; } = 0; /// /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve /// + /// preview public double Calculate(double position) { double[] values = { X1, Y1, X2, Y2 }; diff --git a/src/ElmSharp/ElmSharp/Icon.cs b/src/ElmSharp/ElmSharp/Icon.cs index 3ebff8f..5f2dac4 100755 --- a/src/ElmSharp/ElmSharp/Icon.cs +++ b/src/ElmSharp/ElmSharp/Icon.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for the icon lookup order. Should look for icons in the theme, FDO paths, or both. /// + /// preview public enum IconLookupOrder { /// @@ -46,12 +47,14 @@ namespace ElmSharp /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon context. /// Inherits Image /// + /// preview public class Icon : Image { /// /// Creates and initializes a new instance of Icon class. /// /// The parent is a given container which will be attached by Icon as a child. It's type. + /// preview public Icon(EvasObject parent) : base(parent) { } @@ -59,6 +62,7 @@ namespace ElmSharp /// /// Sets or gets the standard icon name of a given Icon widget. /// + /// preview public string StandardIconName { get @@ -74,6 +78,7 @@ namespace ElmSharp /// /// Sets or gets the icon lookup order of a given Icon widget. /// + /// preview public IconLookupOrder IconLookupOrder { get @@ -91,6 +96,7 @@ namespace ElmSharp /// /// The path to the file that is used as an icon image /// The group that the icon belongs to + /// preview public void SetThumb(string file, string group) { Interop.Elementary.elm_icon_thumb_set(RealHandle, file, group); @@ -101,6 +107,7 @@ namespace ElmSharp /// /// EvasObject /// The new object, otherwise NULL if it cannot be created + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Image.cs b/src/ElmSharp/ElmSharp/Image.cs index a6a499d..368eba9 100644 --- a/src/ElmSharp/ElmSharp/Image.cs +++ b/src/ElmSharp/ElmSharp/Image.cs @@ -26,6 +26,7 @@ namespace ElmSharp /// be it from a disk file or from a memory region. /// Inherits Widget /// + /// preview public class Image : Widget { bool _canScaleUp = true; @@ -39,6 +40,7 @@ namespace ElmSharp /// Creates and initializes a new instance of Image class. /// /// The parent is a given container which will be attached by Image as a child. It's type. + /// preview public Image(EvasObject parent) : base(parent) { _clicked = new SmartEvent(this, "clicked"); @@ -48,21 +50,25 @@ namespace ElmSharp /// /// Clicked will be triggered when the image is clicked. /// + /// preview public event EventHandler Clicked; /// /// LoadingCompleted will be triggered when the image is loaded completely. /// + /// preview public event EventHandler LoadingCompleted; /// /// Clicked will be triggered when the image is fail to load. /// + /// preview public event EventHandler LoadingFailed; /// /// Gets the file that is used as an image. /// + /// preview public string File { get @@ -74,6 +80,7 @@ namespace ElmSharp /// /// Sets or gets the smooth effect for an image. /// + /// preview public bool IsSmooth { get @@ -89,6 +96,7 @@ namespace ElmSharp /// /// Sets or gets whether scaling is disabled on the object. /// + /// preview public bool IsScaling { get @@ -104,6 +112,7 @@ namespace ElmSharp /// /// Sets or gets whether the object is down resizeable. /// + /// preview public bool CanScaleDown { get @@ -120,6 +129,7 @@ namespace ElmSharp /// /// Sets or gets whether the object is up resizeable. /// + /// preview public bool CanScaleUp { get @@ -136,6 +146,7 @@ namespace ElmSharp /// /// Sets or gets whether the image fills the entire object area, when keeping the aspect ratio. /// + /// preview public bool CanFillOutside { get @@ -151,6 +162,7 @@ namespace ElmSharp /// /// Sets or gets the prescale size for the image. /// + /// preview public int PrescaleSize { get @@ -166,6 +178,7 @@ namespace ElmSharp /// /// Sets or gets whether the original aspect ratio of the image should be kept on resize. /// + /// preview public bool IsFixedAspect { get @@ -181,6 +194,7 @@ namespace ElmSharp /// /// Sets or gets whether an image object (which supports animation) is to animate itself. /// + /// preview public bool IsAnimated { get @@ -196,6 +210,7 @@ namespace ElmSharp /// /// Gets whether an image object supports animation. /// + /// preview public bool IsAnimatedAvailable { get @@ -211,6 +226,7 @@ namespace ElmSharp /// An image object, even if it supports animation, will be displayed by default without animation. /// To actually start playing any image object's animation, should be TRUE before setting this property true. /// + /// preview public bool IsAnimationPlaying { get @@ -226,6 +242,7 @@ namespace ElmSharp /// /// Sets or gets whether the image is 'editable'. /// + /// preview public bool IsEditable { get @@ -241,6 +258,7 @@ namespace ElmSharp /// /// Gets the current size of the image. /// + /// preview public Size ObjectSize { get @@ -253,6 +271,7 @@ namespace ElmSharp /// /// Sets or gets whether alpha channel data is being used on the given image object. /// + /// preview public bool IsOpaque { get @@ -275,6 +294,7 @@ namespace ElmSharp /// /// Sets or gets the image orientation. /// + /// preview public ImageOrientation Orientation { get @@ -290,6 +310,7 @@ namespace ElmSharp /// /// Sets or gets the image color /// + /// preview public override Color Color { get @@ -316,6 +337,7 @@ namespace ElmSharp /// /// Sets the background color /// + /// preview public override Color BackgroundColor { set @@ -337,6 +359,7 @@ namespace ElmSharp /// This property allows one to get the underlying EvasObject of type Image from this elementary widget. It can be useful to do things like save the image to a file, etc. /// /// Be careful to not manipulate it, as it is under the control of widget. + /// preview public EvasImage ImageObject { get @@ -361,6 +384,7 @@ namespace ElmSharp /// The border's right width /// The border's top width /// The border's bottom width + /// preview public void SetBorder(int left, int right, int top, int bottom) { ImageObject?.SetBorder(left, right, top, bottom); @@ -374,6 +398,7 @@ namespace ElmSharp /// This function sets if the center part of the scaled image is to be drawn or left completely blank, or forced to be solid. /// Very useful for frames and decorations. /// + /// preview public ImageBorderFillMode BorderCenterFillMode { get @@ -402,6 +427,7 @@ namespace ElmSharp /// /// The path to the file that is used as an image source /// (true = success, false = error) + /// preview public bool Load(string file) { if (file == null) @@ -417,6 +443,7 @@ namespace ElmSharp /// /// The uri to the file that is used as an image source /// (true = success, false = error) + /// preview public bool Load(Uri uri) { if (uri == null) @@ -436,6 +463,7 @@ namespace ElmSharp /// The binary data that is used as an image source /// The size of the binary data blob img /// (true = success, false = error) + /// preview [Obsolete("This method will be removed. Use Load(Stream stream) instead.")] public unsafe bool Load(byte* img, long size) { @@ -452,6 +480,7 @@ namespace ElmSharp /// /// The stream that is used as an image source /// (true = success, false = error) + /// preview public bool Load(Stream stream) { if (stream == null) @@ -477,6 +506,7 @@ namespace ElmSharp /// The path to the file that is used as an image source /// cancellation token /// (true = success, false = error) + /// preview public Task LoadAsync(string file, CancellationToken cancellationToken = default(CancellationToken)) { if (file == null) @@ -532,6 +562,7 @@ namespace ElmSharp /// The uri to the file that is used as an image source /// cancellation token /// (true = success, false = error) + /// preview public Task LoadAsync(Uri uri, CancellationToken cancellationToken = default(CancellationToken)) { if (uri == null) @@ -546,6 +577,7 @@ namespace ElmSharp /// The stream that is used as an image source /// cancellation token /// (true = success, false = error) + /// preview public async Task LoadAsync(Stream stream, CancellationToken cancellationToken = default(CancellationToken)) { if (stream == null) @@ -612,6 +644,7 @@ namespace ElmSharp /// /// The name of color class. /// The struct of color + /// preview public override void SetPartColor(string part, Color color) { Interop.Elementary.elm_object_color_class_color_set(Handle, part, color.R * color.A / 255, @@ -625,6 +658,7 @@ namespace ElmSharp /// /// The name of color class. /// color object + /// preview public override Color GetPartColor(string part) { Interop.Elementary.elm_object_color_class_color_get(Handle, part, out int r, out int g, out int b, out int a); @@ -636,6 +670,7 @@ namespace ElmSharp /// /// The parent is a given container which will be attached by Image as a child. It's type. /// The new object, otherwise null if it cannot be created + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent); @@ -651,6 +686,7 @@ namespace ElmSharp /// /// Enumeration for the fill mode of image border /// + /// preview public enum ImageBorderFillMode { /// @@ -672,6 +708,7 @@ namespace ElmSharp /// /// Enumeration for the possible orientation options /// + /// preview public enum ImageOrientation : int { /// diff --git a/src/ElmSharp/ElmSharp/Index.cs b/src/ElmSharp/ElmSharp/Index.cs index afe9944..6e715dd 100755 --- a/src/ElmSharp/ElmSharp/Index.cs +++ b/src/ElmSharp/ElmSharp/Index.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// An index widget gives you an index for fast access to whichever group of other UI items one might have. /// Inherits Layout /// + /// preview public class Index : Layout { HashSet _children = new HashSet(); @@ -32,6 +33,7 @@ namespace ElmSharp /// Creates and initializes a new instance of Index class. /// /// The parent is a given container which will be attached by Index as a child. It's type. + /// preview public Index(EvasObject parent) : base(parent) { _delayedChanged = new SmartEvent(this, this.RealHandle, "delay,changed"); @@ -41,11 +43,13 @@ namespace ElmSharp /// /// Changed will be triggered when the selected index item is changed. /// + /// preview public event EventHandler Changed; /// /// Sets or gets the auto hiding feature is enabled or not for a given index widget. /// + /// preview public bool AutoHide { get @@ -61,6 +65,7 @@ namespace ElmSharp /// /// Sets or gets a value whether horizontal mode is enabled or not. /// + /// preview public bool IsHorizontal { get @@ -76,6 +81,7 @@ namespace ElmSharp /// /// Sets or gets the value of indicator's disabled status. /// + /// preview public bool IndicatorVisible { get @@ -91,6 +97,7 @@ namespace ElmSharp /// /// Sets or gets the omit feature is enabled or not for a given index widget. /// + /// preview public bool OmitEnabled { get @@ -107,6 +114,7 @@ namespace ElmSharp /// Set a delay change time for index object. /// delay time is 0.2 sec by default. /// + /// preview public double Delay { get @@ -122,6 +130,7 @@ namespace ElmSharp /// /// Gets or sets the items level for a given index widget. /// + /// preview public int Level { get @@ -138,6 +147,7 @@ namespace ElmSharp /// Control standard_priority group of index. /// Priority group will be shown as many items as it can, and other group will be shown one character only. /// + /// preview public int Priority { get @@ -153,6 +163,7 @@ namespace ElmSharp /// /// Gets the last selected item, for a given index widget. /// + /// preview public IndexItem SelectedItem { get @@ -167,6 +178,7 @@ namespace ElmSharp /// /// the label which the item should be indexed /// A object to the IndexItem added or null, on errors + /// preview public IndexItem Append(string label) { IndexItem item = new IndexItem(label); @@ -179,6 +191,7 @@ namespace ElmSharp /// /// the label which the item should be indexed /// A handle to the item added or NULL, on errors + /// preview public IndexItem Prepend(string label) { IndexItem item = new IndexItem(label); @@ -192,6 +205,7 @@ namespace ElmSharp /// the label which the item should be indexed /// The index item to insert after. /// A object to the IndexItem added or null, on errors + /// preview public IndexItem InsertBefore(string label, IndexItem before) { IndexItem item = new IndexItem(label); @@ -205,6 +219,7 @@ namespace ElmSharp /// the label which the item should be indexed /// The index item to insert after. /// A object to the IndexItem added or null, on errors + /// preview public IndexItem InsertAfter(string label, IndexItem after) { IndexItem item = new IndexItem(label); @@ -216,6 +231,7 @@ namespace ElmSharp /// Flush the changes made to the index items so they work correctly. /// /// The index level (one of 0 or 1) where changes were made + /// preview public void Update(int level) { Interop.Elementary.elm_index_level_go(RealHandle, level); @@ -224,6 +240,7 @@ namespace ElmSharp /// /// Removes all items from a given index widget. /// + /// preview public void Clear() { Interop.Elementary.elm_index_item_clear(RealHandle); @@ -234,6 +251,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/IndexItem.cs b/src/ElmSharp/ElmSharp/IndexItem.cs index 67dcfd4..349ae03 100755 --- a/src/ElmSharp/ElmSharp/IndexItem.cs +++ b/src/ElmSharp/ElmSharp/IndexItem.cs @@ -21,12 +21,14 @@ namespace ElmSharp /// The IndexItem is used to manage index item /// Inherits ItemObject /// + /// preview public class IndexItem : ItemObject { /// /// Creates and initializes a new instance of IndexItem class. /// /// the text is set to the Text. It's 'string' type. + /// preview public IndexItem(string text) : base(IntPtr.Zero) { Text = text; @@ -35,17 +37,20 @@ namespace ElmSharp /// /// Selected will be triggered when the index item is selected /// + /// preview public event EventHandler Selected; /// /// Gets the text /// + /// preview public string Text { get; private set; } /// /// Sets the selected state of an item. /// /// The selected state + /// preview public void Select(bool selected) { Interop.Elementary.elm_index_item_selected_set(Handle, selected); diff --git a/src/ElmSharp/ElmSharp/ItemObject.cs b/src/ElmSharp/ElmSharp/ItemObject.cs index f3182aa..5e3211e 100644 --- a/src/ElmSharp/ElmSharp/ItemObject.cs +++ b/src/ElmSharp/ElmSharp/ItemObject.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// The ItemObject is used to manage item object /// + /// preview public class ItemObject { private static Dictionary s_IdToItemTable = new Dictionary(); @@ -38,6 +39,7 @@ namespace ElmSharp /// Creates and initializes a new instance of ItemObject class. /// /// IntPtr + /// preview protected ItemObject(IntPtr handle) { _deleteCallback = DeleteCallbackHandler; @@ -58,11 +60,13 @@ namespace ElmSharp /// /// Gets the id of item object /// + /// preview public int Id { get; private set; } /// /// Sets or gets whether the item object is enabled /// + /// preview public bool IsEnabled { get { return !Interop.Elementary.elm_object_item_disabled_get(Handle); } @@ -72,6 +76,7 @@ namespace ElmSharp /// /// Gets track object of the item. /// + /// preview public EvasObject TrackObject { get @@ -85,6 +90,7 @@ namespace ElmSharp /// /// Sets or gets the style of the Item. /// + /// preview public virtual string Style { get @@ -121,11 +127,13 @@ namespace ElmSharp /// /// Deleted will be triggered when the item object is deleted /// + /// preview public event EventHandler Deleted; /// /// Delete the item object /// + /// preview public void Delete() { Interop.Elementary.elm_object_item_del(Handle); @@ -137,6 +145,7 @@ namespace ElmSharp /// /// The content part name (null for the default content) /// The content of the object item + /// preview public void SetPartContent(string part, EvasObject content) { SetPartContent(part, content, false); @@ -148,6 +157,7 @@ namespace ElmSharp /// The content part name (null for the default content) /// The content of the object item /// judge whether delete old content + /// preview public void SetPartContent(string part, EvasObject content, bool preserveOldContent) { IntPtr oldContent = Interop.Elementary.elm_object_item_part_content_unset(Handle, part); @@ -164,6 +174,7 @@ namespace ElmSharp /// /// The text part name (null for the default label) /// Text of the label + /// preview public void SetPartText(string part, string text) { Interop.Elementary.elm_object_item_part_text_set(Handle, part, text); @@ -174,6 +185,7 @@ namespace ElmSharp /// /// The text part name (null for the default label) /// + /// preview public string GetPartText(string part) { return Interop.Elementary.elm_object_item_part_text_get(Handle, part); @@ -184,6 +196,7 @@ namespace ElmSharp /// /// The text part name (null for the default label) /// the color + /// preview public void SetPartColor(string part, Color color) { Interop.Elementary.elm_object_item_color_class_color_set(Handle, part, color.R * color.A / 255, @@ -197,6 +210,7 @@ namespace ElmSharp /// /// The text part name (null for the default label) /// the color of object item + /// preview public Color GetPartColor(string part) { int r, g, b, a; @@ -208,6 +222,7 @@ namespace ElmSharp /// Deletes color of an object item /// /// The text part name + /// preview public void DeletePartColor(string part) { Interop.Elementary.elm_object_item_color_class_del(Handle, part); @@ -219,6 +234,7 @@ namespace ElmSharp /// The signal's name. /// The signal's source. /// The function to be executed when the signal is emitted. + /// preview public void AddSignalHandler(string emission, string source, Func func) { if (emission != null && source != null && func != null) @@ -241,6 +257,7 @@ namespace ElmSharp /// The signal's name. /// The signal's source. /// The function to be executed when the signal is emitted. + /// preview public void RemoveSignalHandler(string emission, string source, Func func) { if (emission != null && source != null && func != null) @@ -263,6 +280,7 @@ namespace ElmSharp /// /// The signal's name. /// The signal's source. + /// preview public void EmitSignal(string emission, string source) { Interop.Elementary.elm_object_item_signal_emit(Handle, emission, source); @@ -272,6 +290,7 @@ namespace ElmSharp /// Gets the handle of object item /// /// ItemObject + /// preview public static implicit operator IntPtr(ItemObject obj) { if (obj == null) @@ -282,6 +301,7 @@ namespace ElmSharp /// /// OnInvalidate of object item /// + /// preview protected virtual void OnInvalidate() { } internal static ItemObject GetItemById(int id) diff --git a/src/ElmSharp/ElmSharp/ItemObjectExtension.cs b/src/ElmSharp/ElmSharp/ItemObjectExtension.cs index ef8b609..bc4db53 100755 --- a/src/ElmSharp/ElmSharp/ItemObjectExtension.cs +++ b/src/ElmSharp/ElmSharp/ItemObjectExtension.cs @@ -21,12 +21,14 @@ namespace ElmSharp /// /// The ItemObjectExtension is used to manage item object extension /// + /// preview public static class ItemObjectExtension { /// /// Grab high light of item object /// /// the item object which is grabbed high light + /// preview public static void GrabHighlight(this ItemObject obj) { Interop.Elementary.elm_atspi_component_highlight_grab(obj.Handle); @@ -36,6 +38,7 @@ namespace ElmSharp /// Clear high light of item object /// /// the item object which is cleared high light + /// preview public static void ClearHighlight(this ItemObject obj) { Interop.Elementary.elm_atspi_component_highlight_clear(obj.Handle); diff --git a/src/ElmSharp/ElmSharp/Label.cs b/src/ElmSharp/ElmSharp/Label.cs index 12aae07..bbde2f3 100755 --- a/src/ElmSharp/ElmSharp/Label.cs +++ b/src/ElmSharp/ElmSharp/Label.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// Label is a widget to display text, with simple html-like markup. /// Inherits Layout /// + /// preview public class Label : Layout { SmartEvent _slideCompleted; @@ -29,6 +30,7 @@ namespace ElmSharp /// Creates and initializes a new instance of Label class. /// /// The parent is a given container which will be attached by Label as a child. It's type. + /// preview public Label(EvasObject parent) : base(parent) { _slideCompleted = new SmartEvent(this, this.RealHandle, "slide,end"); @@ -41,11 +43,13 @@ namespace ElmSharp /// /// SlideCompleted will be triggered when the slide is completed. /// + /// preview public event EventHandler SlideCompleted; /// /// Sets or gets wrap width of the label. /// + /// preview public int LineWrapWidth { get @@ -61,6 +65,7 @@ namespace ElmSharp /// /// Sets or gets the wrapping behavior of the label. /// + /// preview public WrapType LineWrapType { get @@ -81,6 +86,7 @@ namespace ElmSharp /// /// Sets or gets the slide mode of the label widget. /// + /// preview public LabelSlideMode SlideMode { get @@ -96,6 +102,7 @@ namespace ElmSharp /// /// Sets or gets the slide duration of the label. /// + /// preview public double SlideDuration { get @@ -116,6 +123,7 @@ namespace ElmSharp /// If you set the duration of the slide using elm_label_slide_duration_set() you cannot get the correct speed using this function until the label is actually rendered and resized. /// /// + /// preview public double SlideSpeed { get @@ -131,6 +139,7 @@ namespace ElmSharp /// /// Sets or gets the ellipsis behavior of the label. /// + /// preview public bool IsEllipsis { get @@ -150,6 +159,7 @@ namespace ElmSharp /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Avalilable since Tizen_4.0. /// /// + /// preview public string TextStyle { get @@ -172,6 +182,7 @@ namespace ElmSharp /// /// Start slide effect. /// + /// preview public void PlaySlide() { Interop.Elementary.elm_label_slide_go(RealHandle); @@ -182,6 +193,7 @@ namespace ElmSharp /// /// EvasObject /// The new object, otherwise null if it cannot be created + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_label_add(parent.Handle); @@ -191,6 +203,7 @@ namespace ElmSharp /// /// Enumeration for slide mode of a label widget /// + /// preview public enum LabelSlideMode { /// diff --git a/src/ElmSharp/ElmSharp/Layout.cs b/src/ElmSharp/ElmSharp/Layout.cs index d5716e1..af5ab10 100644 --- a/src/ElmSharp/ElmSharp/Layout.cs +++ b/src/ElmSharp/ElmSharp/Layout.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget. /// Inherits Widget /// + /// preview public class Layout : Container { SmartEvent _languageChanged; @@ -33,6 +34,7 @@ namespace ElmSharp /// Creates and initializes a new instance of Layout class. /// /// The parent is a given container which will be attached by Layout as a child. It's type. + /// preview public Layout(EvasObject parent) : base(parent) { } @@ -40,6 +42,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of Layout class. /// + /// preview protected Layout() : base() { } @@ -47,16 +50,19 @@ namespace ElmSharp /// /// LanguageChanged will be triggered when the program's language is changed. /// + /// preview public event EventHandler LanguageChanged; /// /// ThemeChanged will be triggered when the theme is changed. /// + /// preview public event EventHandler ThemeChanged; /// /// Gets the edje layout. /// + /// preview public EdjeObject EdjeObject { get @@ -70,6 +76,7 @@ namespace ElmSharp /// /// Gets or sets accessibility state of texblock(text) parts in the layout object. /// + /// preview public bool TextBlockAccessibility { get @@ -88,6 +95,7 @@ namespace ElmSharp /// Successive freezes will nest, requiring an equal number of thaws. /// /// The frozen state or 0 if the object is not frozen or on error. + /// preview public int Freeze() { return Interop.Elementary.elm_layout_freeze(RealHandle); @@ -98,6 +106,7 @@ namespace ElmSharp /// If sucessives freezes were done, an equal number of thaws will be required. /// /// The frozen state or 0 if the object is not frozen or on error. + /// preview public int Thaw() { return Interop.Elementary.elm_layout_thaw(RealHandle); @@ -111,6 +120,7 @@ namespace ElmSharp /// The minimum size of the theme is calculated based on minimum size of parts, the size of elements inside containers like box and table, etc. /// All of this can change due to state changes, and that's when this function should be called. /// + /// preview public void Resizing() { Interop.Elementary.elm_layout_sizing_eval(RealHandle); @@ -122,6 +132,7 @@ namespace ElmSharp /// /// Restrict minimum size ot the current width. /// Restrict minimum size ot the current height. + /// preview public void Resizing(bool width, bool height) { Interop.Elementary.elm_layout_sizing_restricted_eval(RealHandle, width, height); @@ -134,6 +145,7 @@ namespace ElmSharp /// /// The data key /// The data + /// preview public string GetEdjeData(string key) { return Interop.Elementary.elm_layout_data_get(RealHandle, key); @@ -144,6 +156,7 @@ namespace ElmSharp /// /// The TEXT part to retrieve the text off. /// + /// preview public override string GetPartText(string part) { return Interop.Elementary.elm_layout_text_get(RealHandle, part); @@ -155,6 +168,7 @@ namespace ElmSharp /// The TEXT part to retrieve the text off. /// The text to set. /// + /// preview public override bool SetPartText(string part, string text) { return Interop.Elementary.elm_layout_text_set(RealHandle, part, text); @@ -168,6 +182,7 @@ namespace ElmSharp /// The part /// The Object to append /// Sucess is true + /// preview public bool BoxAppend(string part, EvasObject child) { AddChild(child); @@ -182,6 +197,7 @@ namespace ElmSharp /// The part /// The Object to prepend /// Sucess is true + /// preview public bool BoxPrepend(string part, EvasObject child) { AddChild(child); @@ -195,6 +211,7 @@ namespace ElmSharp /// The part /// The Object to remove /// Sucess is true + /// preview public bool BoxRemove(string part, EvasObject child) { RemoveChild(child); @@ -208,6 +225,7 @@ namespace ElmSharp /// The part /// If true, then all objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas. /// Sucess is true + /// preview public bool BoxRemoveAll(string part, bool clear) { ClearChildren(); @@ -223,6 +241,7 @@ namespace ElmSharp /// The child object to insert into box. /// The numeric position >=0 to insert the child. /// Sucess is true + /// preview public bool BoxInsertAt(string part, EvasObject child, uint position) { AddChild(child); @@ -238,6 +257,7 @@ namespace ElmSharp /// The child object to insert into box. /// Another reference object to insert before in box. /// Sucess is true + /// preview public bool BoxInsertBefore(string part, EvasObject child, EvasObject reference) { AddChild(child); @@ -250,6 +270,7 @@ namespace ElmSharp /// The swallow part name in the edje file /// The child that will be added in this layout object. /// TRUE on success, FALSE otherwise + /// preview public override bool SetPartContent(string part, EvasObject content) { return SetPartContent(part, content, false); @@ -262,6 +283,7 @@ namespace ElmSharp /// The content /// true, preserve old content will be unset. false, preserve old content will not be unset. /// TRUE on success, FALSE otherwise + /// preview public override bool SetPartContent(string part, EvasObject content, bool preserveOldContent) { if (preserveOldContent) @@ -278,6 +300,7 @@ namespace ElmSharp /// The class of the group /// The group /// The style to use + /// preview public void SetTheme(string klass, string group, string style) { Interop.Elementary.elm_layout_theme_set(RealHandle, klass, group, style); @@ -288,6 +311,7 @@ namespace ElmSharp /// /// The path to the file (edj) that is used as a layout /// The group that the layout belongs to in the edje file + /// preview public void SetFile(string file, string group) { Interop.Elementary.elm_layout_file_set(RealHandle, file, group); @@ -296,6 +320,7 @@ namespace ElmSharp /// /// Sets the back ground color of layout /// + /// preview public override Color BackgroundColor { set @@ -319,6 +344,7 @@ namespace ElmSharp /// /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Avalilable since Tizen_4.0. /// + /// preview public virtual void SetVerticalTextAlignment(string part, double valign) { Interop.Elementary.elm_layout_text_valign_set(RealHandle, part, valign); @@ -330,6 +356,7 @@ namespace ElmSharp /// /// API, elm_layout_text_valign_get, is internal API only in Tizen. Avalilable since Tizen_4.0. /// + /// preview public virtual double GetVerticalTextAlignment(string part) { return Interop.Elementary.elm_layout_text_valign_get(RealHandle, part); @@ -338,6 +365,7 @@ namespace ElmSharp /// /// The callback of Realized Event /// + /// preview protected override void OnRealized() { base.OnRealized(); @@ -359,6 +387,7 @@ namespace ElmSharp /// /// The parent is a given container which will be attached by Layout as a child. It's type. /// The new object, otherwise null if it cannot be created + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/List.cs b/src/ElmSharp/ElmSharp/List.cs index 59eec69..afd3473 100755 --- a/src/ElmSharp/ElmSharp/List.cs +++ b/src/ElmSharp/ElmSharp/List.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// Enumeration for setting list's resizing behavior, transverse axis scrolling and items cropping. /// + /// preview public enum ListMode { /// @@ -52,11 +53,13 @@ namespace ElmSharp /// It contains Item which is type. /// All events of List contain ListItemEventArgs as a parameter. /// + /// preview public class ListItemEventArgs : EventArgs { /// /// Gets or sets List item. The return type is . /// + /// preview public ListItem Item { get; set; } internal static ListItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info) @@ -73,6 +76,7 @@ namespace ElmSharp /// /// /// + /// preview public class List : Layout { HashSet _children = new HashSet(); @@ -86,6 +90,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the List class. /// /// The parent is a given container which will be attached by List as a child. It's type. + /// preview public List(EvasObject parent) : base(parent) { _selected = new SmartEvent(this, this.RealHandle, "selected", ListItemEventArgs.CreateFromSmartEvent); @@ -103,6 +108,7 @@ namespace ElmSharp /// /// Gets or sets which mode to use for the list. /// + /// preview public ListMode Mode { get @@ -118,6 +124,7 @@ namespace ElmSharp /// /// Gets the selected item. /// + /// preview public ListItem SelectedItem { get @@ -130,26 +137,31 @@ namespace ElmSharp /// /// ItemSelected is raised when a new list item is selected. /// + /// preview public event EventHandler ItemSelected; /// /// ItemUnselected is raised when the list item is Unselected. /// + /// preview public event EventHandler ItemUnselected; /// /// ItemDoubleClicked is raised when a new list item is double clicked. /// + /// preview public event EventHandler ItemDoubleClicked; /// /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default it's 1 second. /// + /// preview public event EventHandler ItemLongPressed; /// /// ItemActivated is raised when a new list item is double clicked or pressed (enter|return|spacebar). /// + /// preview public event EventHandler ItemActivated; /// @@ -157,6 +169,7 @@ namespace ElmSharp /// Call before running on the list object. /// If not called, it won't display the list properly. /// + /// preview public void Update() { Interop.Elementary.elm_list_go(RealHandle); @@ -168,6 +181,7 @@ namespace ElmSharp /// The text for the item. /// Return a new added list item that contains a text. /// + /// preview public ListItem Append(string label) { return Append(label, null, null); @@ -181,6 +195,7 @@ namespace ElmSharp /// The right icon for the item. /// Return a new added list item that contains a text and 2 icons. /// + /// preview public ListItem Append(string label, EvasObject leftIcon, EvasObject rightIcon) { ListItem item = new ListItem(label, leftIcon, rightIcon); @@ -194,6 +209,7 @@ namespace ElmSharp /// /// The text for the item. /// Return a new added list item that contains a text. + /// preview public ListItem Prepend(string label) { return Prepend(label, null, null); @@ -206,6 +222,7 @@ namespace ElmSharp /// The left icon for the item. /// The right icon for the item. /// Return a new added list item that contains a text and 2 icons. + /// preview public ListItem Prepend(string label, EvasObject leftIcon, EvasObject rigthIcon) { ListItem item = new ListItem(label, leftIcon, rigthIcon); @@ -218,6 +235,7 @@ namespace ElmSharp /// Removes all items from a given list widget. /// To delete just one item, use . /// + /// preview public void Clear() { Interop.Elementary.elm_list_clear(RealHandle); @@ -233,6 +251,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/ListItem.cs b/src/ElmSharp/ElmSharp/ListItem.cs index 09354b1..8c5a594 100644 --- a/src/ElmSharp/ElmSharp/ListItem.cs +++ b/src/ElmSharp/ElmSharp/ListItem.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// A instance to the list item added. /// It contains Text, LeftIcon and RightIcon properties to show a list item which is given. /// + /// preview public class ListItem : ItemObject { internal ListItem(string text, EvasObject leftIcon, EvasObject rightIcon) : base(IntPtr.Zero) @@ -35,16 +36,19 @@ namespace ElmSharp /// /// Gets the text for the list item. /// + /// preview public string Text { get; internal set; } /// /// Gets the left icon for the list item. /// + /// preview public EvasObject LeftIcon { get; internal set; } /// /// Gets the right icon for the list item. /// + /// preview public EvasObject RightIcon { get; internal set; } } } \ No newline at end of file diff --git a/src/ElmSharp/ElmSharp/MultiButtonEntry.cs b/src/ElmSharp/ElmSharp/MultiButtonEntry.cs index b4c9046..1a3185d 100755 --- a/src/ElmSharp/ElmSharp/MultiButtonEntry.cs +++ b/src/ElmSharp/ElmSharp/MultiButtonEntry.cs @@ -26,6 +26,7 @@ namespace ElmSharp /// When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line. /// The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions. /// + /// preview public class MultiButtonEntry : Layout { HashSet _children = new HashSet(); @@ -49,6 +50,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the MultiButtonEntry class. /// /// The parent is a given container which will be attached by MultiButtonEntry as a child. It's type. + /// preview public MultiButtonEntry(EvasObject parent) : base(parent) { _clicked = new SmartEvent(this, "clicked"); @@ -78,52 +80,62 @@ namespace ElmSharp /// /// Clicked is raised when a MultiButtonEntry is clicked. /// + /// preview public event EventHandler Clicked; /// /// Expanded is raised when a MultiButtonEntry is expanded. /// + /// preview public event EventHandler Expanded; /// /// Contracted is raised when a MultiButtonEntry is contracted. /// + /// preview public event EventHandler Contracted; /// /// ExpandedStateChanged is raised when shrink mode state of MultiButtonEntry is changed. /// + /// preview public event EventHandler ExpandedStateChanged; /// /// ItemSelected is raised when an item is selected by api, user interaction, and etc. /// This is also raised when a user press back space while cursor is on the first field of entry. /// + /// preview public event EventHandler ItemSelected; /// /// ItemClicked is raised when an item is clicked by user interaction. /// + /// preview public event EventHandler ItemClicked; /// /// ItemLongPressed is raised when MultiButtonEntry item is pressed for a long time. /// + /// preview public event EventHandler ItemLongPressed; /// /// ItemAdded is raised when a new MultiButtonEntry item is added. /// + /// preview public event EventHandler ItemAdded; /// /// ItemDeleted is raised when a MultiButtonEntry item is deleted. /// + /// preview public event EventHandler ItemDeleted; /// /// Gets the selected item in the multibuttonentry. /// + /// preview public MultiButtonEntryItem SelectedItem { get @@ -136,6 +148,7 @@ namespace ElmSharp /// /// Gets or sets whether the multibuttonentry is editable or not. /// + /// preview public bool IsEditable { get @@ -153,6 +166,7 @@ namespace ElmSharp /// If true, expanded state. /// If false, single line state. /// + /// preview public bool IsExpanded { get @@ -168,6 +182,7 @@ namespace ElmSharp /// /// Gets the first item in the multibuttonentry. /// + /// preview public MultiButtonEntryItem FirstItem { get @@ -180,6 +195,7 @@ namespace ElmSharp /// /// Gets the last item in the multibuttonentry. /// + /// preview public MultiButtonEntryItem LastItem { get @@ -192,6 +208,7 @@ namespace ElmSharp /// /// Gets the entry object int the multibuttonentry. /// + /// preview public Entry Entry { get @@ -210,6 +227,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_multibuttonentry_add(parent.Handle); @@ -220,6 +238,7 @@ namespace ElmSharp /// /// The label of new item. /// A MultiButtonEntryItem to the item added. + /// preview public MultiButtonEntryItem Append(string label) { var handle = Interop.Elementary.elm_multibuttonentry_item_append(RealHandle, label, null, IntPtr.Zero); @@ -232,6 +251,7 @@ namespace ElmSharp /// /// The label of new item. /// A MultiButtonEntryItem to the item added. + /// preview public MultiButtonEntryItem Prepend(string label) { var handle = Interop.Elementary.elm_multibuttonentry_item_prepend(RealHandle, label, null, IntPtr.Zero); @@ -245,6 +265,7 @@ namespace ElmSharp /// The item before which to add it. /// The label of new item. /// A MultiButtonEntryItem to the item added. + /// preview public MultiButtonEntryItem InsertBefore(MultiButtonEntryItem before, string label) { var handle = Interop.Elementary.elm_multibuttonentry_item_insert_before(RealHandle, before.Handle, label, null, IntPtr.Zero); @@ -258,6 +279,7 @@ namespace ElmSharp /// The item after which to add it. /// The label of new item. /// A MultiButtonEntryItem to the item added. + /// preview public MultiButtonEntryItem InsertAfter(MultiButtonEntryItem after, string label) { var handle = Interop.Elementary.elm_multibuttonentry_item_insert_after(RealHandle, after.Handle, label, null, IntPtr.Zero); @@ -268,6 +290,7 @@ namespace ElmSharp /// /// Remove all items in the multibuttonentry. /// + /// preview public void Clear() { Interop.Elementary.elm_multibuttonentry_clear(RealHandle); @@ -282,6 +305,7 @@ namespace ElmSharp /// Append an item filter function for text inserted in the Multibuttonentry. /// /// The function to use as item filter. + /// preview public void AppendFilter(Func func) { _filters.Add(func); @@ -295,6 +319,7 @@ namespace ElmSharp /// Prepend a filter function for text inserted in the Multibuttonentry. /// /// The function to use as text filter. + /// preview public void PrependFilter(Func func) { _filters.Insert(0, func); @@ -308,6 +333,7 @@ namespace ElmSharp /// Remove a filter from the list. /// /// The filter function to remove. + /// preview public void RemoveFilter(Func func) { _filters.Remove(func); @@ -322,6 +348,7 @@ namespace ElmSharp /// If func is NULL, the default format will be used, which is "+ 'the hidden items counter'". /// /// The function to return string to show + /// preview public void SetFormatCallback(Func func) { if (func == null) @@ -395,11 +422,13 @@ namespace ElmSharp /// The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry. /// It contains Item which is type. /// + /// preview public class MultiButtonEntryItemEventArgs : EventArgs { /// /// Gets or sets MultiButtonEntryItem item. The return type is . /// + /// preview public MultiButtonEntryItem Item { get; set; } internal static MultiButtonEntryItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info) diff --git a/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs b/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs index 583e1ee..4ddd090 100755 --- a/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs +++ b/src/ElmSharp/ElmSharp/MultiButtonEntryItem.cs @@ -23,12 +23,14 @@ namespace ElmSharp /// MutltiButtonEntryItem is a item which is added to MultiButtonEntry. /// It contains Next and Prev properties to get next and previous item. /// + /// preview public class MultiButtonEntryItem : ItemObject { /// /// Creates and initializes a new instance of the MultiButtonEntryItem class. /// /// The text of MultiButtonEntryItem's Label name. + /// preview public MultiButtonEntryItem(string text) : base(IntPtr.Zero) { Label = text; @@ -42,11 +44,13 @@ namespace ElmSharp /// /// Gets the label of this item. /// + /// preview public string Label { get; private set; } /// /// Gets or sets the selected state of an item. /// + /// preview public bool IsSelected { get @@ -62,6 +66,7 @@ namespace ElmSharp /// /// Get the next item in the multibuttonentry. /// + /// preview public MultiButtonEntryItem Next { get @@ -74,6 +79,7 @@ namespace ElmSharp /// /// Get the previous item in the multibuttonentry. /// + /// preview public MultiButtonEntryItem Prev { get diff --git a/src/ElmSharp/ElmSharp/NamedHint.cs b/src/ElmSharp/ElmSharp/NamedHint.cs index d8f5dec..ee00a4c 100644 --- a/src/ElmSharp/ElmSharp/NamedHint.cs +++ b/src/ElmSharp/ElmSharp/NamedHint.cs @@ -19,16 +19,19 @@ namespace ElmSharp /// /// Predefined values for Hints properties in EvasObject /// + /// preview public static class NamedHint { /// /// This value can be used to and /// + /// preview public static double Expand = 1.0; /// /// This value can be used to and /// + /// preview public static double Fill = -1.0; } } diff --git a/src/ElmSharp/ElmSharp/NaviItem.cs b/src/ElmSharp/ElmSharp/NaviItem.cs index 44a0d5c..602c6be 100644 --- a/src/ElmSharp/ElmSharp/NaviItem.cs +++ b/src/ElmSharp/ElmSharp/NaviItem.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// The NaviItem is a widget to contain the contents to show in Naviframe. /// Inherits ItemObject /// + /// preview public class NaviItem : ItemObject { EvasObject _content; @@ -45,11 +46,13 @@ namespace ElmSharp /// /// Popped will be triggered when NaviItem is removed. /// + /// preview public event EventHandler Popped; /// /// Gets the content object. The name of content part is "elm.swallow.content". /// + /// preview public EvasObject Content { get { return _content; } @@ -58,6 +61,7 @@ namespace ElmSharp /// /// Sets or gets a value whether title area is enabled or not. /// + /// preview public bool TitleBarVisible { get @@ -73,6 +77,7 @@ namespace ElmSharp /// /// Sets or gets the title bar background color /// + /// preview public Color TitleBarBackgroundColor { get @@ -96,6 +101,7 @@ namespace ElmSharp /// /// Sets or gets an item style. /// + /// preview public override string Style { get @@ -112,6 +118,7 @@ namespace ElmSharp /// Invalidate the EventArgs if _isPopped is false. /// The method should be overridden in children class. /// + /// preview protected override void OnInvalidate() { if (!_isPopped) diff --git a/src/ElmSharp/ElmSharp/Naviframe.cs b/src/ElmSharp/ElmSharp/Naviframe.cs index 63615bc..b7389c9 100755 --- a/src/ElmSharp/ElmSharp/Naviframe.cs +++ b/src/ElmSharp/ElmSharp/Naviframe.cs @@ -23,17 +23,20 @@ namespace ElmSharp /// The NaviframeEventArgs is a event args class for navi frame. /// Inherits EventArgs /// + /// preview public class NaviframeEventArgs : EventArgs { /// /// Sets or gets the content object. The name of content part is "elm.swallow.content". /// + /// preview public EvasObject Content { get; set; } } /// /// Naviframe is a widget to stands for navigation frame. It's a views manager for applications. /// Inherits Widget /// + /// preview public class Naviframe : Widget { SmartEvent _transitionFinished; @@ -43,6 +46,7 @@ namespace ElmSharp /// Creates and initializes a new instance of Naviframe class. /// /// The parent is a given container which will be attached by Naviframe as a child. It's type. + /// preview public Naviframe(EvasObject parent) : base(parent) { _transitionFinished = new SmartEvent(this, this.RealHandle, "transition,finished"); @@ -58,16 +62,19 @@ namespace ElmSharp /// This event will be invoked in progress of Pop/Delete operation. /// After called Popped event, Pop/Delete method will be returned /// + /// preview public event EventHandler Popped; /// /// AnimationFinished will be triggered when animation is finished. /// + /// preview public event EventHandler AnimationFinished; /// /// Gets the list of navi item /// + /// preview public IReadOnlyList NavigationStack { get { return _itemStack; } @@ -76,6 +83,7 @@ namespace ElmSharp /// /// Sets or gets the the preserve content objects when items are popped. /// + /// preview public bool PreserveContentOnPop { get @@ -91,6 +99,7 @@ namespace ElmSharp /// /// Sets or gets whether the default back button is enabled /// + /// preview public bool DefaultBackButtonEnabled { get @@ -109,6 +118,7 @@ namespace ElmSharp /// /// The main content object. The name of content part is "elm.swallow.content". /// The created item or null upon failure. + /// preview public NaviItem Push(EvasObject content) { return Push(content, null); @@ -121,6 +131,7 @@ namespace ElmSharp /// The main content object. The name of content part is "elm.swallow.content". /// The current item title. null would be default. /// + /// preview public NaviItem Push(EvasObject content, string title) { return Push(content, title, null); @@ -133,6 +144,7 @@ namespace ElmSharp /// The current item title. null would be default. /// The current item style name. null would be default. /// The created item or null upon failure. + /// preview public NaviItem Push(EvasObject content, string title, string style) { IntPtr item = Interop.Elementary.elm_naviframe_item_push(RealHandle, title, IntPtr.Zero, IntPtr.Zero, content.Handle, style); @@ -149,6 +161,7 @@ namespace ElmSharp /// The item which the new item is inserted before. /// The main content object. The name of content part is "elm.swallow.content". /// The created item or null upon failure. + /// preview public NaviItem InsertBefore(NaviItem before, EvasObject content) { return InsertBefore(before, content, ""); @@ -162,6 +175,7 @@ namespace ElmSharp /// The main content object. The name of content part is "elm.swallow.content". /// The current item title. null would be default. /// The created item or null upon failure. + /// preview public NaviItem InsertBefore(NaviItem before, EvasObject content, string title) { return InsertBefore(before, content, title, null); @@ -175,6 +189,7 @@ namespace ElmSharp /// The current item title. null would be default. /// The current item style name. null would be default. /// The created item or null upon failure. + /// preview public NaviItem InsertBefore(NaviItem before, EvasObject content, string title, string style) { IntPtr item = Interop.Elementary.elm_naviframe_item_insert_before(RealHandle, before, title, IntPtr.Zero, IntPtr.Zero, content, null); @@ -192,6 +207,7 @@ namespace ElmSharp /// The item which the new item is inserted after. /// The main content object. The name of content part is "elm.swallow.content". /// The created item or null upon failure. + /// preview public NaviItem InsertAfter(NaviItem after, EvasObject content) { return InsertAfter(after, content, ""); @@ -205,6 +221,7 @@ namespace ElmSharp /// The main content object. The name of content part is "elm.swallow.content". /// The current item title. null would be default. /// The created item or null upon failure. + /// preview public NaviItem InsertAfter(NaviItem after, EvasObject content, string title) { return InsertAfter(after, content, title, null); @@ -218,6 +235,7 @@ namespace ElmSharp /// The current item title. null would be default. /// The current item style name. null would be default. /// The created item or null upon failure. + /// preview public NaviItem InsertAfter(NaviItem after, EvasObject content, string title, string style) { IntPtr item = Interop.Elementary.elm_naviframe_item_insert_after(RealHandle, after, title, IntPtr.Zero, IntPtr.Zero, content, null); @@ -231,6 +249,7 @@ namespace ElmSharp /// /// Pop an item that is on top of the stack. /// + /// preview public void Pop() { Interop.Elementary.elm_naviframe_item_pop(RealHandle); @@ -241,6 +260,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent); diff --git a/src/ElmSharp/ElmSharp/Panel.cs b/src/ElmSharp/ElmSharp/Panel.cs index f34cde3..30b0e6c 100755 --- a/src/ElmSharp/ElmSharp/Panel.cs +++ b/src/ElmSharp/ElmSharp/Panel.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for paneldirection type. /// + /// preview public enum PanelDirection { /// @@ -44,6 +45,7 @@ namespace ElmSharp /// /// The Panel is a container that can contain subobjects. /// + /// preview public class Panel : Layout { SmartEvent _toggled; @@ -52,6 +54,7 @@ namespace ElmSharp /// Creates and initializes a new instance of Panel class. /// /// The EvasObject to which the new Panel will be attached as a child. + /// preview public Panel(EvasObject parent) : base(parent) { _toggled = new SmartEvent(this, this.RealHandle, "toggled"); @@ -61,6 +64,7 @@ namespace ElmSharp /// /// Sets or gets the hidden status of a given Panel widget. /// + /// preview public bool IsOpen { get @@ -76,6 +80,7 @@ namespace ElmSharp /// /// Sets or gets the direction of a given Panel widget. /// + /// preview public PanelDirection Direction { get @@ -91,6 +96,7 @@ namespace ElmSharp /// /// Toggled will be triggered when toggles Panel. /// + /// preview public event EventHandler Toggled; /// @@ -99,6 +105,7 @@ namespace ElmSharp /// /// Bool value can be false or true. /// + /// preview public void SetScrollable(bool enable) { Interop.Elementary.elm_panel_scrollable_set(RealHandle, enable); @@ -110,6 +117,7 @@ namespace ElmSharp /// /// The size of scroll area. /// + /// preview public void SetScrollableArea(double ratio) { Interop.Elementary.elm_panel_scrollable_content_size_set(RealHandle, ratio); @@ -118,6 +126,7 @@ namespace ElmSharp /// /// Toggles the hidden state of the Panel. /// + /// preview public void Toggle() { Interop.Elementary.elm_panel_toggle(RealHandle); @@ -128,6 +137,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent); diff --git a/src/ElmSharp/ElmSharp/Panes.cs b/src/ElmSharp/ElmSharp/Panes.cs index c0290d3..be4a703 100755 --- a/src/ElmSharp/ElmSharp/Panes.cs +++ b/src/ElmSharp/ElmSharp/Panes.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// The Panes is a widget that adds a draggable bar between two contents. /// When dragged this bar resizes contents' size. /// + /// preview public class Panes : Layout { SmartEvent _press; @@ -31,6 +32,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Panes class. /// /// The EvasObject to which the new Panes will be attached as a child. + /// preview public Panes(EvasObject parent) : base(parent) { _press = new SmartEvent(this, this.RealHandle, "press"); @@ -43,17 +45,20 @@ namespace ElmSharp /// /// Pressed will be triggered when panes have been pressed (button isn't released yet). /// + /// preview public event EventHandler Pressed; /// /// Unpressed will be triggered when panes are released after being pressed. /// + /// preview public event EventHandler Unpressed; /// /// Sets or gets resize mode of a given Panes widget. /// True means the left and right panes resize homogeneously. /// + /// preview public bool IsFixed { get @@ -78,6 +83,7 @@ namespace ElmSharp /// /// The value is float type and between 0.0 and 1.0 representing the size proportion of the left side. /// + /// preview public double Proportion { get @@ -98,6 +104,7 @@ namespace ElmSharp /// Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents. /// By default panes is in a vertical mode. /// + /// preview public bool IsHorizontal { get @@ -115,6 +122,7 @@ namespace ElmSharp /// If displayed vertically, left content is displayed at top. /// value representing minimum size of left side in pixels. /// + /// preview public int LeftMinimumSize { get @@ -133,6 +141,7 @@ namespace ElmSharp /// If displayed vertically, left content is displayed at top. /// value between 0.0 and 1.0 representing size proportion of minimum size of left side. /// + /// preview public double LeftMinimumRelativeSize { get @@ -150,6 +159,7 @@ namespace ElmSharp /// If displayed vertically, right content is displayed at top. /// value representing minimum size of right side in pixels. /// + /// preview public int RightMinimumSize { get @@ -168,6 +178,7 @@ namespace ElmSharp /// If displayed vertically, right content is displayed at top. /// value between 0.0 and 1.0 representing size proportion of minimum size of right side. /// + /// preview public double RightMinimumRelativeSize { get @@ -185,6 +196,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Point.cs b/src/ElmSharp/ElmSharp/Point.cs index 6c7ddd1..2dd901b 100755 --- a/src/ElmSharp/ElmSharp/Point.cs +++ b/src/ElmSharp/ElmSharp/Point.cs @@ -21,22 +21,26 @@ namespace ElmSharp /// /// The Point is a struct that defines a 2-D point as a pair of generic type. /// + /// preview public struct Point : IEquatable { /// /// Location along the horizontal axis. /// + /// preview public int X; /// /// Location along the vertical axis. /// + /// preview public int Y; /// /// A human-readable representation of the . /// /// The string is formatted as "{{X={0} Y={1}}}". + /// preview public override string ToString() { return string.Format("{{X={0} Y={1}}}", X, Y); @@ -46,6 +50,7 @@ namespace ElmSharp /// Gets hash code. /// /// The hash code. + /// preview public override int GetHashCode() { unchecked @@ -62,6 +67,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public override bool Equals(object obj) { if (!(obj is Point)) @@ -78,6 +84,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public bool Equals(Point other) { return X.Equals(other.X) && Y.Equals(other.Y); @@ -89,6 +96,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s have equal values. + /// preview public static bool operator ==(Point p1, Point p2) { return p1.Equals(p2); @@ -100,6 +108,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s do not have equal values. + /// preview public static bool operator !=(Point p1, Point p2) { return !p1.Equals(p2); diff --git a/src/ElmSharp/ElmSharp/Point3D.cs b/src/ElmSharp/ElmSharp/Point3D.cs index d7f1bfe..d9ffda8 100755 --- a/src/ElmSharp/ElmSharp/Point3D.cs +++ b/src/ElmSharp/ElmSharp/Point3D.cs @@ -21,33 +21,39 @@ namespace ElmSharp /// /// The Point3D is a Struct that defining a 3-D point. /// + /// preview public struct Point3D : IEquatable { /// /// The X coordinate of a 3D point. /// + /// preview public int X; /// /// The Y coordinate of a 3D point. /// + /// preview public int Y; /// /// The Z coordinate of a 3D point. /// + /// preview public int Z; /// /// A human-readable representation of the . /// /// The string is formatted as "{{X={0} Y={1} Z={2}}}". + /// preview public override string ToString() { return string.Format("{{X={0} Y={1} Z={2}}}", X, Y, Z); } /// + /// preview public override int GetHashCode() { unchecked @@ -67,6 +73,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public override bool Equals(object obj) { if (!(obj is Point3D)) @@ -83,6 +90,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public bool Equals(Point3D other) { return X.Equals(other.X) && Y.Equals(other.Y) && Z.Equals(other.Z); @@ -94,6 +102,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s have equal values. + /// preview public static bool operator ==(Point3D p1, Point3D p2) { return p1.Equals(p2); @@ -105,6 +114,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s do not have equal values. + /// preview public static bool operator !=(Point3D p1, Point3D p2) { return !p1.Equals(p2); diff --git a/src/ElmSharp/ElmSharp/Polygon.cs b/src/ElmSharp/ElmSharp/Polygon.cs index 6ad8183..e050fdf 100755 --- a/src/ElmSharp/ElmSharp/Polygon.cs +++ b/src/ElmSharp/ElmSharp/Polygon.cs @@ -21,12 +21,14 @@ namespace ElmSharp /// /// The Polygon is a widget that used to draw a polygon (filled). /// + /// preview public class Polygon : EvasObject { /// /// Creates and initializes a new instance of the Polygon class. /// The EvasObject to which the new Polygon will be attached as a child. /// + /// preview public Polygon(EvasObject parent) : base(parent) { } @@ -36,6 +38,7 @@ namespace ElmSharp /// The X coordinate of the new vertex. /// The Y coordinate of the new vertex. /// + /// preview public void AddPoint(int x, int y) { Interop.Evas.evas_object_polygon_point_add(Handle, x, y); @@ -45,6 +48,7 @@ namespace ElmSharp /// Adds a new vertex to the Polygon. /// The coordinates of the new vertex. /// + /// preview public void AddPoint(Point p) { AddPoint(p.X, p.Y); @@ -53,6 +57,7 @@ namespace ElmSharp /// /// Removes all the vertices of the Polygon, making it empty. /// + /// preview public void ClearPoints() { Interop.Evas.evas_object_polygon_points_clear(Handle); @@ -63,6 +68,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr evas = Interop.Evas.evas_object_evas_get(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Popup.cs b/src/ElmSharp/ElmSharp/Popup.cs index 91da397..1d68195 100755 --- a/src/ElmSharp/ElmSharp/Popup.cs +++ b/src/ElmSharp/ElmSharp/Popup.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// Enumeration for the popup orientation type. /// + /// preview public enum PopupOrientation { /// @@ -66,6 +67,7 @@ namespace ElmSharp /// The Popup is a widget that is an enhancement of Notify. /// In addition to content area, there are two optional sections, namely title area and action area. /// + /// preview public class Popup : Layout { HashSet _children = new HashSet(); @@ -78,6 +80,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Popup class. /// /// The EvasObject to which the new Popup will be attached as a child. + /// preview public Popup(EvasObject parent) : base(parent) { _dismissed = new SmartEvent(this, "dismissed"); @@ -108,26 +111,31 @@ namespace ElmSharp /// /// Dismissed will be triggered when Popup have been dismissed. /// + /// preview public event EventHandler Dismissed; /// /// OutsideClicked will be triggered when users taps on the outside of Popup. /// + /// preview public event EventHandler OutsideClicked; /// /// OutsideClicked will be triggered when Popup is closed as a result of timeout. /// + /// preview public event EventHandler TimedOut; /// /// OutsideClicked will be triggered when the Popup transition is finished in showing. /// + /// preview public event EventHandler ShowAnimationFinished; /// /// Sets or gets the position in which Popup will appear in its parent. /// + /// preview public PopupOrientation Orientation { get @@ -143,6 +151,7 @@ namespace ElmSharp /// /// Sets or gets the wrapping type of content text packed in content area of Popup widget. /// + /// preview public WrapType ContentTextWrapType { get @@ -165,6 +174,7 @@ namespace ElmSharp /// 0.0 and the popup is previously visible,]]> /// the timer will be started with this value, canceling any running timer. /// + /// preview public double Timeout { get @@ -183,6 +193,7 @@ namespace ElmSharp /// /// The visible region of popup is surrounded by a translucent region called Blocked Event area. /// + /// preview public bool AllowEvents { get @@ -198,6 +209,7 @@ namespace ElmSharp /// /// Sets or gets the AlignmentX in which the popup will appear in its parent. /// + /// preview public override double AlignmentX { get @@ -213,6 +225,7 @@ namespace ElmSharp /// /// Sets or gets the AlignmentY in which the popup will appear in its parent. /// + /// preview public override double AlignmentY { get @@ -228,6 +241,7 @@ namespace ElmSharp /// /// Gets the Opacity value of the Popup. /// + /// preview public override int Opacity { get @@ -246,6 +260,7 @@ namespace ElmSharp /// /// /// The new PopupItem which contains label . + /// preview public PopupItem Append(string label) { return Append(label, null); @@ -257,6 +272,7 @@ namespace ElmSharp /// The Label which will be added into a new PopupItem. /// The icon which will be added into a new PopupItem. /// The new PopupItem which contains label and icon. + /// preview public PopupItem Append(string label, EvasObject icon) { PopupItem item = new PopupItem(label, icon); @@ -269,6 +285,7 @@ namespace ElmSharp /// Uses this function to dismiss the popup in hide effect. /// when the Popup is dismissed, the "dismissed" signal will be emitted. /// + /// preview public void Dismiss() { Interop.Elementary.elm_popup_dismiss(Handle); @@ -279,6 +296,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Elementary.elm_popup_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/PopupItem.cs b/src/ElmSharp/ElmSharp/PopupItem.cs index 1251c55..78c8bdc 100755 --- a/src/ElmSharp/ElmSharp/PopupItem.cs +++ b/src/ElmSharp/ElmSharp/PopupItem.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The PopupItem is a class that including icon and text. /// + /// preview public class PopupItem : ItemObject { internal PopupItem(string text, EvasObject icon) : base(IntPtr.Zero) @@ -32,11 +33,13 @@ namespace ElmSharp /// /// Gets the text label of popupitem.Return value is string. /// + /// preview public string Text { get; internal set; } /// /// Gets the icon EvasObject of popupitem. /// + /// preview public EvasObject Icon { get; internal set; } } } diff --git a/src/ElmSharp/ElmSharp/ProgressBar.cs b/src/ElmSharp/ElmSharp/ProgressBar.cs index ad1c134..4e30436 100755 --- a/src/ElmSharp/ElmSharp/ProgressBar.cs +++ b/src/ElmSharp/ElmSharp/ProgressBar.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The ProgressBar is a widget for visually representing the progress status of a given job/task. /// + /// preview public class ProgressBar : Layout { SmartEvent _changed; @@ -29,6 +30,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the ProgressBar class. /// /// The EvasObject to which the new ProgressBar will be attached as a child. + /// preview public ProgressBar(EvasObject parent) : base(parent) { _changed = new SmartEvent(this, this.RealHandle, "changed"); @@ -41,6 +43,7 @@ namespace ElmSharp /// /// ValueChanged will be triggered when value of ProgressBar change. /// + /// preview public event EventHandler ValueChanged; /// @@ -54,6 +57,7 @@ namespace ElmSharp /// but without exact progress values. In the default theme, /// it animates its bar with the contents filling in constantly and back to non-filled, in a loop. /// + /// preview public bool IsPulseMode { get @@ -74,6 +78,7 @@ namespace ElmSharp /// If you pass a value out of the specified range(0.0~1.0), /// it is interpreted as the closest of the boundary values in the range. /// + /// preview public double Value { get @@ -89,6 +94,7 @@ namespace ElmSharp /// /// Sets or gets the span value of ProgressBar. /// + /// preview public int SpanSize { get @@ -104,6 +110,7 @@ namespace ElmSharp /// /// Sets or gets the value wheather a given ProgressBar widget is horizontal. /// + /// preview public bool IsHorizontal { get @@ -119,6 +126,7 @@ namespace ElmSharp /// /// Sets or gets the value whether a given progress bar widget's displaying values are inverted. /// + /// preview public bool IsInverted { get @@ -140,6 +148,7 @@ namespace ElmSharp /// The units label is provided with a floating point value, so the units text displays at most one floating point value. /// Note that the units label is optional. Use a format string such as "%1.2f meters" for example. /// + /// preview public string UnitFormat { get @@ -155,6 +164,7 @@ namespace ElmSharp /// /// Starts a given progress bar "pulsing" animation, if its under that mode. /// + /// preview public void PlayPulse() { Interop.Elementary.elm_progressbar_pulse(RealHandle, true); @@ -163,6 +173,7 @@ namespace ElmSharp /// /// Stops a given progress bar "pulsing" animation, if its under that mode. /// + /// preview [Obsolete("use StopPulse instead")] public void StopPluse() { @@ -172,6 +183,7 @@ namespace ElmSharp /// /// Stops a given progress bar "pulsing" animation, if its under that mode. /// + /// preview public void StopPulse() { Interop.Elementary.elm_progressbar_pulse(RealHandle, false); @@ -182,6 +194,7 @@ namespace ElmSharp /// /// Part of the Progressbar. /// Returns value range is from 0.0 to 1.0. + /// preview public double GetPartValue(string part) { return Interop.Elementary.elm_progressbar_part_value_get(RealHandle, part); @@ -190,6 +203,7 @@ namespace ElmSharp /// /// Sets or gets the general or main color of the given Progressbar. /// + /// preview public override Color Color { get @@ -207,6 +221,7 @@ namespace ElmSharp /// /// Part of the Progressbar. /// Value range is from 0.0 to 1.0. + /// preview public void SetPartValue(string part, double value) { Interop.Elementary.elm_progressbar_part_value_set(RealHandle, part, value); @@ -217,6 +232,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Radio.cs b/src/ElmSharp/ElmSharp/Radio.cs index 3dc0486..3d889b8 100755 --- a/src/ElmSharp/ElmSharp/Radio.cs +++ b/src/ElmSharp/ElmSharp/Radio.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them. /// + /// preview public class Radio : Layout { SmartEvent _changed; @@ -29,6 +30,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Radio class. /// /// The EvasObject to which the new Radio will be attached as a child. + /// preview public Radio(EvasObject parent) : base(parent) { _changed = new SmartEvent(this, this.RealHandle, "changed"); @@ -38,11 +40,13 @@ namespace ElmSharp /// /// ValueChanged will be triggered when value of Radio change. /// + /// preview public event EventHandler ValueChanged; /// /// Sets or gets a unique value to each Radio button. /// + /// preview public int StateValue { get @@ -58,6 +62,7 @@ namespace ElmSharp /// /// Sets or gets the value of the radio group. /// + /// preview public int GroupValue { get @@ -74,6 +79,7 @@ namespace ElmSharp /// Adds this radio to a group of other radio objects. /// /// Group which add radio in. + /// preview public void SetGroup(Radio group) { if (group == null) @@ -88,6 +94,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/ReadingInfoType.cs b/src/ElmSharp/ElmSharp/ReadingInfoType.cs index 35df932..8c7bf79 100755 --- a/src/ElmSharp/ElmSharp/ReadingInfoType.cs +++ b/src/ElmSharp/ElmSharp/ReadingInfoType.cs @@ -21,6 +21,7 @@ namespace ElmSharp.Accessible /// /// Enumeration for ReadingInfoType. /// + /// preview [Flags] public enum ReadingInfoType { diff --git a/src/ElmSharp/ElmSharp/Rect.cs b/src/ElmSharp/ElmSharp/Rect.cs index ed3d41f..be2176a 100755 --- a/src/ElmSharp/ElmSharp/Rect.cs +++ b/src/ElmSharp/ElmSharp/Rect.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// The Rect is a struct that represent rectangluar space. /// + /// preview [StructLayout(LayoutKind.Sequential)] public struct Rect : IEquatable { @@ -32,6 +33,7 @@ namespace ElmSharp /// Y axis value. /// Width value. /// Height value. + /// preview public Rect(int x, int y, int w, int h) { X = x; @@ -43,57 +45,68 @@ namespace ElmSharp /// /// Gets or sets the position of this Rectangle on the X axis. /// + /// preview public int X { get; set; } /// /// Gets or sets the position of this Rectangle on the Y axis. /// + /// preview public int Y { get; set; } /// /// Gets or sets the width of this Rectangle. /// + /// preview public int Width { get; set; } /// /// Gets or sets the height of this Rectangle. /// + /// preview public int Height { get; set; } /// /// Gets the position of this Rectangle on the X axis. /// + /// preview public int Left { get { return X; } } /// /// Gets the extent along the X axis. /// + /// preview public int Right { get { return X + Width; } } /// /// Gets the position of this Rectangle on the Y axis. /// + /// preview public int Top { get { return Y; } } /// /// Gets the extent along the Y axis. /// + /// preview public int Bottom { get { return Y + Height; } } /// /// Gets the Point defined by Rectangle.Left and Rectangle.Top. /// + /// preview public Point Location { get { return new Point { X = X, Y = Y }; } } /// /// Gets the extent of the Rectangle along its X and Y axis. /// + /// preview public Size Size { get { return new Size { Width = Width, Height = Height }; } } /// /// A human-readable representation of the . /// /// The string is formatted as "{{X={0} Y={1} Width={2} Height={3}}}". + /// preview public override string ToString() { return string.Format("{{X={0} Y={1} Width={2} Height={3}}}", X, Y, Width, Height); @@ -103,6 +116,7 @@ namespace ElmSharp /// Gets the hash code. /// /// The hash code. + /// preview public override int GetHashCode() { unchecked @@ -123,6 +137,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public override bool Equals(object obj) { if (!(obj is Rect)) @@ -139,6 +154,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public bool Equals(Rect other) { return X.Equals(other.X) && Y.Equals(other.Y) && Width.Equals(other.Width) && Height.Equals(other.Height); @@ -150,6 +166,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s have equal values. + /// preview public static bool operator ==(Rect r1, Rect r2) { return r1.Equals(r2); @@ -161,6 +178,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s do not have equal values. + /// preview public static bool operator !=(Rect r1, Rect r2) { return !r1.Equals(r2); diff --git a/src/ElmSharp/ElmSharp/Rectangle.cs b/src/ElmSharp/ElmSharp/Rectangle.cs index 7af4ef7..3aecebf 100755 --- a/src/ElmSharp/ElmSharp/Rectangle.cs +++ b/src/ElmSharp/ElmSharp/Rectangle.cs @@ -21,12 +21,14 @@ namespace ElmSharp /// /// The Rectangle is a class that used to draw a solid colored rectangle. /// + /// preview public class Rectangle : EvasObject { /// /// Creates and initializes a new instance of the Rectangle class. /// /// The to which the new Slider will be attached as a child. + /// preview public Rectangle(EvasObject parent) : base(parent) { Interop.Evas.evas_object_size_hint_weight_set(Handle, 1.0, 1.0); @@ -37,6 +39,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr evas = Interop.Evas.evas_object_evas_get(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Scroller.cs b/src/ElmSharp/ElmSharp/Scroller.cs index a6063a7..6cf1c94 100755 --- a/src/ElmSharp/ElmSharp/Scroller.cs +++ b/src/ElmSharp/ElmSharp/Scroller.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for visible type of scrollbar. /// + /// preview public enum ScrollBarVisiblePolicy { /// @@ -42,6 +43,7 @@ namespace ElmSharp /// /// Enumeration for visible type of scrollbar. /// + /// preview public enum ScrollBlock { /// @@ -63,6 +65,7 @@ namespace ElmSharp /// /// Type that controls how the content is scrolled. /// + /// preview public enum ScrollSingleDirection { /// @@ -84,6 +87,7 @@ namespace ElmSharp /// /// The Scroller is a container that holds and clips a single object and allows you to scroll across it. /// + /// preview public class Scroller : Layout { SmartEvent _scroll; @@ -95,6 +99,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Scroller class. /// /// The to which the new Scroller will be attached as a child. + /// preview public Scroller(EvasObject parent) : base(parent) { } @@ -102,6 +107,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Scroller class. /// + /// preview public Scroller() : base() { } @@ -109,6 +115,7 @@ namespace ElmSharp /// /// Scrolled will be triggered when the content has been scrolled. /// + /// preview public event EventHandler Scrolled { add @@ -124,6 +131,7 @@ namespace ElmSharp /// /// DragStart will be triggered when dragging the contents around has started. /// + /// preview public event EventHandler DragStart { add @@ -139,6 +147,7 @@ namespace ElmSharp /// /// DragStop will be triggered when dragging the contents around has stopped. /// + /// preview public event EventHandler DragStop { add @@ -154,6 +163,7 @@ namespace ElmSharp /// /// PageScrolled will be triggered when the visible page has changed. /// + /// preview public event EventHandler PageScrolled { add @@ -169,6 +179,7 @@ namespace ElmSharp /// /// Gets the current region in the content object that is visible through the Scroller. /// + /// preview public Rect CurrentRegion { get @@ -186,6 +197,7 @@ namespace ElmSharp /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public virtual ScrollBarVisiblePolicy HorizontalScrollBarVisiblePolicy { get @@ -208,6 +220,7 @@ namespace ElmSharp /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. /// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. /// + /// preview public virtual ScrollBarVisiblePolicy VerticalScrollBarVisiblePolicy { get @@ -230,6 +243,7 @@ namespace ElmSharp /// This function will block scrolling movement in a given direction.One can disable movements in the X axis, the Y axis or both. /// The default value is ScrollBlock.None, where movements are allowed in both directions. /// + /// preview public ScrollBlock ScrollBlock { get @@ -250,6 +264,7 @@ namespace ElmSharp /// If there are two or more pages in the viewport, it returns the number of the page which meets the top of the viewport. /// The page number starts from 0. 0 is the first page. /// + /// preview public int VerticalPageIndex { get @@ -268,6 +283,7 @@ namespace ElmSharp /// If there are two or more pages in the viewport, it returns the number of the page which meets the left of the viewport. /// The page number starts from 0. 0 is the first page. /// + /// preview public int HorizontalPageIndex { get @@ -281,6 +297,7 @@ namespace ElmSharp /// /// Sets or gets the maximum limit of the movable page at vertical direction. /// + /// preview public int VerticalPageScrollLimit { get @@ -299,6 +316,7 @@ namespace ElmSharp /// /// Sets or gets the maximum limit of the movable page at horizontal direction. /// + /// preview public int HorizontalPageScrollLimit { get @@ -321,6 +339,7 @@ namespace ElmSharp /// This is enabled by default for both axis. /// This API will set if it is enabled for the given axis with the boolean parameters for each axis. /// + /// preview public bool VerticalBounce { get @@ -343,6 +362,7 @@ namespace ElmSharp /// This is enabled by default for both axis. /// This API will set if it is enabled for the given axis with the boolean parameters for each axis. /// + /// preview public bool HorizontalBounce { get @@ -361,6 +381,7 @@ namespace ElmSharp /// /// Gets the width of the content object of the scroller. /// + /// preview public int ChildWidth { get @@ -374,6 +395,7 @@ namespace ElmSharp /// /// Gets the height of the content object of the scroller. /// + /// preview public int ChildHeight { get @@ -391,6 +413,7 @@ namespace ElmSharp /// x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content /// Default values for x and y are 0.0 /// + /// preview public double HorizontalGravity { get @@ -413,6 +436,7 @@ namespace ElmSharp /// x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content /// Default values for x and y are 0.0 /// + /// preview public double VerticalGravity { get @@ -432,6 +456,7 @@ namespace ElmSharp /// Get scroll last page number. /// The page number starts from 0. 0 is the first page. This returns the last page number among the pages. /// + /// preview public int LastVerticalPageNumber { get @@ -446,6 +471,7 @@ namespace ElmSharp /// Get scroll last page number. /// The page number starts from 0. 0 is the first page. This returns the last page number among the pages. /// + /// preview public int LastHorizontalPageNumber { get @@ -461,6 +487,7 @@ namespace ElmSharp /// This function sets the infinite loop vertically. /// If the content is set, it will be shown repeatedly. /// + /// preview public bool VerticalLoop { get @@ -481,6 +508,7 @@ namespace ElmSharp /// This function sets the infinite loop horizontally. /// If the content is set, it will be shown repeatedly. /// + /// preview public bool HorizontalLoop { get @@ -499,6 +527,7 @@ namespace ElmSharp /// /// Gets or sets a given scroller widget's scrolling page size, relative to its viewport size. /// + /// preview public double VerticalRelativePageSize { get @@ -517,6 +546,7 @@ namespace ElmSharp /// /// Gets or sets a given scroller widget's scrolling page size, relative to its viewport size. /// + /// preview public double HorizontalRelativePageSize { get @@ -541,6 +571,7 @@ namespace ElmSharp /// it will stop at the next page boundaries. This is disabled, by default, for both axis. /// This function will set if it that is enabled or not, for each axis. /// + /// preview public bool VerticalSnap { get @@ -565,6 +596,7 @@ namespace ElmSharp /// it will stop at the next page boundaries. This is disabled, by default, for both axis. /// This function will set if it that is enabled or not, for each axis. /// + /// preview public bool HorizontalSnap { get @@ -583,6 +615,7 @@ namespace ElmSharp /// /// Gets or sets the page size to an absolute fixed value, with 0 turning it off for that axis. /// + /// preview public int PageHeight { get @@ -601,6 +634,7 @@ namespace ElmSharp /// /// Gets or sets the page size to an absolute fixed value, with 0 turning it off for that axis. /// + /// preview public int PageWidth { get @@ -621,6 +655,7 @@ namespace ElmSharp /// This enables or disables event propagation from the scroller content to the scroller and its parent. /// By default event propagation is enabled. /// + /// preview public bool ContentPropagateEvents { get @@ -636,6 +671,7 @@ namespace ElmSharp /// /// Gets or sets the step size to move scroller by key event. /// + /// preview public int HorizontalStepSize { get @@ -654,6 +690,7 @@ namespace ElmSharp /// /// Gets or sets the step size to move scroller by key event. /// + /// preview public int VerticalStepSize { get @@ -672,6 +709,7 @@ namespace ElmSharp /// /// Gets or sets a value whether mouse wheel is enabled or not over the scroller. /// + /// preview public bool WheelDisabled { get @@ -687,6 +725,7 @@ namespace ElmSharp /// /// Gets or sets the type of single direction scroll. /// + /// preview public ScrollSingleDirection SingleDirection { get @@ -706,6 +745,7 @@ namespace ElmSharp /// /// Enable limiting minimum size horizontally /// Enable limiting minimum size vertically + /// preview public void MinimumLimit(bool horizontal, bool vertical) { Interop.Elementary.elm_scroller_content_min_limit(RealHandle, horizontal, vertical); @@ -716,6 +756,7 @@ namespace ElmSharp /// /// The horizontal page size. /// The vertical page size. + /// preview public void SetPageSize(int width, int height) { Interop.Elementary.elm_scroller_page_size_set(RealHandle, width, height); @@ -735,6 +776,7 @@ namespace ElmSharp /// /// The horizontal page relative size. /// The vertical page relative size. + /// preview public void SetPageSize(double width, double height) { Interop.Elementary.elm_scroller_page_relative_set(RealHandle, width, height); @@ -747,6 +789,7 @@ namespace ElmSharp /// The horizontal page number. /// The vertical page number. /// True means slider with animation. + /// preview public void ScrollTo(int horizontalPageIndex, int verticalPageIndex, bool animated) { if (animated) @@ -771,6 +814,7 @@ namespace ElmSharp /// /// Rect struct of region. /// True means allows the scroller to "smoothly slide" to this location. + /// preview public void ScrollTo(Rect region, bool animated) { if (animated) @@ -786,6 +830,7 @@ namespace ElmSharp /// /// The callback of Realized Event /// + /// preview protected override void OnRealized() { base.OnRealized(); @@ -800,6 +845,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Size.cs b/src/ElmSharp/ElmSharp/Size.cs index c7c5a80..a3b81b0 100755 --- a/src/ElmSharp/ElmSharp/Size.cs +++ b/src/ElmSharp/ElmSharp/Size.cs @@ -21,16 +21,19 @@ namespace ElmSharp /// /// The Size is a struct that defining height and width as a pair of generic type. /// + /// preview public struct Size : IEquatable { /// /// Magnitude along the horizontal axis, in platform-defined units. /// + /// preview public int Width; /// /// Magnitude along the vertical axis, in platform-specific units. /// + /// preview public int Height; /// @@ -38,6 +41,7 @@ namespace ElmSharp /// /// The width to set /// The height to set + /// preview public Size(int width, int height) { Width = width; @@ -48,6 +52,7 @@ namespace ElmSharp /// A human-readable representation of the . /// /// The string is formatted as "{{Width={0} Height={1}}}". + /// preview public override string ToString() { return string.Format("{{Width={0} Height={1}}}", Width, Height); @@ -57,6 +62,7 @@ namespace ElmSharp /// Gets hash code. /// /// The hash code. + /// preview public override int GetHashCode() { unchecked @@ -73,6 +79,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public override bool Equals(object obj) { if (!(obj is Size)) @@ -89,6 +96,7 @@ namespace ElmSharp /// true if obj and this instance are the same type and represent the same value. /// otherwise, false. /// + /// preview public bool Equals(Size other) { return Width.Equals(other.Width) && Height.Equals(other.Height); @@ -100,6 +108,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s have equal values. + /// preview public static bool operator ==(Size s1, Size s2) { return s1.Equals(s2); @@ -111,6 +120,7 @@ namespace ElmSharp /// A on the left hand side. /// A on the right hand side. /// True if the two s do not have equal values. + /// preview public static bool operator !=(Size s1, Size s2) { return !s1.Equals(s2); diff --git a/src/ElmSharp/ElmSharp/Slider.cs b/src/ElmSharp/ElmSharp/Slider.cs index 8453026..c5a1d6d 100755 --- a/src/ElmSharp/ElmSharp/Slider.cs +++ b/src/ElmSharp/ElmSharp/Slider.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for the Slider's indicator visiblity mode. /// + /// preview public enum SliderIndicatorVisibleMode { /// @@ -47,6 +48,7 @@ namespace ElmSharp /// /// The Slider is a widget that adds a draggable slider widget for selecting the value of something within a range. /// + /// preview public class Slider : Layout { double _minimum = 0.0; @@ -61,6 +63,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Slider class. /// /// The to which the new Slider will be attached as a child. + /// preview public Slider(EvasObject parent) : base(parent) { _changed = new SmartEvent(this, this.RealHandle, "changed"); @@ -79,6 +82,7 @@ namespace ElmSharp /// /// ValueChanged will be triggered when the Slider value is changed by the user. /// + /// preview public event EventHandler ValueChanged; /// @@ -86,16 +90,19 @@ namespace ElmSharp /// This will be called only when the user stops dragging for a very short period or when they release their finger/mouse, /// so it avoids possibly expensive reactions to the value change. /// + /// preview public event EventHandler DelayedValueChanged; /// /// DragStarted will be triggered when dragging the Slider indicator around has started. /// + /// preview public event EventHandler DragStarted; /// /// DragStopped will be triggered when dragging the Slider indicator around has stopped. /// + /// preview public event EventHandler DragStopped; /// @@ -107,6 +114,7 @@ namespace ElmSharp /// Use this when you're not setting other size hints expanding on the given direction /// (like weight and alignment hints), and you would like it to have a specific size. /// + /// preview public int SpanSize { get @@ -131,6 +139,7 @@ namespace ElmSharp /// such as "%1.2f meters" for example, and it displays values like: "3.14 meters" for a value /// equal to 3.14159.By default, the indicator label is disabled. /// + /// preview public string IndicatorFormat { get @@ -149,6 +158,7 @@ namespace ElmSharp /// /// The orientation may be vertically or horizontally.By default, it's displayed horizontally. /// + /// preview public bool IsHorizontal { get @@ -169,6 +179,7 @@ namespace ElmSharp /// If the actual value is less than min, it is updated to min. /// Actual value can be obtained with Value.By default, min is equal to 0.0. /// + /// preview public double Minimum { get @@ -191,6 +202,7 @@ namespace ElmSharp /// Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. /// Maximum must be greater than minimum, otherwise the behavior is undefined. /// + /// preview public double Maximum { get @@ -211,6 +223,7 @@ namespace ElmSharp /// Value will be presented on the unit label following format specified with UnitFormat and /// on indicator with IndicatorFormat.The value must to be between Minimum and Maximum values. /// + /// preview public double Value { get @@ -232,6 +245,7 @@ namespace ElmSharp /// is set and the flick event is used to inc/dec slider values. /// By default, the step value is equal to 0.05. /// + /// preview public double Step { get @@ -253,6 +267,7 @@ namespace ElmSharp /// as opposed to normally have the low values on the former and high values on the latter, /// respectively, for the horizontal and vertical modes. /// + /// preview public bool IsInverted { get @@ -272,6 +287,7 @@ namespace ElmSharp /// By default, the indicator is bigger when dragged by the user. /// It won't display values set with IndicatorFormat if you disable the indicator. /// + /// preview public bool IsIndicatorVisible { get @@ -287,6 +303,7 @@ namespace ElmSharp /// /// Sets or gets the visible mode of slider indicator. /// + /// preview public SliderIndicatorVisibleMode IndicatorVisibleMode { get @@ -302,6 +319,7 @@ namespace ElmSharp /// /// Sets or gets whether to Show the indicator of slider on focus. /// + /// preview public bool IsIndicatorFocusable { get @@ -319,6 +337,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/SmartEvent.cs b/src/ElmSharp/ElmSharp/SmartEvent.cs index 0742d0f..b81382f 100755 --- a/src/ElmSharp/ElmSharp/SmartEvent.cs +++ b/src/ElmSharp/ElmSharp/SmartEvent.cs @@ -29,6 +29,7 @@ namespace ElmSharp /// They are defined by an event string, which identifies them uniquely. /// /// The parameter for the event. + /// preview public class SmartEvent : IInvalidatable where TEventArgs : EventArgs { /// @@ -38,6 +39,7 @@ namespace ElmSharp /// The sender obj. /// The item sender obj. /// Return smart event item args. + /// preview public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info); private EvasObject _sender; @@ -52,6 +54,7 @@ namespace ElmSharp /// The source of the event. /// The event name. /// The event parameter. + /// preview public SmartEvent(EvasObject sender, string eventName, SmartEventInfoParser parser) : this(sender, sender.Handle, eventName, parser) { } @@ -63,6 +66,7 @@ namespace ElmSharp /// Teh event handler. /// The event name. /// The event parser. + /// preview [EditorBrowsableAttribute(EditorBrowsableState.Never)] public SmartEvent(EvasObject sender, IntPtr handle, string eventName, SmartEventInfoParser parser) { @@ -78,6 +82,7 @@ namespace ElmSharp /// /// The source of the event. /// The event name. + /// preview public SmartEvent(EvasObject sender, string eventName) : this(sender, eventName, null) { } @@ -99,6 +104,7 @@ namespace ElmSharp /// /// Adds or removes delegate for event. /// + /// preview public event EventHandler On { add @@ -136,6 +142,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -145,6 +152,7 @@ namespace ElmSharp /// /// Make current instance invalidate. /// + /// preview public void MakeInvalidate() { _sender = null; @@ -158,6 +166,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (disposing) @@ -181,6 +190,7 @@ namespace ElmSharp /// This way, you can extend EvasObject's own . /// They are defined by an event string, which identifies them uniquely. /// + /// preview public class SmartEvent : IInvalidatable { private SmartEvent _smartEvent; @@ -192,6 +202,7 @@ namespace ElmSharp /// /// The source of the event. /// The event name. + /// preview public SmartEvent(EvasObject sender, string eventName) : this(sender, sender.RealHandle, eventName) { } @@ -202,6 +213,7 @@ namespace ElmSharp /// The source of the event. /// The event handler. /// The event name. + /// preview [EditorBrowsableAttribute(EditorBrowsableState.Never)] public SmartEvent(EvasObject sender, IntPtr handle, string eventName) { @@ -219,6 +231,7 @@ namespace ElmSharp /// /// Adds or removes delegate for event. /// + /// preview public event EventHandler On { add @@ -248,6 +261,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -257,6 +271,7 @@ namespace ElmSharp /// /// Make current instance invalidate. /// + /// preview public void MakeInvalidate() { _smartEvent.MakeInvalidate(); @@ -269,6 +284,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (disposing) diff --git a/src/ElmSharp/ElmSharp/Spinner.cs b/src/ElmSharp/ElmSharp/Spinner.cs index 794aa32..5f619e4 100755 --- a/src/ElmSharp/ElmSharp/Spinner.cs +++ b/src/ElmSharp/ElmSharp/Spinner.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// The Spinner is a widget that increase or decrease numeric values using arrow buttons, or edit values directly. /// Inherits . /// + /// preview public class Spinner : Layout { double _minimum = 0.0; @@ -34,6 +35,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Spinner class. /// /// The parent of new Spinner instance + /// preview public Spinner(EvasObject parent) : base(parent) { } @@ -41,6 +43,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of Layout class. /// + /// preview protected Spinner() : base() { } @@ -48,16 +51,19 @@ namespace ElmSharp /// /// ValueChanged will be triggered whenever the spinner value is changed. /// + /// preview public event EventHandler ValueChanged; /// /// DelayedValueChanged will be triggered after a short time when the value is changed. /// + /// preview public event EventHandler DelayedValueChanged; /// /// Sets or gets the label format of the spinner. /// + /// preview public string LabelFormat { get @@ -73,6 +79,7 @@ namespace ElmSharp /// /// Sets or gets the minimum value for the spinner. /// + /// preview public double Minimum { get @@ -89,6 +96,7 @@ namespace ElmSharp /// /// Sets or gets the maximum value for the spinner. /// + /// preview public double Maximum { get @@ -105,6 +113,7 @@ namespace ElmSharp /// /// Sets or gets the step that used to increment or decrement the spinner value. /// + /// preview public double Step { get @@ -120,6 +129,7 @@ namespace ElmSharp /// /// Sets or gets the value displayed by the spinner. /// + /// preview public double Value { get @@ -135,6 +145,7 @@ namespace ElmSharp /// /// Sets or gets the interval on time updates for an user mouse button hold on spinner widgets' arrows. /// + /// preview public double Interval { get @@ -150,6 +161,7 @@ namespace ElmSharp /// /// Sets or gets the base for rounding. /// + /// preview public double RoundBase { get @@ -165,6 +177,7 @@ namespace ElmSharp /// /// Sets or gets the round value for rounding. /// + /// preview public int RoundValue { get @@ -185,6 +198,7 @@ namespace ElmSharp /// If wrap is enabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the minimum value. /// By default it's disabled. /// + /// preview public bool IsWrapEnabled { get @@ -201,6 +215,7 @@ namespace ElmSharp /// Sets or gets whether the spinner can be directly edited by the user or not. /// /// By default it is enabled + /// preview public bool IsEditable { get @@ -218,6 +233,7 @@ namespace ElmSharp /// /// The numerical value to be replaced /// The label to be used + /// preview public void AddSpecialValue(double value, string label) { Interop.Elementary.elm_spinner_special_value_add(RealHandle, value, label); @@ -227,6 +243,7 @@ namespace ElmSharp /// Remove a previously added special value, After this, the spinner will display the value itself instead of a label. /// /// The replaced numerical value + /// preview public void RemoveSpecialValue(double value) { Interop.Elementary.elm_spinner_special_value_del(RealHandle, value); @@ -237,6 +254,7 @@ namespace ElmSharp /// /// The replaced numerical value. /// The value of the spinner which replaced numerical value with special string + /// preview public string GetSpecialValue(double value) { return Interop.Elementary.elm_spinner_special_value_get(RealHandle, value); @@ -245,6 +263,7 @@ namespace ElmSharp /// /// The callback of Realized Event /// + /// preview protected override void OnRealized() { base.OnRealized(); @@ -260,6 +279,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/Table.cs b/src/ElmSharp/ElmSharp/Table.cs index 33eb504..7176a81 100755 --- a/src/ElmSharp/ElmSharp/Table.cs +++ b/src/ElmSharp/ElmSharp/Table.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows . /// Inherits . /// + /// preview public class Table : Container { int _paddingX = 0; @@ -33,6 +34,7 @@ namespace ElmSharp /// /// A to which the new Table instance will be attached. /// + /// preview public Table(EvasObject parent) : base(parent) { } @@ -41,6 +43,7 @@ namespace ElmSharp /// Sets or gets whether the layout of this table is homogeneous. /// /// True for homogeneous, False for no homogeneous + /// preview public bool Homogeneous { get @@ -56,6 +59,7 @@ namespace ElmSharp /// /// Sets or gets the horizontal padding between the cells. /// + /// preview public int PaddingX { get @@ -72,6 +76,7 @@ namespace ElmSharp /// /// Sets or gets the vertical padding between the cells. /// + /// preview public int PaddingY { get @@ -92,6 +97,7 @@ namespace ElmSharp /// The row number /// The column span /// The row span + /// preview public void Pack(EvasObject obj, int col, int row, int colspan, int rowspan) { if (obj == null) @@ -104,6 +110,7 @@ namespace ElmSharp /// Removes the child from the table. /// /// The subobject + /// preview public void Unpack(EvasObject obj) { if (obj == null) @@ -115,6 +122,7 @@ namespace ElmSharp /// /// Removes all child objects from a table object. /// + /// preview public void Clear() { Interop.Elementary.elm_table_clear(RealHandle, false); @@ -126,6 +134,7 @@ namespace ElmSharp /// /// The name of part class /// The color + /// preview public override void SetPartColor(string part, Color color) { Interop.Elementary.elm_object_color_class_color_set(Handle, part, color.R * color.A / 255, @@ -139,6 +148,7 @@ namespace ElmSharp /// /// The name of part class, it could be 'bg', 'elm.swllow.content' /// The color of the particular part + /// preview public override Color GetPartColor(string part) { int r, g, b, a; @@ -151,6 +161,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent); diff --git a/src/ElmSharp/ElmSharp/Toolbar.cs b/src/ElmSharp/ElmSharp/Toolbar.cs index 49d7178..33fea30 100755 --- a/src/ElmSharp/ElmSharp/Toolbar.cs +++ b/src/ElmSharp/ElmSharp/Toolbar.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// Enumeration for the selection mode of Toolbar. /// + /// preview public enum ToolbarSelectionMode { /// @@ -48,6 +49,7 @@ namespace ElmSharp /// /// Enumeration that sets the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them. /// + /// preview public enum ToolbarShrinkMode { /// @@ -79,6 +81,7 @@ namespace ElmSharp /// /// Enumeration for the icon lookup order of Toolbar. /// + /// preview public enum ToolbarIconLookupOrder { /// @@ -108,11 +111,13 @@ namespace ElmSharp /// /// Inherits EventArgs. /// + /// preview public class ToolbarItemEventArgs : EventArgs { /// /// Gets the ToolbarItem. /// + /// preview public ToolbarItem Item { get; private set; } internal static ToolbarItemEventArgs CreateFromSmartEvent(IntPtr data, IntPtr obj, IntPtr info) @@ -125,6 +130,7 @@ namespace ElmSharp /// /// The Toolbar is a widget that displays a list of items inside a box. /// + /// preview public class Toolbar : Widget { SmartEvent _clicked; @@ -137,6 +143,7 @@ namespace ElmSharp /// /// A EvasObject to which the new Table instance will be attached. /// + /// preview public Toolbar(EvasObject parent) : base(parent) { _selected = new SmartEvent(this, this.RealHandle, "selected", ToolbarItemEventArgs.CreateFromSmartEvent); @@ -163,12 +170,14 @@ namespace ElmSharp /// /// Selected will be triggered when toolbar have been selected. /// + /// preview public event EventHandler Selected; /// /// Sets or gets whether the layout of this toolbar is homogeneous. /// /// True for homogeneous, False for no homogeneous + /// preview public bool Homogeneous { get @@ -184,6 +193,7 @@ namespace ElmSharp /// /// Sets or gets the slection mode of a given Toolbar widget. /// + /// preview public ToolbarSelectionMode SelectionMode { get @@ -199,6 +209,7 @@ namespace ElmSharp /// /// Sets or gets the shrink mode of a given Toolbar widget. /// + /// preview public ToolbarShrinkMode ShrinkMode { get @@ -214,6 +225,7 @@ namespace ElmSharp /// /// Sets or gets toolbar's current orientation. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public bool IsHorizontal { @@ -232,6 +244,7 @@ namespace ElmSharp /// The default lookup order is ToolbarIocnLookupOrder.ThemeFreedesktop. /// Icons added before calling this function will not be affected. /// + /// preview public ToolbarIconLookupOrder IconLookupOrder { get @@ -248,6 +261,7 @@ namespace ElmSharp /// Sets or gets the icon size of a given toolbar widget. /// Default value is 32 pixels, to be used by toolbar items. /// + /// preview public int IconSize { get @@ -263,6 +277,7 @@ namespace ElmSharp /// /// Gets the number of items in a toolbar widget. /// + /// preview public int ItemsCount { get @@ -275,6 +290,7 @@ namespace ElmSharp /// Sets or gets the alignment of the items. /// /// The toolbar items alignment, a float between 0.0 and 1.0 + /// preview public double ItemAlignment { get @@ -294,6 +310,7 @@ namespace ElmSharp /// The transverse expansion of the item, true for on and false for off. /// By default it's false. /// + /// preview public bool TransverseExpansion { get @@ -313,6 +330,7 @@ namespace ElmSharp /// The new ToolbarItem which appended to the toolbar /// /// + /// preview public ToolbarItem Append(string label) { return Append(label, null); @@ -327,6 +345,7 @@ namespace ElmSharp /// /// /// + /// preview public ToolbarItem Append(string label, string icon) { ToolbarItem item = new ToolbarItem(label, icon); @@ -342,6 +361,7 @@ namespace ElmSharp /// /// /// + /// preview public ToolbarItem Prepend(string label) { return Prepend(label, null); @@ -356,6 +376,7 @@ namespace ElmSharp /// /// /// + /// preview public ToolbarItem Prepend(string label, string icon) { ToolbarItem item = new ToolbarItem(label, icon); @@ -370,6 +391,7 @@ namespace ElmSharp /// The label of the item /// The new which insert into the toolbar /// + /// preview public ToolbarItem InsertBefore(ToolbarItem before, string label) { return InsertBefore(before, label, string.Empty); @@ -383,6 +405,7 @@ namespace ElmSharp /// A string with the icon name or the absolute path of an image file /// The new which insert into the toolbar /// + /// preview public ToolbarItem InsertBefore(ToolbarItem before, string label, string icon) { ToolbarItem item = new ToolbarItem(label, icon); @@ -397,6 +420,7 @@ namespace ElmSharp /// The label of the item /// A string with the icon name or the absolute path of an image file /// The new which insert into the toolbar + /// preview public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon) { ToolbarItem item = new ToolbarItem(label, icon); @@ -409,6 +433,7 @@ namespace ElmSharp /// /// The label of the item /// The into the toolbar + /// preview public ToolbarItem FindItemByLabel(string label) { IntPtr handle = Interop.Elementary.elm_toolbar_item_find_by_label(RealHandle, label); @@ -418,6 +443,7 @@ namespace ElmSharp /// /// Gets the selected ToolbarItemItem of the toolbar. /// + /// preview public ToolbarItem SelectedItem { get @@ -430,6 +456,7 @@ namespace ElmSharp /// /// Gets the first ToolbarItemItem of the toolbar. /// + /// preview public ToolbarItem FirstItem { get @@ -442,6 +469,7 @@ namespace ElmSharp /// /// Gets the last ToolbarItemItem of the toolbar. /// + /// preview public ToolbarItem LastItem { get @@ -456,6 +484,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle); diff --git a/src/ElmSharp/ElmSharp/ToolbarItem.cs b/src/ElmSharp/ElmSharp/ToolbarItem.cs index 072baab..38f90a0 100755 --- a/src/ElmSharp/ElmSharp/ToolbarItem.cs +++ b/src/ElmSharp/ElmSharp/ToolbarItem.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// The ToolbarItem is a item of Toolbar. /// + /// preview public class ToolbarItem : ItemObject { string _icon; @@ -34,6 +35,7 @@ namespace ElmSharp /// /// Sets or gets the icon path of the item. /// + /// preview public string Icon { get @@ -50,6 +52,7 @@ namespace ElmSharp /// /// Sets or gets the text string of the item. /// + /// preview public string Text { get @@ -66,6 +69,7 @@ namespace ElmSharp /// /// Sets or gets the enable of the item. /// + /// preview [Obsolete("Enabled is obsolete as of version v1.1.0-beta-023. Please use IsEnabled instead.")] public bool Enabled { @@ -83,6 +87,7 @@ namespace ElmSharp /// Sets or gets whether displaying the item as a separator. /// /// Items aren't set as a separator by default. If set as a separator it displays a separator theme, so it won't display icons or labels. + /// preview public bool IsSeparator { get @@ -98,6 +103,7 @@ namespace ElmSharp /// /// Sets or gets whether the item is selected. /// + /// preview public bool IsSelected { get @@ -113,16 +119,19 @@ namespace ElmSharp /// /// Selected will be triggered when the item is selected. /// + /// preview public event EventHandler Selected; /// /// LongPressed will be triggered when the item is pressed long time. /// + /// preview public event EventHandler LongPressed; /// /// Clicked will be triggered when the item is clicked. /// + /// preview public event EventHandler Clicked; internal void SendSelected() diff --git a/src/ElmSharp/ElmSharp/Transit.cs b/src/ElmSharp/ElmSharp/Transit.cs index 7b79f32..b677c7b 100755 --- a/src/ElmSharp/ElmSharp/Transit.cs +++ b/src/ElmSharp/ElmSharp/Transit.cs @@ -28,6 +28,7 @@ namespace ElmSharp /// For using these effects, create an Transit and add the desired transition effects. /// /// Transit is not reusable. If the effect ends, the transit is destroyed automatically. + /// preview public class Transit : IDisposable { IntPtr _handle = IntPtr.Zero; @@ -42,11 +43,13 @@ namespace ElmSharp /// /// A callback called when the transit is deleted. /// + /// preview public event EventHandler Deleted; /// /// Creates and initializes a new instance of Transit class. /// + /// preview public Transit() { _handle = Interop.Elementary.elm_transit_add(); @@ -71,6 +74,7 @@ namespace ElmSharp /// /// Gets or sets the transit animation time /// + /// preview public double Duration { get @@ -87,6 +91,7 @@ namespace ElmSharp /// Gets or sets a value whether the objects states will be keep or not. /// If it is not kept, the objects states will be reset when transition ends. /// + /// preview public bool ObjectStateKeep { get @@ -102,6 +107,7 @@ namespace ElmSharp /// /// Gets or sets the transit animation acceleration type. /// + /// preview public TweenMode TweenMode { get @@ -118,6 +124,7 @@ namespace ElmSharp /// Gets or sets the transit repeat count. /// If the repeat is a negative number, it will repeat infinite times. /// + /// preview public int Repeat { get @@ -133,6 +140,7 @@ namespace ElmSharp /// /// Gets or sets if the auto reverse is on. /// + /// preview public bool AutoReverse { get @@ -148,6 +156,7 @@ namespace ElmSharp /// /// Gets or sets the event enabled when transit is operating. /// + /// preview public bool EventEnabled { get @@ -164,6 +173,7 @@ namespace ElmSharp /// Gets or sets the smooth scaling for transit map rendering /// This gets smooth scaling for transit map rendering. /// + /// preview public bool Smooth { get @@ -181,6 +191,7 @@ namespace ElmSharp /// The value returned is a fraction(current time / total time). /// It represents the progression position relative to the total. /// + /// preview public double Progress { get @@ -193,6 +204,7 @@ namespace ElmSharp /// Gets or sets the transit animation tween mode acceleration factor. /// /// A factor value from 0.0 to 1.0. + /// preview public double BeginAccelerationFactor { get @@ -211,6 +223,7 @@ namespace ElmSharp /// Gets or sets the transit animation tween mode acceleration factor. /// /// A factor value from 0.0 to 1.0. + /// preview public double EndAccelerationFactor { get @@ -230,6 +243,7 @@ namespace ElmSharp /// Once this API is called, the transit begins to measure the time. /// /// The interval value in seconds + /// preview public void Go(double interval = 0) { Interop.Elementary.elm_transit_go_in(_handle, interval); @@ -238,6 +252,7 @@ namespace ElmSharp /// /// Pause the transition. /// + /// preview public void Pause() { if (Interop.Elementary.elm_transit_paused_get(_handle) == false) @@ -247,6 +262,7 @@ namespace ElmSharp /// /// Resume the transition. /// + /// preview public void Resume() { if (Interop.Elementary.elm_transit_paused_get(_handle) == true) @@ -257,6 +273,7 @@ namespace ElmSharp /// Get the current chained transit list. /// /// Cannot add the duplicate transit. + /// preview public IList Chains { get { return _chains; } @@ -266,6 +283,7 @@ namespace ElmSharp /// Get the objects list of the transit. /// /// Cannot add the duplicate object. + /// preview public IList Objects { get { return _objects; } @@ -275,6 +293,7 @@ namespace ElmSharp /// Add the effect. /// /// EffectBase object. + /// preview public void AddEffect(EffectBase effect) { IntPtr _effect = effect.CreateEffect(_handle); @@ -286,6 +305,7 @@ namespace ElmSharp /// /// Destroy current object /// + /// preview public void Dispose() { Dispose(true); @@ -299,6 +319,7 @@ namespace ElmSharp /// true if managed resources should be disposed /// otherwise, false. /// + /// preview protected virtual void Dispose(bool disposing) { if (_isDisposed) diff --git a/src/ElmSharp/ElmSharp/TransitEffect.cs b/src/ElmSharp/ElmSharp/TransitEffect.cs index fd29499..2e1829e 100755 --- a/src/ElmSharp/ElmSharp/TransitEffect.cs +++ b/src/ElmSharp/ElmSharp/TransitEffect.cs @@ -22,6 +22,7 @@ namespace ElmSharp /// /// The axis along which flip effect should be applied. /// + /// preview public enum FlipAxis { /// @@ -38,6 +39,7 @@ namespace ElmSharp /// /// The direction in which the wipe effect should occur. /// + /// preview public enum WipeDirection { /// @@ -64,6 +66,7 @@ namespace ElmSharp /// /// Whether the wipe effect should show or hide the object. /// + /// preview public enum WipeType { /// @@ -80,6 +83,7 @@ namespace ElmSharp /// /// The type of acceleration used in the transition. /// + /// preview public enum TweenMode { /// @@ -126,11 +130,13 @@ namespace ElmSharp /// /// Blend effect class. /// + /// preview public class BlendEffect : EffectBase { /// /// Creates and initializes a new instance of BlendEffect class. /// + /// preview public BlendEffect() { } @@ -144,6 +150,7 @@ namespace ElmSharp /// /// Color effect class. /// + /// preview public class ColorEffect : EffectBase { Color _begin; @@ -154,6 +161,7 @@ namespace ElmSharp /// /// The begin color of the effect /// The end color of the effect + /// preview public ColorEffect(Color beginColor, Color endColor) { _begin = beginColor; @@ -163,6 +171,7 @@ namespace ElmSharp /// /// The begin color of the effect /// + /// preview public Color BeginColor { get { return _begin; } @@ -171,6 +180,7 @@ namespace ElmSharp /// /// The end color of the effect /// + /// preview public Color EndColor { get { return _end; } @@ -185,11 +195,13 @@ namespace ElmSharp /// /// Fade effect class. /// + /// preview public class FadeEffect : EffectBase { /// /// Creates and initializes a new instance of FadeEffect class. /// + /// preview public FadeEffect() { } @@ -203,6 +215,7 @@ namespace ElmSharp /// /// Flip effect class. /// + /// preview public class FlipEffect : EffectBase { FlipAxis _axis; @@ -215,6 +228,7 @@ namespace ElmSharp /// Flipping Axis(X or Y). /// Flipping Direction. True is clock-wise. /// Resizable effect with FlipEffect + /// preview public FlipEffect(FlipAxis axis, bool clockWise, bool resizable = false) { _axis = axis; @@ -225,6 +239,7 @@ namespace ElmSharp /// /// Flipping Axis(X or Y). /// + /// preview public FlipAxis Axis { get { return _axis; } @@ -233,6 +248,7 @@ namespace ElmSharp /// /// Flipping Direction. True is clock-wise. /// + /// preview public bool ClockWise { get { return _clockWise; } @@ -241,6 +257,7 @@ namespace ElmSharp /// /// Resizable FlipEffect. /// + /// preview public bool Resizable { get { return _resizable; } @@ -257,6 +274,7 @@ namespace ElmSharp /// /// Resizing effect class. /// + /// preview public class ResizingEffect : EffectBase { Size _begin; @@ -267,6 +285,7 @@ namespace ElmSharp /// /// The begin Size of the effect /// The end Size of the effect + /// preview public ResizingEffect(Size beginSize, Size endSize) { _begin = beginSize; @@ -276,6 +295,7 @@ namespace ElmSharp /// /// The begin Size of the effect /// + /// preview public Size BeginSize { get { return _begin; } @@ -284,6 +304,7 @@ namespace ElmSharp /// /// The end Size of the effect /// + /// preview public Size EndSize { get { return _end; } @@ -298,6 +319,7 @@ namespace ElmSharp /// /// Rotation effect class. /// + /// preview public class RotationEffect : EffectBase { float _begin; @@ -308,6 +330,7 @@ namespace ElmSharp /// /// The begin degree of the effect /// The end degree of the effect + /// preview public RotationEffect(float beginDegree, float endDegree) { _begin = beginDegree; @@ -317,6 +340,7 @@ namespace ElmSharp /// /// The begin degree of the effect /// + /// preview public float BeginDegree { get { return _begin; } @@ -325,6 +349,7 @@ namespace ElmSharp /// /// The end degree of the effect /// + /// preview public float EndDegree { get { return _end; } @@ -339,6 +364,7 @@ namespace ElmSharp /// /// Translation effect class. /// + /// preview public class TranslationEffect : EffectBase { Point _begin; @@ -349,6 +375,7 @@ namespace ElmSharp /// /// The begin Point of the effect /// The end Point of the effect + /// preview public TranslationEffect(Point beginPoint, Point endPoint) { _begin = beginPoint; @@ -358,6 +385,7 @@ namespace ElmSharp /// /// The begin Point of the effect /// + /// preview public Point BeginPoint { get { return _begin; } @@ -366,6 +394,7 @@ namespace ElmSharp /// /// The end Point of the effect /// + /// preview public Point EndPoint { get { return _end; } @@ -380,6 +409,7 @@ namespace ElmSharp /// /// Wipe effect class. /// + /// preview public class WipeEffect : EffectBase { WipeType _type; @@ -390,6 +420,7 @@ namespace ElmSharp /// /// Wipe type. Hide or show. /// Wipe Direction. + /// preview public WipeEffect(WipeType type, WipeDirection direction) { _type = type; @@ -399,6 +430,7 @@ namespace ElmSharp /// /// Wipe type. Hide or show. /// + /// preview public WipeType Type { get { return _type; } @@ -407,6 +439,7 @@ namespace ElmSharp /// /// Wipe Direction. /// + /// preview public WipeDirection Direction { get { return _direction; } @@ -421,6 +454,7 @@ namespace ElmSharp /// /// Zoom effect class. /// + /// preview public class ZoomEffect : EffectBase { float _begin; @@ -431,6 +465,7 @@ namespace ElmSharp /// /// The begin rate of the effect /// The end rate of the effect + /// preview public ZoomEffect(float beginRate, float endRate) { _begin = beginRate; @@ -440,6 +475,7 @@ namespace ElmSharp /// /// The begin rate of the effect /// + /// preview public float BeginRate { get { return _begin; } @@ -448,6 +484,7 @@ namespace ElmSharp /// /// The end rate of the effect /// + /// preview public float EndRate { get { return _end; } diff --git a/src/ElmSharp/ElmSharp/Utility.cs b/src/ElmSharp/ElmSharp/Utility.cs index 01d4be2..49877a1 100755 --- a/src/ElmSharp/ElmSharp/Utility.cs +++ b/src/ElmSharp/ElmSharp/Utility.cs @@ -19,12 +19,14 @@ namespace ElmSharp /// /// This class is a static class for a utility methods. /// + /// preview public static class Utility { /// /// Appends a font path to the list of font paths used by the application. /// /// The new font path. + /// preview public static void AppendGlobalFontPath(string path) { Interop.Evas.evas_font_path_global_append(path); @@ -34,6 +36,7 @@ namespace ElmSharp /// Prepends a font path to the list of font paths used by the application. /// /// The new font path. + /// preview public static void PrependEvasGlobalFontPath(string path) { Interop.Evas.evas_font_path_global_prepend(path); @@ -42,6 +45,7 @@ namespace ElmSharp /// /// Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application. /// + /// preview public static void ClearEvasGlobalFontPath() { Interop.Evas.evas_font_path_global_clear(); @@ -64,6 +68,7 @@ namespace ElmSharp /// Shadow Bluevalue /// Shadow Alpha value /// + /// preview public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha, int shadowRed, int shadowGreen, int shadowBlue, int shadowAlpha) { @@ -87,6 +92,7 @@ namespace ElmSharp /// Shadow Bluevalue /// Shadow Alpha value /// + /// preview public static bool GetEdjeColorClass(string colorClass, out int red, out int green, out int blue, out int alpha, out int outlineRed, out int outlineGreen, out int outlineBlue, out int outlineAlpha, out int shadowRed, out int shadowGreen, out int shadowBlue, out int shadowAlpha) { @@ -98,6 +104,7 @@ namespace ElmSharp /// Processes all queued up edje messages. /// This function triggers the processing of messages addressed to any (alive) edje objects. /// + /// preview public static void ProcessEdjeMessageSignal() { Interop.Elementary.edje_message_signal_process(); @@ -110,6 +117,7 @@ namespace ElmSharp /// The font name /// The font size /// True, on success or false, on error + /// preview public static bool SetEdjeTextClass(string textClass, string font, int size) { return Interop.Elementary.edje_text_class_set(textClass, font, size); @@ -122,6 +130,7 @@ namespace ElmSharp /// The font name /// The font size /// True, on success or false, on error + /// preview public static bool GetEdjeTextClass(string textClass, out string font, out int size) { return Interop.Elementary.edje_text_class_get(textClass, out font, out size); @@ -131,6 +140,7 @@ namespace ElmSharp /// Delete the text class. /// /// + /// preview public static void DeleteEdjeTextClass(string textClass) { Interop.Elementary.edje_text_class_del(textClass); @@ -143,6 +153,7 @@ namespace ElmSharp /// The Red component of the color /// The Green component of the color /// The Blue component of the color + /// preview public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue) { Interop.Evas.evas_color_argb_premul(alpha, ref red, ref green, ref blue); @@ -155,6 +166,7 @@ namespace ElmSharp /// The Red component of the color /// The Green component of the color /// The Blue component of the color + /// preview public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue) { Interop.Evas.evas_color_argb_unpremul(alpha, ref red, ref green, ref blue); diff --git a/src/ElmSharp/ElmSharp/Widget.cs b/src/ElmSharp/ElmSharp/Widget.cs index a6b19fe..1649192 100755 --- a/src/ElmSharp/ElmSharp/Widget.cs +++ b/src/ElmSharp/ElmSharp/Widget.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// /// Enumeration for the focus direction. /// + /// preview public enum FocusDirection { /// @@ -60,6 +61,7 @@ namespace ElmSharp /// The Widget is abstract class, it is the parent of other widgets. /// Inherits from . /// + /// preview public abstract class Widget : AccessibleObject { Dictionary _partContents = new Dictionary(); @@ -73,6 +75,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of Widget class. /// + /// preview protected Widget() { } @@ -81,6 +84,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Widget class. /// /// The parent of new Widget instance + /// preview protected Widget(EvasObject parent) : base(parent) { } @@ -90,6 +94,7 @@ namespace ElmSharp /// /// The content which put to the part /// The updated part + /// preview protected void UpdatePartContents(EvasObject content, string part = "__default__") { _partContents[part] = content; @@ -98,16 +103,19 @@ namespace ElmSharp /// /// Focused will be triggered when the widget is focused. /// + /// preview public event EventHandler Focused; /// /// Unfocused will be triggered when the widget is unfocused. /// + /// preview public event EventHandler Unfocused; /// /// Sets or gets the state of the widget, which might be enabled or disabled. /// + /// preview public virtual bool IsEnabled { get @@ -123,6 +131,7 @@ namespace ElmSharp /// /// Sets or gets the style of the widget. /// + /// preview public string Style { get @@ -138,6 +147,7 @@ namespace ElmSharp /// /// Gets whether this widget is focused. /// + /// preview public bool IsFocused { get @@ -150,6 +160,7 @@ namespace ElmSharp /// Gets whether a widget is focusable or not. /// /// Widgets which are meant to be interacted with by input events are created able to be focused, by default + /// preview public bool IsFocusAllowed { get @@ -162,6 +173,7 @@ namespace ElmSharp /// Sets or gets the text of the widget. /// /// It could be override by special child class + /// preview public virtual string Text { get @@ -178,6 +190,7 @@ namespace ElmSharp /// Sets or gets the background color of the widget. /// /// It could be override by special child class + /// preview public virtual Color BackgroundColor { get @@ -206,6 +219,7 @@ namespace ElmSharp /// Sets or gets the opacity of the widget. /// /// It could be override by special child class + /// preview public virtual int Opacity { get @@ -226,6 +240,7 @@ namespace ElmSharp /// /// Sets or gets whether a widget and its children are focusable or not. /// + /// preview public bool AllowTreeFocus { get @@ -241,6 +256,7 @@ namespace ElmSharp /// /// Sets or gets the widget's mirrored mode. /// + /// preview public bool IsMirroredMode { get @@ -257,6 +273,7 @@ namespace ElmSharp /// Sets or gets the widget's mirrored mode setting. /// When widget set automatic mode(true), it follows the system mirrored mode. /// + /// preview public bool IsAutoMirroredMode { get @@ -273,6 +290,7 @@ namespace ElmSharp /// Sets the widget to be focused or not. /// /// Weather be focused + /// preview public void SetFocus(bool isFocus) { Interop.Elementary.elm_object_focus_set(RealHandle, isFocus); @@ -282,6 +300,7 @@ namespace ElmSharp /// Sets the ability for a widget to be focused. /// /// True if the object can be focused, false if not(and on errors) + /// preview public void AllowFocus(bool isAllowFocus) { Interop.Elementary.elm_object_focus_allow_set(RealHandle, isAllowFocus); @@ -291,6 +310,7 @@ namespace ElmSharp /// Gives focus to next widget in widget tree. /// /// Direction to move the focus + /// preview public void FocusNext(FocusDirection direction) { Interop.Elementary.elm_object_focus_next(RealHandle, (int)direction); @@ -301,6 +321,7 @@ namespace ElmSharp /// /// Focus next widget /// Focus direction + /// preview public void SetNextFocusObject(EvasObject next, FocusDirection direction) { Interop.Elementary.elm_object_focus_next_object_set(RealHandle, next.RealHandle, (int)direction); @@ -312,6 +333,7 @@ namespace ElmSharp /// The name of particular part /// The content /// + /// preview public virtual bool SetPartContent(string part, EvasObject content) { return SetPartContent(part, content, false); @@ -324,6 +346,7 @@ namespace ElmSharp /// The content /// true, preserve old content will be unset. false, preserve old content will not be unset. /// + /// preview public virtual bool SetPartContent(string part, EvasObject content, bool preserveOldContent) { if (preserveOldContent) @@ -340,6 +363,7 @@ namespace ElmSharp /// /// The content /// + /// preview public void SetContent(EvasObject content) { SetContent(content, false); @@ -351,6 +375,7 @@ namespace ElmSharp /// The content /// true, preserve old content will be unset. false, preserve old content will not be unset. /// + /// preview public void SetContent(EvasObject content, bool preserveOldContent) { if (preserveOldContent) @@ -367,6 +392,7 @@ namespace ElmSharp /// /// The name of particular part /// The text + /// preview public virtual bool SetPartText(string part, string text) { Interop.Elementary.elm_object_part_text_set(RealHandle, part, text); @@ -378,6 +404,7 @@ namespace ElmSharp /// /// The name of particular part /// Text of the particular part of the widget + /// preview public virtual string GetPartText(string part) { return Interop.Elementary.elm_object_part_text_get(RealHandle, part); @@ -389,6 +416,7 @@ namespace ElmSharp /// The name of particular part /// The color be set to widget /// This method is a virtual method, it could be override by special child class + /// preview public virtual void SetPartColor(string part, Color color) { Interop.Elementary.elm_object_color_class_color_set(RealHandle, part, color.R * color.A / 255, @@ -403,6 +431,7 @@ namespace ElmSharp /// The name of particular part /// The color of the particular part /// This method is a virtual method, it could be override by special child class + /// preview public virtual Color GetPartColor(string part) { int r, g, b, a; @@ -415,6 +444,7 @@ namespace ElmSharp /// /// The name of particular part /// The opacity of the particular part + /// preview public void SetPartOpacity(string part, int opacity) { Interop.Elementary.elm_object_color_class_color_set(Handle, part, 255, 255, 255, opacity); @@ -425,6 +455,7 @@ namespace ElmSharp /// /// The name of particular part /// Opacity value of the particular part + /// preview public int GetPartOpacity(string part) { int r, g, b, a; @@ -437,6 +468,7 @@ namespace ElmSharp /// /// The signal's name. /// The signal's source. + /// preview public void SignalEmit(string emission, string source) { Interop.Elementary.elm_object_signal_emit(Handle, emission, source); @@ -445,6 +477,7 @@ namespace ElmSharp /// /// The callback of Realized Event /// + /// preview protected override void OnRealized() { base.OnRealized(); diff --git a/src/ElmSharp/ElmSharp/Window.cs b/src/ElmSharp/ElmSharp/Window.cs index 74ab8db..6c147dd 100755 --- a/src/ElmSharp/ElmSharp/Window.cs +++ b/src/ElmSharp/ElmSharp/Window.cs @@ -23,6 +23,7 @@ namespace ElmSharp /// /// Enumeration for the display rotation of window. /// + /// preview [Flags] public enum DisplayRotation { @@ -50,6 +51,7 @@ namespace ElmSharp /// /// Enumeration for the indicator opacity /// + /// preview public enum StatusBarMode { /// @@ -74,6 +76,7 @@ namespace ElmSharp /// /// Enumeration for the keygrab modes of window. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public enum KeyGrabMode { @@ -101,6 +104,7 @@ namespace ElmSharp /// /// Enumeration for the indicator mode. /// + /// preview public enum IndicatorMode { /// @@ -122,6 +126,7 @@ namespace ElmSharp /// /// Enumeration for the keyboard mode /// + /// preview public enum KeyboardMode { /// @@ -208,6 +213,7 @@ namespace ElmSharp /// /// Enumeration for the window type /// + /// preview public enum WindowType { /// @@ -306,6 +312,7 @@ namespace ElmSharp /// /// The Window is container that contain the graphical user interface of a program. /// + /// preview public class Window : Widget { SmartEvent _deleteRequest; @@ -316,6 +323,7 @@ namespace ElmSharp /// Creates and initializes a new instance of the Window class. /// /// Window name. + /// preview public Window(string name) : this(null, name) { } @@ -334,6 +342,7 @@ namespace ElmSharp /// When closing the window in any way outside the program control, /// and set callback when window rotation changed. /// + /// preview public Window(Window parent, string name) : this(parent, name, WindowType.Basic) { } @@ -355,6 +364,7 @@ namespace ElmSharp /// When closing the window in any way outside the program control, /// and set callback when window rotation changed. /// + /// preview public Window(Window parent, string name, WindowType type) { Name = name; @@ -371,6 +381,7 @@ namespace ElmSharp /// /// Creates and initializes a new instance of the Window class. /// + /// preview protected Window() { } @@ -378,26 +389,31 @@ namespace ElmSharp /// /// CloseRequested will be triggered when Window close. /// + /// preview public event EventHandler CloseRequested; /// /// RotationChanged will be triggered when Window do rotation. /// + /// preview public event EventHandler RotationChanged; /// /// Sets or gets Window name. /// + /// preview public string Name { get; set; } /// /// Gets the Window type. /// + /// preview public WindowType Type { get; } = WindowType.Basic; /// /// Gets Window size with Size value(w,h) /// + /// preview public Size ScreenSize { get @@ -411,6 +427,7 @@ namespace ElmSharp /// /// Gets the screen dpi for the screen that a Window is on. /// + /// preview public Point ScreenDpi { get @@ -424,6 +441,7 @@ namespace ElmSharp /// /// Gets the rotation of the Window.The rotation of the window in degrees (0-360). /// + /// preview public int Rotation { get @@ -435,6 +453,7 @@ namespace ElmSharp /// /// Gets whether window manager supports window rotation or not. /// + /// preview public bool IsRotationSupported { get @@ -446,12 +465,14 @@ namespace ElmSharp /// /// Sets or gets available rotation degree. /// + /// preview [Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")] public DisplayRotation AavailableRotations { get; set; } /// /// Sets or gets available rotation degree. /// + /// preview public DisplayRotation AvailableRotations { get @@ -477,6 +498,7 @@ namespace ElmSharp /// If you enable auto deletion, the window is automatically destroyed after the signal is emitted. /// If auto deletion is disabled, the window is not destroyed and the program has to handle it. /// + /// preview public bool AutoDeletion { get @@ -496,6 +518,7 @@ namespace ElmSharp /// True if the window alpha channel is enabled, false otherwise. /// If alpha is true, the alpha channel of the canvas will be enabled possibly making parts of the window completely or partially transparent. /// + /// preview public bool Alpha { get @@ -514,6 +537,7 @@ namespace ElmSharp /// /// The Role will be invalid if a new role is set or if the window is destroyed. /// + /// preview public string Role { get @@ -529,6 +553,7 @@ namespace ElmSharp /// /// Sets or gets the mode of status bar. /// + /// preview public StatusBarMode StatusBarMode { get @@ -544,6 +569,7 @@ namespace ElmSharp /// /// Sets or gets the iconified state of a window. /// + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public bool Iconified { @@ -561,6 +587,7 @@ namespace ElmSharp /// Gets or sets the window's indicator mode. /// /// The indicator mode. + /// preview public IndicatorMode IndicatorMode { get @@ -576,6 +603,7 @@ namespace ElmSharp /// /// Gets or sets the aspect ratio of a window. /// + /// preview public double Aspect { get @@ -591,6 +619,7 @@ namespace ElmSharp /// /// Window's autohide state. /// + /// preview public bool AutoHide { get @@ -607,6 +636,7 @@ namespace ElmSharp /// Get the borderless state of a window. /// This function requests the Window Manager to not draw any decoration around the window. /// + /// preview public bool Borderless { get @@ -622,6 +652,7 @@ namespace ElmSharp /// /// Gets or sets the demand attention state of a window. /// + /// preview public bool DemandAttention { get @@ -637,6 +668,7 @@ namespace ElmSharp /// /// Gets or sets the floating mode of a window. /// + /// preview public bool FloatingMode { get @@ -653,6 +685,7 @@ namespace ElmSharp /// Gets or sets the animate status for the focus highlight for this window. /// This function will enable or disable the animation of focus highlight only for the given window, regardless of the global setting for it. /// + /// preview public bool FocusHighlightAnimation { get @@ -669,6 +702,7 @@ namespace ElmSharp /// Gets or sets the enabled status for the focus highlight in a window. /// This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it. /// + /// preview public bool FocusHighlightEnabled { get @@ -685,6 +719,7 @@ namespace ElmSharp /// Gets or sets the style for the focus highlight on this window. /// Sets the style to use for theming the highlight of focused objects on the given window.If style is NULL, the default will be used. /// + /// preview public string FocusHighlightStyle { get @@ -700,6 +735,7 @@ namespace ElmSharp /// /// Get the keyboard mode of the window. /// + /// preview public KeyboardMode KeyboardMode { get @@ -720,6 +756,7 @@ namespace ElmSharp /// more than 5 means that the window will be placed above all others, /// and anything else means that the window will be placed in the default layer. /// + /// preview public override int Layer { get @@ -735,6 +772,7 @@ namespace ElmSharp /// /// Gets or sets the modal state of a window. /// + /// preview public bool Modal { get @@ -752,6 +790,7 @@ namespace ElmSharp /// This is a way to request the display on which the windowis shown does not blank, screensave or otherwise hide or obscure the window.It is intended for uses such as media playback on a television where a user may not want to be interrupted by an idle screen. /// The noblank property may have no effect if the window is iconified/minimized or hidden. /// + /// preview public bool NoBlank { get @@ -767,6 +806,7 @@ namespace ElmSharp /// /// Get the profile of a window. /// + /// preview public string Profile { get @@ -783,6 +823,7 @@ namespace ElmSharp /// Get the constraints on the maximum width and height of a window relative to the width and height of its screen. /// When this function returns true, obj will never resize larger than the screen. /// + /// preview public bool ScreenConstrain { get @@ -798,6 +839,7 @@ namespace ElmSharp /// /// Gets or sets the base size of a window. /// + /// preview public Size BaseSize { get @@ -815,6 +857,7 @@ namespace ElmSharp /// /// Gets or sets the step size of a window. /// + /// preview public Size StepSize { get @@ -832,6 +875,7 @@ namespace ElmSharp /// /// Get the screen position X of a window. /// + /// preview public int ScreenPositionX { get @@ -845,6 +889,7 @@ namespace ElmSharp /// /// Get the screen position Y of a window. /// + /// preview public int ScreenPositionY { get @@ -858,6 +903,7 @@ namespace ElmSharp /// /// Gets or sets the title of the window. /// + /// preview public string Title { get @@ -873,6 +919,7 @@ namespace ElmSharp /// /// Gets or sets the urgent state of a window. /// + /// preview public bool Urgent { get @@ -888,6 +935,7 @@ namespace ElmSharp /// /// Gets or sets the withdrawn state of a window. /// + /// preview public bool Withdrawn { get @@ -907,6 +955,7 @@ namespace ElmSharp /// A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. /// A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service. /// If true, create successfull, otherwise false + /// preview public bool CreateServiceSocket(string name, int number, bool systemWide) { return Interop.Elementary.elm_win_socket_listen(RealHandle, name, number, systemWide); @@ -917,6 +966,7 @@ namespace ElmSharp /// /// The rotation of the window, in degrees (0-360), counter-clockwise. /// Resizes the window's contents so that they fit inside the current window geometry. + /// preview public void SetRotation(int degree, bool resize) { if (resize) @@ -933,6 +983,7 @@ namespace ElmSharp /// Use this for windows that have only output information or might only be interacted with by the mouse or fingers, and never for typing input. /// Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care. /// + /// preview public void FocusSkip(bool skip) { Interop.Elementary.elm_win_prop_focus_skip_set(Handle, skip); @@ -942,6 +993,7 @@ namespace ElmSharp /// Pull up the window object. /// Places the window pointed by obj at the top of the stack, so that it's not covered by any other window. /// + /// preview public void PullUp() { Interop.Elementary.elm_win_raise(Handle); @@ -951,6 +1003,7 @@ namespace ElmSharp /// Bring down the window object. /// Places the window pointed by obj at the bottom of the stack, so that no other window is covered by it. /// + /// preview public void BringDown() { Interop.Elementary.elm_win_lower(Handle); @@ -964,6 +1017,7 @@ namespace ElmSharp /// This is just a request that a Window Manager may ignore, so calling this function does not ensure /// in any way that the window is going to be the active one after it. /// + /// preview public void Active() { Interop.Elementary.elm_win_activate(Handle); @@ -975,6 +1029,7 @@ namespace ElmSharp /// It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled or set as child of some other container. /// /// Resize object. + /// preview public void DeleteResizeObject(EvasObject obj) { Interop.Elementary.elm_win_resize_object_del(Handle, obj); @@ -992,6 +1047,7 @@ namespace ElmSharp /// /// Resize object. /// + /// preview public void AddResizeObject(EvasObject obj) { Interop.Elementary.elm_win_resize_object_add(Handle, obj); @@ -1003,6 +1059,7 @@ namespace ElmSharp /// /// The keyname to grab. /// According to the grabmode, it can grab key differently + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public void WinKeyGrab(string keyname, KeyGrabMode mode) { @@ -1014,6 +1071,7 @@ namespace ElmSharp /// This function unset keygrab value.Ungrab key of window. /// /// The keyname to grab. + /// preview [EditorBrowsable(EditorBrowsableState.Never)] public void WinKeyUngrab(string keyname) { @@ -1024,6 +1082,7 @@ namespace ElmSharp /// Set the keygrab of the window. /// /// keyname string to set keygrab + /// preview public void KeyGrabEx(string keyname) { Interop.Elementary.eext_win_keygrab_set(RealHandle, keyname); @@ -1033,6 +1092,7 @@ namespace ElmSharp /// Unset the keygrab of the window. /// /// keyname string to unset keygrab + /// preview public void KeyUngrabEx(string keyname) { Interop.Elementary.eext_win_keygrab_unset(RealHandle, keyname); @@ -1043,6 +1103,7 @@ namespace ElmSharp /// /// Parent EvasObject /// Handle IntPtr + /// preview protected override IntPtr CreateHandle(EvasObject parent) { Interop.Elementary.elm_config_accel_preference_set("3d"); diff --git a/src/ElmSharp/ElmSharp/WrapType.cs b/src/ElmSharp/ElmSharp/WrapType.cs index 5725790..6c3c09f 100755 --- a/src/ElmSharp/ElmSharp/WrapType.cs +++ b/src/ElmSharp/ElmSharp/WrapType.cs @@ -21,6 +21,7 @@ namespace ElmSharp /// /// Enumeration for the wrap type. /// + /// preview public enum WrapType { /// -- 2.7.4