summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwenxuan.gu <wenxuan.gu@samsung.com>2017-06-19 16:15:52 +0800
committerwenxuan.gu <wenxuan.gu@samsung.com>2017-06-19 16:22:49 +0800
commitd22827d873427c028e7a3a3408b8c1fca936c12e (patch)
treea5fd9b3917ad3ce9b5eaae856d8442090ab05fd7
parentd1f42ae4de98bb31abf005ab8e03dc1caa6c78a4 (diff)
downloadelm-sharp-d22827d873427c028e7a3a3408b8c1fca936c12e.tar.gz
elm-sharp-d22827d873427c028e7a3a3408b8c1fca936c12e.tar.bz2
elm-sharp-d22827d873427c028e7a3a3408b8c1fca936c12e.zip
add API comments for Panes and Scroller
Change-Id: I326bad4050a792c0a885b3a18a172c7564d5085b
-rwxr-xr-xElmSharp/ElmSharp/Panes.cs22
-rwxr-xr-x[-rw-r--r--]ElmSharp/ElmSharp/Scroller.cs16
2 files changed, 36 insertions, 2 deletions
diff --git a/ElmSharp/ElmSharp/Panes.cs b/ElmSharp/ElmSharp/Panes.cs
index db8b850..ec6c861 100755
--- a/ElmSharp/ElmSharp/Panes.cs
+++ b/ElmSharp/ElmSharp/Panes.cs
@@ -109,6 +109,11 @@ namespace ElmSharp
}
}
+ /// <summary>
+ /// Sets or gets the absolute minimum size of panes widget's left side.
+ /// If displayed vertically, left content is displayed at top.
+ /// value representing minimum size of left side in pixels.
+ /// </summary>
public int LeftMinimumSize
{
get
@@ -121,6 +126,12 @@ namespace ElmSharp
}
}
+ /// <summary>
+ /// Sets or gets the relative minimum size of panes widget's left side.
+ /// proportion of minimum size of left side.
+ /// 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.
+ /// </summary>
public double LeftMinimumRelativeSize
{
get
@@ -133,6 +144,11 @@ namespace ElmSharp
}
}
+ /// <summary>
+ /// Sets or gets the absolute minimum size of panes widget's right side.
+ /// If displayed vertically, right content is displayed at top.
+ /// value representing minimum size of right side in pixels.
+ /// </summary>
public int RightMinimumSize
{
get
@@ -145,6 +161,12 @@ namespace ElmSharp
}
}
+ /// <summary>
+ /// Sets or gets the relative minimum size of panes widget's right side.
+ /// proportion of minimum size of right side.
+ /// 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.
+ /// </summary>
public double RightMinimumRelativeSize
{
get
diff --git a/ElmSharp/ElmSharp/Scroller.cs b/ElmSharp/ElmSharp/Scroller.cs
index 6e5fd2c..2ceb38c 100644..100755
--- a/ElmSharp/ElmSharp/Scroller.cs
+++ b/ElmSharp/ElmSharp/Scroller.cs
@@ -494,7 +494,7 @@ namespace ElmSharp
}
/// <summary>
- /// Get a given scroller widget's scrolling page size, relative to its viewport size.
+ /// Gets or sets a given scroller widget's scrolling page size, relative to its viewport size.
/// </summary>
public double VerticalRelativePageSize
{
@@ -512,7 +512,7 @@ namespace ElmSharp
}
/// <summary>
- /// Get a given scroller widget's scrolling page size, relative to its viewport size.
+ /// Gets or sets a given scroller widget's scrolling page size, relative to its viewport size.
/// </summary>
public double HorizontalRelativePageSize
{
@@ -532,6 +532,12 @@ namespace ElmSharp
/// <summary>
/// Gets or Sets the page snapping behavior of a scroller.
/// </summary>
+ /// <remarks>
+ /// When scrolling, if a scroller is paged (see VerticalRelativePageSize),
+ /// the scroller may snap to pages when being scrolled, i.e., even if it had momentum to scroll further,
+ /// 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.
+ /// </remarks>
public bool VerticalSnap
{
get
@@ -550,6 +556,12 @@ namespace ElmSharp
/// <summary>
/// Gets or Sets the page snapping behavior of a scroller.
/// </summary>
+ /// <remarks>
+ /// When scrolling, if a scroller is paged (see HorizontalRelativePageSize),
+ /// the scroller may snap to pages when being scrolled, i.e., even if it had momentum to scroll further,
+ /// 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.
+ /// </remarks>
public bool HorizontalSnap
{
get