summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhongqingli <hongqing.li@samsung.com>2017-06-26 11:14:02 +0800
committerhongqingli <hongqing.li@samsung.com>2017-06-26 11:16:31 +0800
commit27db8e6d13e172abe53fda9c807c2e85b90d9b5c (patch)
treef308190b7f29ceb6bf3d2a1242556d3cdf43b3ce
parent922f78179f6922984909ef8ff3e0034de95de709 (diff)
downloadelm-sharp-27db8e6d13e172abe53fda9c807c2e85b90d9b5c.tar.gz
elm-sharp-27db8e6d13e172abe53fda9c807c2e85b90d9b5c.tar.bz2
elm-sharp-27db8e6d13e172abe53fda9c807c2e85b90d9b5c.zip
add api comments for Calendar/Entry/Image/ItemObjectExtention
Change-Id: Ibf1e84371e49f430d432e2ffb13039439e9b5a20 Signed-off-by: hongqingli <hongqing.li@samsung.com>
-rwxr-xr-x[-rw-r--r--]ElmSharp/ElmSharp/Calendar.cs15
-rwxr-xr-x[-rw-r--r--]ElmSharp/ElmSharp/Entry.cs5
-rwxr-xr-x[-rw-r--r--]ElmSharp/ElmSharp/Image.cs12
-rwxr-xr-x[-rw-r--r--]ElmSharp/ElmSharp/ItemObjectExtension.cs11
4 files changed, 43 insertions, 0 deletions
diff --git a/ElmSharp/ElmSharp/Calendar.cs b/ElmSharp/ElmSharp/Calendar.cs
index 38eace6..ef87281 100644..100755
--- a/ElmSharp/ElmSharp/Calendar.cs
+++ b/ElmSharp/ElmSharp/Calendar.cs
@@ -83,12 +83,27 @@ namespace ElmSharp
OnDemand
}
+ /// <summary>
+ /// Enumeration used to define which fields of a tm struct will be taken into account
+ /// </summary>
[Flags]
public enum CalendarSelectable
{
+ /// <summary>
+ /// None will be taken into account
+ /// </summary>
None = 0,
+ /// <summary>
+ /// Year will be taken into account
+ /// </summary>
Year = 1 << 0,
+ /// <summary>
+ /// Month will be taken into account
+ /// </summary>
Month = 1 << 1,
+ /// <summary>
+ /// Day will be taken into account
+ /// </summary>
Day = 1 << 2
}
diff --git a/ElmSharp/ElmSharp/Entry.cs b/ElmSharp/ElmSharp/Entry.cs
index 420f624..67c7ff9 100644..100755
--- a/ElmSharp/ElmSharp/Entry.cs
+++ b/ElmSharp/ElmSharp/Entry.cs
@@ -753,6 +753,11 @@ namespace ElmSharp
Interop.Elementary.elm_entry_select_none(RealHandle);
}
+ /// <summary>
+ /// Sets the color of color class for a given widget.
+ /// </summary>
+ /// <param name="part">The name of color class.</param>
+ /// <param name="color">The struct of color</param>
public override void SetPartColor(string part, Color color)
{
IntPtr handle = (part == "bg") ? Handle : RealHandle;
diff --git a/ElmSharp/ElmSharp/Image.cs b/ElmSharp/ElmSharp/Image.cs
index 315e999..6c98cb3 100644..100755
--- a/ElmSharp/ElmSharp/Image.cs
+++ b/ElmSharp/ElmSharp/Image.cs
@@ -615,10 +615,22 @@ namespace ElmSharp
}
}
+ /// <summary>
+ /// Enumeration for the fill mode of image border
+ /// </summary>
public enum ImageBorderFillMode
{
+ /// <summary>
+ /// None mode of image border
+ /// </summary>
None,
+ /// <summary>
+ /// Default mode of image border
+ /// </summary>
Default,
+ /// <summary>
+ /// Solid mode of image border
+ /// </summary>
Solid,
}
diff --git a/ElmSharp/ElmSharp/ItemObjectExtension.cs b/ElmSharp/ElmSharp/ItemObjectExtension.cs
index 420c048..ef8b609 100644..100755
--- a/ElmSharp/ElmSharp/ItemObjectExtension.cs
+++ b/ElmSharp/ElmSharp/ItemObjectExtension.cs
@@ -18,13 +18,24 @@ using System;
namespace ElmSharp
{
+ /// <summary>
+ /// The ItemObjectExtension is used to manage item object extension
+ /// </summary>
public static class ItemObjectExtension
{
+ /// <summary>
+ /// Grab high light of item object
+ /// </summary>
+ /// <param name="obj">the item object which is grabbed high light</param>
public static void GrabHighlight(this ItemObject obj)
{
Interop.Elementary.elm_atspi_component_highlight_grab(obj.Handle);
}
+ /// <summary>
+ /// Clear high light of item object
+ /// </summary>
+ /// <param name="obj">the item object which is cleared high light</param>
public static void ClearHighlight(this ItemObject obj)
{
Interop.Elementary.elm_atspi_component_highlight_clear(obj.Handle);