namespace ElmSharp.Accessible
{
/// <summary>
- /// Enumeration for AccessRole.
+ /// Enumeration for the AccessRole.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum AccessRole
{
/// <summary>
- /// Invalid
+ /// Invalid.
/// </summary>
Invalid,
/// <summary>
- /// AcceleratorLabel role
+ /// AcceleratorLabel role.
/// </summary>
AcceleratorLabel,
/// <summary>
- /// Alert role
+ /// Alert role.
/// </summary>
Alert,
/// <summary>
- /// Animation role
+ /// Animation role.
/// </summary>
Animation,
/// <summary>
- /// Arrow role
+ /// Arrow role.
/// </summary>
Arrow,
/// <summary>
- /// Calendar role
+ /// Calendar role.
/// </summary>
Calendar,
/// <summary>
- /// Canvas role
+ /// Canvas role.
/// </summary>
Canvas,
/// <summary>
- /// CheckBox role
+ /// CheckBox role.
/// </summary>
CheckBox,
/// <summary>
- /// CheckMenuItem role
+ /// CheckMenuItem role.
/// </summary>
CheckMenuItem,
/// <summary>
- /// ColorChooser role
+ /// ColorChooser role.
/// </summary>
ColorChooser,
/// <summary>
- /// ColumnHeader role
+ /// ColumnHeader role.
/// </summary>
ColumnHeader,
/// <summary>
- /// ComboBox role
+ /// ComboBox role.
/// </summary>
ComboBox,
/// <summary>
- /// DateEditor role
+ /// DateEditor role.
/// </summary>
DateEditor,
/// <summary>
- /// DesktopIcon role
+ /// DesktopIcon role.
/// </summary>
DesktopIcon,
/// <summary>
- /// DesktopFrame role
+ /// DesktopFrame role.
/// </summary>
DesktopFrame,
/// <summary>
- /// Dial role
+ /// Dial role.
/// </summary>
Dial,
/// <summary>
- /// Dialog role
+ /// Dialog role.
/// </summary>
Dialog,
/// <summary>
- /// DirectoryPane role
+ /// DirectoryPane role.
/// </summary>
DirectoryPane,
/// <summary>
- /// DrawingArea role
+ /// DrawingArea role.
/// </summary>
DrawingArea,
/// <summary>
- /// FileChooser role
+ /// FileChooser role.
/// </summary>
FileChooser,
/// <summary>
/// </summary>
Filler,
/// <summary>
- /// FocusTraversable role
+ /// FocusTraversable role.
/// </summary>
FocusTraversable,
/// <summary>
- /// FontChooser role
+ /// FontChooser role.
/// </summary>
FontChooser,
/// <summary>
- /// Frame role
+ /// Frame role.
/// </summary>
Frame,
/// <summary>
- /// GlassPane role
+ /// GlassPane role.
/// </summary>
GlassPane,
/// <summary>
- /// HtmlContainer role
+ /// HtmlContainer role.
/// </summary>
HtmlContainer,
/// <summary>
- /// Icon role
+ /// Icon role.
/// </summary>
Icon,
/// <summary>
- /// Image role
+ /// Image role.
/// </summary>
Image,
/// <summary>
- /// InternalFrame role
+ /// InternalFrame role.
/// </summary>
InternalFrame,
/// <summary>
/// </summary>
Label,
/// <summary>
- /// LayeredPane role
+ /// LayeredPane role.
/// </summary>
LayeredPane,
/// <summary>
- /// List role
+ /// List role.
/// </summary>
List,
/// <summary>
- /// ListItem role
+ /// ListItem role.
/// </summary>
ListItem,
/// <summary>
- /// Menu role
+ /// Menu role.
/// </summary>
Menu,
/// <summary>
- /// MenuBar role
+ /// MenuBar role.
/// </summary>
MenuBar,
/// <summary>
- /// MenuItem role
+ /// MenuItem role.
/// </summary>
MenuItem,
/// <summary>
- /// OptionPane role
+ /// OptionPane role.
/// </summary>
OptionPane,
/// <summary>
- /// PageTab role
+ /// PageTab role.
/// </summary>
PageTab,
/// <summary>
- /// PageTabList role
+ /// PageTabList role.
/// </summary>
PageTabList,
/// <summary>
- /// Panel role
+ /// Panel role.
/// </summary>
Panel,
/// <summary>
- /// PasswordText role
+ /// PasswordText role.
/// </summary>
PasswordText,
/// <summary>
- /// PopupMenu role
+ /// PopupMenu role.
/// </summary>
PopupMenu,
/// <summary>
- /// ProgressBar role
+ /// ProgressBar role.
/// </summary>
ProgressBar,
/// <summary>
- /// PushButton role
+ /// PushButton role.
/// </summary>
PushButton,
/// <summary>
- /// RadioButton role
+ /// RadioButton role.
/// </summary>
RadioButton,
/// <summary>
- /// RadioMenuItem role
+ /// RadioMenuItem role.
/// </summary>
RadioMenuItem,
/// <summary>
- /// RootPane role
+ /// RootPane role.
/// </summary>
RootPane,
/// <summary>
- /// RowHeader role
+ /// RowHeader role.
/// </summary>
RowHeader,
/// <summary>
- /// ScrollBar role
+ /// ScrollBar role.
/// </summary>
ScrollBar,
/// <summary>
- /// ScrollPane role
+ /// ScrollPane role.
/// </summary>
ScrollPane,
/// <summary>
- /// Separator role
+ /// Separator role.
/// </summary>
Separator,
/// <summary>
- /// Slider role
+ /// Slider role.
/// </summary>
Slider,
/// <summary>
- /// SpinButton role
+ /// SpinButton role.
/// </summary>
SpinButton,
/// <summary>
- /// SplitPane role
+ /// SplitPane role.
/// </summary>
SplitPane,
/// <summary>
- /// StatusBar role
+ /// StatusBar role.
/// </summary>
StatusBar,
/// <summary>
- /// Table role
+ /// Table role.
/// </summary>
Table,
/// <summary>
- /// TableCell role
+ /// TableCell role.
/// </summary>
TableCell,
/// <summary>
- /// TableColumnHeader role
+ /// TableColumnHeader role.
/// </summary>
TableColumnHeader,
/// <summary>
- /// TableRowHeader role
+ /// TableRowHeader role.
/// </summary>
TableRowHeader,
/// <summary>
- /// TearoffMenuItem role
+ /// TearoffMenuItem role.
/// </summary>
TearoffMenuItem,
/// <summary>
- /// Terminal role
+ /// Terminal role.
/// </summary>
Terminal,
/// <summary>
- /// Text role
+ /// Text role.
/// </summary>
Text,
/// <summary>
- /// ToggleButton role
+ /// ToggleButton role.
/// </summary>
ToggleButton,
/// <summary>
- /// ToolBar role
+ /// ToolBar role.
/// </summary>
ToolBar,
/// <summary>
- /// ToolTip role
+ /// ToolTip role.
/// </summary>
ToolTip,
/// <summary>
- /// Tree role
+ /// Tree role.
/// </summary>
Tree,
/// <summary>
- /// TreeTable role
+ /// TreeTable role.
/// </summary>
TreeTable,
/// <summary>
- /// Unknown
+ /// Unknown role.
/// </summary>
Unknown,
/// <summary>
- /// Viewport role
+ /// Viewport role.
/// </summary>
Viewport,
/// <summary>
- /// Window role
+ /// Window role.
/// </summary>
Window,
/// <summary>
- /// Extended role
+ /// Extended role.
/// </summary>
Extended,
/// <summary>
- /// Header role
+ /// Header role.
/// </summary>
Header,
/// <summary>
- /// Footer role
+ /// Footer role.
/// </summary>
Footer,
/// <summary>
- /// Paragraph
+ /// Paragraph role.
/// </summary>
Paragraph,
/// <summary>
- /// Ruler role
+ /// Ruler role.
/// </summary>
Ruler,
/// <summary>
- /// Application role
+ /// Application role.
/// </summary>
Application,
/// <summary>
- /// Autocomplete role
+ /// Autocomplete role.
/// </summary>
Autocomplete,
/// <summary>
- /// Editbar role
+ /// Editbar role.
/// </summary>
Editbar,
/// <summary>
- /// Embedded role
+ /// Embedded role.
/// </summary>
Embedded,
/// <summary>
- /// Entry role
+ /// Entry role.
/// </summary>
Entry,
/// <summary>
- /// Chart role
+ /// Chart role.
/// </summary>
Chart,
/// <summary>
- /// Caption role
+ /// Caption role.
/// </summary>
Caption,
/// <summary>
- /// DocumentFrame role
+ /// DocumentFrame role.
/// </summary>
DocumentFrame,
/// <summary>
- /// Heading role
+ /// Heading role.
/// </summary>
Heading,
/// <summary>
- /// Page role
+ /// Page role.
/// </summary>
Page,
/// <summary>
- /// Section role
+ /// Section role.
/// </summary>
Section,
/// <summary>
- /// RedundantObject role
+ /// RedundantObject role.
/// </summary>
RedundantObject,
/// <summary>
- /// Form role
+ /// Form role.
/// </summary>
Form,
/// <summary>
- /// Link role
+ /// Link role.
/// </summary>
Link,
/// <summary>
- /// InputMethodWindow role
+ /// InputMethodWindow role.
/// </summary>
InputMethodWindow,
/// <summary>
- /// TableRow role
+ /// TableRow role.
/// </summary>
TableRow,
/// <summary>
- /// TreeItem role
+ /// TreeItem role.
/// </summary>
TreeItem,
/// <summary>
- /// DocumentSpreadsheet role
+ /// DocumentSpreadsheet role.
/// </summary>
DocumentSpreadsheet,
/// <summary>
- /// DocumentPresentation role
+ /// DocumentPresentation role.
/// </summary>
DocumentPresentation,
/// <summary>
- /// DocumentText role
+ /// DocumentText role.
/// </summary>
DocumentText,
/// <summary>
- /// DocumentWeb role
+ /// DocumentWeb role.
/// </summary>
DocumentWeb,
/// <summary>
- /// DocumentEmail role
+ /// DocumentEmail role.
/// </summary>
DocumentEmail,
/// <summary>
- /// Comment role
+ /// Comment role.
/// </summary>
Comment,
/// <summary>
- /// ListBox role
+ /// ListBox role.
/// </summary>
ListBox,
/// <summary>
- /// Grouping role
+ /// Grouping role.
/// </summary>
Grouping,
/// <summary>
- /// ImageMap role
+ /// ImageMap role.
/// </summary>
ImageMap,
/// <summary>
- /// Notification role
+ /// Notification role.
/// </summary>
Notification,
/// <summary>
- /// InfoBar role
+ /// InfoBar role.
/// </summary>
InfoBar
}
namespace ElmSharp.Accessible
{
/// <summary>
- /// The delegate to define how to provide informations for <see cref="IAccessibleObject.Name"/> or <see cref="IAccessibleObject.Description"/>.
+ /// The delegate to define how to provide information for <see cref="IAccessibleObject.Name"/> or <see cref="IAccessibleObject.Description"/>.
/// </summary>
/// <param name="obj">The sender obj.</param>
- /// <returns>Return information for Name or Description.</returns>
+ /// <returns>Return information for name or description.</returns>
/// <since_tizen> preview </since_tizen>
public delegate string AccessibleInfoProvider (AccessibleObject obj);
/// <summary>
/// It's a base abstract class for <see cref="Widget"/>.
- /// It provides available definitions for the screen reader, such as <see cref="IAccessibleObject.Name"/>, <see cref="IAccessibleObject.Description"/>, <see cref="IAccessibleObject.ReadingInfoType"/>, etc.
- /// There's many the relationship between two accessible objects, like <see cref="ChildOf"/>, <see cref="ParentOf"/>, <see cref="FlowsTo"/>, <see cref="FlowsFrom"/>, etc.
+ /// It provides the available definitions for the screen reader, such as <see cref="IAccessibleObject.Name"/>, <see cref="IAccessibleObject.Description"/>, <see cref="IAccessibleObject.ReadingInfoType"/>, etc.
+ /// There are many relationships between two accessible objects, like <see cref="ChildOf"/>, <see cref="ParentOf"/>, <see cref="FlowsTo"/>, <see cref="FlowsFrom"/>, etc.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class AccessibleObject : EvasObject, IAccessibleObject
}
/// <summary>
- /// Gets or sets the role of the object in accessibility domain.
+ /// Gets or sets the role of the object in an accessibility domain.
/// </summary>
AccessRole IAccessibleObject.Role
{
}
/// <summary>
- /// Gets or sets highlightable of given widget.
+ /// Gets or sets the highlightable of a given widget.
/// </summary>
bool IAccessibleObject.CanHighlight
{
}
/// <summary>
- /// Gets or sets the translation domain of "name" and "description" properties.
- /// Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties.
- /// 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.
+ /// Gets or sets the translation domain of the "name" and "description" properties.
+ /// The translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties.
+ /// When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter.
+ /// It is the application developers responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.
/// </summary>
string IAccessibleObject.TranslationDomain
{
}
/// <summary>
- /// Gets or sets contextual information about object.
+ /// Gets or sets the contextual information about an object.
/// </summary>
string IAccessibleObject.Description
{
}
/// <summary>
- /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description" />.
+ /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description"/>.
/// </summary>
AccessibleInfoProvider IAccessibleObject.DescriptionProvider
{
}
/// <summary>
- /// Creates and initializes a new instance of the AccessibleObject class with parent EvasObject class parameter.
+ /// Creates and initializes a new instance of the AccessibleObject class with the parent EvasObject class parameter.
/// </summary>
- /// <param name="parent">Parent EvasObject class </param>
+ /// <param name="parent">Parent EvasObject class.</param>
/// <since_tizen> preview </since_tizen>
public AccessibleObject(EvasObject parent) : base(parent)
{
/// <summary>
/// Defines the relationship between two accessible objects.
- /// Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.
- /// AppendRelation API is asymmetric, which means that appending, for example, relation <see cref="FlowsTo"/> from object A to B, do not append relation <see cref="FlowsFrom"/> from object B to object A.
+ /// Relationships can be queried by the Assistive Technology clients to provide customized feedback, and improving overall user experience.
+ /// AppendRelation API is asymmetric, which means that appending, for example, relation <see cref="FlowsTo"/> from object A to B, does not append the relation <see cref="FlowsFrom"/> from object B to object A.
/// </summary>
- /// <param name="relation">The relationship between source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between the source object and target object of a given type.</param>
void IAccessibleObject.AppendRelation(IAccessibleRelation relation)
{
if (relation.Target == null) throw new ArgumentException("Target of Accessibility relation can not be null");
/// <summary>
/// Removes the relationship between two accessible objects.
/// </summary>
- /// <param name="relation">The relationship between source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between the source object and target object of a given type.</param>
void IAccessibleObject.RemoveRelation(IAccessibleRelation relation)
{
if (relation.Target == null) throw new ArgumentException("Target of Accessibility relation can not be null");
}
/// <summary>
- /// Highlights accessible widget.
+ /// Highlights the accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Highlight()
}
/// <summary>
- /// Clears highlight of accessible widget.
+ /// Clears the highlight of the accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Unhighlight()
namespace ElmSharp.Accessible
{
/// <summary>
- /// IAccessibleRelation is a interface which defines the relationship between two accessible objects.
+ /// IAccessibleRelation is an interface, which defines the relationship between two accessible objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IAccessibleRelation
}
/// <summary>
- /// To define label info for accessible object.
+ /// To define the label info for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class LabelledBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is LabelledBy.
+ /// Gets or sets the target object, which is LabelledBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define label info for accessible object.
+ /// To define the label info for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class LabelFor : IAccessibleRelation
}
/// <summary>
- /// To define control relationship for accessible object.
+ /// To define the control relationship for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ControllerFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is ControllerFor.
+ /// Gets or sets the target object, which is ControllerFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define control relationship for accessible object.
+ /// To define the control relationship for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ControlledBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is ControlledBy.
+ /// Gets or sets the target object, which is ControlledBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define member relationship for accessible object.
+ /// To define the member relationship for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MemberOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is MemberOf.
+ /// Gets or sets the target object, which is MemberOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define tooltip for accessible object.
+ /// To define the tooltip for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class TooltipFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is TooltipFor.
+ /// Gets or sets the target object, which is TooltipFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define child for accessible object.
+ /// To define the child for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ChildOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is ChildOf.
+ /// Gets or sets the target object, which is ChildOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define parent for accessible object.
+ /// To define the parent for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ParentOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is ParentOf.
+ /// Gets or sets the target object, which is ParentOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define extend for accessible object.
+ /// To define the extend for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Extended : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is Extended.
+ /// Gets or sets the target object, which is Extended.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
/// <summary>
- /// Gets the Extended type.
+ /// Gets the extended type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Type
public class FlowsTo : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is FlowsTo.
+ /// Gets or sets the target object, which is FlowsTo.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
public class FlowsFrom : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is FlowsFrom.
+ /// Gets or sets the target object, which is FlowsFrom.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define subwindow for accessible object.
+ /// To define the subwindow for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SubwindowOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is SubwindowOf.
+ /// Gets or sets the target object, which is SubwindowOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define embed for accessible object.
+ /// To define the embed for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Embeds : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is Embeds.
+ /// Gets or sets the target object ,which is Embeds.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define embed for accessible object.
+ /// To define the embed for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EmbeddedBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is EmbeddedBy.
+ /// Gets or sets the target object, which is EmbeddedBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define popup for accessible object.
+ /// To define the popup for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class PopupFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is PopupFor.
+ /// Gets or sets the target object, which is PopupFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define parent window for accessible object.
+ /// To define the parent window for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ParentWindowOf : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is ParentWindowOf.
+ /// Gets or sets the target object, which is ParentWindowOf.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define description for accessible object.
+ /// To define the description for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DescriptionFor : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is DescriptionFor.
+ /// Gets or sets the target object, which is DescriptionFor.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
}
/// <summary>
- /// To define description for accessible object.
+ /// To define the description for an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DescribedBy : IAccessibleRelation
{
/// <summary>
- /// Gets or sets the target object which is DescribedBy.
+ /// Gets or sets the target object, which is DescribedBy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AccessibleObject Target { get; set; }
namespace ElmSharp.Accessible
{
/// <summary>
- /// Enumeration for ReadingStatus.
+ /// Enumeration for the ReadingStatus.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ReadingStatus
{
/// <summary>
- /// Unknown status
+ /// Unknown status.
/// </summary>
Unknown,
/// <summary>
- /// Cancelled status
+ /// Cancelled status.
/// </summary>
Cancelled,
/// <summary>
- /// Stopped status
+ /// Stopped status.
/// </summary>
Stoppped,
/// <summary>
- /// Skipped status
+ /// Skipped status.
/// </summary>
Skipped
}
}
/// <summary>
- /// Reads given text by screen reader.
+ /// Reads the given text by a screen reader.
/// </summary>
/// <param name="text">The reading text.</param>
- /// <param name="discardable">If true, reading can be discarded by subsequent reading requests, if false the reading must finish before next reading request can be started.</param>
- /// <returns>Return a task with reading status.</returns>
+ /// <param name="discardable">If true, reading can be discarded by subsequent reading requests. If false, reading must be finished before the next reading request can be started.</param>
+ /// <returns>Return a task with the reading status.</returns>
/// <since_tizen> preview </since_tizen>
public static Task<ReadingStatus> Say(string text, bool discardable)
{
/// <summary>
/// Creates and initializes a new instance of the Background class.
/// </summary>
- /// <param name="parent">The EvasObject to which the new Background will be attached as a child.</param>
+ /// <param name="parent">The EvasObject to which the new background will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Background(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Sets or gets color to Background.
+ /// Sets or gets the color to the background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color Color
}
/// <summary>
- /// Sets or gets image to Background.
+ /// Sets or gets the image to the background.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string File
/// </summary>
/// <remarks>
/// This sets how the background widget will display its image.
- /// 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.
+ /// This will only work if the file was previously set with an image file on object.
+ /// The image can be display tiled, scaled, centered, or stretched. Scaled by default.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public BackgroundOptions BackgroundOption
}
/// <summary>
- /// Set the size of the pixmap representation of the image set on a given background widget.
+ /// Sets the size of the pixmap representation of the image set on a given background widget.
/// This method just makes sense if an image file was set.
/// This is just a hint for the underlying system.
/// The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested.
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for the background type.
+ /// Enumeration for the background types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum BackgroundOptions
{
/// <summary>
- /// Centers the background image
+ /// Centers the background image.
/// </summary>
Center,
/// <summary>
- /// Scales the background image, retaining the aspect ratio
+ /// Scales the background image, retaining the aspect ratio.
/// </summary>
Scale,
Stretch,
/// <summary>
- /// Tiles the background image at its original size
+ /// Tiles the background image at its original size.
/// </summary>
Tile
}
namespace ElmSharp
{
/// <summary>
- /// The Box is a container used to arranges UI components in a linear order.
+ /// The Box is a container that is used to arrange UI components in a linear order.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Box : Container
}
/// <summary>
- /// Sets or gets IsHorizontal value which describe pack direction, vertical is default.
+ /// Sets or gets the IsHorizontal value, which describe the pack direction. Vertical is default.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Sets or gets whether the box to arrange its children homogeneously.
+ /// Sets or gets whether the box has to arrange its children homogeneously.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHomogeneous
/// Adds an object at the end of the pack list.
/// </summary>
/// <remarks>
- /// Packs "content" object into the Box, placing it last in the list of children objects.
- /// The actual position the object will get on screen depends on the layout used.
+ /// Packs the "content" object into the Box, placing it last in the list of children objects.
+ /// The actual position of the object will get on the screen depending on the layout used.
/// If no custom layout is set, it will be at the bottom or right,
/// depending if the Box is vertical or horizontal, respectively.
/// </remarks>
- /// <param name="content">The oject be packed</param>
+ /// <param name="content">The oject to be packed.</param>
/// <since_tizen> preview </since_tizen>
public void PackEnd(EvasObject content)
{
}
/// <summary>
- /// Adds an "content" object to the beginning of the pack list.
+ /// Adds a "content" object to the beginning of the pack list.
/// </summary>
/// <remarks>
- /// Pack "content" object into the Box obj, placing it first in the list of children objects.
- /// The actual position the object will get on screen depends on the layout used.
+ /// Packs the "content" object into the box object, placing it first in the list of children objects.
+ /// The actual position of the object will get on the screen depending on the layout used.
/// If no custom layout is set, it will be at the top or left,
/// depending if the Box is vertical or horizontal, respectively.
/// </remarks>
}
/// <summary>
- /// Adds an "content "object to the Box after the "after" object.
+ /// Adds a "content" object to the box after the "after" object.
/// </summary>
/// <remarks>
- /// This will add the "content" to the Box indicated after the object indicated with "after".
- /// If "after" is not already in the Box, results are undefined.
- /// After means either to the right of the "after" object or below it depending on orientation.
+ /// This will add the "content" to the box indicated after the object indicated with "after".
+ /// If "after" is not already in the box, the results are undefined.
+ /// After means either to the right of the "after" object or below it, depending on orientation.
/// </remarks>
- /// <param name="content">The object will be added in Box</param>
- /// <param name="after">The object has been added in Box</param>
+ /// <param name="content">The object will be added in the box.</param>
+ /// <param name="after">The object has been added in the box.</param>
/// <since_tizen> preview </since_tizen>
public void PackAfter(EvasObject content, EvasObject after)
{
}
/// <summary>
- /// Adds an "content "object to the Box before the "before" object.
+ /// Adds a "content" object to the box before the "before" object.
/// </summary>
/// <remarks>
- /// This will add the "content" to the Box indicated before the object indicated with "before".
- /// If "before" is not already in the Box, results are undefined.
- /// before means either to the left of the "before" object or below it depending on orientation.
+ /// This will add the "content" to the box indicated before the object indicated with "before".
+ /// If "before" is not already in the box, the results are undefined.
+ /// Before means either to the left of the "before" object or below it, depending on orientation.
/// </remarks>
- /// <param name="content">The object will be added in Box</param>
- /// <param name="before">The object has been added in Box</param>
+ /// <param name="content">The object will be added in the box.</param>
+ /// <param name="before">The object has been added in the box.</param>
/// <since_tizen> preview </since_tizen>
public void PackBefore(EvasObject content, EvasObject before)
{
}
/// <summary>
- /// Remove the "content" oject from Box without deleting it.
+ /// Removes the "content" object from the box without deleting it.
/// </summary>
- /// <param name="content">The object to unpack</param>
+ /// <param name="content">The object to unpack.</param>
/// <since_tizen> preview </since_tizen>
public void UnPack(EvasObject content)
{
}
/// <summary>
- /// Removes all objects from Box container.
+ /// Removes all the objects from the Box container.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void UnPackAll()
}
/// <summary>
- /// Whenever anything changes that requires the Box in obj to recalculate the size and position of its elements,
+ /// Whenever any changes that requires the box in object to recalculate the size and position of its elements,
/// the function cb will be called to determine what the layout of the children will be.
/// </summary>
- /// <param name="action">The callback function used for layout </param>
+ /// <param name="action">The callback function used for layout.</param>
/// <since_tizen> preview </since_tizen>
public void SetLayoutCallback(Action action)
{
}
/// <summary>
- /// Sets the color of exact part to Box's layout parent.
+ /// Sets the color of the exact part to the box's layout parent.
/// </summary>
/// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
/// <param name="color">The color value.</param>
}
/// <summary>
- /// Gets the color of exact part of Box's layout parent.
+ /// Gets the color of the exact part of the box's layout parent.
/// </summary>
/// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
/// <returns></returns>
}
/// <summary>
- /// Force the box to recalculate its children packing.
- /// 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.
+ /// Forces the box to recalculate its children packing.
+ /// If any children were added or removed, the 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Recalculate()
}
/// <summary>
- /// Clear the box of all children.
+ /// Clears the box's of all the children.
/// Remove all the elements contained by the box, deleting the respective objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets or gets the alignment of the whole bounding box of contents.
/// </summary>
- /// <param name="horizontal">Horizontal alignment</param>
- /// <param name="vertical">Vertical alignment</param>
+ /// <param name="horizontal">Horizontal alignment.</param>
+ /// <param name="vertical">Vertical alignment.</param>
/// <since_tizen> preview </since_tizen>
public void SetBoxAlignment(double horizontal, double vertical)
{
}
/// <summary>
- /// Sets or gets the space(padding) between the box's elements.
+ /// Sets or gets the space (padding) between the box's elements.
/// </summary>
- /// <param name="horizontal">Horizontal padding</param>
- /// <param name="vertical">vertical padding</param>
+ /// <param name="horizontal">Horizontal padding.</param>
+ /// <param name="vertical">Vertical padding.</param>
/// <since_tizen> preview </since_tizen>
public void SetPadding(int horizontal, int vertical)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Button is a widget works as a clickable input element to trigger events.
+ /// The Button is a widget that works as a clickable input element to trigger events.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Button : Layout
}
/// <summary>
- /// Clicked will be triggered when Button is clicked.
+ /// Clicked will be triggered when the button is clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Repeated will be triggered when Button is pressed without releasing it.
+ /// Repeated will be triggered when the button is pressed without releasing it.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Repeated;
/// <summary>
- /// Pressed will be triggered when the Button is pressed.
+ /// Pressed will be triggered when the button is pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Pressed;
/// <summary>
- /// Released will be triggered when the Button is released after being pressed.
+ /// Released will be triggered when the button is released after being pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Released;
/// <summary>
- /// Sets or gets the autorepeat feature of a given Button.
+ /// Sets or gets the autorepeat feature of a given Bbutton.
/// </summary>
/// <remarks>
- /// Autorepeat feature means autorepeat event generated when the button is kept pressed.
- /// When set AutoRepeat to false, no autorepeat is performed and buttons will trigger Clicked event when they are clicked.
- /// When set to true, keeping a button pressed continuously trigger Repeated event until the button is released.
- /// The time it takes until it starts triggering Repeated is given by AutoRepeatInitialTime,
+ /// Autorepeat feature means the autorepeat event is generated when the button is kept pressed.
+ /// When set to false, no autorepeat is performed and the buttons will trigger the Clicked event when they are clicked.
+ /// When set to true, keeping a button pressed continuously will trigger the Repeated event until the button is released.
+ /// The time it takes until it starts triggering, repeated is given by AutoRepeatInitialTime,
/// and the time between each new emission is given by AutoRepeatGapTimeout.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Delete the object color class.
+ /// Deletes the object Color class.
/// </summary>
- /// <param name="part">The color class to be deleted.</param>
+ /// <param name="part">The Color class to be deleted.</param>
/// <since_tizen> preview </since_tizen>
[Obsolete("DeleteColorClass is obsolete, please use EdjeObject.DeleteColorClass(string)")]
public void DeleteColorClass(string part)
}
/// <summary>
- /// Sets or gets the BackgroundColor of a given Button in normal and pressed status.
+ /// Sets or gets the BackgroundColor of a given button in the normal and pressed status.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// 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.
+ /// Enumeration for event periodicity, used to define if a mark should be repeated beyond the event's day. It's set when a mark is added.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum CalendarMarkRepeatType
{
/// <summary>
- /// Default value. Marks will be displayed only on event day.
+ /// Default value. Marks will be displayed only on the event day.
/// </summary>
Unique,
/// <summary>
- /// Marks will be displayed every day after event day.
+ /// Marks will be displayed every day after the event day.
/// </summary>
Daily,
/// <summary>
- /// Marks will be displayed every week after event day.
+ /// Marks will be displayed every week after the event day.
/// </summary>
Weekly,
/// <summary>
- /// Marks will be displayed every month day that coincides to event day.
+ /// Marks will be displayed every month that coincides to the event day.
/// </summary>
Monthly,
/// <summary>
- /// Marks will be displayed every year that coincides to event day.
+ /// Marks will be displayed every year that coincides to the event day.
/// </summary>
Annually,
/// <summary>
- /// Marks will be displayed every last day of month after event day.
+ /// Marks will be displayed every last day of month after the event day.
/// </summary>
LastDayOfMonth
}
/// <summary>
- /// Enumeration for the mode, which determine how user could select a day.
+ /// Enumeration for the mode, which determines how a user could select a day.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum CalendarSelectMode
{
/// <summary>
- /// Default value. a day is always selected.
+ /// Default value. A day is always selected.
/// </summary>
Default,
None,
/// <summary>
- /// User may have selected a day or not.
+ /// User may have selected a day.
/// </summary>
OnDemand
}
/// <summary>
- /// Enumeration used to define which fields of a tm struct will be taken into account
+ /// Enumeration for defining which fields of a tm struct will be taken into account.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Flags]
public enum CalendarSelectable
{
/// <summary>
- /// None will be taken into account
+ /// None will be taken into account.
/// </summary>
None = 0,
/// <summary>
- /// Year will be taken into account
+ /// Year will be taken into account.
/// </summary>
Year = 1 << 0,
/// <summary>
- /// Month will be taken into account
+ /// Month will be taken into account.
/// </summary>
Month = 1 << 1,
/// <summary>
- /// Day will be taken into account
+ /// Day will be taken into account.
/// </summary>
Day = 1 << 2
}
/// <summary>
- /// The CalendarMark is a Item for marking a Calendar's type,date and repeat type.
+ /// The CalendarMark is an item for marking a Calendar's type, date, and repeat type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CalendarMark
public DateTime Date;
/// <summary>
- /// Repeat the event following this periodicity.
+ /// Repeats the event following this periodicity.
/// </summary>
/// <since_tizen> preview </since_tizen>
public CalendarMarkRepeatType Repeat;
/// <summary>
/// Creates and initializes a new instance of the CalendarMark class.
/// </summary>
- /// <param name="type">Type of mark</param>
- /// <param name="date">Date of inclusion of the mark</param>
- /// <param name="repeat">Repeat type</param>
+ /// <param name="type">Type of mark.</param>
+ /// <param name="date">Date of inclusion of the mark.</param>
+ /// <param name="repeat">Repeat type.</param>
/// <since_tizen> preview </since_tizen>
public CalendarMark(string type, DateTime date, CalendarMarkRepeatType repeat)
{
}
/// <summary>
- /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year and month.
+ /// The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year, and month.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Calendar : Layout
/// Creates and initializes a new instance of the Calendar class.
/// </summary>
/// <param name="parent">
- /// The EvasObject to which the new Calendar will be attached as a child.
+ /// The EvasObject to which the new calendar will be attached as a child.
/// </param>
/// <since_tizen> preview </since_tizen>
public Calendar(EvasObject parent) : base(parent)
}
/// <summary>
- /// Sets or gets the first day of week, who are used on Calendar.
+ /// Sets or gets the first day of the week, which is used on the calendar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime DisplayedTime
}
/// <summary>
- /// Sets or gets the first day of week, who are used on Calendar.
+ /// Sets or gets the first day of the week, which is used on the calendar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DayOfWeek FirstDayOfWeek
}
/// <summary>
- /// Sets or gets the weekdays names to be displayed by the Calendar.
+ /// Sets or gets the weekdays name to be displayed by the calendar.
/// </summary>
/// <remarks>
- /// The usage should be like this;
+ /// The usage should be like this:
/// <![CDATA[List<string> weekDayNames = new List<string>() { "S", "M", "T", "W", "T", "F", "S" };]]>
/// Calendar.WeekDayNames = weekDayNames;
/// </remarks>
/// Sets or gets the selected date.
/// </summary>
/// <remarks>
- /// Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar.
+ /// The selected date changes when the user goes to the next/previous month or selects a day pressing over it on the calendar.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public DateTime SelectedDate
}
/// <summary>
- /// Sets or gets the interval on time updates for an user mouse button
- /// hold on calendar widgets' month/year selection.
+ /// Sets or gets the interval on time updates for a user mouse button
+ /// hold, on the calendar widgets' month/year selection.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Interval
}
/// <summary>
- /// Gets or sets fields of a datetime will be taken into account, when SelectedDate set is invoked.
+ /// Gets or sets the fields of a datetime that will be taken into account, when SelectedDate set is invoked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public CalendarSelectable Selectable
}
/// <summary>
- /// Gets or sets date format the string that will be used to display month and year.
+ /// Gets or sets the date format of the string that will be used to display month and year.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateFormatDelegate DateFormat
}
/// <summary>
- /// Add a new mark to the calendar.
+ /// Adds a new mark to the calendar.
/// </summary>
- /// <param name="type">A string used to define the type of mark. It will be emitted to the theme, that should display a related modification on these days representation.</param>
- /// <param name="date">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.</param>
- /// <param name="repeat">Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually.</param>
+ /// <param name="type">A string used to define the type of mark. It will be emitted to the theme that should display a related modification on these day's representation.</param>
+ /// <param name="date">A time struct to represent the date of inclusion of the mark. For marks that repeat, it will just be displayed after the inclusion date in the calendar.</param>
+ /// <param name="repeat">Repeat the event following this periodicity. Can be a unique mark (that doesn't repeat), daily, weekly, monthly, or annually.</param>
/// <returns>Item for a calendar mark.</returns>
/// <since_tizen> preview </since_tizen>
public CalendarMark AddMark(string type, DateTime date, CalendarMarkRepeatType repeat)
}
/// <summary>
- /// Delete mark from the calendar.
+ /// Deletes a mark from the calendar.
/// </summary>
- /// <param name="mark">Item for a calendar mark</param>
+ /// <param name="mark">Item for a calendar mark.</param>
/// <since_tizen> preview </since_tizen>
public void DeleteMark(CalendarMark mark)
{
}
/// <summary>
- /// Draw calendar marks.
+ /// Draws the calendar marks.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void DrawMarks()
}
/// <summary>
- /// Remove all calendar's marks.
+ /// Removes all the calendar's marks.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearMarks()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
}
}
-}
\ No newline at end of file
+}
namespace ElmSharp
{
/// <summary>
- /// The check is a widget allows for toggling a value between true and false.
+ /// The Check is a widget that allows for toggling a value between true and false.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Check : Layout
/// Creates and initializes a new instance of the Check class.
/// </summary>
/// <param name="parent">
- /// The EvasObject to which the new Check will be attached as a child.
+ /// The EvasObject to which the new check will be attached as a child.
/// </param>
/// <since_tizen> preview </since_tizen>
public Check(EvasObject parent) : base(parent)
}
/// <summary>
- /// StateChanged will be triggered when the IsChecked in the Check is changed.
+ /// StateChanged will be triggered when the IsChecked in the check is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<CheckStateChangedEventArgs> StateChanged;
/// <summary>
- /// Sets or gets whether the given Check is checked or not.
+ /// Sets or gets whether the given check is checked or not.
/// </summary>
/// <remarks>
- /// When object is checked, the value will set to true, Conversely will set to false.
+ /// When an object is checked, the value will be set to true. Conversely, will be set to false.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsChecked
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits System.EventArgs.
- /// The CheckStateChangedEventArgs is EventArgs to record Check's state.
- /// Include old state and new state.
+ /// The CheckStateChangedEventArgs is an EventArgs to record the check's state.
+ /// Include the old state and the new state.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CheckStateChangedEventArgs : EventArgs
{
/// <summary>
- /// Gets the OldState property.The return type is bool.
+ /// Gets the OldState property. The return type is bool.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool OldState { get; private set; }
/// <summary>
- /// Gets the NewState property.The return type is bool.
+ /// Gets the NewState property. The return type is bool.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool NewState { get; private set; }
/// <summary>
/// Creates and initializes a new instance of the CheckStateChangedEventArgs class.
/// </summary>
- /// <param name="oldState">Old state of Check which to use this CheckStateChangedEventArgs.</param>
- /// <param name="newState">New state of Check which to use this CheckStateChangedEventArgs.</param>
+ /// <param name="oldState">Old state of check to use this CheckStateChangedEventArgs.</param>
+ /// <param name="newState">New state of check to use this CheckStateChangedEventArgs.</param>
/// <since_tizen> preview </since_tizen>
public CheckStateChangedEventArgs(bool oldState, bool newState)
{
namespace ElmSharp
{
/// <summary>
- /// The Color is a struct to record Check's state.
+ /// The Color is a struct to record the check's state.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Color
/// Gets a default Color instance.
/// </summary>
/// <remarks>
- /// In default Color instance,Mode type is Default,RGBA all set as -1.
+ /// In the default Color instance, the mode type is default with RGBA all set as -1.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public static Color Default
/// <summary>
/// Gets whether the Color instance's mode is default or not.
- /// Return type is bool.
+ /// The return type is bool.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsDefault
}
/// <summary>
- /// Gets A value of RGBA.
+ /// Gets the A value of RGBA.
/// A means the Alpha in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets R value of RGBA.
+ /// Gets the R value of RGBA.
/// R means the Red in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets G value of RGBA.
+ /// Gets the G value of RGBA.
/// G means the Green in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets B value of RGBA.
+ /// Gets the B value of RGBA.
/// B means the Blue in color.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Creates and initializes a new instance of the Color class.
- /// With RGB parameters.
+ /// Creates and initializes a new instance of the Color class
+ /// with RGB parameters.
/// </summary>
- /// <param name="r">Red of RGB</param>
- /// <param name="g">Green of RGB</param>
- /// <param name="b">Blue of RGB</param>
+ /// <param name="r">Red of RGB.</param>
+ /// <param name="g">Green of RGB.</param>
+ /// <param name="b">Blue of RGB.</param>
/// <since_tizen> preview </since_tizen>
public Color(int r, int g, int b) : this(r, g, b, 255)
{
}
/// <summary>
- /// Creates and initializes a new instance of the Color class.
- /// With RGBA parameters.
+ /// Creates and initializes a new instance of the Color class
+ /// with RGBA parameters.
/// </summary>
- /// <param name="r">Red of RGBA</param>
- /// <param name="g">Green of RGBA</param>
- /// <param name="b">Blue of RGBA</param>
- /// <param name="a">Alpha of RGBA</param>
+ /// <param name="r">Red of RGBA.</param>
+ /// <param name="g">Green of RGBA.</param>
+ /// <param name="b">Blue of RGBA.</param>
+ /// <param name="a">Alpha of RGBA.</param>
/// <since_tizen> preview </since_tizen>
public Color(int r, int g, int b, int a) : this(r, g, b, a, Mode.Rgb)
{
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
+ /// true if the object and this instance are of the same type and represent the same value.
/// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Compare whether two Color instance is same or not.
+ /// Compares whether the two Color instances are same or not.
/// </summary>
/// <param name="a">A Color instance.</param>
/// <param name="b">A Color instance.</param>
- /// <returns>The result whether two instance is same or not.
- /// Return type is bool.If they are same, return true.
+ /// <returns>The result whether the two instances are the same or not.
+ /// Return type is bool. If they are same, return true.
/// </returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Color a, Color b)
}
/// <summary>
- /// Compare whether two Color instance is different or not.
+ /// Compares whether the two Color instances are different or not.
/// </summary>
/// <param name="a">A Color instance.</param>
/// <param name="b">A Color instance.</param>
- /// <returns>The result whether two instance is different or not.
- /// Return type is bool.If they are different, return true.
+ /// <returns>The result whether the two instances are different or not.
+ /// Return type is bool. If they are different, return true.
/// </returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Color a, Color b)
/// Gets a Color instance with a hexadecimal string parameter.
/// </summary>
/// <param name="hex">Hexadecimal string.</param>
- /// <returns>New instance of Color struct.</returns>
+ /// <returns>New instance of the Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromHex(string hex)
{
}
/// <summary>
- /// Gets a Color instance with a Unsigned integer parameter.
+ /// Gets a Color instance with an unsigned integer parameter.
/// </summary>
/// <param name="argb">Unsigned integer indicates RGBA.</param>
- /// <returns>New instance of Color struct.</returns>
+ /// <returns>New instance of the Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromUint(uint argb)
{
/// <summary>
/// Gets a Color instance with R,G,B,A parameters.
/// </summary>
- /// <param name="r">Red in RGBA.</param>
- /// <param name="g">Green in RGBA.</param>
- /// <param name="b">Blue in RGBA.</param>
- /// <param name="a">Alpha in RGBA.</param>
- /// <returns>New instance of Color struct.</returns>
+ /// <param name="r">Red of RGBA.</param>
+ /// <param name="g">Green of RGBA.</param>
+ /// <param name="b">Blue of RGBA.</param>
+ /// <param name="a">Alpha of RGBA.</param>
+ /// <returns>New instance of the Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromRgba(int r, int g, int b, int a)
{
}
/// <summary>
- /// Gets a Color instance with R,G,B,A parameters.
+ /// Gets a Color instance with R,G,B parameters.
/// </summary>
- /// <param name="r">Red in RGB.</param>
- /// <param name="g">Green in RGB.</param>
- /// <param name="b">Blue in RGB.</param>
- /// <returns>New instance of Color struct.</returns>
+ /// <param name="r">Red of RGB.</param>
+ /// <param name="g">Green of RGB.</param>
+ /// <param name="b">Blue of RGB.</param>
+ /// <returns>New instance of the Color struct.</returns>
/// <since_tizen> preview </since_tizen>
public static Color FromRgb(int r, int g, int b)
{
#region Color Definitions
/// <summary>
- /// The Tansparent is a predefined Color, it's rgba value is (0, 0, 0, 0).
+ /// The Tansparent is a predefined Color instance. It's RGBA value is (0, 0, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Transparent = FromRgba(0, 0, 0, 0);
/// <summary>
- /// The Aqua is a predefined Color instance, it's rgb value is (0, 255, 255).
+ /// The Aqua is a predefined Color instance. It's RGB value is (0, 255, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Aqua = FromRgb(0, 255, 255);
/// <summary>
- /// The Black is a predefined Color instance, it's rgb value is (0, 0, 0).
+ /// The Black is a predefined Color instance. It's RGB value is (0, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Black = FromRgb(0, 0, 0);
/// <summary>
- /// The Blue is a predefined Color instance, it's rgb value is (0, 0, 255).
+ /// The Blue is a predefined Color instance. It's RGB value is (0, 0, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Blue = FromRgb(0, 0, 255);
/// <summary>
- /// The Fuchsia is a predefined Color instance, it's rgb value is (255, 0, 255).
+ /// The Fuchsia is a predefined Color instance. It's RGB value is (255, 0, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Fuchsia = FromRgb(255, 0, 255);
/// <summary>
- /// The Gray is a predefined Color instance, it's rgb value is (128, 128, 128).
+ /// The Gray is a predefined Color instance. It's RGB value is (128, 128, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Gray = FromRgb(128, 128, 128);
/// <summary>
- /// The Green is a predefined Color instance, it's rgb value is (0, 128, 0).
+ /// The Green is a predefined Color instance. It's RGB value is (0, 128, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Green = FromRgb(0, 128, 0);
/// <summary>
- /// The Lime is a predefined Color instance, it's rgb value is (0, 255, 0).
+ /// The Lime is a predefined Color instance. It's RGB value is (0, 255, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Lime = FromRgb(0, 255, 0);
/// <summary>
- /// The Maroon is a predefined Color instance, it's rgb value is (128, 0, 0).
+ /// The Maroon is a predefined Color instance. It's RGB value is (128, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Maroon = FromRgb(128, 0, 0);
/// <summary>
- /// The Navy is a predefined Color instance, it's rgb value is (0, 0, 128).
+ /// The Navy is a predefined Color instance. It's RGB value is (0, 0, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Navy = FromRgb(0, 0, 128);
/// <summary>
- /// The Olive is a predefined Color instance, it's rgb value is (128, 128, 0).
+ /// The Olive is a predefined Color instance. It's RGB value is (128, 128, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Olive = FromRgb(128, 128, 0);
/// <summary>
- /// The Orange is a predefined Color instance, it's rgb value is (255, 165, 0).
+ /// The Orange is a predefined Color instance. It's RGB value is (255, 165, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Orange = FromRgb(255, 165, 0);
/// <summary>
- /// The Purple is a predefined Color instance, it's rgb value is (128, 0, 128).
+ /// The Purple is a predefined Color instance. It's RGB value is (128, 0, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Purple = FromRgb(128, 0, 128);
/// <summary>
- /// The Pink is a predefined Color instance, it's rgb value is (255, 102, 255).
+ /// The Pink is a predefined Color instance. It's RGB value is (255, 102, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Pink = FromRgb(255, 102, 255);
/// <summary>
- /// The Red is a predefined Color instance, it's rgb value is (255, 0, 0).
+ /// The Red is a predefined Color instance. It's RGB value is (255, 0, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Red = FromRgb(255, 0, 0);
/// <summary>
- /// The Silver is a predefined Color instance, it's rgb value is (192, 192, 192).
+ /// The Silver is a predefined Color instance. It's RGB value is (192, 192, 192).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Silver = FromRgb(192, 192, 192);
/// <summary>
- /// The Teal is a predefined Color instance, it's rgb value is (0, 128, 128).
+ /// The Teal is a predefined Color instance. It's RGB value is (0, 128, 128).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Teal = FromRgb(0, 128, 128);
/// <summary>
- /// The White is a predefined Color instance, it's rgb value is (255, 255, 255).
+ /// The White is a predefined Color instance. It's RGB value is (255, 255, 255).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color White = FromRgb(255, 255, 255);
/// <summary>
- /// The Yellow is a predefined Color instance, it's rgb value is (255, 255, 0).
+ /// The Yellow is a predefined Color instance. It's RGB value is (255, 255, 0).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static readonly Color Yellow = FromRgb(255, 255, 0);
{
/// <summary>
/// It inherits System.EventArgs.
- /// Event ColorChanged of ColorSelector contain ColorChangedEventArgs as a parameter.
+ /// Event ColorChanged of the ColorSelector contains ColorChangedEventArgs as a parameter.
/// Refer to <see cref="ColorSelector"/>type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ColorChangedEventArgs : EventArgs
{
/// <summary>
- /// Gets old color in color changed event.
+ /// Gets an old color in the color changed event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color OldColor { get; private set; }
/// <summary>
- /// Gets new color in color changed event.
+ /// Gets a new color in the color changed event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color NewColor { get; private set; }
/// <summary>
/// Creates and initializes a new instance of the ColorChangedEventArgs class.
/// </summary>
- /// <param name="oldColor">old color</param>
- /// <param name="newColor">new color</param>
+ /// <param name="oldColor">Old color.</param>
+ /// <param name="newColor">New color.</param>
/// <since_tizen> preview </since_tizen>
public ColorChangedEventArgs(Color oldColor, Color newColor)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for mode of ColorSelector
+ /// Enumeration for the modes of ColorSelector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ColorSelectorMode
{
/// <summary>
- /// Only color palette is displayed, default
+ /// Only the color palette is displayed, by default.
/// </summary>
Palette,
/// <summary>
- /// Only color selector is displayed
+ /// Only the color selector is displayed.
/// </summary>
[Obsolete("Components is obsolete as of version 1.2.3 and is no longer supported.")]
Components,
/// <summary>
- /// Both Palette and selector is displayed
+ /// Both the palette and the selector is displayed.
/// </summary>
[Obsolete("Both is obsolete as of version 1.2.3 and is no longer supported.")]
Both,
/// <summary>
- /// Only color picker is displayed
+ /// Only the color picker is displayed.
/// </summary>
[Obsolete("Picker is obsolete as of version 1.2.3 and is no longer supported.")]
Picker,
/// <summary>
- /// This mode is not supported. If you use this, nothing will be shown
+ /// This mode is not supported. If you use this, nothing will be shown.
/// </summary>
[Obsolete("Plane is obsolete as of version 1.2.3 and is no longer supported.")]
Plane,
/// <summary>
- /// This mode is not supported. If you use this, it will be shown same with Palette mode
+ /// This mode is not supported. If you use this, it will be shown same with the Palette mode.
/// </summary>
[Obsolete("PallettePlane is obsolete as of version 1.2.3 and is no longer supported.")]
PallettePlane,
/// <summary>
- /// This mode is not supported. If you use this, it will be shown same with Palette mode
+ /// This mode is not supported. If you use this, it will be shown same with the Palette mode.
/// </summary>
[Obsolete("All is obsolete as of version 1.2.3 and is no longer supported.")]
All
/// <summary>
/// The ColorSelector is a widget to set a series of colors.
- /// It also allows to load/save colors from/to config with a unique identifier.
+ /// It also allows to load/save colors from/to the configuration with a unique identifier.
/// </summary>
/// <remarks>
- /// By default, the colors are loaded/saved from/to config using "default" identifier.
- /// 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.
+ /// By default, the colors are loaded/saved from/to configuration using the "default" identifier.
+ /// The colors can be picked by the user from the color set by clicking on individual
+ /// color items on the palette, or by selecting it from the selector.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public class ColorSelector : Layout
}
/// <summary>
- /// ColorChanged will be triggered when the SelectedColor changed.
+ /// ColorChanged will be triggered when the SelectedColor is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ColorChangedEventArgs> ColorChanged
}
/// <summary>
- /// Gets or sets color of colorselector.
+ /// Gets or sets the color of colorselector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color SelectedColor
}
/// <summary>
- /// Gets Alpha of a default Color Class(Value is -1).
+ /// Gets the Alpha of a default Color class (value is -1).
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
}
/// <summary>
- /// Gets or sets Colorselector's mode.
+ /// Gets or sets the Colorselector's mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public ColorSelectorMode Mode
}
/// <summary>
- /// Get or set current palette's name.
+ /// Gets or sets the current palette's name.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string PaletteName
}
/// <summary>
- /// Adds a new color item to palette.
+ /// Adds a new color item to the palette.
/// </summary>
- /// <param name="color">Color item to add</param>
+ /// <param name="color">The color item to add.</param>
/// <returns>A new color palette Item.</returns>
/// <since_tizen> preview </since_tizen>
public ColorSelectorItem AddPaletteColor(Color color)
}
/// <summary>
- /// Clear the palette items.
+ /// Clears the palette items.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearPalette()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// A instance to the ColorSelector item added.
+ /// An instance to the ColorSelector item gets added.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ColorSelectorItem : ItemObject
}
/// <summary>
- /// Gets or sets the Palette item's color
+ /// Gets or sets the palette item's color.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color Color
namespace ElmSharp
{
/// <summary>
- /// The check is a widget that can be used in elementary apps
+ /// The Conformant is a widget that can be used in elementary applications
/// to account for space taken up by the indicator,
/// virtual keypad & softkey windows when running the illume2 module of E17.
/// </summary>
/// <summary>
/// Creates and initializes a new instance of the Conformant class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Conformant
- /// as a child.It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by Conformant
+ /// as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Conformant(Window parent) : base(parent)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="Widget"/>.
- /// The Container is a abstract class.
- /// Other class inherits it to Elementary is about displaying
+ /// The Container is an abstract class.
+ /// The other class inherits it to elementary, which is about displaying
/// its widgets in a nice layout.
/// </summary>
/// <since_tizen> preview </since_tizen>
HashSet<EvasObject> _children = new HashSet<EvasObject>();
/// <summary>
- /// Creates and initializes a new instance of class which inherit from Container.
+ /// Creates and initializes a new instance of the class, which inherit from the Container.
/// </summary>
- /// <param name="parent">The parent is a given object which will be attached by Container
- /// as a child.It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given object, which will be attached by the Container
+ /// as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Container(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of Container class.
+ /// Creates and initializes a new instance of the Container class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Container() : base()
}
/// <summary>
- /// Gets the collection of child EvasObject of the Container.
+ /// Gets the collection of a child EvasObject of the Container.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected IEnumerable<EvasObject> Children => _children;
/// <summary>
- /// Add an EvasObject object as a child of Container.
+ /// Add the EvasObject object as a child of the Container.
/// </summary>
- /// <param name="obj">The EvasObject object to be added</param>
+ /// <param name="obj">The EvasObject object to be added.</param>
/// <since_tizen> preview </since_tizen>
protected void AddChild(EvasObject obj)
{
}
/// <summary>
- /// Remove an EvasObject object as a child of Container.
+ /// Removes the EvasObject object as a child of the Container.
/// </summary>
- /// <param name="obj">The EvasObject object to be removed</param>
+ /// <param name="obj">The EvasObject object to be removed.</param>
/// <since_tizen> preview </since_tizen>
protected void RemoveChild(EvasObject obj)
{
}
/// <summary>
- /// Clear all children of the Container.
+ /// Clears all the children of the Container.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected void ClearChildren()
}
/// <summary>
- /// The Container Callback that is invoked when a child is removed.
+ /// The Container callback that is invoked when a child is removed.
/// </summary>
- /// <param name="sender">The called Container</param>
+ /// <param name="sender">The called Container.</param>
/// <param name="a"><see cref="EventArgs"/></param>
void OnChildDeleted(object sender, EventArgs a)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration of ContextPopup direction type.
+ /// Enumeration for the ContextPopup direction types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ContextPopupDirection
{
/// <summary>
- /// ContextPopup show appear below clicked area
+ /// The ContextPopup appears below the clicked area.
/// /// </summary>
Down,
/// <summary>
- /// ContextPopup show appear to the right of the clicked area
+ /// The ContextPopup appears to the right of the clicked area.
/// </summary>
Right,
/// <summary>
- /// ContextPopup show appear to the left of the clicked area
+ /// The ContextPopup appears to the left of the clicked area.
/// </summary>
Left,
/// <summary>
- /// ContextPopup show appear above the clicked area
+ /// The ContextPopup appears above the clicked area.
/// </summary>
Up,
/// <summary>
- /// ContextPopup does not determine it's direction yet
+ /// The ContextPopup does not determine it's direction yet.
/// </summary>
Unknown
}
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The ContextPopup is a widget that when it shown, pops up a list of items.
+ /// The ContextPopup is a widget that when shown, pops up a list of items.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ContextPopup : Layout
/// <summary>
/// Creates and initializes a new instance of the ContextPopup class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by ContextPopup
- /// as a child.It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by ContextPopup
+ /// as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public ContextPopup(EvasObject parent) : base(parent)
{
/// Dismissed is raised when the ContextPopup item is dismissed.
/// </summary>
/// <remarks>
- /// Outside of ContextPopup was clicked or it's parent area is changed or the language is changed. and then ContextPopup is dismissed.
+ /// Outside of ContextPopup is clicked or it's parent area is changed or the language is changed, and then ContextPopup is dismissed.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public event EventHandler Dismissed;
/// Gets the current direction of a ContextPopup.
/// </summary>
/// <remarks>
- /// Once the ContextPopup showed up, the direction would be determined.
+ /// Once the ContextPopup shows up, the direction would be determined.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public ContextPopupDirection Direction
}
/// <summary>
- /// Gets or sets the value of current ContextPopup object's orientation.
- /// True for horizontal mode, False for vertical mode (or errors)
+ /// Gets or sets the value of the current ContextPopup object's orientation.
+ /// True for horizontal mode, False for vertical mode (or errors).
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Gets or sets whether ContextPopup hide automatically
- /// or not when parent of ContextPopup is resized.
+ /// Gets or sets whether the ContextPopup hides automatically
+ /// or not when the parent of the ContextPopup is resized.
/// </summary>
/// <remarks>
/// Default value of AutoHide is False.
}
/// <summary>
- /// Clears all items in the given ContextPopup object.
+ /// Clears all the items in a given ContextPopup object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
/// <summary>
/// Sets the direction priority of a ContextPopup.
/// </summary>
- /// <param name="first">1st priority of direction </param>
- /// <param name="second">2nd priority of direction </param>
- /// <param name="third">3th priority of direction </param>
- /// <param name="fourth">4th priority of direction</param>
+ /// <param name="first">1st priority of the direction.</param>
+ /// <param name="second">2nd priority of the direction.</param>
+ /// <param name="third">3th priority of the direction.</param>
+ /// <param name="fourth">4th priority of the direction.</param>
/// <since_tizen> preview </since_tizen>
public void SetDirectionPriorty(ContextPopupDirection first, ContextPopupDirection second, ContextPopupDirection third, ContextPopupDirection fourth)
{
/// <summary>
/// Gets the direction priority of a ContextPopup.
/// </summary>
- /// <param name="first">1st priority of direction to be returned</param>
- /// <param name="second">2nd priority of direction to be returned</param>
- /// <param name="third">2nd priority of direction to be returned </param>
- /// <param name="fourth">4th priority of direction to be returned</param>
+ /// <param name="first">1st priority of the direction to be returned.</param>
+ /// <param name="second">2nd priority of the direction to be returned.</param>
+ /// <param name="third">2nd priority of the direction to be returned.</param>
+ /// <param name="fourth">4th priority of the direction to be returned.</param>
/// <since_tizen> preview </since_tizen>
public void GetDirectionPriority(out ContextPopupDirection first, out ContextPopupDirection second, out ContextPopupDirection third, out ContextPopupDirection fourth)
{
}
/// <summary>
- /// Adds a new item to a ContextPopup object with label.
+ /// Adds a new item to a ContextPopup object with the label.
/// </summary>
- /// <param name="label">The Label of the new item</param>
+ /// <param name="label">Label of the new item.</param>
/// <returns>
- /// A ContextPopupItem added or NULL, on errors
+ /// A ContextPopupItem added, or null on errors.
/// </returns>
/// <since_tizen> preview </since_tizen>
public ContextPopupItem Append(string label)
}
/// <summary>
- /// Adds a new item to a ContextPopup object with label and icon.
+ /// Adds a new item to a ContextPopup object with the label and icon.
/// </summary>
- /// <param name="label">The Label of the new item</param>
- /// <param name="icon">Icon to be set on new item</param>
- /// <returns>A ContextPopupItem added or NULL, on errors</returns>
+ /// <param name="label">Label of the new item.</param>
+ /// <param name="icon">Icon to be set on the new item.</param>
+ /// <returns>A ContextPopupItem added, or null on errors.</returns>
/// <since_tizen> preview </since_tizen>
public ContextPopupItem Append(string label, EvasObject icon)
{
}
/// <summary>
- /// Dismiss a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted.
+ /// Dismisses a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dismiss()
}
/// <summary>
- /// Gets the possibility that the direction would be available
+ /// Gets the possibility that the direction would be available.
/// </summary>
- /// <param name="direction">A direction user wants to check</param>
+ /// <param name="direction">A direction that the user wants to check.</param>
/// <returns>
- /// Get false if you cannot put it in the direction. Gets true if it's possible.
+ /// Get false if you cannot put it in the direction. Get true if it's possible.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool IsAvailableDirection(ContextPopupDirection direction)
}
/// <summary>
- /// Gets Alpha of a default Color Class.
+ /// Gets the Alpha of a default Color class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="ItemObject"/>.
- /// A instance to the ContextPopup item added.
+ /// An instance to the ContextPopup item is added.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ContextPopupItem : ItemObject
public string Text { get; internal set; }
/// <summary>
- /// Gets the Icon(type is <see cref="EvasObject"/>) property of the given ContextPopupItem.
+ /// Gets the Icon (type is <see cref="EvasObject"/>) property of the given ContextPopupItem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Icon { get; internal set; }
/// <summary>
- /// Selected will be triggered when the ContextPopupItem is Selected.
+ /// Selected will be triggered when the ContextPopupItem is selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
{
/// <summary>
/// It inherits System.EventArgs.
- /// The DateChanged event in Calendar and DateTimeChanged event in DateTimeSelector.
- /// contain DateChangedEventArgs as a parameter.
+ /// The DateChanged event in the Calendar and the DateTimeChanged event in DateTimeSelector
+ /// contain the DateChangedEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DateChangedEventArgs : EventArgs
/// Creates and initializes a new instance of the DateChangedEventArgs class.
/// </summary>
/// <param name="oldDate">
- /// Old date when DateChanged event or DateTimeChanged event triggered
+ /// Old date when the DateChanged event or DateTimeChanged event triggered.
/// </param>
/// <param name="newDate">
- /// New date when DateChanged event or DateTimeChanged event triggered
+ /// New date when the DateChanged event or DateTimeChanged event triggered.
/// </param>
/// <since_tizen> preview </since_tizen>
public DateChangedEventArgs(DateTime oldDate, DateTime newDate)
namespace ElmSharp
{
/// <summary>
- /// Enumeration of datetime field types for DateTimeSelector.
+ /// Enumeration for the datetime field types for DateTimeSelector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum DateTimeFieldType
{
/// <summary>
- /// Indicates Year field.
+ /// Indicates the Year field.
/// </summary>
Year,
/// <summary>
- /// Indicates Month field.
+ /// Indicates the Month field.
/// </summary>
Month,
/// <summary>
- /// Indicates Date field.
+ /// Indicates the Date field.
/// </summary>
Date,
/// <summary>
- /// Indicates Hour field.
+ /// Indicates the Hour field.
/// </summary>
Hour,
/// <summary>
- /// Indicates Minute field.
+ /// Indicates the Minute field.
/// </summary>
Minute,
/// <summary>
- /// Indicates AM/PM field.
+ /// Indicates the AM/PM field.
/// </summary>
AmPm
}
/// <summary>
- /// It inherits <see cref="Layout"/>
- /// DateTimeSelector is a widget to display and input date & time values.
- /// 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.
+ /// It inherits <see cref="Layout"/>.
+ /// The DateTimeSelector is a widget to display and input the date & time values.
+ /// This widget displays the date and time as per the system's locale settings
+ /// (Date includes Day, Month & Year) along with the defined separators and time including hour, minute & AM/PM fields. Separator for the AM/PM field is ignored.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DateTimeSelector : Layout
/// <summary>
/// Creates and initializes a new instance of the DateTimeSelector class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by DateTimeSelector
- ///as a child.It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the DateTimeSelector
+ /// as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public DateTimeSelector(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of DateTimeSelector class.
+ /// Creates and initializes a new instance of the DateTimeSelector class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected DateTimeSelector() : base()
}
/// <summary>
- /// ItemSelected is raised when Datetime field value changed.
+ /// ItemSelected is raised when the DateTime field value is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<DateChangedEventArgs> DateTimeChanged;
/// Gets or sets the datetime format.
/// </summary>
/// <remarks>
- /// format is a combination of allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p".
+ /// Format is a combination of the allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p".
/// </remarks>
/// <since_tizen> preview </since_tizen>
public string Format
}
/// <summary>
- /// Gets or sets the upper boundary of DateTime field.
+ /// Gets or sets the upper boundary of the DateTime field.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime MaximumDateTime
}
/// <summary>
- /// Gets or sets the lower boundary of DateTime field.
+ /// Gets or sets the lower boundary of the DateTime field.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime MinimumDateTime
}
/// <summary>
- /// Gets or sets the current value of DateTime field.
+ /// Gets or sets the current value of the DateTime field.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DateTime DateTime
/// <summary>
/// Gets whether a field can be visible.
/// </summary>
- /// <param name="type">Enumeration <see cref="DateTimeFieldType"/></param>
+ /// <param name="type">Enumeration for <see cref="DateTimeFieldType"/>.</param>
/// <returns>
/// The field is visible or not.
- /// Type is bool.If visible, return true.
+ /// Type is bool. If visible, return true.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool IsFieldVisible(DateTimeFieldType type)
/// <summary>
/// Sets the field limits of a field.
/// </summary>
- /// <param name="type">Enumeration <see cref="DateTimeFieldType"/></param>
- /// <param name="minimum">minimum limit</param>
- /// <param name="maximum">maximum limit</param>
+ /// <param name="type">Enumeration for <see cref="DateTimeFieldType"/>.</param>
+ /// <param name="minimum">The minimum limit.</param>
+ /// <param name="maximum">The maximum limit.</param>
/// <since_tizen> preview </since_tizen>
public void SetFieldLimit(DateTimeFieldType type, int minimum, int maximum)
{
/// <summary>
/// Gets whether a field can be visible.
/// </summary>
- /// <param name="type">Enumeration <see cref="DateTimeFieldType"/></param>
- /// <param name="visible">When set as true, the field type visible.</param>
+ /// <param name="type">Enumeration for <see cref="DateTimeFieldType"/>.</param>
+ /// <param name="visible">When set as true, the field type is visible.</param>
/// <since_tizen> preview </since_tizen>
public void SetFieldVisible(DateTimeFieldType type, bool visible)
{
}
/// <summary>
- /// The callback of Realized Event
+ /// The callback of the Realized event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits System.EventArgs.
- /// The DisplayedMonthChangedEvent in Calendar contain
+ /// The DisplayedMonthChangedEvent in a calendar contains the
/// DisplayedMonthChangedEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// Creates and initializes a new instance of the DisplayedMonthChangedEventArgs class.
/// </summary>
/// <param name="oldMonth">
- /// old month of date when DisplayedMonthChangedEvent triggered.
+ /// Old month of the date when the DisplayedMonthChangedEvent triggered.
/// </param>
/// <param name="newMonth">
- /// new month of date when DisplayedMonthChangedEvent triggered.
+ /// New month of the date when the DisplayedMonthChangedEvent triggered.
/// </param>
/// <since_tizen> preview </since_tizen>
public DisplayedMonthChangedEventArgs(int oldMonth, int newMonth)
namespace ElmSharp
{
/// <summary>
- /// EcoreAnimator is a helper class, it provides functions to manager animations.
+ /// EcoreAnimator is a helper class. It provides the functions to manage animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class EcoreAnimator
}
/// <summary>
- /// Gets current system time as a floating point value in seconds.
+ /// Gets the current system time as a floating point value in seconds.
/// </summary>
/// <returns>Current system time</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Adds an animator to call <paramref name="handler"/> at every animation tick during main loop execution.
+ /// Adds an animator to call <paramref name="handler"/> at every animation tick during the main loop execution.
/// </summary>
- /// <param name="handler">The function to call when it ticks off</param>
- /// <returns>A handle to the new animator</returns>
+ /// <param name="handler">The function to call when it ticks off.</param>
+ /// <returns>A handle to the new animator.</returns>
/// <since_tizen> preview </since_tizen>
public static IntPtr AddAnimator(Func<bool> handler)
{
/// <summary>
/// Removes the specified animator from the animator list.
/// </summary>
- /// <param name="anim">The specified animator handle</param>
+ /// <param name="anim">The specified animator handle.</param>
/// <since_tizen> preview </since_tizen>
public static void RemoveAnimator(IntPtr anim)
{
namespace ElmSharp
{
/// <summary>
- /// The EcoreEventType is type of EcoreEvent.
+ /// The EcoreEventType is a type of EcoreEvent.
/// It includes some predefined instance.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// The EcoreEvent is a class to help to create events are being notified of events.
+ /// The EcoreEvent is a class to help create events that are being notified of events.
/// </summary>
- /// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam>
+ /// <typeparam name="TEventArgs">Kinds of EventArgs.</typeparam>
/// <since_tizen> preview </since_tizen>
public class EcoreEvent<TEventArgs> : IDisposable where TEventArgs : EventArgs
{
/// <summary>
- /// EventInfoParser delegate of EcoreEvent class
+ /// EventInfoParser delegate of the EcoreEvent class.
/// </summary>
/// <param name="data">IntPtr</param>
/// <param name="type">EcoreEventType</param>
}
/// <summary>
- /// Destructor for EcoreEvent class.
+ /// Destructor for the EcoreEvent class.
/// </summary>
~EcoreEvent()
{
}
/// <summary>
- /// On Event Handler of EcoreEvent.
+ /// On Event Handler of the EcoreEvent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<TEventArgs> On
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if managed resources should be disposed
- /// otherwise, false.
+ /// true if the managed resources should be disposed,
+ /// otherwise false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Event class for EcoreEvent
+ /// The event class for EcoreEvent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreEvent : EcoreEvent<EventArgs>
{
/// <summary>
/// It inherits System.EventArgs.
- /// The EcoreKeyEventArgs is a EventArgs to record Ecore event's key name and key code.
+ /// The EcoreKeyEventArgs is an EventArgs to record the Ecore event's key name and key code.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreKeyEventArgs : EventArgs
{
/// <summary>
- /// Gets the KeyName property.The return type is string.
+ /// Gets the KeyName property. The return type is string.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string KeyName { get; private set; }
/// <summary>
- /// Gets the KeyCode property.The return type is int.
+ /// Gets the KeyCode property. The return type is int.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int KeyCode { get; private set; }
/// </summary>
/// <param name="data">data</param>
/// <param name="type">type</param>
- /// <param name="info">information </param>
- /// <returns>new instance of the EcoreKeyEventArgs class</returns>
+ /// <param name="info">information</param>
+ /// <returns>New instance of the EcoreKeyEventArgs class.</returns>
/// <since_tizen> preview </since_tizen>
public static EcoreKeyEventArgs Create(IntPtr data, EcoreEventType type, IntPtr info)
{
namespace ElmSharp
{
/// <summary>
- /// EcoreMainloop is a helper class, it provide functions relative Ecore's main loop.
+ /// EcoreMainloop is a helper class, which provides the functions relative to Ecore's main loop.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class EcoreMainloop
/// <summary>
/// Checks if you are calling this function from the main thread.
/// </summary>
- /// <remarks>True is the calling function is the same thread, false otherwise.</remarks>
+ /// <remarks>True if the calling function is the same thread, false otherwise.</remarks>
/// <since_tizen> preview </since_tizen>
public static bool IsMainThread => Interop.Eina.eina_main_loop_is();
}
/// <summary>
- /// Quits the main loop once all the events currently on the queue have been processed.
+ /// Quits the main loop, once all the events currently on the queue have been processed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void Quit()
/// <summary>
/// Adds an idler handler.
/// </summary>
- /// <param name="task">The action to call when idling</param>
+ /// <param name="task">The action to call when idle.</param>
/// <since_tizen> preview </since_tizen>
public static void Post(Action task)
{
}
/// <summary>
- /// Calls callback asynchronously in the main loop.
+ /// Calls the callback asynchronously in the main loop.
/// </summary>
- /// <param name="task">The action wanted to be called</param>
+ /// <param name="task">The action wanted to be called.</param>
/// <since_tizen> preview </since_tizen>
public static void PostAndWakeUp(Action task)
{
}
/// <summary>
- /// Calls callback synchronously in the main loop.
+ /// Calls the callback synchronously in the main loop.
/// </summary>
- /// <param name="task">The action wanted to be called</param>
+ /// <param name="task">The action wanted to be called.</param>
/// <since_tizen> preview </since_tizen>
public static void Send(Action task)
{
/// </summary>
/// <param name="interval">The interval in seconds.</param>
/// <param name="handler">The given function.</param>
- /// <returns>A timer object handler on success, NULL on failure.</returns>
+ /// <returns>A timer object handler on success, or null on failure.</returns>
/// <since_tizen> preview </since_tizen>
public static IntPtr AddTimer(double interval, Func<bool> handler)
{
{
/// <summary>
- /// Provides a synchronization context for the efl application.
+ /// Provides a synchronization context for the EFL application.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreSynchronizationContext : SynchronizationContext
}
/// <summary>
- /// Initilizes a new EcoreSynchronizationContext and install into current thread
+ /// Initilizes a new EcoreSynchronizationContext and installs into the current thread.
/// </summary>
/// <remarks>
/// It is equivalent
}
/// <summary>
- /// Dispatches a synchronous message to a Ecore main loop
+ /// Dispatches an synchronous message to a Ecore main loop.
/// </summary>
/// <param name="d"><see cref="System.Threading.SendOrPostCallback"/>The SendOrPostCallback delegate to call.</param>
/// <param name="state"><see cref="System.Object"/>The object passed to the delegate.</param>
namespace ElmSharp
{
/// <summary>
- /// EcoreTimelineAnimator is a helper class, it provides functions to manager animations.
+ /// EcoreTimelineAnimator is a helper class, which provides the functions to manage animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EcoreTimelineAnimator
/// <summary>
/// Creates and initializes a new instance of the EcoreTimelineAnimator class.
/// </summary>
- /// <param name="runtime">The time to run in seconds</param>
- /// <param name="timelineCallback">Functions called at each time line</param>
+ /// <param name="runtime">The time to run in seconds.</param>
+ /// <param name="timelineCallback">Functions called at each time line.</param>
/// <since_tizen> preview </since_tizen>
public EcoreTimelineAnimator(double runtime, Action timelineCallback)
{
public double Position => _position;
/// <summary>
- /// Starts an animator that runs for a limited time.for a limited time.
+ /// Starts an animator that runs for a limited time.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Start()
}
/// <summary>
- /// Stops an animator that running.
+ /// Stops an animator that is running.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Stop()
}
/// <summary>
- /// Callback that is called when ticks off
+ /// Callback is called when it ticks off.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected void OnTimeline()
namespace ElmSharp
{
/// <summary>
- /// The EdjeObject is a class that evas object exist in
+ /// The EdjeObject is a class that the evas object exists in.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EdjeObject
/// Checks whether an edje part exists in a given edje object's group definition.
/// This function returns if a given part exists in the edje group bound to object obj
/// </summary>
- /// <remarks>This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj.</remarks>
- /// <param name="part">The part's name to check for existence in obj's group</param>
- /// <returns>TRUE, if the edje part exists in obj's group, otherwise FALSE</returns>
+ /// <remarks>This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to object.</remarks>
+ /// <param name="part">The part's name to check for existence in object's group.</param>
+ /// <returns>TRUE, if the edje part exists in the object's group, otherwise FALSE.</returns>
/// <since_tizen> preview </since_tizen>
public EdjeTextPartObject this[string part]
{
}
/// <summary>
- /// Sends/emits an edje signal to a given edje object.
+ /// Sends or emits an edje signal to a given edje object.
/// </summary>
/// <param name="emission">The signal's "emission" string</param>
/// <param name="source">The signal's "source" string</param>
}
/// <summary>
- /// Deletes the object color class.
- /// This function deletes any values at the object level for the specified object and color class.
+ /// Deletes the object Color class.
+ /// This function deletes any values at the object level for the specified object and Color class.
/// </summary>
- /// <remarks>Deleting the color class defined in the theme file.</remarks>
- /// <param name="part">The color class to be deleted</param>
+ /// <remarks>Deleting the Color class defined in the theme file.</remarks>
+ /// <param name="part">The Color class to be deleted.</param>
/// <since_tizen> preview </since_tizen>
public void DeleteColorClass(string part)
{
}
/// <summary>
- /// Sets the object color class.
+ /// Sets the object Color class.
/// </summary>
- /// <param name="colorClass">The color class name.</param>
- /// <param name="red">The object Red value.</param>
- /// <param name="green">The object Green value.</param>
- /// <param name="blue">The object Blue value.</param>
- /// <param name="alpha">The object Alpha value.</param>
- /// <param name="outlineRed">The outline Red value.</param>
- /// <param name="outlineGreen">The outline Green value.</param>
- /// <param name="outlineBlue">The outline Blue value.</param>
- /// <param name="outlineAlpha">The outline Alpha value.</param>
- /// <param name="shadowRed">The shadow Red value.</param>
- /// <param name="shadowGreen">The shadow Green value.</param>
- /// <param name="shadowBlue">The shadow Blue value.</param>
- /// <param name="shadowAlpha">The shadow Alpha value.</param>
- /// <returns>True if succeed, otherwise False</returns>
+ /// <param name="colorClass">The Color class name.</param>
+ /// <param name="red">The object red value.</param>
+ /// <param name="green">The object green value.</param>
+ /// <param name="blue">The object blue value.</param>
+ /// <param name="alpha">The object alpha value.</param>
+ /// <param name="outlineRed">The outline red value.</param>
+ /// <param name="outlineGreen">The outline green value.</param>
+ /// <param name="outlineBlue">The outline blue value.</param>
+ /// <param name="outlineAlpha">The outline alpha value.</param>
+ /// <param name="shadowRed">The shadow red value.</param>
+ /// <param name="shadowGreen">The shadow green value.</param>
+ /// <param name="shadowBlue">The shadow blue value.</param>
+ /// <param name="shadowAlpha">The shadow alpha value.</param>
+ /// <returns>True if succeeds, otherwise False.</returns>
/// <since_tizen> preview </since_tizen>
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)
}
/// <summary>
- /// Gets the object color class.
+ /// Gets the object Color class.
/// </summary>
- /// <param name="colorClass">The color class name.</param>
- /// <param name="red">The object Red value.</param>
- /// <param name="green">The object Green value.</param>
- /// <param name="blue">The object Blue value.</param>
- /// <param name="alpha">The object Alpha value.</param>
- /// <param name="outlineRed">The outline Red value.</param>
- /// <param name="outlineGreen">The outline Green value.</param>
- /// <param name="outlineBlue">The outline Blue value.</param>
- /// <param name="outlineAlpha">The outline Alpha value.</param>
- /// <param name="shadowRed">The shadow Red value.</param>
- /// <param name="shadowGreen">The shadow Green value.</param>
- /// <param name="shadowBlue">The shadow Blue value.</param>
- /// <param name="shadowAlpha">The shadow Alpha value.</param>
- /// <returns>True if succeed, otherwise False</returns>
+ /// <param name="colorClass">The Color class name.</param>
+ /// <param name="red">The object red value.</param>
+ /// <param name="green">The object green value.</param>
+ /// <param name="blue">The object blue value.</param>
+ /// <param name="alpha">The object alpha value.</param>
+ /// <param name="outlineRed">The outline red value.</param>
+ /// <param name="outlineGreen">The outline green value.</param>
+ /// <param name="outlineBlue">The outline blue value.</param>
+ /// <param name="outlineAlpha">The outline alpha value.</param>
+ /// <param name="shadowRed">The shadow red value.</param>
+ /// <param name="shadowGreen">The shadow green value.</param>
+ /// <param name="shadowBlue">The shadow blue value.</param>
+ /// <param name="shadowAlpha">The shadow alpha value.</param>
+ /// <returns>True if succeeds, otherwise False.</returns>
/// <since_tizen> preview </since_tizen>
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)
}
/// <summary>
- /// Sets Edje text class.
+ /// Sets the Edje text class.
/// </summary>
/// <param name="textClass">The text class name.</param>
- /// <param name="font"> Font name.</param>
+ /// <param name="font">Font name.</param>
/// <param name="fontSize">Font size.</param>
- /// <returns>True if succeed, otherwise False</returns>
+ /// <returns>True if succeeds, otherwise False.</returns>
/// <since_tizen> preview </since_tizen>
public bool SetTextClass(string textClass, string font, int fontSize)
{
}
/// <summary>
- /// Gets Edje text class.
+ /// Gets the Edje text class.
/// </summary>
/// <param name="textClass">The text class name.</param>
/// <param name="font">Font name.</param>
/// <param name="fontSize">Font size.</param>
- /// <returns>True if succeed, otherwise False</returns>
+ /// <returns>True if succeeds, otherwise False.</returns>
/// <since_tizen> preview </since_tizen>
public bool GetTextClass(string textClass, out string font, out int fontSize)
{
/// <summary>
/// Adds Action for an arriving edje signal, emitted by a given Ejde object.
/// </summary>
- /// <param name="emission">The signal's "emission" string</param>
- /// <param name="source">The signal's "source" string</param>
- /// <param name="action">The action to be executed when the signal is emitted</param>
+ /// <param name="emission">The signal's "emission" string.</param>
+ /// <param name="source">The signal's "source" string.</param>
+ /// <param name="action">The action to be executed when the signal is emitted.</param>
/// <since_tizen> preview </since_tizen>
public void AddSignalAction(string emission, string source, Action<string, string> action)
{
/// <summary>
/// Deletes a signal-triggered action from an object.
/// </summary>
- /// <param name="emission">The signal's "emission" string</param>
- /// <param name="source">The signal's "source" string</param>
- /// <param name="action">The action to be executed when the signal is emitted</param>
+ /// <param name="emission">The signal's "emission" string.</param>
+ /// <param name="source">The signal's "source" string.</param>
+ /// <param name="action">The action to be executed when the signal is emitted.</param>
/// <since_tizen> preview </since_tizen>
public void DeleteSignalAction(string emission, string source, Action<string, string> action)
{
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
+ /// true if the object and this instance are of the same type and represent the same value.
/// otherwise, false.
/// </returns>
public override bool Equals(object obj)
}
/// <summary>
- /// An EdjeTextPartObject is a class dealing with parts of type text.
+ /// The EdjeTextPartObject is a class dealing with parts of type text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EdjeTextPartObject
}
/// <summary>
- /// Gets the name of the EdjeTextPartObject
+ /// Gets the name of the EdjeTextPartObject.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Name { get { return _part; } }
namespace ElmSharp
{
/// <summary>
- /// EffectBase class for the TransitEffect
+ /// The EffectBase class for TransitEffect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class EffectBase
{
/// <summary>
- /// EffectEneded event will be triggered when be effect ended.
+ /// EffectEnded event will be triggered when the effect has ended.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler EffectEnded;
namespace ElmSharp
{
/// <summary>
- /// Focus Autoscroll Mode
+ /// Focus Autoscroll mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FocusAutoScrollMode
{
/// <summary>
- /// Directly show the focused region or item automatically
+ /// Directly show the focused region or item automatically.
/// </summary>
Show,
/// <summary>
- /// Do not show the focused region or item automatically
+ /// Do not show the focused region or item automatically.
/// </summary>
None,
/// <summary>
- /// Bring in the focused region or item automatically which might invole the scrolling
+ /// Bring in the focused region or item automatically, which might involve the scrolling.
/// </summary>
BringIn
}
/// <summary>
- /// The Elementary is a General Elementary,a VERY SIMPLE toolkit.
+ /// The Elementary is a general elementary, a VERY SIMPLE toolkit.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class Elementary
}
/// <summary>
- /// Gets or sets the enable status of the focus highlight animation
+ /// Gets or sets the enable status of the focus highlight animation.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static bool IsFocusHighlightAnimation
}
/// <summary>
- /// Gets or sets the amount of inertia a scroller imposes during region bring animations.
+ /// Gets or sets the amount of inertia, a scroller imposes during a region to bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static double BringInScrollFriction
}
/// <summary>
- /// Gets of sets focus auto scroll mode.
+ /// Gets or sets the focus on autoscroll mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static FocusAutoScrollMode FocusAutoScrollMode
}
/// <summary>
- /// Runs Elementary's main loop.
+ /// Runs the elementary's main loop.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void Run()
}
/// <summary>
- /// Prepends a theme overlay to the list of overlays
+ /// Prepends a theme overlay to the list of overlays.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Prepends a theme overlay to the list of overlays
+ /// Prepends a theme overlay to the list of overlays.
/// </summary>
- /// <param name="filePath">The Edje file path to be used.</param>
+ /// <param name="filePath">The edje file path to be used.</param>
/// <since_tizen> preview </since_tizen>
public static void AddThemeOverlay(string filePath)
{
}
/// <summary>
- /// Delete a theme overlay from the list of overlays
+ /// Deletes a theme overlay from the list of overlays.
/// </summary>
/// <param name="filePath">The name of the theme overlay.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Free a theme
+ /// Frees a theme.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FreeTheme()
}
/// <summary>
- /// Set the theme search order for the given theme
+ /// Sets the theme search order for the given theme.
/// </summary>
- /// <param name="theme">Theme search string</param>
- /// <remarks>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"</remarks>
+ /// <param name="theme">Theme search string.</param>
+ /// <remarks>This sets the search string for the theme in path-notation from the first theme to search, to last, delimited by the : character. For example, "shiny:/path/to/file.edj:default".</remarks>
/// <since_tizen> preview </since_tizen>
public static void SetTheme(string theme)
{
}
/// <summary>
- /// Flush the current theme.
+ /// Flushes the current theme.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushTheme()
}
/// <summary>
- /// This flushes all themes (default and specific ones).
+ /// This flushes all the themes (default and specific ones).
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushAllThemes()
}
/// <summary>
- /// Gets the amount of inertia a scroller imposes during region bring animations.
+ /// Gets the amount of inertia that a scroller imposes during region to bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Sets the amount of inertia a scroller imposes during region bring animations.
+ /// Sets the amount of inertia that a scroller imposes during the region bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Get Elementary's profile in use
+ /// Gets the elementary's profile in use.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Set the global scaling factor
+ /// Sets the global scaling factor.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Get the global scaling factor
+ /// Gets the global scaling factor.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// 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.
+ /// Flushes all the cache.
+ /// 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushAllCashe()
/// <summary>
/// Changes the language of the current application.
/// </summary>
- /// <param name="language">The language to set, must be the full name of the locale.</param>
+ /// <param name="language">The language to set must be the full name of the locale.</param>
/// <since_tizen> preview </since_tizen>
public static void SetLanguage(string language)
{
/// <summary>
/// Sets a new policy's value (for a given policy group/identifier).
/// </summary>
- /// <param name="policy">The policy identifier</param>
- /// <param name="value">The policy value, which depends on the identifier</param>
+ /// <param name="policy">The policy identifier.</param>
+ /// <param name="value">The policy value, which depends on the identifier.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public static bool SetPolicy(uint policy, int value)
}
/// <summary>
- /// Reload Elementary's configuration, bounded to current selected profile.
+ /// Reloads the elementary's configuration, bounded to the current selected profile.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Flushes all config settings and then applies those settings to all applications using elementary on the current display.
+ /// Flushes all the configuration settings, and then applies those settings to all applications using elementary on the current display.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void FlushAllConfig()
namespace ElmSharp
{
/// <summary>
- /// The ElmScrollConfig is a scrollable views's config
+ /// The ElmScrollConfig is a scrollable views's configuration.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class ElmScrollConfig
{
/// <summary>
- /// Gets or sets the amount of inertia a scroller imposes during region bring animations.
+ /// Gets or sets the amount of inertia that a scroller imposes during the region to bring animations.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
namespace ElmSharp
{
/// <summary>
- /// Enumeration for describing InputPanel layout type.
+ /// Enumeration for describing the InputPanel layout types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum InputPanelLayout
{
/// <summary>
- /// InputPanel layout type default.
+ /// The InputPanel layout type default.
/// </summary>
Normal,
/// <summary>
- /// InputPanel layout type number.
+ /// The InputPanel layout type number.
/// </summary>
Number,
/// <summary>
- /// InputPanel layout type email.
+ /// The InputPanel layout type email.
/// </summary>
Email,
/// <summary>
- /// InputPanel layout type url.
+ /// The InputPanel layout type URL.
/// </summary>
Url,
/// <summary>
- /// InputPanel layout type phone.
+ /// The InputPanel layout type phone.
/// </summary>
PhoneNumber,
/// <summary>
- /// InputPanel layout type ip.
+ /// The InputPanel layout type IP.
/// </summary>
Ip,
/// <summary>
- /// InputPanel layout type month.
+ /// The InputPanel layout type month.
/// </summary>
Month,
/// <summary>
- /// InputPanel layout type number.
+ /// The InputPanel layout type number.
/// </summary>
NumberOnly,
/// <summary>
- /// InputPanel layout type error type. Do not use it directly!
+ /// The InputPanel layout type error type. Do not use it directly!
/// </summary>
Invalid,
/// <summary>
- /// InputPanel layout type hexadecimal.
+ /// The InputPanel layout type hexadecimal.
/// </summary>
Hex,
/// <summary>
- /// InputPanel layout type terminal type, esc, alt, ctrl, etc.
+ /// The InputPanel layout type terminal type: Esc, Alt, Ctrl, etc.
/// </summary>
Terminal,
/// <summary>
- /// InputPanel layout type password.
+ /// The InputPanel layout type password.
/// </summary>
Password,
/// <summary>
- /// Keyboard layout type date and time.
+ /// The keyboard layout type date and time.
/// </summary>
DateTime,
/// <summary>
- /// InputPanel layout type emoticons.
+ /// The InputPanel layout type emoticons.
/// </summary>
Emoticon
}
/// <summary>
- /// Enumeration that defines the "Return" key types on the input panel (virtual keyboard).
+ /// Enumeration for defining the "Return" key types on the input panel (virtual keyboard).
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum InputPanelReturnKeyType
{
/// <summary>
- /// Default key type
+ /// The Default key type.
/// </summary>
Default,
/// <summary>
- /// Done key type
+ /// The Done key type.
/// </summary>
Done,
/// <summary>
- /// Go key type
+ /// The Go key type.
/// </summary>
Go,
/// <summary>
- /// Join key type
+ /// The Join key type.
/// </summary>
Join,
/// <summary>
- /// Login key type
+ /// The Login key type.
/// </summary>
Login,
/// <summary>
- /// Next key type
+ /// The Next key type.
/// </summary>
Next,
/// <summary>
- /// Search string or magnifier icon key type
+ /// The Search string or magnifier icon key type.
/// </summary>
Search,
/// <summary>
- /// Send key type
+ /// The Send key type.
/// </summary>
Send,
/// <summary>
- /// Sign-in key type
+ /// The Sign-in key type.
/// </summary>
Signin
}
/// <summary>
- /// Enumeration that defines the autocapitalization types.
+ /// Enumeration for defining the autocapitalization types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum AutoCapital
{
/// <summary>
- /// No autocapitalization when typing
+ /// No autocapitalization when typing.
/// </summary>
None,
/// <summary>
- /// Autocapitalize each typed word
+ /// Autocapitalize each of the typed word.
/// </summary>
Word,
/// <summary>
- /// Autocapitalize the start of each sentence
+ /// Autocapitalize the start of each sentence.
/// </summary>
Sentence,
/// <summary>
- /// Autocapitalize all letters
+ /// Autocapitalize all the letters.
/// </summary>
All
}
/// <summary>
- /// Enumeration that defines the entry's copy and paste policy.
+ /// Enumeration for defining the entry's copy and paste policy.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum CopyAndPasteMode
{
/// <summary>
- /// Copy and paste text with markup tag
+ /// Copy and paste text with a markup tag.
/// </summary>
Markup,
/// <summary>
- /// Copy and paste text without item(image) tag
+ /// Copy and paste text without an item (image) tag.
/// </summary>
NoImage,
/// <summary>
- /// Copy and paste text without markup tag
+ /// Copy and paste text without a markup tag.
/// </summary>
PlainText
}
/// <summary>
- /// Enumeration that defines the text format types.
+ /// Enumeration for the text format types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum TextFormat
{
/// <summary>
- /// Plain type
+ /// Plain type.
/// </summary>
Plain,
/// <summary>
- /// Markup type
+ /// Markup type.
/// </summary>
Markup
}
public enum InputHints
{
/// <summary>
- /// No active hints
+ /// No active hints.
/// </summary>
None,
/// <summary>
- /// suggest word auto completion
+ /// Suggest word auto-completion.
/// </summary>
AutoComplete,
/// <summary>
- /// typed text should not be stored.
+ /// The typed text should not be stored.
/// </summary>
SensitiveData,
}
/// <summary>
- /// Enumeration that defines the input panel (virtual keyboard) language modes.
+ /// Enumeration for defining the input panel (virtual keyboard) language modes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum InputPanelLanguage
{
/// <summary>
- /// Automatic language mode
+ /// Automatic language mode.
/// </summary>
Automatic,
/// <summary>
- /// Alphabet language mode
+ /// Alphabet language mode.
/// </summary>
Alphabet,
}
/// <summary>
- /// The entry is a convenience widget that shows a box in which the user can enter text.
+ /// The Entry is a convenience widget that shows a box in which the user can enter text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Entry : Layout
}
/// <summary>
- /// Activated will be triggered when the entry in Activated stated.
+ /// Activated will be triggered when the entry is activated.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Activated;
public event EventHandler Clicked;
/// <summary>
- /// ChangedByUser will be triggered when the entry changed by user.
+ /// ChangedByUser will be triggered when the entry is changed by user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ChangedByUser;
/// <summary>
- /// CursorChanged will be triggered when the Cursor in the entry is changed.
+ /// CursorChanged will be triggered when the cursor in the entry is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler CursorChanged;
}
/// <summary>
- /// Sets or gets text currently shown in the object entry.
+ /// Sets or gets the text currently shown in the object entry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override string Text
}
/// <summary>
- /// Sets or gets the style on the top of the user style stack.
+ /// Sets or gets the style on top of the user style stack.
/// </summary>
- /// <remarks>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').</remarks>
+ /// <remarks>If there are styles in the user style stack, the properties in the top style of the user style stack will replace the properties in current theme. The input style is specified in the format, tag='property=value' (i.e., DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').</remarks>
/// <since_tizen> preview </since_tizen>
public string TextStyle
{
}
/// <summary>
- /// Sets or Gets the autocapitalization type on the immodule.
+ /// Sets or gets the autocapitalization type on the immodule.
/// </summary>
/// <since_tizen> preview </since_tizen>
public AutoCapital AutoCapital
}
/// <summary>
- /// Sets or Gets the entry object's 'autosave' status.
+ /// Sets or gets the entry object's 'autosave' status.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsAutoSave
}
/// <summary>
- /// Sets or Gets entry text paste/drop mode.
+ /// Sets or gets the entry text paste/drop mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public CopyAndPasteMode CopyAndPasteMode
}
/// <summary>
- /// Sets or Gets the value of input hint.
+ /// Sets or gets the value of the input hint.
/// </summary>
/// <since_tizen> preview </since_tizen>
public InputHints InputHint
}
/// <summary>
- /// Sets or gets the line wrap type to use on multi-line entries.
+ /// Sets or gets the line wrap type to use on multiline entries.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WrapType LineWrapType
}
/// <summary>
- /// Sets or gets the attribute to show the input panel in case of only an user's explicit Mouse Up event.
+ /// Sets or gets the attribute to show the input panel, in case of only an user's explicit Mouse Up event.
/// 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.)
+ /// If true, the input panel will be shown only in case of the Mouse up event (Focus event will be ignored).
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool InputPanelShowByOnDemand
/// <summary>
/// Sets the file (and implicitly loads it) for the text to display and then edit.
/// </summary>
- /// <param name="file">The path to the file to load and save</param>
- /// <param name="textFormat">The file format</param>
+ /// <param name="file">The path to the file to load and save.</param>
+ /// <param name="textFormat">The file format.</param>
/// <since_tizen> preview </since_tizen>
public void SetFile(string file, TextFormat textFormat)
{
/// <summary>
/// Converts a markup (HTML-like) string into UTF-8.
/// </summary>
- /// <param name="markup">The string (in markup) to be converted</param>
- /// <returns>The converted string (in UTF-8) </returns>
+ /// <param name="markup">The string (in markup) to be converted.</param>
+ /// <returns>The converted string (in UTF-8).</returns>
/// <since_tizen> preview </since_tizen>
public static string ConvertMarkupToUtf8(string markup)
{
/// <summary>
/// Moves the cursor one place to the left within the entry.
/// </summary>
- /// <returns>TRUE on success, otherwise FALSE on failure</returns>
+ /// <returns>TRUE on success, otherwise FALSE on failure.</returns>
/// <since_tizen> preview </since_tizen>
public bool MoveCursorPrev()
{
/// <summary>
/// Moves the cursor one line up within the entry.
/// </summary>
- /// <returns>TRUE on success, otherwise FALSE on failure</returns>
+ /// <returns>TRUE on success, otherwise FALSE on failure.</returns>
/// <since_tizen> preview </since_tizen>
public bool MoveCursorUp()
{
/// <summary>
/// Moves the cursor one line down within the entry.
/// </summary>
- /// <returns>TRUE on success, otherwise FALSE on failure</returns>
+ /// <returns>TRUE on success, otherwise FALSE on failure.</returns>
/// <since_tizen> preview </since_tizen>
public bool MoveCursorDown()
{
/// <summary>
/// Sets the input panel layout of the entry.
/// </summary>
- /// <param name="layout">The layout type</param>
+ /// <param name="layout">The layout type.</param>
/// <since_tizen> preview </since_tizen>
public void SetInputPanelLayout(InputPanelLayout layout)
{
/// <summary>
/// Sets the attribute to show the input panel automatically.
/// </summary>
- /// <param name="enabled">If true the input panel appears when the entry is clicked or has focus, otherwise false</param>
+ /// <param name="enabled">If true, the input panel appears when the entry is clicked or has focus, otherwise false.</param>
/// <since_tizen> preview </since_tizen>
public void SetInputPanelEnabled(bool enabled)
{
/// <summary>
/// Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel.
/// </summary>
- /// <param name="keyType">The type of "return" key on the input panel</param>
+ /// <param name="keyType">The type of "return" key on the input panel.</param>
/// <since_tizen> preview </since_tizen>
public void SetInputPanelReturnKeyType(InputPanelReturnKeyType keyType)
{
}
/// <summary>
- /// Forces calculation of the entry size and text layouting.
+ /// Forces calculation of the entry size and text layout.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ForceCalculation()
}
/// <summary>
- /// Begins a selection within the entry as though the user were holding down the mouse button to make a selection.
+ /// Begins a selection within the entry, as though the user was holding down the mouse button to make a selection.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void BeginCursorSelection()
/// <summary>
/// Appends the text of the entry.
/// </summary>
- /// <param name="text">The text to be displayed</param>
+ /// <param name="text">The text to be displayed.</param>
/// <since_tizen> preview </since_tizen>
public void AppendText(string text)
{
}
/// <summary>
- /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
+ /// Sets or gets the value of the HorizontalScrollBarVisiblePolicy.
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means that the horizontal scrollbar is made visible if it is needed, or otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
/// </summary>
/// <remarks>
- /// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
+ /// ScrollBarVisiblePolicy.Auto means that the vertical scrollbar is made visible if it is needed, or otherwise kept hidden.
/// ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the vertical bounce behaviour.
+ /// Sets or gets the vertical bounce behavior.
/// When scrolling, the scroller may "bounce" when reaching an edge of the content object.
- /// This is a visual way to indicate the end has been reached.
- /// 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.
+ /// This is a visual way to indicate that the end has reached.
+ /// This is enabled by default for both the axis.
+ /// This API will be set if it is enabled for the given axis with boolean parameters for each axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool VerticalBounce
}
/// <summary>
- /// Sets or gets the horizontal bounce behaviour.
+ /// Sets or gets the horizontal bounce behavior.
/// When scrolling, the scroller may "bounce" when reaching an edge of the content object.
- /// This is a visual way to indicate the end has been reached.
- /// 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.
+ /// This is a visual way to indicate that the end has reached.
+ /// This is enabled by default for both the axis.
+ /// This API will be set if it is enabled for the given axis with boolean parameters for each axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool HorizontalBounce
/// <summary>
/// Inserts the given text into the entry at the current cursor position.
/// </summary>
- /// <param name="text"></param>
+ /// <param name="text">The text to be inserted.</param>
/// <since_tizen> preview </since_tizen>
public void InsertTextToCursor(string text)
{
}
/// <summary>
- /// Writes any changes made to the file that is set by File.
+ /// Writes any changes made to the file that is set by a file.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void SaveFile()
}
/// <summary>
- /// Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
+ /// Show the input panel (virtual keyboard) based on the input panel property of the entry such as layout, autocapital types, and so on.
/// </summary>
/// <remarks>
- /// 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).
+ /// 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 the case of manual control by using the SetInputPanelEnabled(false).
/// </remarks>
/// <since_tizen> preview </since_tizen>
public void ShowInputPanel()
}
/// <summary>
- /// Append a markup filter function for text inserted in the entry.
+ /// Appends a markup filter function for text inserted in the entry.
/// </summary>
/// <param name="filter">This function type is used by entry filters to modify text.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Prepend a markup filter function for text inserted in the entry.
+ /// Prepends a markup filter function for text inserted in the entry.
/// </summary>
/// <param name="filter">This function type is used by entry filters to modify text.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Remove a markup filter
+ /// Removes a markup filter.
/// </summary>
/// <param name="filter">This function type is used by entry filters to modify text.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// This disabled the entry's selection.
+ /// This disables the entry's selection.
/// </summary>
- /// <param name="disable">If true, the selection are disabled.</param>
+ /// <param name="disable">If true, the selection is disabled.</param>
/// <since_tizen> preview </since_tizen>
public void DisableSelection(bool disable)
{
}
/// <summary>
- /// Get any selected text within the entry.
+ /// Gets any selected text within the entry.
/// </summary>
- /// <returns>Selection's value</returns>
+ /// <returns>Selection's value.</returns>
/// <since_tizen> preview </since_tizen>
public string GetSelection()
{
/// <summary>
/// This selects a region of text within the entry.
/// </summary>
- /// <param name="start">The starting position.</param>
+ /// <param name="start">The start position.</param>
/// <param name="end">The end position.</param>
/// <since_tizen> preview </since_tizen>
public void SetSelectionRegion(int start, int end)
}
/// <summary>
- /// Sets the visibility of the left-side widget of the entry
+ /// Sets the visibility of the left-side widget of the entry.
/// </summary>
- /// <param name="isDisplay">true if the object should be displayed, false if not.</param>
+ /// <param name="isDisplay">true if the object should be displayed, otherwise false.</param>
/// <since_tizen> preview </since_tizen>
public void SetIconVisible(bool isDisplay)
{
}
/// <summary>
- /// Set whether the return key on the input panel is disabled automatically when entry has no text.
+ /// Sets whether the return key on the input panel is disabled automatically, when the entry has no text.
/// </summary>
/// <param name="enable">If enabled is true, the return key is automatically disabled when the entry has no text.</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Low level Evas canvas functions. Sub groups will present more high level ones, though.
- /// Most of these functions deal with low level Evas actions, like:
- /// create/destroy raw canvases, not bound to any displaying engine
- /// tell a canvas i got focused(in a windowing context, for example)
- /// tell a canvas a region should not be calculated anymore in rendering
- /// tell a canvas to render its contents, immediately
- /// 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.
+ /// Low-level Evas canvas functions. Subgroups will be present more than the high-level ones, though.
+ /// Most of these functions deal with low-level Evas actions like:
+ /// create/destroy raw canvases, not bound to any displaying engine.
+ /// tell a canvas, I got focused (in a windowing context, for example).
+ /// tell a canvas, a region should not be calculated anymore in rendering.
+ /// tell a canvas, to render its contents immediately.
+ /// 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 will 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasCanvas
/// <summary>
/// Gets or sets the image cache.
- /// This function returns the image cache size of canvas in bytes.
+ /// This function returns the image cache size of the canvas in bytes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ImageCacheSize
}
/// <summary>
- /// Flush the image cache of the canvas.
+ /// Flushes the image cache of the canvas.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void FlushImageCache()
}
/// <summary>
- /// Add a damage rectangle.
+ /// Adds a damage rectangle.
/// </summary>
/// <param name="x">The rectangle's top left corner's horizontal coordinate.</param>
/// <param name="y">The rectangle's top left corner's vertical coordinate.</param>
}
/// <summary>
- /// Add an "obscured region" to an Evas canvas.
+ /// Adds an "obscured region" to an Evas canvas.
/// </summary>
/// <param name="x">The rectangle's top left corner's horizontal coordinate.</param>
/// <param name="y">The rectangle's top left corner's vertical coordinate.</param>
}
/// <summary>
- /// Remove all "obscured regions" from an Evas canvas.
+ /// Removes all the "obscured regions" from an Evas canvas.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearObscuredRectangle()
}
/// <summary>
- /// Adds or registers a event to a given canvas event.
+ /// Adds or registers an event to a given canvas event.
/// </summary>
- /// <param name="type">The type of event that triggers</param>
- /// <param name="action">The action to be called when the event is triggered</param>
+ /// <param name="type">The type of event that triggers.</param>
+ /// <param name="action">The action to be called when the event is triggered.</param>
/// <since_tizen> preview </since_tizen>
public void AddEventAction(EvasObjectCallbackType type, Action action)
{
}
/// <summary>
- /// Deletes a event to a given canvas event.
+ /// Deletes an event to a given canvas event.
/// </summary>
- /// <param name="type">The type of event that triggers</param>
+ /// <param name="type">The type of event that triggers.</param>
/// <param name="action">The action to be called when the event is triggered</param>
/// <since_tizen> preview </since_tizen>
public void DeleteEventAction(EvasObjectCallbackType type, Action action)
/// Creates an Evas canvas handle.
/// </summary>
/// <param name="evasObject">EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <returns>Handle IntPtr.</returns>
IntPtr CreateHandle(IntPtr evasObject)
{
return Interop.Evas.evas_object_evas_get(evasObject);
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
public override bool Equals(object obj)
{
namespace ElmSharp
{
/// <summary>
- /// This group provides functions for image objects.
+ /// This group provides the functions for image objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasImage : EvasObject
IntPtr _handle = IntPtr.Zero;
/// <summary>
- /// Creates and initializes a new instance of EvasImage class.
+ /// Creates and initializes a new instance of the EvasImage class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by EvasImage as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by EvasImage as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public EvasImage(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Sets or gets the source file from where an image object must fetch the real image data
+ /// Sets or gets the source file from where an image object must fetch the real image data.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string File
}
/// <summary>
- /// Sets or gets whether an object is clipped by source object's clipper.
+ /// Sets or gets whether an object is clipped by the source object's clipper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsSourceClipped
}
/// <summary>
- /// Sets or gets the scaling factor (multiplier) for the borders of an image object.
+ /// Sets or gets the scaling factor (multiplier) for the borders of the image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double BorderScale
}
/// <summary>
- /// Sets or gets whether alpha channel data is being used on the given image object.
+ /// Sets or gets whether the alpha channel data is being used on the given image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsOpaque
}
/// <summary>
- /// Sets or gets whether to use high-quality image scaling algorithm on the given image object.
+ /// Sets or gets whether to use a high-quality image scaling algorithm on the given image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsSmoothScaled
/// <summary>
/// Sets how to fill an image object's drawing rectangle given the (real) image bound to it.
/// </summary>
- /// <param name="geometry"></param>
+ /// <param name="geometry">The rectangle of the given image object that the image will be drawn to.</param>
/// <since_tizen> preview </since_tizen>
public void SetFill(Rect geometry)
{
/// <summary>
/// Sets the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones).
/// </summary>
- /// <param name="file">The image file path</param>
- /// <param name="key">The image key in file (if its an Eet one), otherwise set null</param>
+ /// <param name="file">The image file path.</param>
+ /// <param name="key">The image key in file (if its an Eet one), otherwise set null.</param>
/// <since_tizen> preview </since_tizen>
public void SetFile(string file, string key)
{
}
/// <summary>
- /// Sets the data for an image from memory to be loaded.
+ /// Sets the data for an image from the memory to be loaded.
/// </summary>
/// <param name="stream">memory stream</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets the source object on an image object to used as a proxy.
+ /// Sets the source object on an image object to be used as a proxy.
/// </summary>
- /// <param name="source">The proxy (image) object</param>
- /// <returns>true if the source object is set successfully, ortherwise false on error</returns>
+ /// <param name="source">The proxy (image) object.</param>
+ /// <returns>true if the source object is set successfully, otherwise false on error.</returns>
/// <since_tizen> preview </since_tizen>
public bool SetSource(EvasObject source)
{
}
/// <summary>
- /// Set the native surface of a given image of the canvas
+ /// Set the native surface of a given image of the canvas.
/// </summary>
/// <param name="surface">The surface.</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets the dimensions for an image object's border, a region which is not scaled together with its center ever.
/// </summary>
- /// <param name="left">The border's left width</param>
- /// <param name="right">The border's right width</param>
- /// <param name="top">The border's top width</param>
- /// <param name="bottom">The border's bottom width</param>
+ /// <param name="left">The border's left width.</param>
+ /// <param name="right">The border's right width.</param>
+ /// <param name="top">The border's top width.</param>
+ /// <param name="bottom">The border's bottom width.</param>
/// <since_tizen> preview </since_tizen>
public void SetBorder(int left, int right, int top, int bottom)
{
/// <summary>
/// Sets the content at a part of a given container widget.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Image as a child. It's <see cref="EvasObject"/> type.</param>
- /// <returns>The new object, otherwise null if it cannot be created</returns>
+ /// <param name="parent">The parent is a given container, which will be attached by the image as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <returns>The new object, otherwise null if it cannot be created.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The EvasKeyEventArgs is an EvasKey EventArgs
+ /// The EvasKeyEventArgs is a EvasKey EventArgs.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasKeyEventArgs : EventArgs
IntPtr _nativeEventInfo;
/// <summary>
- /// BackButton name in Platform
+ /// BackButton name in platform.
/// </summary>
/// <since_tizen> preview </since_tizen>
public const string PlatformBackButtonName = "XF86Back";
/// <summary>
- /// MenuButton name in Platform
+ /// MenuButton name in platform.
/// </summary>
/// <since_tizen> preview </since_tizen>
public const string PlatformMenuButtonName = "XF86Menu";
/// <summary>
- /// HomeButton name in Platform
+ /// HomeButton name in platform.
/// </summary>
/// <since_tizen> preview </since_tizen>
public const string PlatformHomeButtonName = "XF86Home";
/// <summary>
- /// Gets the name of Key
+ /// Gets the name of the key.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string KeyName { get; private set; }
/// <summary>
/// Creates and initializes a new instance of the EvasKeyEventArgs class.
/// </summary>
- /// <param name="data">data info</param>
- /// <param name="obj"> object </param>
- /// <param name="info">information </param>
- /// <returns>EvasKey eventArgs</returns>
+ /// <param name="data">The data information.</param>
+ /// <param name="obj">The object.</param>
+ /// <param name="info">The information.</param>
+ /// <returns>EvasKey eventArgs.</returns>
/// <since_tizen> preview </since_tizen>
static public EvasKeyEventArgs Create(IntPtr data, IntPtr obj, IntPtr info)
{
struct EvasEventKeyDown
{
/// <summary>
- /// Name string of the key pressed
+ /// Name string of the key pressed.
/// </summary>
public string keyname;
/// <summary>
- /// Data to be passed to the event
+ /// Data to be passed to the event.
/// </summary>
public IntPtr data;
/// <summary>
- /// Modifier keys pressed during the event
+ /// Modifier keys pressed during the event.
/// </summary>
public IntPtr modifiers;
/// <summary>
- /// Locks info
+ /// Locks information.
/// </summary>
public IntPtr locks;
/// <summary>
- /// Logical key: (example, shift+1 == exclamation)
+ /// Logical key: (example, shift+1 == exclamation).
/// </summary>
public string key;
/// <summary>
- /// UTF8 string if this keystroke has produced a visible string to be ADDED
+ /// UTF-8 string, if this keystroke has produced a visible string to be added.
/// </summary>
public string str;
/// <summary>
- /// UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one
+ /// UTF-8 string, if this keystroke has modified a string in the middle of being composed - this string replaces the previous one.
/// </summary>
public string compose;
public uint timestamp;
/// <summary>
- /// Event_flags
+ /// Event_flags.
/// </summary>
public EvasEventFlag event_flags;
public IntPtr dev;
/// <summary>
- /// Keycode
+ /// Keycode.
/// </summary>
public uint keycode;
};
}
/// <summary>
- /// Flags for Events
+ /// Flags for the events.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Flags]
public enum EvasEventFlag
{
/// <summary>
- /// No fancy flags set
+ /// No fancy flags set.
/// </summary>
None = 0,
/// <summary>
- ///This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything
+ /// This event is being delivered but should be put "on hold" until the on hold flag is unset. The event should be used for informational purposes and maybe some indications visually, but not actually perform anything.
/// </summary>
OnHold = 1,
}
}
/// <summary>
- /// Gets or sets the flag of the object move synchronization for map rendering.
+ /// Gets or sets the flag of the object to move synchronization for map rendering.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsMoveSync
}
/// <summary>
- /// Populates source and destination map points to exactly match the object.
+ /// Populates the source and destination map points to exactly match the object.
/// </summary>
- /// <param name="obj">The object to use unmapped geometry to populate map coordinates</param>
+ /// <param name="obj">The object to use unmapped geometry to populate the map coordinates.</param>
/// <since_tizen> preview </since_tizen>
public void PopulatePoints(EvasObject obj)
{
}
/// <summary>
- /// Populates source and destination map points to exactly match the object.
+ /// Populates the source and destination map points to exactly match the object.
/// </summary>
- /// <param name="obj">The object to use unmapped geometry to populate map coordinates</param>
+ /// <param name="obj">The object to use unmapped geometry to populate the map coordinates.</param>
/// <param name="z">
- /// The point Z coordinate hint (pre-perspective transform)This value is used for all four points.
+ /// The point Z-coordinate hint (pre-perspective transform). This value is used for all the four points.
/// </param>
/// <since_tizen> preview </since_tizen>
public void PopulatePoints(EvasObject obj, int z)
/// <summary>
/// Populates the source and destination map points to match the given geometry.
/// </summary>
- /// <param name="geometry">The geometry value contains X coordinate,Y coordinate,the width and height to use to calculate second and third points</param>
- /// <param name="z">The Z coordinate hint (pre-perspective transform) This value is used for all four points.</param>
+ /// <param name="geometry">The geometry value contains X-coordinate, Y-coordinate, the width and height to use, to calculate the second and third points.</param>
+ /// <param name="z">The Z-coordinate hint (pre-perspective transform) This value is used for all the four points.</param>
/// <since_tizen> preview </since_tizen>
public void PopulatePoints(Rect geometry, int z)
{
}
/// <summary>
- /// Rotate the map
+ /// Rotates the map.
/// </summary>
- /// <param name="degrees">The abount of degrees from 0.0 to 360.0 to rotate</param>
- /// <param name="cx">rotation's center horizontal position.</param>
- /// <param name="cy">rotation's center vertical position.</param>
+ /// <param name="degrees">The abount of degrees from 0.0 to 360.0 to rotate.</param>
+ /// <param name="cx">The rotation's center horizontal position.</param>
+ /// <param name="cy">The rotation's center vertical position.</param>
/// <since_tizen> preview </since_tizen>
public void Rotate(double degrees, int cx, int cy)
{
/// <summary>
/// Rotates the map around 3 axes in 3D.
/// </summary>
- /// <param name="dx">The amount of degrees from 0.0 to 360.0 to rotate around X axis</param>
- /// <param name="dy">The amount of degrees from 0.0 to 360.0 to rotate around Y axis</param>
- /// <param name="dz">The amount of degrees from 0.0 to 360.0 to rotate around Z axis</param>
- /// <param name="cx">The rotation's center horizontal position</param>
- /// <param name="cy">The rotation's center vertical position</param>
- /// <param name="cz">The rotation's center depth position</param>
+ /// <param name="dx">The amount of degrees from 0.0 to 360.0 to rotate around the X-axis.</param>
+ /// <param name="dy">The amount of degrees from 0.0 to 360.0 to rotate around the Y-axis.</param>
+ /// <param name="dz">The amount of degrees from 0.0 to 360.0 to rotate around the Z-axis.</param>
+ /// <param name="cx">The rotation's center horizontal position.</param>
+ /// <param name="cy">The rotation's center vertical position.</param>
+ /// <param name="cz">The rotation's center depth position.</param>
/// <since_tizen> preview </since_tizen>
public void Rotate3D(double dx, double dy, double dz, int cx, int cy, int cz)
{
/// <summary>
/// Changes the map point's coordinate.
/// </summary>
- /// <param name="idx">The index of point to change ,this must be smaller than map size.</param>
- /// <param name="point">3D Point coordinate</param>
+ /// <param name="idx">The index of point to change, this must be smaller than the map size.</param>
+ /// <param name="point">The 3D point coordinate.</param>
/// <since_tizen> preview </since_tizen>
public void SetPointCoordinate(int idx, Point3D point)
{
/// <summary>
/// Gets the map point's coordinate.
/// </summary>
- /// <param name="idx">The index of point to change ,this must be smaller than map size.</param>
- /// <returns>The coordinates of the given point in the map.</returns>
+ /// <param name="idx">The index of point to change, this must be smaller than the map size.</param>
+ /// <returns>The coordinates of a given point in the map.</returns>
/// <since_tizen> preview </since_tizen>
public Point3D GetPointCoordinate(int idx)
{
/// <summary>
/// Changes the map to apply the given zooming.
/// </summary>
- /// <param name="x">The horizontal zoom to use</param>
- /// <param name="y">The vertical zoom to use</param>
- /// <param name="cx">The zooming center horizontal position</param>
- /// <param name="cy">The zooming center vertical position</param>
+ /// <param name="x">The horizontal zoom to use.</param>
+ /// <param name="y">The vertical zoom to use.</param>
+ /// <param name="cx">The zooming center horizontal position.</param>
+ /// <param name="cy">The zooming center vertical position.</param>
/// <since_tizen> preview </since_tizen>
public void Zoom(double x, double y, int cx, int cy)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for tooltip orientation.
+ /// Enumeration for the Tooltip orientation.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum TooltipOrientation
{
/// <summary>
- /// Default value, Tooltip moves with mouse pointer.
+ /// Default value. Tooltip moves with a mouse pointer.
/// </summary>
None,
/// <summary>
- /// Tooltip should appear at the top left of parent.
+ /// Tooltip should appear to the top left of the parent.
/// </summary>
TopLeft,
/// <summary>
- /// Tooltip should appear at the left of parent.
+ /// Tooltip should appear to the left of the parent.
/// </summary>
Top,
/// <summary>
- /// Tooltip should appear at the top right of parent.
+ /// Tooltip should appear to the top right of the parent.
/// </summary>
TopRight,
/// <summary>
- /// Tooltip should appear at the left of parent.
+ /// Tooltip should appear to the left of the parent.
/// </summary>
Left,
/// <summary>
- /// Tooltip should appear at the center of parent.
+ /// Tooltip should appear to the center of the parent.
/// </summary>
Center,
/// <summary>
- /// Tooltip should appear at the right of parent.
+ /// Tooltip should appear to the right of the parent.
/// </summary>
Right,
/// <summary>
- /// Tooltip should appear at the bottom left of parent.
+ /// Tooltip should appear to the bottom left of the parent.
/// </summary>
BottomLeft,
/// <summary>
- /// Tooltip should appear at the bottom of parent.
+ /// Tooltip should appear to the bottom of the parent.
/// </summary>
Bottom,
/// <summary>
- /// Tooltip should appear at the bottom right of parent.
+ /// Tooltip should appear to the bottom right of the parent.
/// </summary>
BottomRight,
}
/// <summary>
- /// Enumeration for aspect control.
+ /// Enumeration for the aspect control.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum AspectControl
{
/// <summary>
- /// Preference on scaling unset.
+ /// Preference on the scaling unset.
/// </summary>
None = 0,
/// <summary>
- /// Same effect as unset preference on scaling.
+ /// Same effect as the unset preference on the scaling.
/// </summary>
Neither = 1,
/// <summary>
- /// Use all horizontal container space to place an object, using the given aspect
+ /// Use all horizontal container space to place an object using the given aspect.
/// </summary>
Horizontal = 2,
/// <summary>
- /// Use all vertical container space to place an object, using the given aspect.
+ /// Use all vertical container space to place an object using the given aspect.
/// </summary>
Vertical = 3,
}
/// <summary>
- /// The EcasObject is a base class for other widget class
+ /// The EvasObject is a base class for other widget classes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class EvasObject
readonly HashSet<IInvalidatable> _eventStore = new HashSet<IInvalidatable>();
/// <summary>
- /// Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter.
+ /// Creates and initializes a new instance of the EvasObject class with the parent EvasObject class parameter.
/// </summary>
- /// <param name="parent">Parent EvasObject class </param>
+ /// <param name="parent">Parent EvasObject class.</param>
/// <since_tizen> preview </since_tizen>
protected EvasObject(EvasObject parent) : this()
{
//}
/// <summary>
- /// Deleted will be triggered when widght is deleted
+ /// Deleted will be triggered when the widght is deleted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Deleted;
/// <summary>
- /// KeyUp will be triggered when key is loose
+ /// KeyUp will be triggered when the key is loose.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<EvasKeyEventArgs> KeyUp
}
/// <summary>
- /// KeyDown will be triggered when key is preesd down
+ /// KeyDown will be triggered when the key is pressed down.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<EvasKeyEventArgs> KeyDown
}
/// <summary>
- /// BackButtonPressed will be triggered when Back button is pressed
+ /// BackButtonPressed will be triggered when the Back button is pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler BackButtonPressed
}
/// <summary>
- /// MoreButtonPressed will be triggered when More button is pressed
+ /// MoreButtonPressed will be triggered when the More button is pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler MoreButtonPressed
}
/// <summary>
- /// Moved will be triggered when widght is moved
+ /// Moved will be triggered when the widght is moved.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Moved
}
/// <summary>
- /// Current widget's size Resized Event Handler
+ /// Resized Event Handler of the current widget's size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Resized
}
/// <summary>
- /// Current widget RenderPost Event Handler
+ /// RenderPost Event Handler of the current widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler RenderPost
}
/// <summary>
- /// Called back when a widget's tooltip is activated and needs content.
+ /// Called when a widget's tooltip is activated and needs content.
/// </summary>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public delegate EvasObject GetTooltipContentDelegate();
/// <summary>
- /// Get widget's status of Realized or not.
+ /// Gets a widget's status of realized or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsRealized { get { return Handle != IntPtr.Zero; } }
/// <summary>
- /// Gets EvasCanvas
+ /// Gets EvasCanvas.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasCanvas EvasCanvas
}
/// <summary>
- /// Sets or gets the Width hints for an object's minimum size.
+ /// Sets or gets the width hints for an object's minimum size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MinimumWidth
}
/// <summary>
- /// Sets or gets the Height hints for an object's minimum size.
+ /// Sets or gets the height hints for an object's minimum size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MinimumHeight
}
/// <summary>
- /// Sets or gets current object transformation map.
+ /// Sets or gets the current object's transformation map.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasMap EvasMap
}
/// <summary>
- /// Sets or Gets style for this object tooltip.
+ /// Sets or gets the style for this object tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string TooltipStyle
}
/// <summary>
- /// Sets or gets the orientation of Tooltip.
+ /// Sets or gets the orientation of tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public TooltipOrientation TooltipOrientation
}
/// <summary>
- /// Gets the movement freeze by 1
+ /// Gets the movement freeze by 1.
/// This gets the movement freeze count by one.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Clips one object to another.
/// </summary>
- /// <param name="clip">The object to clip object by</param>
+ /// <param name="clip">The object to clip object by.</param>
/// <since_tizen> preview </since_tizen>
public void SetClip(EvasObject clip)
{
/// <summary>
/// Sets the hints for an object's alignment.
/// </summary>
- /// <param name="x">The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 </param>
- /// <param name="y">The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 </param>
+ /// <param name="x">The horizontal alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.</param>
+ /// <param name="y">The vertical alignment hint as double value ranging from 0.0 to 1.0. The default alignment hint value is 0.5.</param>
/// <since_tizen> preview </since_tizen>
public void SetAlignment(double x, double y)
{
/// <summary>
/// Sets the hints for an object's weight.
/// </summary>
- /// <param name="x">The non-negative double value to use as horizontal weight hint</param>
- /// <param name="y">The non-negative double value to use as vertical weight hint</param>
+ /// <param name="x">The non-negative double value to be used as horizontal weight hint.</param>
+ /// <param name="y">The non-negative double value to be used as vertical weight hint.</param>
/// <since_tizen> preview </since_tizen>
public void SetWeight(double x, double y)
{
/// <summary>
/// Sets the text for an object's tooltip.
/// </summary>
- /// <param name="text">The text value to display inside the tooltip</param>
+ /// <param name="text">The text value to display inside the tooltip.</param>
/// <since_tizen> preview </since_tizen>
public void SetTooltipText(string text)
{
}
/// <summary>
- /// Force hide tooltip of object.
+ /// Force hide the tooltip of the object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void HideTooltip()
}
/// <summary>
- /// Force show tooltip of object.
+ /// Force show the tooltip of the object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ShowTooltip()
/// <summary>
/// Changes the size of the current object.
/// </summary>
- /// <param name="w">The new width</param>
- /// <param name="h">The new height</param>
+ /// <param name="w">The new width.</param>
+ /// <param name="h">The new height.</param>
/// <since_tizen> preview </since_tizen>
public void Resize(int w, int h)
{
/// <summary>
/// Moves the current object to the given location.
/// </summary>
- /// <param name="x">The X position to move the object to.</param>
- /// <param name="y">The Y position to move the object to.</param>
+ /// <param name="x">The X position to move the object.</param>
+ /// <param name="y">The Y position to move the object.</param>
/// <since_tizen> preview </since_tizen>
public void Move(int x, int y)
{
}
/// <summary>
- /// Lowers obj to the bottom of its layer.
+ /// Lowers the object to the bottom of its layer.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Lower()
}
/// <summary>
- /// Define IntPtr operator
+ /// Define the IntPtr operator.
/// </summary>
- /// <param name="obj">Parent object</param>
+ /// <param name="obj">Parent object.</param>
/// <since_tizen> preview </since_tizen>
public static implicit operator IntPtr(EvasObject obj)
{
}
/// <summary>
- /// Requests keyname key events be directed to current obj.
+ /// Requests the keyname key events to be directed to the current object.
/// </summary>
- /// <param name="keyname">The key to request events for</param>
- /// <param name="exclusive">Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE</param>
- /// <returns>If the call succeeded is true,otherwise is false</returns>
+ /// <param name="keyname">The key to request events for.</param>
+ /// <param name="exclusive">Set TRUE to request that the obj is the only object receiving the keyname events, otherwise set to FALSE.</param>
+ /// <returns>If the call succeeds then true, otherwise false.</returns>
/// <since_tizen> preview </since_tizen>
public bool KeyGrab(string keyname, bool exclusive)
{
}
/// <summary>
- /// Removes the grab on keyname key events.
+ /// Removes the grab on the keyname key events.
/// </summary>
- /// <param name="keyname">The key the grab is set for</param>
+ /// <param name="keyname">The key the grab is set for.</param>
/// <since_tizen> preview </since_tizen>
public void KeyUngrab(string keyname)
{
}
/// <summary>
- /// Mark smart object as changed.
+ /// Marks the smart object as changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MarkChanged()
}
/// <summary>
- /// Call the calculate smart function immediately.
+ /// Calls the calculate smart function immediately.
/// This will force immediate calculations needed for renderization of this object.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets the hints for an object's aspect ratio.
/// </summary>
- /// <param name="aspect">The policy or type of aspect ratio to apply to object</param>
- /// <param name="w">The integer to use as aspect width ratio term</param>
- /// <param name="h">The integer to use as aspect height ratio term</param>
+ /// <param name="aspect">The policy or type of aspect ratio to apply to an object.</param>
+ /// <param name="w">The integer to be used as aspect width ratio term.</param>
+ /// <param name="h">The integer to be used as aspect height ratio term.</param>
/// <since_tizen> preview </since_tizen>
public void SetSizeHintAspect(AspectControl aspect, int w, int h)
{
/// <summary>
/// Gets the hints for an object's aspect ratio.
/// </summary>
- /// <param name="aspect">The policy or type of aspect ratio to apply to object</param>
- /// <param name="w">The integer to use as aspect width ratio term</param>
- /// <param name="h">The integer to use as aspect height ratio term</param>
+ /// <param name="aspect">The policy or type of aspect ratio to apply to an object.</param>
+ /// <param name="w">The integer to be used as aspect width ratio term.</param>
+ /// <param name="h">The integer to be used as aspect height ratio term.</param>
/// <since_tizen> preview </since_tizen>
public void GetSizeHintAspect(out AspectControl aspect, out int w, out int h)
{
}
/// <summary>
- /// Stack immediately below anchor.
+ /// Stacks immediately below anchor.
/// </summary>
/// <param name="anchor">The object below which to stack.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Stack immediately above anchor.
+ /// Stacks immediately above anchor.
/// </summary>
/// <param name="anchor">The object above which to stack.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Raise to the top of its layer.
+ /// Raises to the top of its layer.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void RaiseTop()
}
/// <summary>
- /// Get the geometry of a line number.
+ /// Gets the geometry of a line number.
/// </summary>
- /// <param name="lineNumber">the line number.</param>
- /// <param name="x">x coord of the line.</param>
- /// <param name="y">y coord of the line.</param>
- /// <param name="w">w coord of the line.</param>
- /// <param name="h">h coord of the line.</param>
+ /// <param name="lineNumber">The line number.</param>
+ /// <param name="x">x coordinate of the line.</param>
+ /// <param name="y">y coordinate of the line.</param>
+ /// <param name="w">w coordinate of the line.</param>
+ /// <param name="h">h coordinate of the line.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public bool GetTextBlockGeometryByLineNumber(int lineNumber, out int x, out int y, out int w, out int h)
}
/// <summary>
- /// The callback of Invalidate Event
+ /// The callback of the Invalidate Event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnInvalidate()
}
/// <summary>
- /// The callback of Instantiated Event
+ /// The callback of the Instantiated Event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnInstantiated()
}
/// <summary>
- /// The callback of Realized Event
+ /// The callback of the Realized Event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnRealized()
}
/// <summary>
- /// The callback of Unrealize Event
+ /// The callback of the Unrealize Event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnUnrealize()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected abstract IntPtr CreateHandle(EvasObject parent);
/// <summary>
/// For this object bind Parent object.Init handle and all kinds of EvasObjectEvent.
/// </summary>
- /// <param name="parent">Parent object</param>
+ /// <param name="parent">Parent object.</param>
/// <since_tizen> preview </since_tizen>
public void Realize(EvasObject parent)
{
}
/// <summary>
- /// Removes current object relationship with others.
+ /// Removes the current object relationship with others.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Unrealize()
namespace ElmSharp
{
/// <summary>
- /// IInvalidatable is a interface which can be overrided by its children class.
- /// Inherits IDisposable
+ /// IInvalidatable is an interface, which can be overrided by its children class.
+ /// Inherits IDisposable.
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IInvalidatable : IDisposable
{
/// <summary>
- /// Make current instance invalidate
+ /// Makes the current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
void MakeInvalidate();
}
/// <summary>
- /// Enumeration for EvasObjectCallbackType
+ /// Enumeration for EvasObjectCallbackType.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum EvasObjectCallbackType
MouseIn,
/// <summary>
- /// Mouse Out Event CallbackType
+ /// Mouse Out Event CallbackType.
/// </summary>
MouseOut,
/// <summary>
- /// Mouse Button Down Event CallbackType
+ /// Mouse Button Down Event CallbackType.
/// </summary>
MouseDown,
/// <summary>
- /// Mouse Button Up Event CallbackType
+ /// Mouse Button Up Event CallbackType.
/// </summary>
MouseUp,
/// <summary>
- /// Mouse Move Event CallbackType
+ /// Mouse Move Event CallbackType.
/// </summary>
MouseMove,
/// <summary>
- /// Mouse Wheel Event CallbackType
+ /// Mouse Wheel Event CallbackType.
/// </summary>
MouseWheel,
/// <summary>
- /// Multi-touch Down Event CallbackType
+ /// Multi-touch Down Event CallbackType.
/// </summary>
MultiDown,
/// <summary>
- /// Multi-touch Up Event CallbackType
+ /// Multi-touch Up Event CallbackType.
/// </summary>
MultiUp,
/// <summary>
- /// Multi-touch Move Event CallbackType
+ /// Multi-touch Move Event CallbackType.
/// </summary>
MultiMove,
/// <summary>
- /// Object Being Freed (Called after Del)
+ /// Object Being Freed (Called after Del).
/// </summary>
Free,
/// <summary>
- /// Key Press Event CallbackType
+ /// Key Press Event CallbackType.
/// </summary>
KeyDown,
/// <summary>
- /// Key Release Event CallbackType
+ /// Key Release Event CallbackType.
/// </summary>
KeyUp,
/// <summary>
- /// Focus In Event CallbackType
+ /// Focus In Event CallbackType.
/// </summary>
FocusIn,
/// <summary>
- /// Focus Out Event CallbackType
+ /// Focus Out Event CallbackType.
/// </summary>
FocusOut,
/// <summary>
- /// Show Event CallbackType
+ /// Show Event CallbackType.
/// </summary>
Show,
/// <summary>
- /// Hide Event CallbackType
+ /// Hide Event CallbackType.
/// </summary>
Hide,
/// <summary>
- /// Move Event CallbackType
+ /// Move Event CallbackType.
/// </summary>
Move,
/// <summary>
- /// Resize Event CallbackType
+ /// Resize Event CallbackType.
/// </summary>
Resize,
/// <summary>
- /// Restack Event CallbackType
+ /// Restack Event CallbackType.
/// </summary>
Restack,
/// <summary>
- /// Object Being Deleted (called before Free)
+ /// Object being deleted (called before Free).
/// </summary>
Del,
/// <summary>
- /// Hold Event CallbackType, Informational purpose event to indicate something
+ /// Hold Event CallbackType, Informational purpose event to indicate something.
/// </summary>
Hold,
/// <summary>
- /// Size hints changed Event CallbackType
+ /// Size hints changed the CallbackType event.
/// </summary>
ChangedSizeHints,
/// <summary>
- /// Image has been preloaded
+ /// Image has been pre-loaded.
/// </summary>
ImagePreloaded,
/// <summary>
- /// Canvas got focus as a whole
+ /// Canvas got focus as a whole.
/// </summary>
CanvasFocusIn,
/// <summary>
- /// Canvas lost focus as a whole
+ /// Canvas lost focus as a whole.
/// </summary>
CanvasFocusOut,
/// <summary>
- /// Called just before rendering is updated on the canvas target
+ /// Called just before rendering is updated on the canvas target.
/// </summary>
RenderFlushPre,
/// <summary>
- /// Called just after rendering is updated on the canvas target
+ /// Called just after rendering is updated on the canvas target.
/// </summary>
RenderFlushPost,
/// <summary>
- /// Canvas object got focus
+ /// Canvas object got focus.
/// </summary>
CanvasObjectFocusIn,
/// <summary>
- /// Canvas object lost focus
+ /// Canvas object lost focus.
/// </summary>
CanvasObjectFocusOut,
/// <summary>
- /// Image data has been unloaded (by some mechanism in Evas that throw out original image data)
+ /// Image data has been unloaded (by some mechanism in Evas that throw out the original image data).
/// </summary>
ImageUnloaded,
/// <summary>
- /// Called just before rendering starts on the canvas target
+ /// Called just before rendering starts on the canvas target.
/// </summary>
RenderPre,
/// <summary>
- /// Called just after rendering stops on the canvas target
+ /// Called just after rendering stops on the canvas target.
/// </summary>
RenderPost,
/// <summary>
- /// Image size is changed
+ /// Image size is changed.
/// </summary>
ImageResize,
/// <summary>
- /// Devices added, removed or changed on canvas
+ /// Devices added, removed, or changed on canvas.
/// </summary>
DeviceChanged,
/// <summary>
- /// Axis is changed
+ /// Axis is changed.
/// </summary>
AxisUpdate,
/// <summary>
- /// Canvas Viewport size is changed
+ /// Canvas Viewport size is changed.
/// </summary>
CanvasViewportResize
}
/// <summary>
- /// Event class for EvasObject
+ /// Event class for EvasObject.
/// </summary>
- /// <typeparam name="TEventArgs">Kinds of EventArgs</typeparam>
+ /// <typeparam name="TEventArgs">Kinds of EventArgs.</typeparam>
/// <since_tizen> preview </since_tizen>
public class EvasObjectEvent<TEventArgs> : IInvalidatable where TEventArgs : EventArgs
{
/// <summary>
- /// SmartEventInfoParser delegate of EvasObjectEvent class
+ /// SmartEventInfoParser delegate of the EvasObjectEvent class.
/// </summary>
/// <param name="data">data</param>
/// <param name="obj">obj</param>
/// <param name="info">info</param>
- /// <returns> delegate handle</returns>
+ /// <returns>Delegate handle.</returns>
/// <since_tizen> preview </since_tizen>
public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info);
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belong to</param>
+ /// <param name="sender">EvasObject class belongs to.</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <param name="parser">SmartEventInfoParser</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belong to</param>
- /// <param name="handle">EvasObject handle</param>
+ /// <param name="sender">EvasObject class belongs to.</param>
+ /// <param name="handle">EvasObject handle.</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <param name="parser">SmartEventInfoParser</param>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belong with</param>
+ /// <param name="sender">EvasObject class belongs to.</param>
/// <param name="type">SmartEventInfoParser</param>
/// <since_tizen> preview </since_tizen>
public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, type, null)
}
/// <summary>
- /// Destroy the EvasObjectEvent object.
+ /// Destroys the EvasObjectEvent object.
/// </summary>
~EvasObjectEvent()
{
}
/// <summary>
- /// On Event Handler of EvasObjectEvent
+ /// On Event Handler of the EvasObjectEvent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<TEventArgs> On
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if managed resources should be disposed
+ /// true if the managed resources should be disposed
/// otherwise, false.
/// </param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Make current instance invalidate
+ /// Makes the current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
}
/// <summary>
- /// Event class for EvasObject
+ /// Event class for EvasObject.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class EvasObjectEvent : IInvalidatable
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belong to</param>
+ /// <param name="sender">EvasObject class belongs to.</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <since_tizen> preview </since_tizen>
public EvasObjectEvent(EvasObject sender, EvasObjectCallbackType type) : this(sender, sender.Handle, type)
/// <summary>
/// Creates and initializes a new instance of the EvasObjectEvent.
/// </summary>
- /// <param name="sender">EvasObject class belong to</param>
- /// <param name="handle">EvasObject handle</param>
+ /// <param name="sender">EvasObject class belongs to.</param>
+ /// <param name="handle">EvasObject handle.</param>
/// <param name="type">EvasObjectCallbackType</param>
/// <since_tizen> preview </since_tizen>
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
}
/// <summary>
- /// Destroy the EvasObjectEvent object.
+ /// Destroys the EvasObjectEvent object.
/// </summary>
~EvasObjectEvent()
{
}
/// <summary>
- /// On Event Handler of EvasObjectEvent
+ /// On Event Handler of EvasObjectEvent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler On
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
/// true if managed resources should be disposed
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Make current instance invalidate
+ /// Makes the current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
namespace ElmSharp
{
/// <summary>
- /// A flip selector is a widget to show a set of text items,one at a time.with the same sheet switching style as the clock widget, when one changes the current displaying sheet.
+ /// The FlipSelector is a widget to show a set of text items, one at a time, with the same sheet switching style as the clock widget when one changes the current displaying sheet.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class FlipSelector : Layout
/// <summary>
/// Creates and initializes a new instance of the FlipSelector.
/// </summary>
- /// <param name="parent">Parent EvasObject </param>
+ /// <param name="parent">Parent EvasObject.</param>
/// <since_tizen> preview </since_tizen>
public FlipSelector(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Selected will be triggered when be Selected
+ /// Selected will be triggered when selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
/// <summary>
- /// Overflowed will be triggered when Overflowed
+ /// Overflowed will be triggered when overflowed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Overflowed;
/// <summary>
- /// Underflowed will be triggered when be Underflowed
+ /// Underflowed will be triggered when underflowed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Underflowed;
/// <summary>
- /// Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget.
+ /// Sets or gets the interval on time updates for a user mouse button to hold on the flip selector widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Interval
/// <summary>
- /// Gets the currently selected item in a flip selector widget.
+ /// Gets the currently selected item in the flip selector widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FlipSelectorItem SelectedItem
}
/// <summary>
- /// Appends a (text) item to a flip selector widget.
+ /// Appends the (text) item to the flip selector widget.
/// </summary>
/// <param name="text">text value</param>
/// <returns>
- /// A handle to the item added or NULL, on errors
+ /// A handle to the item added, or null on errors.
/// </returns>
/// <remarks>
- /// The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected.
+ /// 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 the same item is selected.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public FlipSelectorItem Append(string text)
}
/// <summary>
- /// Prepend a (text) item to a flip selector widget.
+ /// Prepends the (text) item to a flip selector widget.
/// </summary>
/// <param name="text">Prepend text</param>
- /// <returns>A handle to the item added or NULL, on errors</returns>
+ /// <returns>A handle to the item added, or null on errors.</returns>
/// <remarks>
- /// The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected.
+ /// 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 the same item is selected.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public FlipSelectorItem Prepend(string text)
/// <summary>
/// To remove the given item.
/// </summary>
- /// <param name="item">FlipSelector's item</param>
+ /// <param name="item">FlipSelector's item.</param>
/// <since_tizen> preview </since_tizen>
public void Remove(FlipSelectorItem item)
{
}
/// <summary>
- /// Programmatically select the next item of a flip selector widget.
+ /// Programmatically select the next item of the flip selector widget.
/// </summary>
/// <remarks>
/// The selection will be animated. Also, if it reaches the beginning of its list of member items, it will continue with the last one backwards.
}
/// <summary>
- /// Programmatically select the previous item of a flip selector widget.
+ /// Programmatically select the previous item of the flip selector widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Prev()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Iterm class of FlipSelector
+ /// The item class of FlipSelector.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class FlipSelectorItem : ItemObject
{
/// <summary>
- /// Sets or gets the Text of FlipSelectorItem
+ /// Sets or gets the text of the FlipSelectorItem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Text { get; private set; }
/// <summary>
- /// Selected will be triggered when Selected
+ /// Selected will be triggered when selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
namespace ElmSharp
{
/// <summary>
- /// The FloatingButton is a widget that to add floating area for buttons.
+ /// The FloatingButton is a widget to add the floating area for buttons.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class FloatingButton : Layout
/// <summary>
/// Creates and initializes a new instance of the FloatingButton class.
/// </summary>
- /// <param name="parent">Created on this parent container..</param>
+ /// <param name="parent">Created on this parent container.</param>
/// <since_tizen> preview </since_tizen>
public FloatingButton(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Sets or gets floatingbutton mode.
+ /// Sets or gets the floatingbutton mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FloatingButtonMode Mode
}
/// <summary>
- /// Gets floatingbutton Position.
+ /// Gets the floatingbutton position.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FloatingButtonPosition Position
}
/// <summary>
- /// Sets or gets movability for a given floatingbutton widget.
+ /// Sets or gets the movability for a given FloatingButton widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool MovementBlock
}
/// <summary>
- /// Get Opacity's value of the given FloatingButton.
+ /// Gets the opacity's value of the given FloatingButton.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
}
/// <summary>
- /// Set the floatingbutton position with animation or not.
+ /// Set the floatingbutton position with or without animation.
/// </summary>
- /// <param name="position">Button position</param>
- /// <param name="animated">Animat flag</param>
+ /// <param name="position">Button position.</param>
+ /// <param name="animated">Animation flag.</param>
/// <since_tizen> preview </since_tizen>
public void SetPosition(FloatingButtonPosition position, bool animated)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for FloatingButtonMode
+ /// Enumeration for the FloatingButtonMode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FloatingButtonMode
{
/// <summary>
- /// Allows all positions
+ /// Allows all positions.
/// </summary>
All,
/// <summary>
- /// Allows LEFT and RIGHT positions only
+ /// Allows left and right positions only.
/// </summary>
LeftRightOnly,
}
/// <summary>
- /// Enumeration for FloatingButtonPosition
+ /// Enumeration for the FloatingButtonPosition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FloatingButtonPosition
{
/// <summary>
- /// Hides in the left, but small handler will show only
+ /// Hides in the left, but only the small handler will show.
/// </summary>
LeftOut,
/// <summary>
- /// Shows all of buttons, but lies on the left
+ /// Shows all of the buttons, but lies on the left.
/// </summary>
Left,
/// <summary>
- /// Shows all of buttons, but lies on the center
+ /// Shows all of the buttons, but lies on the center.
/// </summary>
Center,
/// <summary>
- /// Shows all of buttons, but lies on the right
+ /// Shows all of the buttons, but lies on the right.
/// </summary>
Right,
/// <summary>
- /// Hides in the right, but small handler will show only
+ /// Hides in the right, but only the small handler will show.
/// </summary>
RightOut,
}
{
/// <summary>
/// It inherits System.EventArgs.
- /// It contains Item which is <see cref="GenGridItem"/> type.
- /// All events of GenGrid contain GenGridItemEventArgs as a parameter.
+ /// It contains the item which is the <see cref="GenGridItem"/> type.
+ /// All events of the GenGrid contain GenGridItemEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGridItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets GenGrid item.The return type is <see cref="GenGridItem"/>.
+ /// Gets or sets the gengrid item. The return type is <see cref="GenGridItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem Item { get; set; }
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The GenGrid is a widget that aims to position objects in a grid layout while actually creating and rendering only the visible ones.
- /// It has two direction in which a given GenGrid widget expands while placing its items, horizontal and vertical.
- /// The GenGrid items are represented through <see cref="GenItemClass"/> definition field details.
+ /// The GenGrid is a widget that aims to position objects in a grid layout, while actually creating and rendering only the visible ones.
+ /// It has two directions in which a given GenGrid widget expands while placing its items, horizontal and vertical.
+ /// The gengrid items are represented through the <see cref="GenItemClass"/> definition field details.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGrid : Layout
/// <summary>
/// Creates and initializes a new instance of the GenGrid class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by GenGrid as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by GenGrid as a child. It's the <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public GenGrid(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// ItemSelected is raised when a new gengrid item is selected.
+ /// ItemSelected is raised when a new GenGrid item is selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemSelected;
/// <summary>
- /// ItemUnselected is raised when the gengrid item is Unselected.
+ /// ItemUnselected is raised when the gengrid item is unselected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemUnselected;
public event EventHandler<GenGridItemEventArgs> ItemReleased;
/// <summary>
- /// ItemActivated is raised when a new gengrid item is double clicked or pressed (enter|return|spacebar).
+ /// ItemActivated is raised when a new gengrid item is double-clicked or pressed (enter|return|spacebar).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemActivated;
/// <summary>
- /// ItemDoubleClicked is raised when a new gengrid item is double clicked.
+ /// ItemDoubleClicked is raised when a new gengrid item is double-clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemDoubleClicked;
/// <summary>
- /// ItemRealized is raised when a gengrid item is implementing through <see cref="GenItemClass"/>.
+ /// ItemRealized is raised when a gengrid item is implemented through <see cref="GenItemClass"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenGridItemEventArgs> ItemRealized;
public event EventHandler<GenGridItemEventArgs> ItemLongPressed;
/// <summary>
- /// Changed is raised when an item is added, removed, resized or moved and when the gengrid is resized or gets "horizontal" property changes.
+ /// Changed is raised when an item is added, removed, resized, or moved, and when the gengrid is resized or gets "horizontal" property changes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Changed;
/// <summary>
- /// Gets or sets the item's grid alignment along x-axis within a given gengrid widget.
+ /// Gets or sets the item's grid alignment along X-axis within a given GenGrid widget.
/// 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.
+ /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along X-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ItemAlignmentX
}
/// <summary>
- /// Gets or sets the item's grid alignment on y-axis within a given gengrid widget.
+ /// Gets or sets the item's grid alignment on Y-axis within a given GenGrid widget.
/// 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.
+ /// By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along Y-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ItemAlignmentY
}
/// <summary>
- /// Gets or sets the manner in which the items grid is filled within a given gengrid widget.
- /// It is filled if true, otherwise false.
+ /// Gets or sets the manner in which the items grid is filled within a given GenGrid widget.
+ /// It is filled if true, otherwise not filled if false.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool FillItems
}
/// <summary>
- /// Gets or sets whether multi-selection is enabled or disabled for a given gengrid widget.
+ /// Gets or sets whether multi-selection is enabled or disabled for a given GenGrid widget.
/// </summary>
/// <remarks>
/// Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously.
}
/// <summary>
- /// Gets or sets the width for the items of a given gengrid widget.
+ /// Gets or sets the width for the items of a given GenGrid widget.
/// </summary>
/// <remarks>
/// A gengrid, after creation, still has no information on the size to give to each of its cells.
- /// The default width and height just have one finger wide.
+ /// The default width and height just are one finger wide.
/// Use this property to force a custom width for your items, making them as big as you wish.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the height for the items of a given gengrid widget.
+ /// Gets or sets the height for the items of a given GenGrid widget.
/// </summary>
/// <remarks>
/// A gengrid, after creation, still has no information on the size to give to each of its cells.
- /// The default width and height just have one finger wide.
+ /// The default width and height just are one finger wide.
/// Use this property to force a custom height for your items, making them as big as you wish.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the direction for which a given gengrid widget expands while placing its items.
+ /// Gets or sets the direction for which a given GenGrid widget expands while placing its items.
/// </summary>
/// <remarks>
/// 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.
}
/// <summary>
- /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
+ /// Sets or gets the value of HorizontalScrollBarVisiblePolicy.
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
}
/// <summary>
- /// Gets the first item in a given gengrid widget.
+ /// Gets the first item in a given GenGrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem FirstItem
}
/// <summary>
- /// Gets the last item in a given gengrid widget.
+ /// Gets the last item in a given GenGrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem LastItem
}
/// <summary>
- /// Gets the items count in a given gengrid widget.
+ /// Gets the items count in a given GenGrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public uint ItemCount
}
/// <summary>
- /// Gets the selected item in a given gengrid widget.
+ /// Gets the selected item in a given GenGrid widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenGridItem SelectedItem
}
/// <summary>
- /// Gets or sets whether a given gengrid widget is or not able have items reordered.
+ /// Gets or sets whether a given GenGrid widget is able to or not able to have items reordered.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ReorderMode
}
/// <summary>
- /// Appends a new item to a given gengrid widget. This adds an item to the end of the gengrid.
+ /// Appends a new item to a given GenGrid widget. This adds an item to the end of the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a gengrid item that contains data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Prepends a new item to a given gengrid widget. This adds an item to the beginning of the gengrid.
+ /// Prepends a new item to a given GenGrid widget. This adds an item to the beginning of the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a gengrid item that contains data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Inserts an item before another in a gengrid widget. This inserts an item before another in the gengrid.
+ /// Inserts an item before another in a GenGrid widget. This inserts an item before another in the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
- /// <returns>Return a gengrid item that contains data and itemClass./></returns>
+ /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Inserts an item before another in a gengrid widget. This inserts an item after another in the gengrid.
+ /// Inserts an item after another in a GenGrid widget. This inserts an item after another in the gengrid.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="after">The item after which to place this new one.</param>
- /// <returns>Return a gengrid item that contains data and itemClass.</returns>
+ /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenGridItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Insert an item in a gengrid widget using a user-defined sort function.
+ /// Inserts an item in a GenGrid widget using a user-defined sort function.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="comparison">User defined comparison function that defines the sort order based on gengrid item and its data.</param>
- /// <returns>Return a gengrid item that contains data and itemClass.</returns>
+ /// <param name="comparison">User defined comparison function that defines the sort order based on the gengrid item and its data.</param>
+ /// <returns>Return a gengrid item that contains the data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenGridItem InsertSorted(GenItemClass itemClass, object data, Comparison<object> comparison)
{
/// <param name="position">The position of the item in the viewport.</param>
/// <param name="animated">The type of how to show the item.</param>
/// <remarks>
- /// If animated is true, the gengrid shows item by scrolling if it's not fully visible.
- /// If animated is false, the gengrid shows item by jumping if it's not fully visible.
+ /// If animated is true, the gengrid shows the item by scrolling if it's not fully visible.
+ /// If animated is false, the gengrid shows the item by jumping if it's not fully visible.
/// </remarks>
/// <seealso cref="ScrollToPosition"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes all items from a given gengrid widget.
- /// This removes(and deletes) all items in obj, making it empty.
+ /// Removes all the items from a given GenGrid widget.
+ /// This removes (and deletes) all the items in the object, making it empty.
/// </summary>
/// <remarks>
/// <see cref="ItemObject.Delete()"/> to delete just one item.
}
/// <summary>
- /// Get the item that is at the x, y canvas coords.
+ /// Gets the item that is at the X, Y canvas coordinates.
/// </summary>
- /// <param name="x">The input x coordinate</param>
- /// <param name="y">The input y coordinate</param>
+ /// <param name="x">The input X coordinate.</param>
+ /// <param name="y">The input Y coordinate.</param>
/// <param name="portionX">The position relative to the item returned here.
- /// -1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1).
+ /// -1, 0, or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0), or on the right part(1).
/// </param>
- /// <param name="portionY">The position relative to the item returned here
- /// -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).
+ /// <param name="portionY">The position relative to the item returned here.
+ /// -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).
/// </param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="GenItem"/>.
- /// A instance to the gengrid item added.
- /// It contains Update() method to update a gengrid item which is given.
+ /// An instance to the gengrid item is added.
+ /// It contains the Update() method to update a gengrid item which is given.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGridItem : GenItem
}
/// <summary>
- /// Sets or gets the cursor to be shown when mouse is over the gengrid item.
+ /// Sets or gets the cursor to be shown when the mouse is over the gengrid item.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Sets or gets or sets the style of given gengrid item's tooltip.
+ /// Sets or gets, or sets the style of the given gengrid item's tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override string TooltipStyle
}
/// <summary>
- /// Get the gengrid item's select mode.
+ /// Gets the gengrid item's select mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override GenItemSelectionMode SelectionMode
}
/// <summary>
- /// Gets or sets gengrid item's row position, relative to the whole gengrid's grid area.
+ /// Gets or sets the gengrid item's row position, relative to the whole gengrid's grid area.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Row
}
/// <summary>
- /// Gets or sets gengrid item's column position, relative to the whole gengrid's grid area.
+ /// Gets or sets the gengrid item's column position, relative to the whole gengrid's grid area.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Column
}
/// <summary>
- /// Set the text to be shown in the gengrid item.
+ /// Sets the text to be shown in the gengrid item.
/// </summary>
/// <param name="tooltip">The text to set.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Unset tooltip from item.
+ /// Unsets the tooltip from item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override void UnsetTooltip()
/// <summary>
/// Updates the content of a given gengrid item.
- /// This updates an item by calling all the genitem class functions again to get the content, text, and states.
+ /// This updates an item by calling all the GenItem class functions again to get the content, text, and states.
/// Use this when the original item data has changed and you want the changes to reflect.
/// </summary>
/// <remarks>
}
/// <summary>
- /// Set the content to be shown in the tooltip item.
+ /// Sets the content to be shown in the tooltip item.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void UpdateTooltipDelegate()
namespace ElmSharp
{
/// <summary>
- /// Enumeration for select mode of GenItem.
+ /// Enumeration for the selection modes of GenItem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GenItemSelectionMode
/// <summary>
/// It inherits <see cref="ItemObject"/>.
/// A base class for <see cref="GenGridItem"/> and <see cref="GenListItem"/>.
- /// It contains genitem class and data to display data.
+ /// It contains the GenItem class and data to display the data.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract class GenItem : ItemObject
public GenItemClass ItemClass { get; protected set; }
/// <summary>
- /// Sets or gets tooltip content delegate.
+ /// Sets or gets the tooltip content delegate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GetTooltipContentDelegate TooltipContentDelegate
}
/// <summary>
- /// It's a abstract property.
+ /// It's an abstract property.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract GenItemSelectionMode SelectionMode { get; set; }
/// <summary>
- /// Sets or gets the cursor to be shown when mouse is over the gengrid item
+ /// Sets or gets the cursor to be shown when the mouse is over the gengrid item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract string Cursor { get; set; }
public abstract bool IsUseEngineCursor { get; set; }
/// <summary>
- /// Gets item data that is added through calling <see cref="GenGrid.Append(GenItemClass, object)"/>, <see cref="GenGrid.Prepend(GenItemClass, object)"/> or <see cref="GenGrid.InsertBefore(GenItemClass, object, GenGridItem)"/> methods.
+ /// Gets the item data that is added through calling <see cref="GenGrid.Append(GenItemClass, object)"/>, <see cref="GenGrid.Prepend(GenItemClass, object)"/>, or <see cref="GenGrid.InsertBefore(GenItemClass, object, GenGridItem)"/> methods.
/// </summary>
/// <since_tizen> preview </since_tizen>
public object Data { get; protected set; }
/// <summary>
- /// It's a abstract property. It's implemented by <see cref="GenGridItem.IsSelected"/> and <see cref="GenListItem.IsSelected"/>.
+ /// It's an abstract property. It's implemented by <see cref="GenGridItem.IsSelected"/> and <see cref="GenListItem.IsSelected"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract bool IsSelected { get; set; }
/// <summary>
- /// It's a abstract property. It's implemented by <see cref="GenGridItem.TooltipStyle"/> and <see cref="GenListItem.TooltipStyle"/>.
+ /// It's an abstract property. It's implemented by <see cref="GenGridItem.TooltipStyle"/> and <see cref="GenListItem.TooltipStyle"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract string TooltipStyle { get; set; }
/// <summary>
- /// Set tooltip text.
+ /// Sets the tooltip text.
/// </summary>
/// <param name="tooltip">The text to set.</param>
/// <since_tizen> preview </since_tizen>
public abstract void SetTooltipText(string tooltip);
/// <summary>
- /// Unset tooltip.
+ /// Unsets the tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract void UnsetTooltip();
/// <summary>
- /// It's a abstract method. It's implemented by <see cref="GenGridItem.Update"/> and <see cref="GenListItem.Update"/>.
+ /// It's an abstract method. It's implemented by <see cref="GenGridItem.Update"/> and <see cref="GenListItem.Update"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public abstract void Update();
/// <summary>
- /// The override method for delete item class and item data. It's called when the item is deleting.
+ /// The override method for deleting the item class and item data. It's called when the item is deleted.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnInvalidate()
}
/// <summary>
- /// Abstract method for updating tooltip content.
+ /// Abstract method for updating the tooltip content.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected abstract void UpdateTooltipDelegate();
{
/// <summary>
/// It represents the GenGrid or GenList item class definition field details.
- /// It has some display styles, such as "default", "full" and "group_index".
+ /// It has some display styles, such as "default", "full", and "group_index".
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenItemClass : IDisposable
/// </summary>
/// <param name="data">The item data.</param>
/// <param name="part">The part where the data should be shown.</param>
- /// <param name="old">The content has been added in gengrid.</param>
+ /// <param name="old">The content that has been added in gengrid.</param>
/// <returns>Return content that should be shown.</returns>
/// <since_tizen> preview </since_tizen>
public delegate EvasObject GetReusableContentDelegate(object data, string part, EvasObject old);
}
/// <summary>
- /// Destroy the GenItemClass object.
+ /// Destroys the GenItemClass object.
/// </summary>
~GenItemClass()
{
public string ItemStyle { get { return _style; } }
/// <summary>
- /// Gets or sets the callback that defines how to display item text.
+ /// Gets or sets the callback that defines how to display the item text.
/// If get, return <see cref="GetTextDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GetTextDelegate GetTextHandler { get; set; }
/// <summary>
- /// Gets or sets the callback that defines how to display item content.
+ /// Gets or sets the callback that defines how to display the item content.
/// If get, return <see cref="GetContentDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GetContentDelegate GetContentHandler { get; set; }
/// <summary>
- /// Gets or sets the callback that defines how to delete item text and content.
+ /// Gets or sets the callback that defines how to delete the item text and content.
/// If get, return <see cref="DeleteDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DeleteDelegate DeleteHandler { get; set; }
/// <summary>
- /// Gets or sets the callback that defines how to reuse item content.
+ /// Gets or sets the callback that defines how to reuse the item content.
/// If get, return <see cref="GetReusableContentDelegate"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if managed resources should be disposed
- /// otherwise, false.
+ /// true if the managed resources should be disposed,
+ /// otherwise false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Create a new genlist item class in a given genlist widget.
+ /// Creates a new GenList item class in a given GenList widget.
/// </summary>
/// <returns>The new item class object.</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Remove an item class in a given genlist widget.
+ /// Removes an item class in a given GenList widget.
/// </summary>
/// <param name="unmanagedPtr">The object to be removed.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// It represents the GenGrid item class definition field details.
+ /// It represents the gengrid item class definition field details.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenGridItemClass : GenItemClass
}
/// <summary>
- /// Add a new gengrid item class in a given gengrid widget.
+ /// Adds a new gengrid item class in a given GenGrid widget.
/// </summary>
/// <returns>The new instance.</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Remove an item class in a given gengrid widget.
+ /// Removes the item class in a given GenGrid widget.
/// </summary>
/// <param name="unmanagedPtr">The object to be removed.</param>
/// <since_tizen> preview </since_tizen>
namespace ElmSharp
{
/// <summary>
- /// Enumeration for setting genlist item type.
+ /// Enumeration for setting the genlist item types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GenListItemType
{
/// <summary>
- /// if Normal is set then this item is normal item.
+ /// If Normal is set, then this item is a normal item.
/// </summary>
Normal = 0,
/// <summary>
- /// If tree is set then this item is displayed as an item that is able to expand and have child items.
+ /// If Tree is set, then this item is displayed as an item that is able to expand and have child items.
/// </summary>
Tree = (1 << 0),
/// <summary>
- /// if Group is set then this item is group index item that is displayed at the top until the next group comes.
+ /// If Group is set, then this item is a group index item that is displayed at the top until the next group comes.
/// </summary>
Group = (1 << 1),
}
/// <summary>
- /// Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping.
+ /// Enumeration for setting the genlist's resizing behavior, transverse axis scrolling, and items cropping.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GenListMode
{
/// <summary>
/// The genlist won't set any of its size hints to inform how a possible container should resize it.
- /// Then, if it's not created as a "resize object", it might end with zeroed dimensions.
- /// The genlist will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
+ /// Then, if it's not created as a "resize object", it might end up with zeroed dimensions.
+ /// The genlist will respect the container's geometry,and if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
/// </summary>
Compress = 0,
Limit,
/// <summary>
- /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.
+ /// Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time.
/// This is naturally bound by the genlist object's maximum size hints, set externally.
/// </summary>
Expand
/// <summary>
/// It inherits System.EventArgs.
- /// It contains Item which is <see cref="GenListItem"/> type.
- /// All events of GenList contain GenListItemEventArgs as a parameter.
+ /// It contains an item which is <see cref="GenListItem"/> type.
+ /// All events of the GenList contain GenListItemEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenListItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets GenList item. The return type is <see cref="GenListItem"/>.
+ /// Gets or sets the genlist item. The return type is <see cref="GenListItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenListItem Item { get; set; }
}
/// <summary>
- /// Enumeration that defines where to position the item in the genlist.
+ /// Enumeration for defining where to position the item in the genlist.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ScrollToPosition
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The GenList is a widget that aims to have more expansive list than the simple <see cref="List"/> in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage.
+ /// The GenList is a widget that aims to have a more expansive list than the simple <see cref="List"/> in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage.
/// At the same time it was also made to be able to do tree structures.
- /// 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 <see cref="List"/> widget.
+ /// But the price to pay is more complex when it comes to usage.
+ /// If all you want is a simple list with icons and a single text, use <see cref="List"/> widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenList : Layout
/// <summary>
/// Creates and initializes a new instance of the GenList class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by GenList as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by GenList as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public GenList(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of GenList class.
+ /// Creates and initializes a new instance of the GenList class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected GenList() : base()
/// Gets or sets whether the homogeneous mode is enabled.
/// </summary>
/// <remarks>
- /// If true, the genlist items have same height and width.
+ /// If true, the genlist items will have the same height and width.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool Homogeneous
/// <summary>
/// Gets or sets the horizontal stretching mode. This mode used for sizing items horizontally.
- /// The default value is <see cref="GenListMode.Scroll"/> which means that if items are too wide to fit, the scroller scrolls horizontally.
- /// If set <see cref="GenListMode.Compress"/> which means that the item width is fixed (restricted to a minimum of) to the list width when calculating its size in order to allow the height to be calculated based on it.
- /// If set <see cref="GenListMode.Limit"/> which means that items are expanded to the viewport width and limited to that size.
- /// if set <see cref="GenListMode.Expand"/> which means that genlist try to reserve space to all its items to be visible at a time.
+ /// The default value is <see cref="GenListMode.Scroll"/>, which means that if the items are too wide to fit, the scroller scrolls horizontally.
+ /// If set to <see cref="GenListMode.Compress"/>, means that the item width is fixed (restricted to a minimum) to the list width when calculating its size in order to allow the height to be calculated based on it.
+ /// If set to <see cref="GenListMode.Limit"/>, means that items are expanded to the viewport width and limited to that size.
+ /// If set to <see cref="GenListMode.Expand"/>, means that genlist try to reserve space to all its items to be visible at a time.
/// </summary>
/// <remarks>
- /// Compress makes genlist resize slower as it recalculates every item height again whenever the list width changes.
- /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, genlist items are initialized fast.
- /// However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK).
+ /// Compress makes the genlist resize slower, as it recalculates every item height again whenever the list width changes.
+ /// The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, the genlist items are initialized fast.
+ /// However, there are no subobjects 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or set the maximum number of items within an item block.
+ /// Gets or sets the maximum number of items within an item block.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int BlockCount
}
/// <summary>
- /// Gets or Sets focus upon items selection mode.
+ /// Gets or sets the focus upon the items selection mode.
/// </summary>
/// <remarks>
- /// When enabled, every selection of an item inside the <see cref="GenList"/> will automatically set focus to its first focusable widget from the left.
- /// 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.
+ /// When enabled, every selection of an item inside <see cref="GenList"/> will automatically set focus to its first focusable widget from the left.
+ /// 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets whether enable multi-selection in the genlist.
+ /// Gets or sets whether to enable multi-selection in the genlist.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsMultiSelection
}
/// <summary>
- /// Gets the selected item in a given genlist widget.
+ /// Gets the selected item in a given GenList widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public GenListItem SelectedItem
}
/// <summary>
- /// Gets count of items in a this genlist widget
+ /// Gets the count of items in a this genlist widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Count
public event EventHandler<GenListItemEventArgs> ItemSelected;
/// <summary>
- /// ItemUnselected is raised when the genlist item is Unselected.
+ /// ItemUnselected is raised when the genlist item is unselected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemUnselected;
public event EventHandler<GenListItemEventArgs> ItemReleased;
/// <summary>
- /// ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar).
+ /// ItemActivated is raised when a new genlist item is double-clicked or pressed (enter|return|spacebar).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemActivated;
/// <summary>
- /// ItemDoubleClicked is raised when a new genlist item is double clicked.
+ /// ItemDoubleClicked is raised when a new genlist item is double-clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemDoubleClicked;
/// <summary>
/// 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.
+ /// After calling unrealize, the item's content objects are deleted, and the item object itself is deleted or is put into a floating cache.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemUnrealized;
/// <summary>
- /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second.
+ /// ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default, it's 1 second.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<GenListItemEventArgs> ItemLongPressed;
public event EventHandler<GenListItemEventArgs> ItemMovedBefore;
/// <summary>
- /// Changed is raised when genlist is changed.
+ /// Changed is raised when the genlist has changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Changed
}
/// <summary>
- /// ScrollAnimationStarted is raised when scrolling animation has started.
+ /// ScrollAnimationStarted is raised when the scrolling animation has started.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ScrollAnimationStarted
}
/// <summary>
- /// ScrollAnimationStopped is raised when scrolling animation has stopped.
+ /// ScrollAnimationStopped is raised when the scrolling animation has stopped.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ScrollAnimationStopped
}
/// <summary>
- /// Appends a new item to the end of a given genlist widget.
+ /// Appends a new item to the end of a given GenList widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
/// <seealso cref="GenItemClass"/>
/// <seealso cref="GenListItem"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Appends a new item with <see cref="GenListItemType"/> to the end of a given genlist widget.
+ /// Appends a new item with <see cref="GenListItemType"/> to the end of a given GenList widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type)
{
}
/// <summary>
- /// Appends a new item with <see cref="GenListItemType"/> to the end of a given genlist widget or the end of the children list if the parent is given.
+ /// Appends a new item with <see cref="GenListItemType"/> to the end of a given GenList widget or the end of the children list, if the parent is given.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Append(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Prepends a new item to the beginning of a given genlist widget.
+ /// Prepends a new item to the beginning of a given GenList widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Prepend(GenItemClass itemClass, object data)
{
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type)
{
}
/// <summary>
- /// Prepends a new item with <see cref="GenListItemType"/> to the beginning of a given genlist widget or the beginning of the children list if the parent is given.
+ /// Prepends a new item with <see cref="GenListItemType"/> to the beginning of a given GenList widget or the beginning of the children list, if the parent is given.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains the data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem Prepend(GenItemClass itemClass, object data, GenListItemType type, GenListItem parent)
{
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before)
{
}
/// <summary>
- /// Inserts an item with <see cref="GenListItemType"/> before another item in a genlist widget.
- /// It is the same tree level or group as the item before which it is inserted.????
+ /// Inserts an item with <see cref="GenListItemType"/> before another item in a GenList widget.
+ /// It is the same tree level or group as the item before which it is inserted.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type)
{
}
/// <summary>
- /// Inserts an item with <see cref="GenListItemType"/> before another item under a parent in a genlist widget.
+ /// Inserts an item with <see cref="GenListItemType"/> before another item under a parent in a GenList widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="before">The item before which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertBefore(GenItemClass itemClass, object data, GenListItem before, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Inserts an item with <see cref="GenListItemType"/> after another item under a parent in a genlist widget.
+ /// Inserts an item with <see cref="GenListItemType"/> after another item under a parent in a GenList widget.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
/// <param name="after">The item after which to place this new one.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a new added genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a newly added genlist item that contains data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertAfter(GenItemClass itemClass, object data, GenListItem after, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Insert an item in a genlist widget using a user-defined sort function.
+ /// Inserts an item in a GenList widget using a user-defined sort function.
/// </summary>
/// <param name="itemClass">The itemClass defines how to display the data.</param>
/// <param name="data">The item data.</param>
- /// <param name="comparison">User defined comparison function that defines the sort order based on genlist item and its data.</param>
+ /// <param name="comparison">User-defined comparison function that defines the sort order based on the genlist item and its data.</param>
/// <param name="type">The genlist item type.</param>
/// <param name="parent">The parent item, otherwise null if there is no parent item.</param>
- /// <returns>Return a genlist item that contains data and itemClass.</returns>
+ /// <returns>Return a genlist item that contains the data and itemClass.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem InsertSorted(GenItemClass itemClass, object data, Comparison<object> comparison, GenListItemType type, GenListItem parent)
{
}
/// <summary>
- /// Shows the given item with position type in a genlist.
- /// When animated is true, genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and may take some time.
- /// When animated is false, genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible.
+ /// Shows the given item with the position type in a genlist.
+ /// When animated is true, the genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and take sometime.
+ /// When animated is false, the genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible.
/// </summary>
/// <param name="item">The item to display.</param>
/// <param name="position">The position to show the given item to <see cref="ScrollToPosition"/>.</param>
/// <summary>
/// Updates the content of all the realized items.
- /// This updates all the realized items by calling all the <see cref="GenItemClass"/> again to get the content, text and states.
+ /// This updates all the realized items by calling all <see cref="GenItemClass"/> again to get the content, text, and states.
/// Use this when the original item data has changed and the changes are desired to reflect.
/// To update just one item, use <see cref="GenListItem.Update"/>.
/// </summary>
}
/// <summary>
- /// Removes all items from a given genlist widget.
- /// This removes (and deletes) all items in obj, making it empty.
+ /// Removes all the items from a given genlist widget.
+ /// This removes (and deletes) all items in the object, making it empty.
/// To delete just one item, use <see cref="ItemObject.Delete"/>.
/// </summary>
/// <seealso cref="ItemObject.Delete"/>
}
/// <summary>
- /// Get the item that is at the x, y canvas coords.
+ /// Gets the item that is at the X, Y canvas coordinates.
/// </summary>
- /// <param name="x">The input x coordinate</param>
- /// <param name="y">The input y coordinate</param>
- /// <param name="pos">The position relative to the item returned here
- /// -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).
+ /// <param name="x">The input X-coordinate.</param>
+ /// <param name="y">The input Y-coordinate.</param>
+ /// <param name="pos">The position relative to the item returned here.
+ /// -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).
/// </param>
- /// <returns></returns>
+ /// <returns>The item at the given coordinates.</returns>
/// <since_tizen> preview </since_tizen>
public GenListItem GetItemByPosition(int x, int y, out int pos)
{
/// <summary>
/// Gets the nth item in a given genlist widget, placed at position nth, in its internal items list.
/// </summary>
- /// <param name="index">The number of the item to grab (0 being the first)</param>
+ /// <param name="index">The number of the item to grab (0 being the first).</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public GenListItem GetItemByIndex(int index)
}
/// <summary>
- /// The callback of Unrealize Event
+ /// The callback of the Unrealized event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The type of item's part type.
+ /// The type of the item's part types.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Flags]
All = 0,
/// <summary>
- /// The text part type.
+ /// The Text part type.
/// </summary>
Text = (1 << 0),
Content = (1 << 1),
/// <summary>
- /// The state of part.
+ /// The State part type.
/// </summary>
State = (1 << 2),
/// <summary>
/// It inherits <see cref="GenItem"/>.
- /// A instance to the genlist item added.
- /// It contains Update() method to update a genlist item which is given.
+ /// A instance to the genlist item is added.
+ /// It contains the Update() method to update a genlist item which is given.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GenListItem : GenItem
/// <summary>
/// Updates the content of an item.
- /// This updates an item by calling all the <see cref="GenItemClass"/> again to get the content, text, and states.
+ /// This updates an item by calling all <see cref="GenItemClass"/> again to get the content, text, and states.
/// Use this when the original item data has changed and the changes are desired to reflect.
- /// To update already realized items, use <see cref="GenList.UpdateRealizedItems"/>.
+ /// To update the already realized items, use <see cref="GenList.UpdateRealizedItems"/>.
/// </summary>
/// <seealso cref="GenList.UpdateRealizedItems"/>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Updates the part of an item.
- /// This updates an item's part by calling item's fetching functions again to get the contents, texts and states.
+ /// This updates an item's part by calling the item's fetching functions again to get the contents, texts, and states.
/// Use this when the original item data has changed and the changes are desired to be reflected.
/// To update an item's all property, use <see cref="GenList.UpdateRealizedItems"/>.
/// </summary>
- /// <param name="part">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.</param>
- /// <param name="type">The type of item's part type.</param>
+ /// <param name="part">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 for updating multi-fields.</param>
+ /// <param name="type">The type of the item's part type.</param>
/// <seealso cref="GenList.UpdateRealizedItems"/>
/// <since_tizen> preview </since_tizen>
public void UpdateField(string part, GenListItemFieldType type)
}
/// <summary>
- /// Demote an item to the end of the list.
+ /// Demotes an item to the end of the list.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void DemoteItem()
}
/// <summary>
- /// Get the previous item in a genlist widget's internal list of items.
+ /// Gets the previous item in a genlist widget's internal list of items.
/// </summary>
/// <seealso cref="Next"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the content to be shown in the tooltip item
+ /// Sets or gets the content to be shown in the tooltip item.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Set the text to be shown in the genlist item.
+ /// Sets the text to be shown in the genlist item.
/// </summary>
/// <param name="tooltip">The text to set in the content.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Unset tooltip from item.
+ /// Unsets the tooltip from the item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override void UnsetTooltip()
}
/// <summary>
- /// Gets or sets the style of given genlist item's tooltip.
+ /// Gets or sets the style of the given genlist item's tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override string TooltipStyle
}
/// <summary>
- /// Gets or sets whether disable size restrictions on an object's tooltip.
+ /// Gets or sets the disable size restrictions on an object's tooltip.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsTooltipWindowMode
}
/// <summary>
- /// Gets the index of the item. It is only valid once displayed.
+ /// Gets the index of the item. It is only valid, once displayed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Index
}
/// <summary>
- /// Gets the depth of expanded item.
+ /// Gets the depth of the expanded item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ExpandedItemDepth
}
/// <summary>
- /// Remove all sub-items (children) of the given item.
+ /// Remove all the subitems (children) of the given item.
/// </summary>
/// <remarks>
- /// This removes all items that are children (and their descendants) of the given item it.
+ /// This removes the items that are the children (and their descendants) of the given item.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public void ClearSubitems()
}
/// <summary>
- /// Update the item class of an item.
+ /// Updates the item class of the item.
/// This sets another class of the item, changing the way that it is displayed. After changing the item class, <see cref="Update"/> is called on the item.
/// </summary>
/// <param name="itemClass">The item class for the item.</param>
}
/// <summary>
- /// Set the content to be shown in the tooltip item.
+ /// Sets the content to be shown in the tooltip item.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void UpdateTooltipDelegate()
{
/// <summary>
/// The GestureLayer is used to detect gestures.
- /// Inherits Widget
+ /// Inherits Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class GestureLayer : Widget
private readonly List<NativeCallback> _handlers = new List<NativeCallback>();
/// <summary>
- /// Creates and initializes a new instance of GestureLayer class.
+ /// Creates and initializes a new instance of the GestureLayer class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by GestureLayer as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container which will be attached by the GestureLayer as a child. It's the <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public GestureLayer(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Enumeration for supported gesture types.
+ /// Enumeration for the supported gesture types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GestureType
{
/// <summary>
- /// N fingers single taps
+ /// N fingers single taps.
/// </summary>
Tap = 1,
/// <summary>
- /// N fingers single long-taps
+ /// N fingers single long-taps.
/// </summary>
LongTap,
/// <summary>
- /// N fingers double-single taps
+ /// N fingers double-single taps.
/// </summary>
DoubleTap,
/// <summary>
- /// N fingers triple-single taps
+ /// N fingers triple-single taps.
/// </summary>
TripleTap,
/// <summary>
- /// Reports momentum in the direction of move
+ /// Reports momentum in the direction of the move.
/// </summary>
Momentum,
/// <summary>
- /// N fingers line gesture
+ /// N fingers line gesture.
/// </summary>
Line,
/// <summary>
- /// N fingers flick gesture
+ /// N fingers flick gesture.
/// </summary>
Flick,
/// <summary>
- /// Zoom
+ /// Zoom.
/// </summary>
Zoom,
/// <summary>
- /// Rotate
+ /// Rotate.
/// </summary>
Rotate,
}
/// <summary>
- /// Enumeration for gesture states.
+ /// Enumeration for the gesture states.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum GestureState
{
/// <summary>
- /// Gesture not started
+ /// Gesture not started.
/// </summary>
Undefined = -1,
/// <summary>
- /// Gesture started
+ /// Gesture started.
/// </summary>
Start,
/// <summary>
- /// Gesture is ongoing
+ /// Gesture is ongoing.
/// </summary>
Move,
/// <summary>
- /// Gesture completed
+ /// Gesture completed.
/// </summary>
End,
/// <summary>
- /// Ongoing gesture is aborted
+ /// Ongoing gesture is aborted.
/// </summary>
Abort,
}
}
/// <summary>
- /// Sets or gets the gesture layer continues enable of an object
+ /// Sets or gets the gesture layer to continue enable of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Continues
}
/// <summary>
- /// Sets or gets the gesture layer long tap start timeout of an object
+ /// Sets or gets the gesture layer long tap start timeout of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double LongTapTimeout
}
/// <summary>
- /// Sets or gets the gesture layer double tap timeout of an object
+ /// Sets or gets the gesture layer double tap timeout of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double DoubleTapTimeout
}
/// <summary>
- /// Sets or gets the gesture layer flick time limit (in ms) of an object
+ /// Sets or gets the gesture layer flick time limit (in ms) of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int FlickTimeLimit
}
/// <summary>
- /// Sets or gets the gesture layer line min length of an object
+ /// Sets or gets the gesture layer line minimum length of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int MinimumLineLength
}
/// <summary>
- /// Sets or gets the gesture layer line angular tolerance of an object
+ /// Sets or gets the gesture layer line angular tolerance of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double LineAngularTolerance
}
/// <summary>
- /// Sets or gets the gesture layer line distance tolerance of an object
+ /// Sets or gets the gesture layer line distance tolerance of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int LineDistanceTolerance
}
/// <summary>
- /// Sets or gets step-value for rotate action.
+ /// Sets or gets the step-value for the rotate action.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double RotateStep
}
/// <summary>
- /// Sets or gets the gesture layer rotate angular tolerance of an object
+ /// Sets or gets the gesture layer rotate angular tolerance of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double RotateAngularTolerance
}
/// <summary>
- /// Sets or gets control step value for zoom action.
+ /// Sets or gets the control step value for the zoom action.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ZoomStep
}
/// <summary>
- /// Sets or gets the gesture layer zoom distance tolerance of an object
+ /// Sets or gets the gesture layer zoom distance tolerance of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ZoomDistanceTolerance
}
/// <summary>
- /// Sets or gets the gesture layer zoom finger factor of an object
+ /// Sets or gets the gesture layer zoom finger factor of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ZoomFingerFactor
}
/// <summary>
- /// Sets or gets the gesture layer zoom wheel factor of an object
+ /// Sets or gets the gesture layer zoom wheel factor of an object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double ZoomWheelFactor
#endregion Properties
/// <summary>
- /// Attach a gesture layer widget to an Evas object (setting the widget's target).
+ /// Attaches a gesture layer widget to an Evas object (setting the widget's target).
/// A gesture layer's target may be any Evas object. This object will be used to listen to mouse and key events.
/// </summary>
/// <param name="target">The object to attach.</param>
}
/// <summary>
- /// Set the gesture state change callback.
+ /// Sets the gesture state change callback.
/// When all callbacks for the gesture are set to null, it means this gesture is disabled.
/// </summary>
/// <param name="type">The gesture you want to track state of.</param>
}
/// <summary>
- /// clear the gesture state change callback.
+ /// Clears the gesture state change callback.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearCallbacks()
// Following methods have been added for convenience, so the user will not have to convert Info structures himself
/// <summary>
- /// Set the tap callback.
+ /// Sets the tap callback.
/// </summary>
/// <param name="type">The gesture you want to track state of.</param>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
}
/// <summary>
- /// Set the gesture state change callback with Momentum Gesture Type
+ /// Sets the gesture state change callback with momentum gesture type.
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Set the gesture state change callback with Line Gesture Type
+ /// Sets the gesture state change callback with line gesture type.
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Set the gesture state change callback with Flick Gesture Type
+ /// Sets the gesture state change callback with flick gesture type.
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Set the gesture state change callback with Zoom Gesture Type
+ /// Sets the gesture state change callback with zoom gesture type.
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
}
/// <summary>
- /// Set the gesture state change callback with Rotate Gesture Type
+ /// Sets the gesture state change callback with rotate gesture type.
/// </summary>
/// <param name="state">The event the callback tracks (START, MOVE, END, ABORT).</param>
/// <param name="action">The callback itself.</param>
#endregion Typed callback setting methods
/// <summary>
- /// Call this function to construct a new gesture-layer object.
+ /// Calls this function to construct a new gesture-layer object.
/// </summary>
/// <param name="parent">The gesture layer's parent widget.</param>
/// <returns></returns>
}
/// <summary>
- /// clear the gesture state change callback.
+ /// Clears the gesture state change callback.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnUnrealize()
#region Info structures
/// <summary>
- /// The struct of TapData
+ /// The struct of TapData.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct TapData
{
/// <summary>
- /// The x coordinate of the center point.
+ /// The X coordinate of the center point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 X;
/// <summary>
- /// The y coordinate of the center point.
+ /// The Y coordinate of the center point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y;
}
/// <summary>
- /// The struct of MomentumData
+ /// The struct of MomentumData.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public Int32 X2;
/// <summary>
- /// Final-swipe direction ending point on Y
+ /// Final-swipe direction ending point on Y.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y2;
#pragma warning disable 3003
/// <summary>
- /// Timestamp of start of final x-swipe.
+ /// Timestamp of start of final X-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 HorizontalSwipeTimestamp;
/// <summary>
- /// Timestamp of start of final y-swipe.
+ /// Timestamp of start of final Y-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 VerticalSwipeTimestamp;
}
/// <summary>
- /// The struct of LineData
+ /// The struct of LineData.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public Int32 X2;
/// <summary>
- /// Final-swipe direction ending point on Y
+ /// Final-swipe direction ending point on Y.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y2;
#pragma warning disable 3003
/// <summary>
- /// Timestamp of start of final x-swipe.
+ /// Timestamp of start of final X-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 HorizontalSwipeTimestamp;
/// <summary>
- /// Timestamp of start of final y-swipe.
+ /// Timestamp of start of final Y-swipe.
/// </summary>
/// <since_tizen> preview </since_tizen>
public UInt32 VerticalSwipeTimestamp;
}
/// <summary>
- /// The struct of ZoomData
+ /// The struct of ZoomData.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct ZoomData
{
/// <summary>
- /// The x coordinate of zoom center point reported to user.
+ /// The X coordinate of zoom center point reported to the user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 X;
/// <summary>
- /// The y coordinate of zoom center point reported to user.
+ /// The Y coordinate of zoom center point reported to the user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y;
}
/// <summary>
- /// The struct of RotateData
+ /// The struct of RotateData.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
public struct RotateData
{
/// <summary>
- /// The x coordinate of rotation center point reported to user.
+ /// The X coordinate of rotation center point reported to the user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 X;
/// <summary>
- /// The y coordinate of rotation center point reported to user.
+ /// The Y coordinate of rotation center point reported to the user.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Int32 Y;
namespace ElmSharp
{
/// <summary>
- /// The HoverselItemEventArgs is an HoverselItem's EventArgs
+ /// The HoverselItemEventArgs is a HoverselItem's EventArgs.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class HoverselItemEventArgs : EventArgs
{
/// <summary>
- /// Hoversel's Item
+ /// The hoversel's item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public HoverselItem Item { get; set; }
/// <summary>
/// Creates and initializes a new instance of the Hoversel class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Hoversel as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by Hoversel as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Hoversel(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Clicked will be triggered when Hoversel is clicked
+ /// Clicked will be triggered when the hoversel is clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Expanded will be triggered when Hoversel is activated by clicking the hoversel or by a function
+ /// Expanded will be triggered when the hoversel is activated by clicking the hoversel, or by a function.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Expanded;
/// <summary>
- /// Dismissed will be triggered when Hoversel Dismissed
+ /// Dismissed will be triggered when the hoversel is dismissed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Dismissed;
/// <summary>
- /// ItemSelected will be triggered when Hoversel's Item Selected
+ /// ItemSelected will be triggered when the hoversel's item is selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<HoverselItemEventArgs> ItemSelected;
}
/// <summary>
- /// Gets or sets the status of whether update icon and text of hoversel same to those of selected item automatically.
+ /// Gets or sets the status of whether to update the icon and text of hoversel same to those of the selected item automatically.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool AutoUpdate
}
/// <summary>
- /// This triggers the hoversel popup from code, the same as if the user had clicked the button.
+ /// This triggers the hoversel popup from the code, the same as if the user had clicked the button.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void HoverBegin()
}
/// <summary>
- /// Add an item to the hoversel button.
+ /// Adds an item to the hoversel button.
/// This adds an item to the hoversel to show when it is clicked.
/// </summary>
- /// <param name="label">Item's label</param>
+ /// <param name="label">Item's label.</param>
/// <returns>A handle to the added item.</returns>
/// <since_tizen> preview </since_tizen>
public HoverselItem AddItem(string label)
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The HoverselItem is the Item of Hoversel
+ /// The HoverselItem is the item of Hoversel.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class HoverselItem : ItemObject
}
/// <summary>
- /// HoverselItem's label
+ /// The HoverselItem's label.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Label { get; internal set; }
/// <summary>
- /// ItemSelected will be triggered when HoverselItem Selected
+ /// ItemSelected will be triggered when the HoverselItem is selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ItemSelected;
namespace ElmSharp.Accessible
{
/// <summary>
- /// IAccessibleObject is a interface which defines properties and methods of accessible object.
+ /// IAccessibleObject is an interface, which defines the properties and methods of an accessible object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IAccessibleObject
ReadingInfoType ReadingInfoType { get; set; }
/// <summary>
- /// Gets or sets the role of the object in accessibility domain.
+ /// Gets or sets the role of the object in an accessibility domain.
/// </summary>
/// <since_tizen> preview </since_tizen>
AccessRole Role { get; set; }
/// <summary>
- /// Gets or sets highlightable of given widget.
+ /// Gets or sets the highlightable of the given widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
bool CanHighlight { get; set; }
/// <summary>
- /// Gets or sets the translation domain of "name" and "description" properties.
- /// Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties.
- /// 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.
+ /// Gets or sets the translation domain of the "name" and "description" properties.
+ /// Translation domain should be set if the application wants to support i18n for accessing the "name" and "description" properties.
+ /// When the translation domain is set, values of the "name" and "description" properties will be translated with dgettext function using the current translation domain as "domainname" parameter.
+ /// It is the application developer's responsibility to ensure that translation files are loaded and binded to the translation domain when accessibility is enabled.
/// </summary>
/// <since_tizen> preview </since_tizen>
string TranslationDomain { get; set; }
string Name { get; set; }
/// <summary>
- /// Gets or sets contextual information about object.
+ /// Gets or sets contextual information about the object.
/// </summary>
/// <since_tizen> preview </since_tizen>
string Description { get; set; }
AccessibleInfoProvider NameProvider { get; set; }
/// <summary>
- /// Gets or sets the delegate for <see cref = "IAccessibleObject.Description" />.
+ /// Gets or sets the delegate for <see cref="IAccessibleObject.Description"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
AccessibleInfoProvider DescriptionProvider { get; set; }
/// <summary>
/// Defines the relationship between two accessible objects.
/// Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience.
- /// AppendRelation API is asymmetric, which means that appending, for example, relation <see cref="FlowsTo"/> from object A to B, do not append relation <see cref="FlowsFrom"/> from object B to object A.
+ /// AppendRelation API is asymmetric, which means that appending (For example, relation <see cref="FlowsTo"/> from object A to B) do not append relation <see cref="FlowsFrom"/> from object B to object A.
/// </summary>
- /// <param name="relation">The relationship between source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between the source object and target object of a given type.</param>
/// <since_tizen> preview </since_tizen>
void AppendRelation(IAccessibleRelation relation);
/// <summary>
/// Removes the relationship between two accessible objects.
/// </summary>
- /// <param name="relation">The relationship between source object and target object of a given type.</param>
+ /// <param name="relation">The relationship between the source object and target object of a given type.</param>
/// <since_tizen> preview </since_tizen>
void RemoveRelation(IAccessibleRelation relation);
/// <summary>
- /// Highlights accessible widget.
+ /// Highlights the accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
void Highlight();
/// <summary>
- /// Clears highlight of accessible widget.
+ /// Clears the highlight of the accessible widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
void Unhighlight();
namespace ElmSharp
{
/// <summary>
- /// The AnimatorMotionMapper interface
+ /// The AnimatorMotionMapper interface.
/// </summary>
/// <since_tizen> preview </since_tizen>
public interface IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
double Calculate(double position);
}
/// <summary>
- /// The LinearMotionMapper class
+ /// The LinearMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class LinearMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The AccelerateMotionMapper class
+ /// The AccelerateMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class AccelerateMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The DecelerateMotionMapper class
+ /// The DecelerateMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DecelerateMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The SinusoidalMotionMapper class
+ /// The SinusoidalMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SinusoidalMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
}
- /// <summary>
- /// The AccelerateFactorMotionMapper class
+ /// <summary>.
+ /// The AccelerateFactorMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class AccelerateFactorMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The power factor of AccelerateFactorMotionMapper
+ /// The power factor of AccelerateFactorMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double PowerFactor { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The DecelerateFactorMotionMapper class
+ /// The DecelerateFactorMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DecelerateFactorMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The power factor of DecelerateFactorMotionMapper
+ /// The power factor of DecelerateFactorMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double PowerFactor { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The SinusoidalFactorMotionMapper class
+ /// The SinusoidalFactorMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SinusoidalFactorMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The power factor of SinusoidalFactorMotionMapper
+ /// The power factor of SinusoidalFactorMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double PowerFactor { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The DivisorInterpolatedMotionMapper class
+ /// The DivisorInterpolatedMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class DivisorInterpolatedMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The Divisor of DivisorInterpolatedMotionMapper
+ /// The Divisor of DivisorInterpolatedMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Divisor { get; set; } = 0;
/// <summary>
- /// The power of DivisorInterpolatedMotionMapper
+ /// The power of DivisorInterpolatedMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Power { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The BounceMotionMapper class
+ /// The BounceMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class BounceMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The bounces of BounceMotionMapper
+ /// The bounces of BounceMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Bounces { get; set; } = 0;
/// <summary>
- /// The decay factor of BounceMotionMapper
+ /// The decay factor of BounceMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double DecayFactor { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The SpringMotionMapper class
+ /// The SpringMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class SpringMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The wobbles of SpringMotionMapper
+ /// The wobbles of SpringMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Wobbles { get; set; } = 0;
/// <summary>
- /// The decat factir of SpringMotionMapper
+ /// The decay factor of SpringMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double DecayFactor { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
}
/// <summary>
- /// The CubicBezierMotionMapper class
+ /// The CubicBezierMotionMapper class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class CubicBezierMotionMapper : IAnimatorMotionMapper
{
/// <summary>
- /// The X1 of CubicBezierMotionMapper
+ /// The X1 of CubicBezierMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double X1 { get; set; } = 0;
/// <summary>
- /// The Y1 of CubicBezierMotionMapper
+ /// The Y1 of CubicBezierMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Y1 { get; set; } = 0;
/// <summary>
- /// The X2 of CubicBezierMotionMapper
+ /// The X2 of CubicBezierMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double X2 { get; set; } = 0;
/// <summary>
- /// The Y2 of CubicBezierMotionMapper
+ /// The Y2 of CubicBezierMotionMapper.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Y2 { get; set; } = 0;
/// <summary>
- /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve
+ /// Maps an input position from 0.0 to 1.0 along a timeline to a position in a different curve.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Calculate(double position)
public enum IconLookupOrder
{
/// <summary>
- /// Icon look up order: freedesktop, theme
+ /// Icon look up order: freedesktop, theme.
/// </summary>
FreeDesktopFirst = 0,
/// <summary>
- /// Icon look up order: theme, freedesktop
+ /// Icon look up order: theme, freedesktop.
/// </summary>
ThemeFirst,
/// <summary>
- /// Icon look up order: freedesktop
+ /// Icon look up order: freedesktop.
/// </summary>
FreeDesktopOnly,
/// <summary>
- /// Icon look up order: theme
+ /// Icon look up order: theme.
/// </summary>
ThemeOnly
}
/// <summary>
- /// The Icon is a widget that displays standard icon images ("delete", "edit", "arrows", etc.)
- /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon context.
- /// Inherits Image
+ /// The Icon is a widget that displays the standard icon images ("delete", "edit", "arrows", etc.)
+ /// or images coming from a custom file (PNG, JPG, EDJE, etc.), on the icon context.
+ /// Inherits Image.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Icon : Image
{
/// <summary>
- /// Creates and initializes a new instance of Icon class.
+ /// Creates and initializes a new instance of the Icon class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Icon as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by Icon as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Icon(EvasObject parent) : base(parent)
{
/// <summary>
/// Sets the file that is used, but uses a generated thumbnail.
/// </summary>
- /// <param name="file">The path to the file that is used as an icon image</param>
- /// <param name="group">The group that the icon belongs to</param>
+ /// <param name="file">The path to the file that is used as an icon image.</param>
+ /// <param name="group">The group that the icon belongs to.</param>
/// <since_tizen> preview </since_tizen>
public void SetThumb(string file, string group)
{
/// Adds a new icon object to the parent.
/// </summary>
/// <param name="parent">EvasObject</param>
- /// <returns>The new object, otherwise NULL if it cannot be created</returns>
+ /// <returns>The new object, otherwise null if it cannot be created.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
/// <summary>
/// The Image is a widget that allows one to load and display an image file on it,
/// be it from a disk file or from a memory region.
- /// Inherits Widget
+ /// Inherits Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Image : Widget
EvasImage _imageObject = null;
/// <summary>
- /// Creates and initializes a new instance of Image class.
+ /// Creates and initializes a new instance of the Image class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Image as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the image as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Image(EvasObject parent) : base(parent)
{
public event EventHandler LoadingCompleted;
/// <summary>
- /// Clicked will be triggered when the image is fail to load.
+ /// Clicked will be triggered when the image fails to load.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler LoadingFailed;
}
/// <summary>
- /// Sets or gets whether the object is down resizeable.
+ /// Sets or gets whether the object is down resizable.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool CanScaleDown
}
/// <summary>
- /// Sets or gets whether the object is up resizeable.
+ /// Sets or gets whether the object is up resizable.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool CanScaleUp
}
/// <summary>
- /// Sets or gets whether alpha channel data is being used on the given image object.
+ /// Sets or gets whether the alpha channel data is being used on the given image object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsOpaque
}
/// <summary>
- /// Sets or gets the image color
+ /// Sets or gets the image color.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color Color
}
/// <summary>
- /// Sets the background color
+ /// Sets the background color.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
/// Gets the inlined image object of the image widget.
/// 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.
/// </summary>
- /// <remarks>Be careful to not manipulate it, as it is under the control of widget.</remarks>
+ /// <remarks>Be careful not to manipulate it, as it is under the control of the widget.</remarks>
/// <since_tizen> preview </since_tizen>
public EvasImage ImageObject
{
/// <summary>
/// Sets the dimensions for an image object's border, a region which is not scaled together with its center ever.
/// </summary>
- /// <param name="left">The border's left width</param>
- /// <param name="right">The border's right width</param>
- /// <param name="top">The border's top width</param>
- /// <param name="bottom">The border's bottom width</param>
+ /// <param name="left">The border's left width.</param>
+ /// <param name="right">The border's right width.</param>
+ /// <param name="top">The border's top width.</param>
+ /// <param name="bottom">The border's bottom width.</param>
/// <since_tizen> preview </since_tizen>
public void SetBorder(int left, int right, int top, int bottom)
{
/// <summary>
/// Sets the file that is used as the image's source.
/// </summary>
- /// <param name="file">The path to the file that is used as an image source</param>
+ /// <param name="file">The path to the file that is used as an image source.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public bool Load(string file)
}
/// <summary>
- /// Sets the uri that is used as the image's source.
+ /// Sets the URI that is used as the image's source.
/// </summary>
- /// <param name="uri">The uri to the file that is used as an image source</param>
+ /// <param name="uri">The URI to the file that is used as an image source.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public bool Load(Uri uri)
/// Sets a location in the memory to be used as an image object's source bitmap.
/// </summary>
/// <remarks>
- /// This function is handy when the contents of an image file are mapped into the memory, for example.
- /// The format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary).
+ /// This function is handy when the contents of an image file are mapped into the memory, for example,
+ /// the format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary).
/// This improves the loader performance as it tries the "correct" loader first, before trying a range of other possible loaders until one succeeds.
/// </remarks>
- /// <param name="img">The binary data that is used as an image source</param>
- /// <param name="size">The size of the binary data blob img</param>
+ /// <param name="img">The binary data that is used as an image source.</param>
+ /// <param name="size">The size of the binary data blob img.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
[Obsolete("This method will be removed. Use Load(Stream stream) instead.")]
/// <summary>
/// Sets the stream that is used as the image's source.
/// </summary>
- /// <param name="stream">The stream that is used as an image source</param>
+ /// <param name="stream">The stream that is used as an image source.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public bool Load(Stream stream)
/// <summary>
/// Sets the file that is used as the image's source with async.
/// </summary>
- /// <param name="file">The path to the file that is used as an image source</param>
- /// <param name="cancellationToken">cancellation token</param>
+ /// <param name="file">The path to the file that is used as an image source.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public Task<bool> LoadAsync(string file, CancellationToken cancellationToken = default(CancellationToken))
}
/// <summary>
- /// Sets the uri that is used as the image's source with async.
+ /// Sets the URI that is used as the image's source with async.
/// </summary>
- /// <param name="uri">The uri to the file that is used as an image source</param>
- /// <param name="cancellationToken">cancellation token</param>
+ /// <param name="uri">The URI to the file that is used as an image source.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public Task<bool> LoadAsync(Uri uri, CancellationToken cancellationToken = default(CancellationToken))
/// <summary>
/// Sets the stream that is used as the image's source with async.
/// </summary>
- /// <param name="stream">The stream that is used as an image source</param>
- /// <param name="cancellationToken">cancellation token</param>
+ /// <param name="stream">The stream that is used as an image source.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
/// <returns>(true = success, false = error)</returns>
/// <since_tizen> preview </since_tizen>
public async Task<bool> LoadAsync(Stream stream, CancellationToken cancellationToken = default(CancellationToken))
}
/// <summary>
- /// Sets the color of color class for a given widget.
+ /// Sets the color of the Color class for a given widget.
/// </summary>
- /// <param name="part">The name of color class.</param>
- /// <param name="color">The struct of color</param>
+ /// <param name="part">The name of the Color class.</param>
+ /// <param name="color">The struct of the Color class.</param>
/// <since_tizen> preview </since_tizen>
public override void SetPartColor(string part, Color color)
{
}
/// <summary>
- /// Gets the color of color class for a given widget.
+ /// Gets the color of the Color class for a given widget.
/// </summary>
- /// <param name="part">The name of color class.</param>
- /// <returns>color object</returns>
+ /// <param name="part">The name of the Color class.</param>
+ /// <returns>The color object.</returns>
/// <since_tizen> preview </since_tizen>
public override Color GetPartColor(string part)
{
/// <summary>
/// Sets the content at a part of a given container widget.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Image as a child. It's <see cref="EvasObject"/> type.</param>
- /// <returns>The new object, otherwise null if it cannot be created</returns>
+ /// <param name="parent">The parent is a given container, which will be attached by the image as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <returns>The new object, otherwise null if it cannot be created.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for the fill mode of image border
+ /// Enumeration for the fill mode of the image border.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ImageBorderFillMode
{
/// <summary>
- /// None mode of image border
+ /// None mode of the image border.
/// </summary>
None,
/// <summary>
- /// Default mode of image border
+ /// Default mode of the image border.
/// </summary>
Default,
/// <summary>
- /// Solid mode of image border
+ /// Solid mode of the image border.
/// </summary>
Solid,
}
/// <summary>
- /// Enumeration for the possible orientation options
+ /// Enumeration for the possible orientation options.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ImageOrientation : int
{
/// <summary>
- /// No orientation change
+ /// No orientation change.
/// </summary>
None = 0,
/// <summary>
- /// Rotate 90 degrees clockwise
+ /// Rotate 90 degrees clockwise.
/// </summary>
Rotate90,
/// <summary>
- /// Rotate 180 degrees clockwise
+ /// Rotate 180 degrees clockwise.
/// </summary>
Rotate180,
/// <summary>
- /// Rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise)
+ /// Rotate 90 degrees counter-clockwise (i.e., 270 degrees clockwise).
/// </summary>
Rotate270,
/// <summary>
- /// Flip image horizontally
+ /// Flip the image horizontally.
/// </summary>
FlipHorizontal,
/// <summary>
- /// Flip image vertically
+ /// Flip the image vertically.
/// </summary>
FlipVertical,
/// <summary>
- /// Flip the image along the y = (width - x) line (bottom-left to top-right)
+ /// Flip the image along the Y = (width - X) line (bottom-left to top-right).
/// </summary>
FlipTranspose,
/// <summary>
- /// Flip the image along the y = x line (top-left to bottom-right)
+ /// Flip the image along the Y = X line (top-left to bottom-right).
/// </summary>
FlipTransverse
}
namespace ElmSharp
{
/// <summary>
- /// An index widget gives you an index for fast access to whichever group of other UI items one might have.
- /// Inherits Layout
+ /// The Index widget gives you an index for fast access to whichever group of the other UI items one might have.
+ /// Inherits Layout.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Index : Layout
SmartEvent _delayedChanged;
/// <summary>
- /// Creates and initializes a new instance of Index class.
+ /// Creates and initializes a new instance of the Index class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Index as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by Index as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Index(EvasObject parent) : base(parent)
{
public event EventHandler Changed;
/// <summary>
- /// Sets or gets the auto hiding feature is enabled or not for a given index widget.
+ /// Sets or gets whether the auto hiding feature is enabled or not for a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool AutoHide
}
/// <summary>
- /// Sets or gets a value whether horizontal mode is enabled or not.
+ /// Sets or gets a value whether the horizontal mode is enabled or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Sets or gets the value of indicator's disabled status.
+ /// Sets or gets a value of the indicator's disabled status.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IndicatorVisible
}
/// <summary>
- /// Sets or gets the omit feature is enabled or not for a given index widget.
+ /// Sets or gets whether the omit feature is enabled or not for a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool OmitEnabled
}
/// <summary>
- /// Set a delay change time for index object.
- /// delay time is 0.2 sec by default.
+ /// Sets a delay change time for the index object.
+ /// The delay time is 0.2 seconds by default.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Delay
}
/// <summary>
- /// 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.
+ /// Controls the standard_priority group of the index.
+ /// Priority group will be shown as many items as it can, and other group will be shown for one character only.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Priority
}
/// <summary>
- /// Gets the last selected item, for a given index widget.
+ /// Gets the last selected item for a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public IndexItem SelectedItem
}
/// <summary>
- /// Append a new item on a given index widget.
+ /// Appends a new item on a given index widget.
/// </summary>
- /// <param name="label">the label which the item should be indexed</param>
- /// <returns>A object to the IndexItem added or null, on errors</returns>
+ /// <param name="label">The label for which the item should be indexed.</param>
+ /// <returns>An object to the IndexItem if added, or null on errors.</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem Append(string label)
{
}
/// <summary>
- /// Prepend a new item on a given index widget.
+ /// Prepends a new item on a given index widget.
/// </summary>
- /// <param name="label">the label which the item should be indexed</param>
- /// <returns>A handle to the item added or NULL, on errors</returns>
+ /// <param name="label">The label for which the item should be indexed.</param>
+ /// <returns>A handle to the item if added, or null on errors.</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem Prepend(string label)
{
}
/// <summary>
- /// Insert a new item into the index object before item before.
+ /// Inserts a new item into the index object before the item before.
/// </summary>
- /// <param name="label">the label which the item should be indexed</param>
+ /// <param name="label">The label for which the item should be indexed.</param>
/// <param name="before">The index item to insert after.</param>
- /// <returns>A object to the IndexItem added or null, on errors</returns>
+ /// <returns>An object to the IndexItem if added, or null on errors.</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem InsertBefore(string label, IndexItem before)
{
}
/// <summary>
- /// Insert a new item into the index object after item after.
+ /// Inserts a new item into the index object after the item after.
/// </summary>
- /// <param name="label">the label which the item should be indexed</param>
+ /// <param name="label">The label for which the item should be indexed.</param>
/// <param name="after">The index item to insert after.</param>
- /// <returns>A object to the IndexItem added or null, on errors</returns>
+ /// <returns>An object to the IndexItem if added, or null on errors.</returns>
/// <since_tizen> preview </since_tizen>
public IndexItem InsertAfter(string label, IndexItem after)
{
}
/// <summary>
- /// Flush the changes made to the index items so they work correctly.
+ /// Flushes the changes made to the index items so that they work correctly.
/// </summary>
- /// <param name="level">The index level (one of 0 or 1) where changes were made</param>
+ /// <param name="level">The index level (one of 0 or 1) where the changes were made.</param>
/// <since_tizen> preview </since_tizen>
public void Update(int level)
{
}
/// <summary>
- /// Removes all items from a given index widget.
+ /// Removes all the items from a given index widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The IndexItem is used to manage index item
- /// Inherits ItemObject
+ /// The IndexItem is used to manage the index item.
+ /// Inherits ItemObject.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class IndexItem : ItemObject
{
/// <summary>
- /// Creates and initializes a new instance of IndexItem class.
+ /// Creates and initializes a new instance of the IndexItem class.
/// </summary>
- /// <param name="text">the text is set to the Text. It's 'string' type.</param>
+ /// <param name="text">The text is set to the Text. It's the 'string' type.</param>
/// <since_tizen> preview </since_tizen>
public IndexItem(string text) : base(IntPtr.Zero)
{
}
/// <summary>
- /// Selected will be triggered when the index item is selected
+ /// Selected will be triggered when the index item is selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Selected;
/// <summary>
- /// Gets the text
+ /// Gets the text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Text { get; private set; }
/// <summary>
/// Sets the selected state of an item.
/// </summary>
- /// <param name="selected">The selected state</param>
+ /// <param name="selected">The selected state.</param>
/// <since_tizen> preview </since_tizen>
public void Select(bool selected)
{
namespace ElmSharp
{
/// <summary>
- /// The ItemObject is used to manage item object
+ /// The ItemObject is used to manage the item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ItemObject
EvasObject _trackObject = null;
/// <summary>
- /// Creates and initializes a new instance of ItemObject class.
+ /// Creates and initializes a new instance of the ItemObject class.
/// </summary>
/// <param name="handle">IntPtr</param>
/// <since_tizen> preview </since_tizen>
//}
/// <summary>
- /// Gets the id of item object
+ /// Gets the ID of the item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Id { get; private set; }
/// <summary>
- /// Sets or gets whether the item object is enabled
+ /// Sets or gets whether the item object is enabled.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsEnabled
}
/// <summary>
- /// Gets track object of the item.
+ /// Gets the track object of the item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject TrackObject
}
/// <summary>
- /// Sets or gets the style of the Item.
+ /// Sets or gets the style of the item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public virtual string Style
}
/// <summary>
- /// Deleted will be triggered when the item object is deleted
+ /// Deleted will be triggered when the item object is deleted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Deleted;
/// <summary>
- /// Delete the item object
+ /// Deletes the item object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Delete()
}
/// <summary>
- /// Set a content of an object item and delete old content
+ /// Sets a content of an object item and deletes the old content.
/// </summary>
- /// <param name="part">The content part name (null for the default content)</param>
- /// <param name="content">The content of the object item</param>
+ /// <param name="part">The content part name (null for the default content).</param>
+ /// <param name="content">The content of the object item.</param>
/// <since_tizen> preview </since_tizen>
public void SetPartContent(string part, EvasObject content)
{
SetPartContent(part, content, false);
}
- /// <summary>
- /// Set a content of an object item
+ /// <summary>.
+ /// Sets a content of the object item.
/// </summary>
/// <param name="part">The content part name (null for the default content)</param>
- /// <param name="content">The content of the object item</param>
- /// <param name="preserveOldContent">judge whether delete old content</param>
+ /// <param name="content">The content of the object item.</param>
+ /// <param name="preserveOldContent">Judge whether to delete the old content.</param>
/// <since_tizen> preview </since_tizen>
public void SetPartContent(string part, EvasObject content, bool preserveOldContent)
{
}
/// <summary>
- /// Set a label of an object item
+ /// Sets the label of the object item.
/// </summary>
- /// <param name="part">The text part name (null for the default label)</param>
- /// <param name="text">Text of the label</param>
+ /// <param name="part">The text part name (null for the default label).</param>
+ /// <param name="text">Text of the label.</param>
/// <since_tizen> preview </since_tizen>
public void SetPartText(string part, string text)
{
}
/// <summary>
- /// Gets a label of an object item
+ /// Gets the label of the object item.
/// </summary>
- /// <param name="part">The text part name (null for the default label)</param>
+ /// <param name="part">The text part name (null for the default label).</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public string GetPartText(string part)
}
/// <summary>
- /// Sets color of an object item
+ /// Sets the color of the object item.
/// </summary>
- /// <param name="part">The text part name (null for the default label)</param>
- /// <param name="color">the color</param>
+ /// <param name="part">The text part name (null for the default label).</param>
+ /// <param name="color">The color.</param>
/// <since_tizen> preview </since_tizen>
public void SetPartColor(string part, Color color)
{
}
/// <summary>
- /// Gets color of an object item
+ /// Gets the color of the object item.
/// </summary>
- /// <param name="part">The text part name (null for the default label)</param>
- /// <returns>the color of object item</returns>
+ /// <param name="part">The text part name (null for the default label).</param>
+ /// <returns>The color of an object item.</returns>
/// <since_tizen> preview </since_tizen>
public Color GetPartColor(string part)
{
}
/// <summary>
- /// Deletes color of an object item
+ /// Deletes the color of the object item.
/// </summary>
- /// <param name="part">The text part name</param>
+ /// <param name="part">The text part name.</param>
/// <since_tizen> preview </since_tizen>
public void DeletePartColor(string part)
{
}
/// <summary>
- /// Add a function for a signal emitted by object item edje.
+ /// Adds a function for a signal emitted by the object item edje.
/// </summary>
/// <param name="emission">The signal's name.</param>
/// <param name="source">The signal's source.</param>
}
/// <summary>
- /// Remove a signal-triggered function from a object item edje object.
+ /// Removes a signal-triggered function from the object item edje object.
/// </summary>
/// <param name="emission">The signal's name.</param>
/// <param name="source">The signal's source.</param>
}
/// <summary>
- /// Gets the handle of object item
+ /// Gets the handle of the object item.
/// </summary>
/// <param name="obj">ItemObject</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// OnInvalidate of object item
+ /// OnInvalidate of the object item.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected virtual void OnInvalidate() { }
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
public override bool Equals(object obj)
{
IntPtr _parent = IntPtr.Zero;
/// <summary>
- /// Creates and initializes a new instance of ItemEvasObject class.
+ /// Creates and initializes a new instance of the ItemEvasObject class.
/// </summary>
/// <param name="parent">IntPtr</param>
public ItemEvasObject(IntPtr parent) : base()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
protected override IntPtr CreateHandle(EvasObject parent)
{
return Interop.Elementary.elm_object_item_track(_parent);
namespace ElmSharp
{
/// <summary>
- /// The ItemObjectExtension is used to manage item object extension
+ /// The ItemObjectExtension is used to manage the item object extension.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class ItemObjectExtension
{
/// <summary>
- /// Grab high light of item object
+ /// Grabs the highlight of the item object.
/// </summary>
- /// <param name="obj">the item object which is grabbed high light</param>
+ /// <param name="obj">The item object, which has grabbed the highlight.</param>
/// <since_tizen> preview </since_tizen>
public static void GrabHighlight(this ItemObject obj)
{
}
/// <summary>
- /// Clear high light of item object
+ /// Clears the highlight of the item object.
/// </summary>
- /// <param name="obj">the item object which is cleared high light</param>
+ /// <param name="obj">The item object, which has cleared the highlight.</param>
/// <since_tizen> preview </since_tizen>
public static void ClearHighlight(this ItemObject obj)
{
namespace ElmSharp
{
/// <summary>
- /// Label is a widget to display text, with simple html-like markup.
- /// Inherits Layout
+ /// The Label is a widget to display text, with a simple HTML-like markup.
+ /// Inherits Layout.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Label : Layout
SmartEvent _slideCompleted;
/// <summary>
- /// Creates and initializes a new instance of Label class.
+ /// Creates and initializes a new instance of the Label class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Label as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the Label as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Label(EvasObject parent) : base(parent)
{
public event EventHandler SlideCompleted;
/// <summary>
- /// Sets or gets wrap width of the label.
+ /// Sets or gets the wrap width of the label.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int LineWrapWidth
}
/// <summary>
- /// Sets or gets the slide mode of the label widget.
+ /// Sets or gets the slide mode of the Label widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public LabelSlideMode SlideMode
}
/// <summary>
- /// Sets or gets the slide Speed of the label.
+ /// Sets or gets the slide speed of the label.
/// </summary>
/// <remarks>
/// The speed of the slide animation in px per seconds.
- /// 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.
+ /// 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.
/// </remarks>
/// <seealso cref="SlideDuration"/>
/// <since_tizen> preview </since_tizen>
/// Sets or gets the style of the label text.
/// </summary>
/// <remarks>
- /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Avalilable since Tizen_4.0.
+ /// APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Available since Tizen_4.0.
/// </remarks>
///
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Start slide effect.
+ /// Starts the slide effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void PlaySlide()
/// Sets the content at a part of a given container widget.
/// </summary>
/// <param name="parent">EvasObject</param>
- /// <returns>The new object, otherwise null if it cannot be created</returns>
+ /// <returns>The new object, otherwise null if it cannot be created.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Enumeration for slide mode of a label widget
+ /// Enumeration for the slide modes of a label widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum LabelSlideMode
{
/// <summary>
- /// no slide effect
+ /// No slide effect.
/// </summary>
None = 0,
/// <summary>
- /// slide only if the label area is bigger than the text width length
+ /// Slide only if the label area is bigger than the text width length.
/// </summary>
Auto,
/// <summary>
- /// slide always
+ /// Slide always.
/// </summary>
Always
}
namespace ElmSharp
{
/// <summary>
- /// This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget.
- /// Inherits Widget
+ /// This is a container widget that takes a standard edje design file and wraps it very thinly in a widget.
+ /// Inherits Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Layout : Container
IntPtr _edjeHandle;
/// <summary>
- /// Creates and initializes a new instance of Layout class.
+ /// Creates and initializes a new instance of the Layout class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Layout as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the layout as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public Layout(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Creates and initializes a new instance of Layout class.
+ /// Creates and initializes a new instance of the Layout class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Layout() : base()
}
/// <summary>
- /// Gets or sets accessibility state of texblock(text) parts in the layout object.
+ /// Gets or sets the accessibility state of texblock (text) parts in a layout object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool TextBlockAccessibility
/// <summary>
/// Freezes the Elementary layout object.
- /// This function puts all changes on hold.
+ /// This function puts all the changes on hold.
/// Successive freezes will nest, requiring an equal number of thaws.
/// </summary>
- /// <returns>The frozen state or 0 if the object is not frozen or on error.</returns>
+ /// <returns>The frozen state, or 0 if the object is not frozen or on error.</returns>
/// <since_tizen> preview </since_tizen>
public int Freeze()
{
/// Thaws the Elementary object.
/// If sucessives freezes were done, an equal number of thaws will be required.
/// </summary>
- /// <returns>The frozen state or 0 if the object is not frozen or on error.</returns>
+ /// <returns>The frozen state, or 0 if the object is not frozen or on error.</returns>
/// <since_tizen> preview </since_tizen>
public int Thaw()
{
/// Manually forces a sizing re-evaluation.
/// This is useful when the minimum size required by the edje theme of this layout has changed.
/// The change on the minimum size required by the edje theme is not immediately reported to the elementary layout, so one needs to call this function in order to tell the widget (layout) that it needs to reevaluate its own size.
- /// 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.
+ /// The minimum size of the theme is calculated based on the minimum size of parts, the size of elements inside containers like the box and table, etc.
/// All of this can change due to state changes, and that's when this function should be called.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Request sizing reevaluation, restricted to current width and/or height.
- /// Useful mostly when there are TEXTBLOCK parts defining the height of the object and nothing else restricting it to a minimum width.Calling this function will restrict the minimum size in the Edje calculation to whatever size it the layout has at the moment.
+ /// Requests sizing re-evaluation, restricted to the current width and/or height.
+ /// Useful mostly when there are TEXTBLOCK parts defining the height of an object and nothing else, restricting it to a minimum width. Calling this function will restrict minimum size in the Edje calculation to whatever size the layout has at the moment.
/// </summary>
- /// <param name="width">Restrict minimum size ot the current width.</param>
- /// <param name="height">Restrict minimum size ot the current height.</param>
+ /// <param name="width">Restrict minimum size of the current width.</param>
+ /// <param name="height">Restrict minimum size of the current height.</param>
/// <since_tizen> preview </since_tizen>
public void Resizing(bool width, bool height)
{
}
/// <summary>
- /// Get the edje data from the given layout.
- /// This function fetches data specified inside the edje theme of this layout.
- /// This function return NULL if data is not found.
+ /// Gets the edje data from the given layout.
+ /// This function fetches the data specified inside the edje theme of this layout.
+ /// This function returns null if the data is not found.
/// </summary>
- /// <param name="key">The data key</param>
- /// <returns>The data</returns>
+ /// <param name="key">The data key.</param>
+ /// <returns>The data.</returns>
/// <since_tizen> preview </since_tizen>
public string GetEdjeData(string key)
{
/// <summary>
/// Gets the text set in the given part.
/// </summary>
- /// <param name="part">The TEXT part to retrieve the text off.</param>
+ /// <param name="part">The text part to retrieve the text off.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public override string GetPartText(string part)
/// <summary>
/// Sets the text set in the given part.
/// </summary>
- /// <param name="part">The TEXT part to retrieve the text off.</param>
+ /// <param name="part">The text part to retrieve the text off.</param>
/// <param name="text">The text to set.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Append child to layout box part.
- /// Once the object is appended, it will become child of the layout.
- /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
+ /// Appends a child to the layout box part.
+ /// Once the object is appended, it will become a child of the layout.
+ /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part</param>
- /// <param name="child">The Object to append</param>
- /// <returns>Sucess is true</returns>
+ /// <param name="part">The part.</param>
+ /// <param name="child">The object to append.</param>
+ /// <returns>Success is true.</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxAppend(string part, EvasObject child)
{
}
/// <summary>
- /// Prepend child to layout box part.
- /// Once the object is prepended, it will become child of the layout.
- /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
+ /// Prepends a child to the layout box part.
+ /// Once the object is prepended, it will become a child of the layout.
+ /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part</param>
- /// <param name="child">The Object to prepend</param>
- /// <returns>Sucess is true</returns>
+ /// <param name="part">The part.</param>
+ /// <param name="child">The object to prepend.</param>
+ /// <returns>Success is true.</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxPrepend(string part, EvasObject child)
{
}
/// <summary>
- /// Remove a child of the given part box.
+ /// Removes a child from the given part box.
/// The object will be removed from the box part and its lifetime will not be handled by the layout anymore.
/// </summary>
- /// <param name="part">The part</param>
- /// <param name="child">The Object to remove</param>
- /// <returns>Sucess is true</returns>
+ /// <param name="part">The part.</param>
+ /// <param name="child">The object to remove.</param>
+ /// <returns>Success if true</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxRemove(string part, EvasObject child)
{
}
/// <summary>
- /// Remove all children of the given part box.
+ /// Removes all the children from the given part box.
/// The objects will be removed from the box part and their lifetime will not be handled by the layout anymore.
/// </summary>
- /// <param name="part">The part</param>
- /// <param name="clear">If true, then all objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas.</param>
- /// <returns>Sucess is true</returns>
+ /// <param name="part">The part.</param>
+ /// <param name="clear">If true, then all the objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas.</param>
+ /// <returns>Success if true.</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxRemoveAll(string part, bool clear)
{
}
/// <summary>
- /// Insert child to layout box part at a given position.
- /// Once the object is inserted, it will become child of the layout.
- /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
+ /// Inserts a child to the layout box part at a given position.
+ /// Once the object is inserted, it will become a child of the layout.
+ /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
/// </summary>
- /// <param name="part">The part</param>
- /// <param name="child">The child object to insert into box.</param>
+ /// <param name="part">The part.</param>
+ /// <param name="child">The child object to insert into the box.</param>
/// <param name="position">The numeric position >=0 to insert the child.</param>
- /// <returns>Sucess is true</returns>
+ /// <returns>Success if true.</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxInsertAt(string part, EvasObject child, uint position)
{
}
/// <summary>
- /// Insert child to layout box part before a reference object.
+ /// Inserts a child to the layout box part before a reference object.
/// Once the object is inserted, it will become child of the layout.
- /// Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically.
+ /// Its lifetime will be bound to the layout. Whenever the layout dies, the child will be deleted automatically.
/// </summary>
- /// <param name="part"></param>
- /// <param name="child">The child object to insert into box.</param>
- /// <param name="reference">Another reference object to insert before in box.</param>
- /// <returns>Sucess is true</returns>
+ /// <param name="part">The part.</param>
+ /// <param name="child">The child object to insert into the box.</param>
+ /// <param name="reference">Another reference object to insert before the box.</param>
+ /// <returns>Success is true.</returns>
/// <since_tizen> preview </since_tizen>
public bool BoxInsertBefore(string part, EvasObject child, EvasObject reference)
{
/// <summary>
/// Sets the layout content.
/// </summary>
- /// <param name="part">The swallow part name in the edje file</param>
+ /// <param name="part">The swallow part name in the edje file.</param>
/// <param name="content">The child that will be added in this layout object.</param>
- /// <returns>TRUE on success, FALSE otherwise</returns>
+ /// <returns>TRUE on success, FALSE otherwise.</returns>
/// <since_tizen> preview </since_tizen>
public override bool SetPartContent(string part, EvasObject content)
{
/// <summary>
/// Sets the layout content.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <param name="content">The content</param>
+ /// <param name="part">The name of a particular part.</param>
+ /// <param name="content">The content.</param>
/// <param name="preserveOldContent">true, preserve old content will be unset. false, preserve old content will not be unset.</param>
- /// <returns>TRUE on success, FALSE otherwise</returns>
+ /// <returns>TRUE on success, FALSE otherwise.</returns>
/// <since_tizen> preview </since_tizen>
public override bool SetPartContent(string part, EvasObject content, bool preserveOldContent)
{
/// <summary>
/// Sets the edje group from the elementary theme that is used as a layout.
/// </summary>
- /// <param name="klass">The class of the group</param>
- /// <param name="group">The group</param>
- /// <param name="style">The style to use</param>
+ /// <param name="klass">The class of the group.</param>
+ /// <param name="group">The group.</param>
+ /// <param name="style">The style to use.</param>
/// <since_tizen> preview </since_tizen>
public void SetTheme(string klass, string group, string style)
{
/// <summary>
/// Sets the file that is used as a layout.
/// </summary>
- /// <param name="file">The path to the file (edj) that is used as a layout</param>
- /// <param name="group">The group that the layout belongs to in the edje file</param>
+ /// <param name="file">The path to the file (edje) that is used as a layout.</param>
+ /// <param name="group">The group that the layout belongs to in the edje file.</param>
/// <since_tizen> preview </since_tizen>
public void SetFile(string file, string group)
{
}
/// <summary>
- /// Sets the back ground color of layout
+ /// Sets the background color of a layout.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override Color BackgroundColor
}
/// <summary>
- /// Sets the vertical text alignment of layout's text part
+ /// Sets the vertical text alignment of the layout's text part.
/// </summary>
/// <remarks>
- /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Avalilable since Tizen_4.0.
+ /// API, elm_layout_text_valign_set, is an internal API only in Tizen. Available since Tizen_4.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public virtual void SetVerticalTextAlignment(string part, double valign)
}
/// <summary>
- /// Gets the vertical text alignment of layout's text part
+ /// Gets the vertical text alignment of the layout's text part.
/// </summary>
/// <remarks>
- /// API, elm_layout_text_valign_get, is internal API only in Tizen. Avalilable since Tizen_4.0.
+ /// API, elm_layout_text_valign_get, is an internal API only in Tizen. Available since Tizen_4.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public virtual double GetVerticalTextAlignment(string part)
}
/// <summary>
- /// The callback of Realized Event
+ /// The callback of the Realized Event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Sets the content at a part of a given container widget.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by Layout as a child. It's <see cref="EvasObject"/> type.</param>
- /// <returns>The new object, otherwise null if it cannot be created</returns>
+ /// <param name="parent">The parent is a given container which will be attached by the layout as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <returns>The new object, otherwise null if it cannot be created.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for setting list's resizing behavior, transverse axis scrolling and items cropping.
+ /// Enumeration for setting the list's resizing behavior, transverse axis scrolling, and items cropping.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ListMode
/// <summary>
/// The list won't set any of its size hints to inform how a possible container should resize it.
/// Then, if it's not created as a "resize object", it might end with zeroed dimensions.
- /// The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
+ /// The list will respect the container's geometry, and if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.
/// </summary>
Compress = 0,
/// <summary>
/// </summary>
Scroll,
/// <summary>
- /// Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly).
+ /// Sets a minimum size hint on the genlist object, so that the containers may respect it (and resize itself to fit the child properly).
/// More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well.
/// This is naturally bound by the list object's maximum size hints, set externally.
/// </summary>
Limit,
/// <summary>
- /// Besides setting a minimum size on the transverse axis, just like on Limit, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.
+ /// Besides setting a minimum size on the transverse axis, just like on limit, the list will set a minimum size on the longitudinal axis, trying to reserve space to all its children to be visible at a time.
/// This is naturally bound by the list object's maximum size hints, set externally.
/// </summary>
Expand
/// <summary>
/// It inherits System.EventArgs.
- /// It contains Item which is <see cref="ListItem"/> type.
- /// All events of List contain ListItemEventArgs as a parameter.
+ /// It contains an item which is <see cref="ListItem"/> type.
+ /// All the events of a list contain ListItemEventArgs as a parameter.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ListItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets List item. The return type is <see cref="ListItem"/>.
+ /// Gets or sets the list item. The return type is <see cref="ListItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public ListItem Item { get; set; }
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The List is a widget that aims to display simple list item which has 2 icons and 1 text, and can be selected.
+ /// The List is a widget that aims to display a simple list item which has 2 icons, 1 text, and can be selected.
/// For more robust lists, <see cref="GenList"/> should probably be used.
/// </summary>
/// <seealso cref="GenList"/>
/// <summary>
/// Creates and initializes a new instance of the List class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by List as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the list as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public List(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Gets or sets which mode to use for the list.
+ /// Gets or sets which mode to be used for the list.
/// </summary>
/// <since_tizen> preview </since_tizen>
public ListMode Mode
public event EventHandler<ListItemEventArgs> ItemSelected;
/// <summary>
- /// ItemUnselected is raised when the list item is Unselected.
+ /// ItemUnselected is raised when a list item is Unselected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemUnselected;
/// <summary>
- /// ItemDoubleClicked is raised when a new list item is double clicked.
+ /// ItemDoubleClicked is raised when a new list item is double-clicked.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemDoubleClicked;
/// <summary>
- /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default it's 1 second.
+ /// ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default, it's 1 second.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemLongPressed;
/// <summary>
- /// ItemActivated is raised when a new list item is double clicked or pressed (enter|return|spacebar).
+ /// ItemActivated is raised when a new list item is double-clicked or pressed (enter|return|spacebar).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ListItemEventArgs> ItemActivated;
/// <summary>
/// Starts the list.
- /// Call before running <see cref="EvasObject.Show"/> on the list object.
+ /// Called before running <see cref="EvasObject.Show"/> on the list object.
/// If not called, it won't display the list properly.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes all items from a given list widget.
+ /// Removes all the items from a given list widget.
/// To delete just one item, use <see cref="ItemObject.Delete"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// It inherits <see cref="ItemObject"/>.
- /// A instance to the list item added.
- /// It contains Text, LeftIcon and RightIcon properties to show a list item which is given.
+ /// An instance to the list item is added.
+ /// It contains the Text, LeftIcon, and RightIcon properties to show the list item which is given.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ListItem : ItemObject
{
/// <summary>
/// It inherits <see cref="Layout"/>.
- /// The MultiButtonEntry is a widget letting an user enter text and each chunk of text managed as a set of buttons.
+ /// The MultiButtonEntry is a widget, that lets a user enter text and each chunk of the text managed as a set of buttons.
/// Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row.
/// 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.
/// <summary>
/// Creates and initializes a new instance of the MultiButtonEntry class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntry(EvasObject parent) : base(parent)
{
public event EventHandler ExpandedStateChanged;
/// <summary>
- /// 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.
+ /// ItemSelected is raised when an item is selected by API, user interaction, and etc.
+ /// This is also raised when a user presses backspace, while the cursor is on the first field of the entry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<MultiButtonEntryItemEventArgs> ItemSelected;
public event EventHandler<MultiButtonEntryItemEventArgs> ItemDeleted;
/// <summary>
- /// Gets the selected item in the multibuttonentry.
+ /// Gets the selected item in the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem SelectedItem
}
/// <summary>
- /// Gets or sets whether the multibuttonentry is editable or not.
+ /// Gets or sets whether the MultiButtonEntry is editable or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsEditable
}
/// <summary>
- /// Gets or sets the multibuttonentry to expanded state.
+ /// Gets or sets the MultiButtonEntry to expanded state.
/// If true, expanded state.
/// If false, single line state.
/// </summary>
}
/// <summary>
- /// Gets the first item in the multibuttonentry.
+ /// Gets the first item in the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem FirstItem
}
/// <summary>
- /// Gets the last item in the multibuttonentry.
+ /// Gets the last item in the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem LastItem
}
/// <summary>
- /// Gets the entry object int the multibuttonentry.
+ /// Gets the entry object int the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Entry Entry
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
}
/// <summary>
- /// Append a new item to the multibuttonentry.
+ /// Appends a new item to the multibuttonentry.
/// </summary>
- /// <param name="label">The label of new item.</param>
+ /// <param name="label">The label of the new item.</param>
/// <returns>A MultiButtonEntryItem to the item added.</returns>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Append(string label)
}
/// <summary>
- /// Prepend a new item to the multibuttonentry.
+ /// Prepends a new item to the MultiButtonEntry.
/// </summary>
- /// <param name="label">The label of new item.</param>
+ /// <param name="label">The label of the new item.</param>
/// <returns>A MultiButtonEntryItem to the item added.</returns>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Prepend(string label)
}
/// <summary>
- /// Add a new item to the multibuttonentry before the indicated object reference.
+ /// Adds a new item to the MultiButtonEntry before the indicated object reference.
/// </summary>
/// <param name="before">The item before which to add it.</param>
/// <param name="label">The label of new item.</param>
}
/// <summary>
- /// Add a new item to the multibuttonentry after the indicated object.
+ /// Adds a new item to the MultiButtonEntry after the indicated object.
/// </summary>
/// <param name="after">The item after which to add it.</param>
/// <param name="label">The label of new item.</param>
}
/// <summary>
- /// Remove all items in the multibuttonentry.
+ /// Removes all items in the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
}
/// <summary>
- /// Append an item filter function for text inserted in the Multibuttonentry.
+ /// Appends an item filter function for the text inserted in the multibuttonentry.
/// </summary>
/// <param name="func">The function to use as item filter.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Prepend a filter function for text inserted in the Multibuttonentry.
+ /// Prepends a filter function for the text inserted in the MultiButtonEntry.
/// </summary>
/// <param name="func">The function to use as text filter.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Remove a filter from the list.
+ /// Removes a filter from the list.
/// </summary>
/// <param name="func">The filter function to remove.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Set a function to format the string that will be used to display the hidden items counter.
+ /// Sets a function to format the string that will be used to display the hidden items counter.
/// If func is NULL, the default format will be used, which is "+ 'the hidden items counter'".
/// </summary>
- /// <param name="func">The function to return string to show</param>
+ /// <param name="func">The function to return string to show.</param>
/// <since_tizen> preview </since_tizen>
public void SetFormatCallback(Func<int, string> func)
{
/// <summary>
/// Creates and initializes a new instance of the EntryInner class.
/// </summary>
- /// <param name="parent">The parent is a given container which will be attached by MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
+ /// <param name="parent">The parent is a given container, which will be attached by the MultiButtonEntry as a child. It's <see cref="EvasObject"/> type.</param>
internal EntryInner(EvasObject parent) : base(parent)
{
}
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
protected override IntPtr CreateHandle(EvasObject parent)
{
return Interop.Elementary.elm_multibuttonentry_entry_get(parent.Handle);
/// <summary>
/// It inherits System.EventArgs.
/// The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry.
- /// It contains Item which is <see cref="MultiButtonEntryItem"/> type.
+ /// It contains the Item which is <see cref="MultiButtonEntryItem"/> type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MultiButtonEntryItemEventArgs : EventArgs
{
/// <summary>
- /// Gets or sets MultiButtonEntryItem item. The return type is <see cref="MultiButtonEntryItem"/>.
+ /// Gets or sets the MultiButtonEntryItem item. The return type is <see cref="MultiButtonEntryItem"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Item { get; set; }
{
/// <summary>
/// It inherits <see cref="ItemObject"/>.
- /// MutltiButtonEntryItem is a item which is added to MultiButtonEntry.
- /// It contains Next and Prev properties to get next and previous item.
+ /// MutltiButtonEntryItem is an item, which is added to MultiButtonEntry.
+ /// It contains Next and Prev properties to get the next and previous item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class MultiButtonEntryItem : ItemObject
/// <summary>
/// Creates and initializes a new instance of the MultiButtonEntryItem class.
/// </summary>
- /// <param name="text">The text of MultiButtonEntryItem's Label name.</param>
+ /// <param name="text">The text of the MultiButtonEntryItem's label name.</param>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem(string text) : base(IntPtr.Zero)
{
}
/// <summary>
- /// Get the next item in the multibuttonentry.
+ /// Get the next item in the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Next
}
/// <summary>
- /// Get the previous item in the multibuttonentry.
+ /// Get the previous item in the MultiButtonEntry.
/// </summary>
/// <since_tizen> preview </since_tizen>
public MultiButtonEntryItem Prev
namespace ElmSharp
{
/// <summary>
- /// Predefined values for Hints properties in EvasObject
+ /// Predefined values for the hint properties in EvasObject.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class NamedHint
{
/// <summary>
- /// This value can be used to <see cref="EvasObject.WeightX"/> and <see cref="EvasObject.WeightY"/>
+ /// This value can be used for <see cref="EvasObject.WeightX"/> and <see cref="EvasObject.WeightY"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static double Expand = 1.0;
/// <summary>
- /// This value can be used to <see cref="EvasObject.AlignmentX"/> and <see cref="EvasObject.AlignmentY"/>
+ /// This value can be used for <see cref="EvasObject.AlignmentX"/> and <see cref="EvasObject.AlignmentY"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static double Fill = -1.0;
namespace ElmSharp
{
/// <summary>
- /// The NaviItem is a widget to contain the contents to show in Naviframe.
+ /// The NaviItem is a widget that contain the contents to show in Naviframe.
/// Inherits ItemObject
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Popped;
/// <summary>
- /// Gets the content object. The name of content part is "elm.swallow.content".
+ /// Gets the content object. The name of the content part is "elm.swallow.content".
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Content
}
/// <summary>
- /// Sets or gets a value whether title area is enabled or not.
+ /// Sets or gets a value whether the title area is enabled or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool TitleBarVisible
}
/// <summary>
- /// Sets or gets the title bar background color
+ /// Sets or gets the title bar background color.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color TitleBarBackgroundColor
}
/// <summary>
- /// Invalidate the EventArgs if _isPopped is false.
- /// The method should be overridden in children class.
+ /// Invalidates the EventArgs if _isPopped is false.
+ /// The method should be overridden in the children class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnInvalidate()
namespace ElmSharp
{
/// <summary>
- /// The NaviframeEventArgs is a event args class for navi frame.
- /// Inherits EventArgs
+ /// The NaviframeEventArgs is an event arguments class for naviframe.
+ /// Inherits EventArgs.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class NaviframeEventArgs : EventArgs
{
/// <summary>
- /// Sets or gets the content object. The name of content part is "elm.swallow.content".
+ /// Sets or gets the content object. The name of the content part is "elm.swallow.content".
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Content { get; set; }
}
/// <summary>
- /// Naviframe is a widget to stands for navigation frame. It's a views manager for applications.
- /// Inherits Widget
+ /// The Naviframe is a widget to stand for the navigation frame. It's a views manager for applications.
+ /// Inherits Widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Naviframe : Widget
readonly List<NaviItem> _itemStack = new List<NaviItem>();
/// <summary>
- /// Creates and initializes a new instance of Naviframe class.
+ /// Creates and initializes a new instance of the Naviframe class.
/// </summary>
/// <param name="parent">The parent is a given container which will be attached by Naviframe as a child. It's <see cref="EvasObject"/> type.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Popped will be triggered when NaviItem is removed.
+ /// Popped will be triggered when the NaviItem is removed.
/// </summary>
/// <remarks>
- /// It is always called when NaviItem was removed.
+ /// It is always called when the NaviItem is removed.
/// (even if removed by NaviItem.Delete())
- /// This event will be invoked in progress of Pop/Delete operation.
- /// After called Popped event, Pop/Delete method will be returned
+ /// This event will be invoked in progress of the Pop/Delete operation.
+ /// After calling the Popped event, the Pop/Delete method will be returned.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public event EventHandler<NaviframeEventArgs> Popped;
/// <summary>
- /// AnimationFinished will be triggered when animation is finished.
+ /// AnimationFinished will be triggered when the animation is finished.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler AnimationFinished;
/// <summary>
- /// Gets the list of navi item
+ /// Gets the list of the navi item.
/// </summary>
/// <since_tizen> preview </since_tizen>
public IReadOnlyList<NaviItem> NavigationStack
}
/// <summary>
- /// Sets or gets the the preserve content objects when items are popped.
+ /// Sets or gets the preserve content objects when items are popped.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool PreserveContentOnPop
}
/// <summary>
- /// Sets or gets whether the default back button is enabled
+ /// Sets or gets whether the default back button is enabled.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool DefaultBackButtonEnabled
}
/// <summary>
- /// Push a new item to the top of the naviframe stack and show it.
+ /// Pushes a new item to the top of the naviframe stack and shows it.
/// The title and style are null.
/// </summary>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem Push(EvasObject content)
{
}
/// <summary>
- /// Push a new item to the top of the naviframe stack and show it.
- /// The style are null.
+ /// Pushes a new item to the top of the naviframe stack and shows it.
+ /// The style is null.
/// </summary>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. null would be default.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. Null would be default.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public NaviItem Push(EvasObject content, string title)
}
/// <summary>
- /// Push a new item to the top of the naviframe stack and show it.
+ /// Pushes a new item to the top of the naviframe stack and shows it.
/// </summary>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. null would be default.</param>
- /// <param name="style">The current item style name. null would be default.</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. Null would be default.</param>
+ /// <param name="style">The current item style name. Null would be default.</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem Push(EvasObject content, string title, string style)
{
}
/// <summary>
- /// Insert a new item into the naviframe before item.
+ /// Inserts a new item into the naviframe before the item.
/// The title is "" and the style is null.
/// </summary>
- /// <param name="before">The item which the new item is inserted before.</param>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="before">The item for which a new item is inserted before.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertBefore(NaviItem before, EvasObject content)
{
}
/// <summary>
- /// Insert a new item into the naviframe before item.
+ /// Inserts a new item into the naviframe before the item.
/// The style is null.
/// </summary>
- /// <param name="before">The item which the new item is inserted before.</param>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. null would be default.</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="before">The item for which a new item is inserted before.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. Null would be default.</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertBefore(NaviItem before, EvasObject content, string title)
{
}
/// <summary>
- /// Insert a new item into the naviframe before item.
+ /// Inserts a new item into the naviframe before the item.
/// </summary>
- /// <param name="before">The item which the new item is inserted before.</param>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. null would be default.</param>
- /// <param name="style">The current item style name. null would be default.</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="before">The item for which a new item is inserted before.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. Null would be default.</param>
+ /// <param name="style">The current item style name. Null would be default.</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertBefore(NaviItem before, EvasObject content, string title, string style)
{
}
/// <summary>
- /// Insert a new item into the naviframe after item.
+ /// Inserts a new item into the naviframe after the item.
/// The title is "" and the style is null.
/// </summary>
- /// <param name="after">The item which the new item is inserted after.</param>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="after">The item for which a new item is inserted after.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertAfter(NaviItem after, EvasObject content)
{
}
/// <summary>
- /// Insert a new item into the naviframe after item.
+ /// Inserts a new item into the naviframe after the item.
/// The style is null.
/// </summary>
- /// <param name="after">The item which the new item is inserted after.</param>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. null would be default.</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="after">The item which a new item is inserted after.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. Null would be default.</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertAfter(NaviItem after, EvasObject content, string title)
{
}
/// <summary>
- /// Insert a new item into the naviframe after item.
+ /// Inserts a new item into the naviframe after the item.
/// </summary>
- /// <param name="after">The item which the new item is inserted after.</param>
- /// <param name="content">The main content object. The name of content part is "elm.swallow.content".</param>
- /// <param name="title">The current item title. null would be default.</param>
- /// <param name="style">The current item style name. null would be default.</param>
- /// <returns>The created item or null upon failure.</returns>
+ /// <param name="after">The item for which a new item is inserted after.</param>
+ /// <param name="content">The main content object. The name of the content part is "elm.swallow.content".</param>
+ /// <param name="title">The current item title. Null would be default.</param>
+ /// <param name="style">The current item style name. Null would be default.</param>
+ /// <returns>The created item, or null upon failure.</returns>
/// <since_tizen> preview </since_tizen>
public NaviItem InsertAfter(NaviItem after, EvasObject content, string title, string style)
{
}
/// <summary>
- /// Pop an item that is on top of the stack.
+ /// Pops an item that is on top of the stack.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Pop()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for paneldirection type.
+ /// Enumeration for the PanelDirection types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum PanelDirection
{
/// <summary>
- /// Top to bottom
+ /// Top to bottom.
/// </summary>
Top = 0,
/// <summary>
- /// Bottom to top
+ /// Bottom to top.
/// </summary>
Bottom,
/// <summary>
- /// Left to right
+ /// Left to right.
/// </summary>
Left,
/// <summary>
- /// Right to left
+ /// Right to left.
/// </summary>
Right,
}
SmartEvent _toggled;
/// <summary>
- /// Creates and initializes a new instance of Panel class.
+ /// Creates and initializes a new instance of the Panel class.
/// </summary>
- /// <param name="parent">The EvasObject to which the new Panel will be attached as a child.</param>
+ /// <param name="parent">The EvasObject to which the new panel will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Panel(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Toggled will be triggered when toggles Panel.
+ /// Toggled will be triggered when the panel is toggled.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Toggled;
/// <summary>
- /// Enable or disable scrolling in the Panel.
+ /// Enable or disable scrolling in the panel.
/// </summary>
/// <param name="enable">
/// Bool value can be false or true.
}
/// <summary>
- /// Sets the scroll size of Panel.
+ /// Sets the scroll size of the panel.
/// </summary>
/// <param name="ratio">
- /// The size of scroll area.
+ /// The size of the scroll area.
/// </param>
/// <since_tizen> preview </since_tizen>
public void SetScrollableArea(double ratio)
}
/// <summary>
- /// Toggles the hidden state of the Panel.
+ /// Toggles the hidden state of the panel.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Toggle()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
{
/// <summary>
/// The Panes is a widget that adds a draggable bar between two contents.
- /// When dragged this bar resizes contents' size.
+ /// When dragged, this bar resizes the contents' size.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Panes : Layout
}
/// <summary>
- /// Pressed will be triggered when panes have been pressed (button isn't released yet).
+ /// Pressed will be triggered when the panes have been pressed (button isn't released yet).
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Pressed;
/// <summary>
- /// Unpressed will be triggered when panes are released after being pressed.
+ /// Unpressed will be triggered when the panes are released after being pressed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Unpressed;
/// <summary>
- /// Sets or gets resize mode of a given Panes widget.
+ /// Sets or gets the resize mode of a given Panes widget.
/// True means the left and right panes resize homogeneously.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or Gets the size proportion of the Panes widget's left side.
+ /// Sets or gets the size proportion of the Panes widget's left side.
/// </summary>
/// <remarks>
- /// By default it's homogeneous, i.e., both sides have the same size.If something different is required,
+ /// By default, it's homogeneous, i.e., both sides have the same size. If something different is required,
/// it can be set with this function. For example, if the left content should be displayed over 75% of the panes size,
- /// size should be passed as 0.75. This way, the right content is resized to 25% of the panes size.
- /// If displayed vertically, left content is displayed at the top, and right content at the bottom.
+ /// the size should be passed as 0.75. This way, the right content is resized to 25% of the panes size.
+ /// If displayed vertically, left content is displayed at the top and right content at the bottom.
/// This proportion changes when the user drags the panes bar.
///
- /// The value is float type and between 0.0 and 1.0 representing the size proportion of the left side.
+ /// The float type value between 0.0 and 1.0 represents the size proportion of the left side.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Proportion
/// Sets or gets the orientation of a given Panes widget.
/// </summary>
/// <remarks>
- /// Use this function to change how your panes is to be disposed: vertically or horizontally.
+ /// Use this function to change how your panes are to be disposed: vertically or horizontally.
/// Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents.
- /// By default panes is in a vertical mode.
+ /// By default, the panes are in a vertical mode.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
/// <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.
+ /// If displayed vertically, left content is displayed at the top.
+ /// The value represents minimum size of the left side in pixels.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int LeftMinimumSize
}
/// <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.
+ /// Sets or gets the relative minimum size of the panes widget's left side.
+ /// The proportion of minimum size of the left side.
+ /// If displayed vertically, left content is displayed at the top.
+ /// The value between 0.0 and 1.0 represents size proportion of the minimum size of the left side.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double LeftMinimumRelativeSize
}
/// <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.
+ /// Sets or gets the absolute minimum size of the panes widget's right side.
+ /// If displayed vertically, right content is displayed at the top.
+ /// The value represents the minimum size of the right side in pixels.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int RightMinimumSize
}
/// <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.
+ /// Sets or gets the relative minimum size of the panes widget's right side.
+ /// Proportion of the minimum size of the right side.
+ /// If displayed vertically, right content is displayed at the top.
+ /// The value between 0.0 and 1.0 represents size proportion of the minimum size of the right side.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double RightMinimumRelativeSize
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Point is a struct that defines a 2-D point as a pair of generic type.
+ /// The Point is a struct that defines the 2D point as a pair of generic type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Point : IEquatable<Point>
public int Y;
/// <summary>
- /// A human-readable representation of the <see cref="T:Tizen.UI.Point" />.
+ /// A human readable representation of <see cref="T:Tizen.UI.Point"/>.
/// </summary>
/// <returns>The string is formatted as "{{X={0} Y={1}}}".</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets hash code.
+ /// Gets the hash code.
/// </summary>
/// <returns>The hash code.</returns>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Point"/> to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are the same type and represent the same value,
+ /// otherwise false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool Equals(Point other)
}
/// <summary>
- /// Whether the two <see cref="T:Tizen.UI.Point" />s are equal.
+ /// Whether both <see cref="T:Tizen.UI.Point"/>s are equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point"/> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Point"/>s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Point p1, Point p2)
{
}
/// <summary>
- /// Whether two <see cref="T:Tizen.UI.Point" />s are not equal.
+ /// Whether both <see cref="T:Tizen.UI.Point"/>s are not equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point" /> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Point" />s do not have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point"/> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Point"/>s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Point p1, Point p2)
{
namespace ElmSharp
{
/// <summary>
- /// The Point3D is a Struct that defining a 3-D point.
+ /// The Point3D is a struct that defines a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Point3D : IEquatable<Point3D>
{
/// <summary>
- /// The X coordinate of a 3D point.
+ /// The X-coordinate of a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int X;
/// <summary>
- /// The Y coordinate of a 3D point.
+ /// The Y-coordinate of a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Y;
/// <summary>
- /// The Z coordinate of a 3D point.
+ /// The Z-coordinate of a 3D point.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Z;
/// <summary>
- /// A human-readable representation of the <see cref="T:Tizen.UI.Point3D" />.
+ /// A human-readable representation of <see cref="T:Tizen.UI.Point3D"/>.
/// </summary>
/// <returns>The string is formatted as "{{X={0} Y={1} Z={2}}}".</returns>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Point3D"/> to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
+ /// true if the object and this instance are of the same type and represent the same value.
/// otherwise, false.
/// </returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Whether the two <see cref="T:Tizen.UI.Point3D" />s are equal.
+ /// Whether both <see cref="T:Tizen.UI.Point3D"/>s are equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point3D" /> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point3D" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Point3D" />s have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point3D"/> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point3D"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Point3D"/>s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Point3D p1, Point3D p2)
{
}
/// <summary>
- /// Whether two <see cref="T:Tizen.UI.Point3D" />s are not equal.
+ /// Whether both <see cref="T:Tizen.UI.Point3D"/>s are not equal.
/// </summary>
- /// <param name="p1">A <see cref="T:Tizen.UI.Point3D" /> on the left hand side.</param>
- /// <param name="p2">A <see cref="T:Tizen.UI.Point3D" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Point3D" />s do not have equal values.</returns>
+ /// <param name="p1">A <see cref="T:Tizen.UI.Point3D"/> on the left hand side.</param>
+ /// <param name="p2">A <see cref="T:Tizen.UI.Point3D"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Point3D"/>s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Point3D p1, Point3D p2)
{
namespace ElmSharp
{
/// <summary>
- /// The Polygon is a widget that used to draw a polygon (filled).
+ /// The Polygon is a widget that is used to draw a polygon (filled).
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Polygon : EvasObject
}
/// <summary>
- /// Adds a new vertex to the Polygon.
- /// <param name="x">The X coordinate of the new vertex.</param>
- /// <param name="y">The Y coordinate of the new vertex.</param>
+ /// Adds a new vertex to the polygon.
+ /// <param name="x">The X-coordinate of the new vertex.</param>
+ /// <param name="y">The Y-coordinate of the new vertex.</param>
/// </summary>
/// <since_tizen> preview </since_tizen>
public void AddPoint(int x, int y)
}
/// <summary>
- /// Adds a new vertex to the Polygon.
+ /// Adds a new vertex to the polygon.
/// <param name="p">The coordinates of the new vertex.</param>
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Removes all the vertices of the Polygon, making it empty.
+ /// Removes all the vertices of the polygon, making it empty.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void ClearPoints()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the popup orientation type.
+ /// Enumeration for the popup orientation types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum PopupOrientation
{
/// <summary>
- /// Appears in the top of parent, default.
+ /// Appears in the top of parent, by default.
/// </summary>
Top,
/// <summary>
}
/// <summary>
- /// The Popup is a widget that is an enhancement of Notify.
+ /// 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Creates and initializes a new instance of the Popup class.
/// </summary>
- /// <param name="parent">The EvasObject to which the new Popup will be attached as a child.</param>
+ /// <param name="parent">The EvasObject to which the new popup will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Popup(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Dismissed will be triggered when Popup have been dismissed.
+ /// Dismissed will be triggered when the popup has been dismissed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Dismissed;
public event EventHandler OutsideClicked;
/// <summary>
- /// OutsideClicked will be triggered when Popup is closed as a result of timeout.
+ /// OutsideClicked will be triggered when the popup is closed as a result of timeout.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler TimedOut;
/// <summary>
- /// OutsideClicked will be triggered when the Popup transition is finished in showing.
+ /// OutsideClicked will be triggered when the popup transition has finished in showing.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ShowAnimationFinished;
/// <summary>
- /// Sets or gets the position in which Popup will appear in its parent.
+ /// Sets or gets the position in which the popup will appear in its parent.
/// </summary>
/// <since_tizen> preview </since_tizen>
public PopupOrientation Orientation
}
/// <summary>
- /// Sets or gets the wrapping type of content text packed in content area of Popup widget.
+ /// Sets or gets the wrapping type of content text packed in the content area of Popup widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WrapType ContentTextWrapType
}
/// <summary>
- /// Sets or gets the timeout value set to the Popup(in seconds).
+ /// Sets or gets the timeout value set to the popup (in seconds).
/// </summary>
/// <remarks>
/// Since calling Show() on a popup restarts the timer controlling when it is hidden,
- /// setting this before the popup is shown will in effect mean starting the timer when the popup is shown.
- /// TimedOut is called afterwards which can be handled if needed.
- /// <![CDATA[Set a value <= 0.0 to disable a running timer.If the value > 0.0 and the popup is previously visible,]]>
+ /// setting this before the popup is shown, will in effect mean starting the timer when the popup is shown.
+ /// TimedOut is called afterwards, which can be handled, if needed.
+ /// <![CDATA[Set a value <= 0.0 to disable a running timer. If the value is > 0.0 and the popup is previously visible,]]>
/// the timer will be started with this value, canceling any running timer.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets whether events should be passed to event blocked area by a click outside.
+ /// Sets or gets whether events should be passed to the event blocked area by a click outside.
/// </summary>
/// <remarks>
- /// The visible region of popup is surrounded by a translucent region called Blocked Event area.
+ /// The visible region of the popup is surrounded by a translucent region called the Blocked event area.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool AllowEvents
}
/// <summary>
- /// Gets the Opacity value of the Popup.
+ /// Gets the opacity value of the popup.
/// </summary>
/// <since_tizen> preview </since_tizen>
public override int Opacity
}
/// <summary>
- /// Adds label to a Popup widget.
+ /// Adds the label to a Popup widget.
/// </summary>
/// <param name="label"></param>
- /// <returns>The new PopupItem which contains label .</returns>
+ /// <returns>The new PopupItem which contains a label.</returns>
/// <since_tizen> preview </since_tizen>
public PopupItem Append(string label)
{
}
/// <summary>
- /// Adds Label and icon to a Popup widget.
+ /// Adds the Label and icon to a Popup widget.
/// </summary>
- /// <param name="label">The Label which will be added into a new PopupItem. </param>
- /// <param name="icon">The icon which will be added into a new PopupItem. </param>
- /// <returns>The new PopupItem which contains label and icon.</returns>
+ /// <param name="label">The Label, which will be added into a new PopupItem.</param>
+ /// <param name="icon">The icon, which will be added into a new PopupItem. </param>
+ /// <returns>The new PopupItem, which contains the label and icon.</returns>
/// <since_tizen> preview </since_tizen>
public PopupItem Append(string label, EvasObject icon)
{
/// <summary>
/// Uses this function to dismiss the popup in hide effect.
- /// when the Popup is dismissed, the "dismissed" signal will be emitted.
+ /// When the Popup is dismissed, the "dismissed" signal will be emitted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dismiss()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The PopupItem is a class that including icon and text.
+ /// The PopupItem is a class that includes the icon and text.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class PopupItem : ItemObject
}
/// <summary>
- /// Gets the text label of popupitem.Return value is string.
+ /// Gets the text label of the popupitem. Return value is string.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Text { get; internal set; }
/// <summary>
- /// Gets the icon EvasObject of popupitem.
+ /// Gets the EvasObject icon of the popupitem.
/// </summary>
/// <since_tizen> preview </since_tizen>
public EvasObject Icon { get; internal set; }
namespace ElmSharp
{
/// <summary>
- /// The ProgressBar is a widget for visually representing the progress status of a given job/task.
+ /// The ProgressBar is a widget for visually representing the progress status of a given job or task.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ProgressBar : Layout
}
/// <summary>
- /// ValueChanged will be triggered when value of ProgressBar change.
+ /// ValueChanged will be triggered when the value of the ProgressBar changes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ValueChanged;
/// <summary>
- /// Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode".
+ /// Sets or gets the value whether a given ProgressBar widget is at the "pulsing mode".
/// </summary>
/// <remarks>
/// By default, progress bars display values from low to high value boundaries.
/// There are, though, contexts in which the progress of a given task is unknown.
- /// For such cases, one can set a progress bar widget to a "pulsing state",
+ /// For such cases, one can set the progress bar widget to a "pulsing state",
/// to give the user an idea that some computation is being held,
- /// but without exact progress values. In the default theme,
+ /// but without the 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the value of ProgressBar.
+ /// Sets or gets the value of the ProgressBar.
/// </summary>
/// <remarks>
/// Use this property to set the progress bar levels.
- /// If you pass a value out of the specified range(0.0~1.0),
+ /// 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the span value of ProgressBar.
+ /// Sets or gets the span value of the ProgressBar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int SpanSize
}
/// <summary>
- /// Sets or gets the value wheather a given ProgressBar widget is horizontal.
+ /// Sets or gets the value whether a given ProgressBar widget is horizontal.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
}
/// <summary>
- /// Sets or gets format string for a given progress bar widget's units label.
+ /// Sets or gets the format string for a given progress bar widget's units label.
/// </summary>
/// <remarks>
- /// If NULL is passed on format, it makes obj units area to be hidden completely.
+ /// If null is passed on format, it makes the object units area to be hidden completely.
/// If not, it sets the format string for the units label's text.
- /// The units label is provided with a floating point value, so the units text displays at most one floating point value.
+ /// The units label are provided with a floating point value, so the units text displays at the most one floating point value.
/// Note that the units label is optional. Use a format string such as "%1.2f meters" for example.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets the part value of the given part of the Progressbar.
+ /// Gets the part value of a given part of the Progressbar.
/// </summary>
/// <param name="part">Part of the Progressbar.</param>
- /// <returns>Returns value range is from 0.0 to 1.0.</returns>
+ /// <returns>Value range is from 0.0 to 1.0.</returns>
/// <since_tizen> preview </since_tizen>
public double GetPartValue(string part)
{
}
/// <summary>
- /// Sets the part value of the give part of the Progressbar.
+ /// Sets the part value of a given part of the Progressbar.
/// </summary>
/// <param name="part">Part of the Progressbar.</param>
/// <param name="value">Value range is from 0.0 to 1.0.</param>
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them.
+ /// The Radio is a widget that allows for 1 or more options to be displayed, and have the user choose only 1 of them.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Radio : Layout
}
/// <summary>
- /// ValueChanged will be triggered when value of Radio change.
+ /// ValueChanged will be triggered when value of the radio changes.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler ValueChanged;
/// <summary>
- /// Sets or gets a unique value to each Radio button.
+ /// Sets or gets a unique value to each radio button.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int StateValue
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
public enum ReadingInfoType
{
/// <summary>
- /// None
+ /// None.
/// </summary>
None = 0,
/// <summary>
- /// Name for reading info type
+ /// Name for reading info type.
/// </summary>
Name = 0x1,
/// <summary>
- /// Role for reading info type
+ /// Role for reading info type.
/// </summary>
Role = 0x2,
/// <summary>
- /// Description for reading info type
+ /// Description for reading info type.
/// </summary>
Description = 0x4,
/// <summary>
- /// State for reading info type
+ /// State for reading info type.
/// </summary>
State = 0x8
}
namespace ElmSharp
{
/// <summary>
- /// The Rect is a struct that represent rectangluar space.
+ /// The Rect is a struct that represents the rectangular space.
/// </summary>
/// <since_tizen> preview </since_tizen>
[StructLayout(LayoutKind.Sequential)]
/// <summary>
/// Creates and initializes a new instance of the Rect class.
/// </summary>
- /// <param name="x">X axis value.</param>
- /// <param name="y">Y axis value.</param>
+ /// <param name="x">X-axis value.</param>
+ /// <param name="y">Y-axis value.</param>
/// <param name="w">Width value.</param>
/// <param name="h">Height value.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the position of this Rectangle on the X axis.
+ /// Gets or sets the position of this rectangle on the X-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int X { get; set; }
/// <summary>
- /// Gets or sets the position of this Rectangle on the Y axis.
+ /// Gets or sets the position of this rectangle on the Y-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Y { get; set; }
/// <summary>
- /// Gets or sets the width of this Rectangle.
+ /// Gets or sets the width of this rectangle.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Width { get; set; }
/// <summary>
- /// Gets or sets the height of this Rectangle.
+ /// Gets or sets the height of this rectangle.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Height { get; set; }
/// <summary>
- /// Gets the position of this Rectangle on the X axis.
+ /// Gets the position of this rectangle on the X-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Left { get { return X; } }
/// <summary>
- /// Gets the extent along the X axis.
+ /// Gets the extent along the X-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Right { get { return X + Width; } }
/// <summary>
- /// Gets the position of this Rectangle on the Y axis.
+ /// Gets the position of this rectangle on the Y-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Top { get { return Y; } }
/// <summary>
- /// Gets the extent along the Y axis.
+ /// Gets the extent along the Y-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Bottom { get { return Y + Height; } }
/// <summary>
- /// Gets the Point defined by Rectangle.Left and Rectangle.Top.
+ /// Gets the point defined by Rectangle.Left and Rectangle.Top.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point Location { get { return new Point { X = X, Y = Y }; } }
/// <summary>
- /// Gets the extent of the Rectangle along its X and Y axis.
+ /// Gets the extent of the rectangle along its X-axis and Y-axis.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size Size { get { return new Size { Width = Width, Height = Height }; } }
/// <summary>
- /// A human-readable representation of the <see cref="T:Tizen.UI.Rect" />.
+ /// A human-readable representation of <see cref="T:Tizen.UI.Rect"/>.
/// </summary>
/// <returns>The string is formatted as "{{X={0} Y={1} Width={2} Height={3}}}".</returns>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Rect"/> to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise, false
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool Equals(Rect other)
}
/// <summary>
- /// Whether the two <see cref="T:Tizen.UI.Rectangle" />s are equal.
+ /// Whether both <see cref="T:Tizen.UI.Rectangle"/>'s are equal.
/// </summary>
- /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle" /> on the left hand side.</param>
- /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Rectangle" />s have equal values.</returns>
+ /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle"/> on the left hand side.</param>
+ /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Rectangle"/>'s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Rect r1, Rect r2)
{
}
/// <summary>
- /// Whether two <see cref="T:Tizen.UI.Rectangle" />s are not equal.
+ /// Whether both <see cref="T:Tizen.UI.Rectangle"/>'s are not equal.
/// </summary>
- /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle" /> on the left hand side.</param>
- /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Rectangle" />s do not have equal values.</returns>
+ /// <param name="r1">A <see cref="T:Tizen.UI.Rectangle"/> on the left hand side.</param>
+ /// <param name="r2">A <see cref="T:Tizen.UI.Rectangle"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Rectangle"/>'s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Rect r1, Rect r2)
{
namespace ElmSharp
{
/// <summary>
- /// The Rectangle is a class that used to draw a solid colored rectangle.
+ /// The Rectangle is a class that is used to draw a solid colored rectangle.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Rectangle : EvasObject
/// <summary>
/// Creates and initializes a new instance of the Rectangle class.
/// </summary>
- /// <param name="parent">The <see cref="EvasObject"/> to which the new Slider will be attached as a child.</param>
+ /// <param name="parent">The <see cref="EvasObject"/> to which the new slider will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Rectangle(EvasObject parent) : base(parent)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for visible type of scrollbar.
+ /// Enumeration for the visible type of scrollbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ScrollBarVisiblePolicy
{
/// <summary>
- /// Show scrollbars as needed
+ /// Show scrollbars as needed.
/// </summary>
Auto = 0,
/// <summary>
- /// Always show scrollbars
+ /// Always show scrollbars.
/// </summary>
Visible,
/// <summary>
- /// Never show scrollbars
+ /// Never show scrollbars.
/// </summary>
Invisible
}
/// <summary>
- /// Enumeration for visible type of scrollbar.
+ /// Enumeration for the visible type of scrollbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ScrollBlock
{
/// <summary>
- /// Scrolling movement is allowed in both direction.(X axis and Y axis)
+ /// Scrolling movement is allowed in both the directions (X-axis and Y-axis).
/// </summary>
None = 1,
/// <summary>
- /// Scrolling movement is not allowed in Y axis direction.
+ /// Scrolling movement is not allowed in the Y-axis direction.
/// </summary>
Vertical = 2,
/// <summary>
- /// Scrolling movement is not allowed in X axis direction.
+ /// Scrolling movement is not allowed in the X-axis direction.
/// </summary>
Horizontal = 4
}
public enum ScrollSingleDirection
{
/// <summary>
- /// Scroll every direction.
+ /// Scroll in every direction.
/// </summary>
None,
/// <summary>
- /// Scroll single direction if the direction is certain.
+ /// Scroll in single direction if the direction is certain.
/// </summary>
Soft,
/// <summary>
- /// Scroll only single direction.
+ /// Scroll only in a single direction.
/// </summary>
Hard,
}
}
/// <summary>
- /// Gets the current region in the content object that is visible through the Scroller.
+ /// Gets the current region in the content object that is visible through the scroller.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Rect CurrentRegion
}
/// <summary>
- /// Sets or gets the value of HorizontalScrollBarVisiblePolicy
+ /// Sets or gets the value of HorizontalScrollBarVisiblePolicy.
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden.
}
/// <summary>
- /// Sets or gets the value of VerticalScrollBarVisiblePolicy
+ /// Sets or gets the value of VerticalScrollBarVisiblePolicy.
/// </summary>
/// <remarks>
/// ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden.
/// Sets or gets the value of ScrollBlock.
/// </summary>
/// <remarks>
- /// This function will block scrolling movement in a given direction.One can disable movements in the X axis, the Y axis or both.
+ /// 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets scroll current page number.
+ /// Sets or gets the scroll current page number.
/// </summary>
/// <remarks>
/// Current page means the page which meets the top of the viewport.
}
/// <summary>
- /// Sets or gets scroll current page number.
+ /// Sets or gets the scroll current page number.
/// </summary>
/// <remarks>
/// Current page means the page which meets the left of the viewport.
}
/// <summary>
- /// Set scrolling gravity values for a scroller.
- /// The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase.
- /// The scroller will adjust the view to glue itself as follows.
- /// 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
+ /// Sets the scrolling gravity values for a scroller.
+ /// The gravity defines how the scroller will adjust its view when the size of the scroller contents increase.
+ /// The scroller will adjust the view to glue itself as follows:
+ /// 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double HorizontalGravity
}
/// <summary>
- /// Set scrolling gravity values for a scroller.
- /// The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase.
- /// The scroller will adjust the view to glue itself as follows.
- /// 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
+ /// Sets the scrolling gravity values for a scroller.
+ /// The gravity defines how the scroller will adjust its view when the size of the scroller contents increase.
+ /// The scroller will adjust the view to glue itself as follows:
+ /// 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double VerticalGravity
}
/// <summary>
- /// Get scroll last page number.
+ /// Gets the scroll last page number.
/// The page number starts from 0. 0 is the first page. This returns the last page number among the pages.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Get scroll last page number.
+ /// Gets the scroll last page number.
/// The page number starts from 0. 0 is the first page. This returns the last page number among the pages.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Set an infinite loop_ for a scroller.
+ /// Sets an infinite loop_ for a scroller.
/// This function sets the infinite loop vertically.
/// If the content is set, it will be shown repeatedly.
/// </summary>
}
/// <summary>
- /// Set an infinite loop_ for a scroller.
+ /// Sets an infinite loop_ for a scroller.
/// This function sets the infinite loop horizontally.
/// If the content is set, it will be shown repeatedly.
/// </summary>
}
/// <summary>
- /// Gets or Sets the page snapping behavior of a scroller.
+ /// Gets or sets the page snapping behavior of a scroller.
/// </summary>
/// <remarks>
/// When scrolling, if a scroller is paged (see VerticalRelativePageSize),
}
/// <summary>
- /// Gets or Sets the page snapping behavior of a scroller.
+ /// Gets or sets the page snapping behavior of a scroller.
/// </summary>
/// <remarks>
/// When scrolling, if a scroller is paged (see HorizontalRelativePageSize),
/// <summary>
/// Gets or sets the event propagation for a scroller.
/// This enables or disables event propagation from the scroller content to the scroller and its parent.
- /// By default event propagation is enabled.
+ /// By default, event propagation is enabled.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ContentPropagateEvents
/// <summary>
/// Sets the scroller minimum size limited to the minimum size of the content.
- /// By default the scroller will be as small as its design allows, irrespective of its content.
+ /// By default, the scroller will be as small as its design allows, irrespective of its content.
/// This will make the scroller minimum size the right size horizontally and/or vertically to perfectly fit its content in that direction.
/// </summary>
- /// <param name="horizontal">Enable limiting minimum size horizontally</param>
- /// <param name="vertical">Enable limiting minimum size vertically</param>
+ /// <param name="horizontal">Enable limiting minimum size horizontally.</param>
+ /// <param name="vertical">Enable limiting minimum size vertically.</param>
/// <since_tizen> preview </since_tizen>
public void MinimumLimit(bool horizontal, bool vertical)
{
}
/// <summary>
- /// The callback of Realized Event
+ /// The callback of the Realized event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Size is a struct that defining height and width as a pair of generic type.
+ /// The Size is a struct defining the height and width as a pair of generic type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public struct Size : IEquatable<Size>
public int Height;
/// <summary>
- /// Initializes a new instance of the Size structure from the specified dimensions.
+ /// Initializes a new instance of the size structure from specified dimensions.
/// </summary>
- /// <param name="width">The width to set</param>
- /// <param name="height">The height to set</param>
+ /// <param name="width">The width to set.</param>
+ /// <param name="height">The height to set.</param>
/// <since_tizen> preview </since_tizen>
public Size(int width, int height)
{
}
/// <summary>
- /// A human-readable representation of the <see cref="T:Tizen.UI.Size" />.
+ /// A human-readable representation of <see cref="T:Tizen.UI.Size"/>.
/// </summary>
/// <returns>The string is formatted as "{{Width={0} Height={1}}}".</returns>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets hash code.
+ /// Gets the hash code.
/// </summary>
/// <returns>The hash code.</returns>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public override bool Equals(object obj)
/// </summary>
/// <param name="other">The <see cref="Size"/> to compare with the current instance.</param>
/// <returns>
- /// true if obj and this instance are the same type and represent the same value.
- /// otherwise, false.
+ /// true if the object and this instance are of the same type and represent the same value,
+ /// otherwise false.
/// </returns>
/// <since_tizen> preview </since_tizen>
public bool Equals(Size other)
}
/// <summary>
- /// Whether the two <see cref="T:Tizen.UI.Size" />s are equal.
+ /// Whether both <see cref="T:Tizen.UI.Size"/>s are equal.
/// </summary>
- /// <param name="s1">A <see cref="T:Tizen.UI.Size" /> on the left hand side.</param>
- /// <param name="s2">A <see cref="T:Tizen.UI.Size" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Size" />s have equal values.</returns>
+ /// <param name="s1">A <see cref="T:Tizen.UI.Size"/> on the left hand side.</param>
+ /// <param name="s2">A <see cref="T:Tizen.UI.Size"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Size"/>s have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator ==(Size s1, Size s2)
{
}
/// <summary>
- /// Whether two <see cref="T:Tizen.UI.Size" />s are not equal.
+ /// Whether both <see cref="T:Tizen.UI.Size"/>s are not equal.
/// </summary>
- /// <param name="s1">A <see cref="T:Tizen.UI.Size" /> on the left hand side.</param>
- /// <param name="s2">A <see cref="T:Tizen.UI.Size" /> on the right hand side.</param>
- /// <returns>True if the two <see cref="T:Tizen.UI.Size" />s do not have equal values.</returns>
+ /// <param name="s1">A <see cref="T:Tizen.UI.Size"/> on the left hand side.</param>
+ /// <param name="s2">A <see cref="T:Tizen.UI.Size"/> on the right hand side.</param>
+ /// <returns>True if both <see cref="T:Tizen.UI.Size"/>s do not have equal values.</returns>
/// <since_tizen> preview </since_tizen>
public static bool operator !=(Size s1, Size s2)
{
public enum SliderIndicatorVisibleMode
{
/// <summary>
- /// Show indicator on mouse down or change in slider value.
+ /// Shows the indicator on mouse down or change in the slider value.
/// </summary>
Default,
/// <summary>
/// Creates and initializes a new instance of the Slider class.
/// </summary>
- /// <param name="parent">The <see cref="EvasObject"/> to which the new Slider will be attached as a child.</param>
+ /// <param name="parent">The <see cref="EvasObject"/> to which the new slider will be attached as a child.</param>
/// <since_tizen> preview </since_tizen>
public Slider(EvasObject parent) : base(parent)
{
/// </summary>
/// <remarks>
/// This sets the minimum width (when in the horizontal mode) or height (when in the vertical mode)
- /// of the actual bar area of the slider obj. This in turn affects the object's minimum size.
+ /// of the actual bar area of the slider object. This in turn affects the object's minimum size.
/// 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.
/// </remarks>
/// <remarks>
/// The slider may display its value somewhere other than the unit label,
/// for example, above the slider knob that is dragged around. This function sets the format string
- /// used for this.If NULL, the indicator label won't be visible. If not, it sets the format string
+ /// used for this. If null, the indicator label won't be visible. If not, it sets the format string
/// for the label text. For the label text floating point value is provided, so the label text can
- /// display up to 1 floating point value. Note that this is optional.Use a format string
+ /// display up to 1 floating point value. Note that this is optional. Use a format string
/// 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.
+ /// equal to 3.14159. By default, the indicator label is disabled.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public string IndicatorFormat
/// Sets or gets the orientation of a given slider widget.
/// </summary>
/// <remarks>
- /// The orientation may be vertically or horizontally.By default, it's displayed horizontally.
+ /// The orientation may be vertical or horizontal. By default, it's displayed horizontally.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsHorizontal
/// <remarks>
/// This defines the allowed minimum values to be selected by the user.
/// 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.
+ /// Actual value can be obtained with value. By default, the minimum is equal to 0.0.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Minimum
/// <remarks>
/// This defines the allowed maximum values to be selected by the user.
/// If the actual value is bigger then max, it is updated to max.
- /// Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0.
+ /// Actual value can be obtained with value. By default, minimum is equal to 0.0 and maximum is equal to 1.0.
/// Maximum must be greater than minimum, otherwise the behavior is undefined.
/// </remarks>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <remarks>
/// 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.
+ /// on indicator with IndicatorFormat. The value must be between minimum and maximum values.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public double Value
/// <remarks>
/// This value is used when the draggable object is moved automatically i.e.,
/// in case of a key event when up/down/left/right key is pressed or in case accessibility
- /// is set and the flick event is used to inc/dec slider values.
+ /// is set and the flick event is used to increase or decrease the slider values.
/// By default, the step value is equal to 0.05.
/// </remarks>
/// <since_tizen> preview </since_tizen>
/// </summary>
/// <remarks>
/// A slider may be inverted, in which case it gets its values inverted,
- /// with high values being on the left or top and low values on the right or bottom,
+ /// with high values being on the left or top, and low values on the right or bottom,
/// as opposed to normally have the low values on the former and high values on the latter,
/// respectively, for the horizontal and vertical modes.
/// </remarks>
/// </summary>
/// <remarks>
/// By default, the indicator is bigger when dragged by the user.
- /// It won't display values set with IndicatorFormat if you disable the indicator.
+ /// It won't display the values set with IndicatorFormat if you disable the indicator.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsIndicatorVisible
}
/// <summary>
- /// Sets or gets the visible mode of slider indicator.
+ /// Sets or gets the visible mode of the slider indicator.
/// </summary>
/// <since_tizen> preview </since_tizen>
public SliderIndicatorVisibleMode IndicatorVisibleMode
}
/// <summary>
- /// Sets or gets whether to Show the indicator of slider on focus.
+ /// Sets or gets whether to show the indicator of a slider on focus.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsIndicatorFocusable
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
/// <summary>
/// It inherits <see cref="IInvalidatable"/>.
/// The event with TEventArgs for <see cref="EvasObject"/>.
- /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates.
+ /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates.
/// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
/// They are defined by an event string, which identifies them uniquely.
/// </summary>
public class SmartEvent<TEventArgs> : IInvalidatable where TEventArgs : EventArgs
{
/// <summary>
- /// The delegate for creating smart event item args.
+ /// The delegate for creating smart event item arguments.
/// </summary>
/// <param name="data">The item data.</param>
- /// <param name="obj">The sender obj.</param>
- /// <param name="info">The item sender obj.</param>
+ /// <param name="obj">The sender object.</param>
+ /// <param name="info">The item sender object.</param>
/// <returns>Return smart event item args.</returns>
/// <since_tizen> preview </since_tizen>
public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info);
}
/// <summary>
- /// reates and initializes a new instance of the SmartEvent class.
+ /// Creates and initializes a new instance of the SmartEvent class.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="handle">Teh event handler.</param>
}
/// <summary>
- /// Destroy the SmartEvent object.
+ /// Destroys the SmartEvent object.
/// </summary>
~SmartEvent()
{
}
/// <summary>
- /// Adds or removes delegate for event.
+ /// Adds or removes a delegate for the event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<TEventArgs> On
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Make current instance invalidate.
+ /// Makes the current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if managed resources should be disposed
- /// otherwise, false.
+ /// true if the managed resources should be disposed,
+ /// otherwise false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
/// <summary>
/// It inherits <see cref="IInvalidatable"/>.
- /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates.
+ /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates.
/// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
/// They are defined by an event string, which identifies them uniquely.
/// </summary>
}
/// <summary>
- /// Destroy the SmartEvent object.
+ /// Destroys the SmartEvent object.
/// </summary>
~SmartEvent()
{
}
/// <summary>
- /// Adds or removes delegate for event.
+ /// Adds or removes a delegate for the event.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler On
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Make current instance invalidate.
+ /// Makes the current instance invalidate.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void MakeInvalidate()
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if managed resources should be disposed
- /// otherwise, false.
+ /// true if the managed resources should be disposed,
+ /// otherwise false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
namespace ElmSharp
{
/// <summary>
- /// The Spinner is a widget that increase or decrease numeric values using arrow buttons, or edit values directly.
+ /// The Spinner is a widget that increases or decreases the numeric values using arrow buttons, or edit values directly.
/// Inherits <see cref="Layout"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Creates and initializes a new instance of Layout class.
+ /// Creates and initializes a new instance of the Layout class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Spinner() : base()
public event EventHandler ValueChanged;
/// <summary>
- /// DelayedValueChanged will be triggered after a short time when the value is changed.
+ /// DelayedValueChanged will be triggered after a short time when the value is changed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler DelayedValueChanged;
}
/// <summary>
- /// Sets or gets the step that used to increment or decrement the spinner value.
+ /// Sets or gets the step that is used to increment or decrement the spinner value.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Step
}
/// <summary>
- /// Sets or gets the interval on time updates for an user mouse button hold on spinner widgets' arrows.
+ /// Sets or gets the interval on time updates for a user mouse button to hold on the spinner widgets' arrows.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Interval
/// Sets or gets the wrap of a given spinner widget.
/// </summary>
/// <remarks>
- /// If wrap is disabled, 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 maximum value.
- /// 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.
+ /// If wrap is disabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the maximum value.
+ /// If wrap is enabled when the user tries to increment the value, but the displayed value plus step value is bigger than the maximum value, then the new value will be the minimum value.
+ /// By default, it's disabled.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public bool IsWrapEnabled
/// <summary>
/// Sets or gets whether the spinner can be directly edited by the user or not.
/// </summary>
- /// <remarks>By default it is enabled</remarks>
+ /// <remarks>By default, it is enabled.</remarks>
/// <since_tizen> preview </since_tizen>
public bool IsEditable
{
}
/// <summary>
- /// Set a special string to display in the place of the numerical value.
+ /// Sets a special string to display in the place of the numerical value.
/// </summary>
/// <param name="value">The numerical value to be replaced</param>
/// <param name="label">The label to be used</param>
}
/// <summary>
- /// Remove a previously added special value, After this, the spinner will display the value itself instead of a label.
+ /// Removes a previously added special value. After this, the spinner will display the value itself instead of a label.
/// </summary>
- /// <param name="value">The replaced numerical value</param>
+ /// <param name="value">The replaced numerical value.</param>
/// <since_tizen> preview </since_tizen>
public void RemoveSpecialValue(double value)
{
}
/// <summary>
- /// Get the special string display in the place of the numerical value.
+ /// Gets the special string display in the place of the numerical value.
/// </summary>
/// <param name="value">The replaced numerical value.</param>
- /// <returns>The value of the spinner which replaced numerical value with special string</returns>
+ /// <returns>The value of the spinner, which replaced the numerical value with a special string.</returns>
/// <since_tizen> preview </since_tizen>
public string GetSpecialValue(double value)
{
}
/// <summary>
- /// The callback of Realized Event
+ /// The callback of the Realized event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows .
+ /// The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows.
/// Inherits <see cref="Container"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets or gets whether the layout of this table is homogeneous.
/// </summary>
- /// <remarks>True for homogeneous, False for no homogeneous</remarks>
+ /// <remarks>True for homogeneous, False for no homogeneous.</remarks>
/// <since_tizen> preview </since_tizen>
public bool Homogeneous
{
/// <summary>
/// Adds a subobject on the table with the coordinates passed.
/// </summary>
- /// <param name="obj">The subobject to be added to the table</param>
- /// <param name="col">The column number</param>
- /// <param name="row">The row number</param>
- /// <param name="colspan">The column span</param>
- /// <param name="rowspan">The row span</param>
+ /// <param name="obj">The subobject to be added to the table.</param>
+ /// <param name="col">The column number.</param>
+ /// <param name="row">The row number.</param>
+ /// <param name="colspan">The column span.</param>
+ /// <param name="rowspan">The row span.</param>
/// <since_tizen> preview </since_tizen>
public void Pack(EvasObject obj, int col, int row, int colspan, int rowspan)
{
/// <summary>
/// Removes the child from the table.
/// </summary>
- /// <param name="obj">The subobject</param>
+ /// <param name="obj">The subobject.</param>
/// <since_tizen> preview </since_tizen>
public void Unpack(EvasObject obj)
{
}
/// <summary>
- /// Removes all child objects from a table object.
+ /// Removes all the child objects from a table object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Clear()
}
/// <summary>
- /// Sets the color for particular part of the table.
+ /// Sets the color for a particular part of the table.
/// </summary>
- /// <param name="part">The name of part class</param>
- /// <param name="color">The color</param>
+ /// <param name="part">The name of part class.</param>
+ /// <param name="color">The color.</param>
/// <since_tizen> preview </since_tizen>
public override void SetPartColor(string part, Color color)
{
}
/// <summary>
- /// Gets the color of particular part of the table.
+ /// Gets the color of a particular part of the table.
/// </summary>
- /// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'</param>
- /// <returns>The color of the particular part</returns>
+ /// <param name="part">The name of part class, it could be 'bg', 'elm.swllow.content'.</param>
+ /// <returns>The color of a particular part.</returns>
/// <since_tizen> preview </since_tizen>
public override Color GetPartColor(string part)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the selection mode of Toolbar.
+ /// Enumeration for the selection mode of the toolbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ToolbarSelectionMode
}
/// <summary>
- /// Enumeration that sets the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them.
+ /// Enumeration for setting the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ToolbarShrinkMode
{
/// <summary>
- /// Sets minimum toolbar size to fit all the items.
+ /// Sets the minimum toolbar size to fit all the items.
/// </summary>
None = 0,
Scroll,
/// <summary>
- /// Inserts a button to pop up a menu with exceeding items.
+ /// Inserts a button to popup a menu with exceeding items.
/// </summary>
Menu,
}
/// <summary>
- /// Enumeration for the icon lookup order of Toolbar.
+ /// Enumeration for the icon lookup order of the toolbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum ToolbarIconLookupOrder
{
/// <summary>
- /// Icon look up order: freedesktop, theme.
+ /// Icon lookup order: freedesktop, theme.
/// </summary>
FreedesktopTheme,
/// <summary>
- /// Icon look up order: theme, freedesktop.
+ /// Icon lookup order: theme, freedesktop.
/// </summary>
ThemeFreedesktop,
/// <summary>
- /// Icon look up order: freedesktop.
+ /// Icon lookup order: freedesktop.
/// </summary>
Freedesktop,
/// <summary>
- /// Icon look up order: theme.
+ /// Icon lookup order: theme.
/// </summary>
Theme,
}
}
/// <summary>
- /// Selected will be triggered when toolbar have been selected.
+ /// Selected will be triggered when toolbar has been selected.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler<ToolbarItemEventArgs> Selected;
/// <summary>
/// Sets or gets whether the layout of this toolbar is homogeneous.
/// </summary>
- /// <remarks>True for homogeneous, False for no homogeneous</remarks>
+ /// <remarks>True for homogeneous, False for no homogeneous.</remarks>
/// <since_tizen> preview </since_tizen>
public bool Homogeneous
{
}
/// <summary>
- /// Sets or gets toolbar's current orientation.
+ /// Sets or gets the toolbar's current orientation.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets the number of items in a toolbar widget.
+ /// Gets the number of items in a Toolbar widget.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ItemsCount
/// <summary>
/// Sets or gets the alignment of the items.
/// </summary>
- /// <remarks>The toolbar items alignment, a float between 0.0 and 1.0</remarks>
+ /// <remarks>The toolbar items alignment, a float between 0.0 and 1.0.</remarks>
/// <since_tizen> preview </since_tizen>
public double ItemAlignment
{
}
/// <summary>
- /// Sets or gets the item's transverse expansion of a given toolbar widget.
+ /// Sets or gets the item's transverse expansion of a given Toolbar widget.
/// </summary>
/// <remarks>
/// The transverse expansion of the item, true for on and false for off.
}
/// <summary>
- /// Appends ToolbarItem which just contains label to the toolbar.
+ /// Appends the ToolbarItem, which just contains label to the toolbar.
/// </summary>
- /// <param name="label">The label of the item</param>
- /// <returns>The new ToolbarItem which appended to the toolbar</returns>
+ /// <param name="label">The label of the item.</param>
+ /// <returns>The new ToolbarItem which is appended to the toolbar.</returns>
/// <seealso cref="Append(string, string)"/>
/// <seealso cref="Prepend(string)"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Appends ToolbarItem which contains label and icon to the toolbar.
+ /// Appends the ToolbarItem, which contains label and icon to the toolbar.
/// </summary>
- /// <param name="label">The label of the item</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
- /// <returns>The new ToolbarItem which appended to the toolbar</returns>
+ /// <param name="label">The label of the item.</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
+ /// <returns>The new ToolbarItem which is appended to the toolbar.</returns>
/// <seealso cref="Append(string)"/>
/// <seealso cref="Prepend(string)"/>
/// <seealso cref="Prepend(string, string)"/>
}
/// <summary>
- /// Prepends ToolbarItem which just contains label to the toolbar.
+ /// Prepends the ToolbarItem, which just contains label to the toolbar.
/// </summary>
- /// <param name="label">The label of the item</param>
- /// <returns>The new ToolbarItem which prepended to the toolbar</returns>
+ /// <param name="label">The label of the item.</param>
+ /// <returns>The new ToolbarItem which is prepended to the toolbar.</returns>
/// <seealso cref="Append(string)"/>
/// <seealso cref="Append(string, string)"/>
/// <seealso cref="Prepend(string, string)"/>
}
/// <summary>
- /// Prepends ToolbarItem which contains label and icon to the toolbar.
+ /// Prepends the ToolbarItem, which contains label and icon to the toolbar.
/// </summary>
- /// <param name="label">The label of the item</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
- /// <returns>The new <see cref="ToolbarItem"/> which prepended to the toolbar</returns>
+ /// <param name="label">The label of the item.</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which is prepended to the toolbar.</returns>
/// <seealso cref="Append(string)"/>
/// <seealso cref="Append(string, string)"/>
/// <seealso cref="Prepend(string)"/>
/// <summary>
/// Inserts a new item which just contains label into the toolbar object before item <paramref name="before"/>.
/// </summary>
- /// <param name="before">The toolbar item to insert before</param>
- /// <param name="label">The label of the item</param>
- /// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
+ /// <param name="before">The toolbar item to insert before.</param>
+ /// <param name="label">The label of the item.</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which is inserted into the toolbar.</returns>
/// <seealso cref="InsertBefore(ToolbarItem, string, string)"/>
/// <since_tizen> preview </since_tizen>
public ToolbarItem InsertBefore(ToolbarItem before, string label)
/// <summary>
/// Inserts a new item which contains label and icon into the toolbar object before item <paramref name="before"/>.
/// </summary>
- /// <param name="before">The toolbar item to insert before</param>
- /// <param name="label">The label of the item</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
- /// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
+ /// <param name="before">The toolbar item to insert before.</param>
+ /// <param name="label">The label of the item.</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which is inserted into the toolbar.</returns>
/// <seealso cref="InsertBefore(ToolbarItem, string)"/>
/// <since_tizen> preview </since_tizen>
public ToolbarItem InsertBefore(ToolbarItem before, string label, string icon)
/// <summary>
/// Inserts a new item which contains label and icon into the toolbar object after item <paramref name="after"/>.
/// </summary>
- /// <param name="after">The toolbar item to insert after</param>
- /// <param name="label">The label of the item</param>
- /// <param name="icon">A string with the icon name or the absolute path of an image file</param>
- /// <returns>The new <see cref="ToolbarItem"/> which insert into the toolbar</returns>
+ /// <param name="after">The toolbar item to insert after.</param>
+ /// <param name="label">The label of the item.</param>
+ /// <param name="icon">A string with the icon name or the absolute path of an image file.</param>
+ /// <returns>The new <see cref="ToolbarItem"/> which is inserted into the toolbar.</returns>
/// <since_tizen> preview </since_tizen>
public ToolbarItem InsertAfter(ToolbarItem after, string label, string icon)
{
}
/// <summary>
- /// Find the item with that label in the toolbar.
+ /// Finds the item with that label in the toolbar.
/// </summary>
- /// <param name="label">The label of the item</param>
- /// <returns>The <see cref="ToolbarItem"/> into the toolbar</returns>
+ /// <param name="label">The label of the item.</param>
+ /// <returns>The <see cref="ToolbarItem"/> into the toolbar.</returns>
/// <since_tizen> preview </since_tizen>
public ToolbarItem FindItemByLabel(string label)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// The ToolbarItem is a item of Toolbar.
+ /// The ToolbarItem is an item of the toolbar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class ToolbarItem : ItemObject
/// <summary>
/// Sets or gets whether displaying the item as a separator.
/// </summary>
- /// <remarks>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.</remarks>
+ /// <remarks>Items aren't set as a separator by default. If set as a separator, it displays a separator theme, so it won't display the icons or labels.</remarks>
/// <since_tizen> preview </since_tizen>
public bool IsSeparator
{
public event EventHandler Selected;
/// <summary>
- /// LongPressed will be triggered when the item is pressed long time.
+ /// LongPressed will be triggered when the item is pressed for a long time.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler LongPressed;
namespace ElmSharp
{
/// <summary>
- /// Transit is designed to apply various animated transition effects, such like translation, rotation, etc.
- /// For using these effects, create an Transit and add the desired transition effects.
+ /// Transit is designed to apply various animated transition effects, such as translation, rotation, etc.
+ /// For using these effects, create a transit and add the desired transition effects.
/// </summary>
/// <remarks>Transit is not reusable. If the effect ends, the transit is destroyed automatically.</remarks>
/// <since_tizen> preview </since_tizen>
Elm_Transit_Effect_Transition_Cb EffectTransitionCallback;
/// <summary>
- /// A callback called when the transit is deleted.
+ /// A callback is called when the transit is deleted.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler Deleted;
/// <summary>
- /// Creates and initializes a new instance of Transit class.
+ /// Creates and initializes a new instance of the Transit class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Transit()
}
/// <summary>
- /// Destroy the Transit object.
+ /// Destroys the transit object.
/// </summary>
~Transit()
{
}
/// <summary>
- /// Gets or sets the transit animation time
+ /// Gets or sets the transit animation time.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Duration
}
/// <summary>
- /// 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.
+ /// Gets or sets a value whether the objects states will be kept or not.
+ /// If it is not kept, the objects states will be reset when the transition ends.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ObjectStateKeep
}
/// <summary>
- /// Gets or sets if the auto reverse is on.
+ /// Gets or sets if auto reverse is on.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool AutoReverse
}
/// <summary>
- /// Gets or sets the smooth scaling for transit map rendering
- /// This gets smooth scaling for transit map rendering.
+ /// Gets or sets the smooth scaling for transit map rendering.
+ /// This gets the smooth scaling for transit map rendering.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Smooth
}
/// <summary>
- /// Get the time progression of the animation (a double value between 0.0 and 1.0).
- /// The value returned is a fraction(current time / total time).
+ /// Gets the time progression of the animation (a double value between 0.0 and 1.0).
+ /// The value returned is a fraction (current time/total time).
/// It represents the progression position relative to the total.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// Starts the transition in given seconds.
/// Once this API is called, the transit begins to measure the time.
/// </summary>
- /// <param name="interval">The interval value in seconds</param>
+ /// <param name="interval">The interval value in seconds.</param>
/// <since_tizen> preview </since_tizen>
public void Go(double interval = 0)
{
}
/// <summary>
- /// Pause the transition.
+ /// Pauses the transition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Pause()
}
/// <summary>
- /// Resume the transition.
+ /// Resumes the transition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Resume()
}
/// <summary>
- /// Get the current chained transit list.
+ /// Gets the current chained transit list.
/// </summary>
/// <remarks>Cannot add the duplicate transit.</remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Get the objects list of the transit.
+ /// Gets the objects list of the transit.
/// </summary>
/// <remarks>Cannot add the duplicate object.</remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Add the effect.
+ /// Adds the effect.
/// </summary>
/// <param name="effect">EffectBase object.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Destroy current object
+ /// Destroys the current object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void Dispose()
}
/// <summary>
- /// Releases all resources currently used by this instance.
+ /// Releases all the resources currently used by this instance.
/// </summary>
/// <param name="disposing">
- /// true if managed resources should be disposed
- /// otherwise, false.
+ /// true if the managed resources should be disposed,
+ /// otherwise false.
/// </param>
/// <since_tizen> preview </since_tizen>
protected virtual void Dispose(bool disposing)
}
/// <summary>
- /// Add new object to apply the effects.
- /// After the first addition of an object to transit, if its object list become empty again, the transit will be killed.
- /// If the obj belongs to another transit, the obj will be removed from it and it will only belong to the other transit.
+ /// Adds a new object to apply the effects.
+ /// After the first addition of an object to transit, if its object list becomes empty again, the transit will be killed.
+ /// If the object belongs to another transit, the object will be removed from it and it will only belong to the other transit.
/// </summary>
- /// <remarks>It is not allowed to add a new object after transit begins.</remarks>
+ /// <remarks>It is not allowed to add a new object after the transit begins.</remarks>
/// <param name="obj">Object to be animated.</param>
void AddObject(EvasObject obj)
{
/// <summary>
/// Makes the chain relationship between two transits.
/// </summary>
- /// <param name="transit">The chain transit object. This transit will be operated after transit is done.</param>
+ /// <param name="transit">The chain transit object. This transit will be operated after the transit is done.</param>
void AddChainedTransit(Transit transit)
{
if (_checker.Contains(transit))
}
/// <summary>
- /// Cut off the chain relationship between two transits.
+ /// Cuts off the chain relationship between two transits.
/// </summary>
/// <param name="transit">The chain transit object.</param>
void DeleteChainedTransit(Transit transit)
namespace ElmSharp
{
/// <summary>
- /// The axis along which flip effect should be applied.
+ /// Enumeration for the axis along which flip effect should be applied.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum FlipAxis
{
/// <summary>
- /// Flip on X axis
+ /// Flip on X-axis.
/// </summary>
X,
/// <summary>
- /// Flip on Y axis
+ /// Flip on Y-axis.
/// </summary>
Y,
}
/// <summary>
- /// The direction in which the wipe effect should occur.
+ /// Enumeration for the direction in which the wipe effect should occur.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WipeDirection
{
/// <summary>
- /// Wipe to the left
+ /// Wipe to the left.
/// </summary>
Left,
/// <summary>
- /// Wipe to the right
+ /// Wipe to the right.
/// </summary>
Right,
/// <summary>
- /// Wipe to the up
+ /// Wipe to the up.
/// </summary>
Up,
/// <summary>
- /// Wipe to the down
+ /// Wipe to the down.
/// </summary>
Down,
}
/// <summary>
- /// Whether the wipe effect should show or hide the object.
+ /// Enumeration for whether the wipe effect should show or hide the object.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WipeType
{
/// <summary>
- /// Hide the object during the animation
+ /// Hide the object during the animation.
/// </summary>
Hide,
/// <summary>
- /// Show the object during the animation
+ /// Show the object during the animation.
/// </summary>
Show,
}
/// <summary>
- /// The type of acceleration used in the transition.
+ /// Enumration for the type of acceleration used in transition.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum TweenMode
{
/// <summary>
- /// Constant speed
+ /// Constant speed.
/// </summary>
Linear,
/// <summary>
- /// Starts slow, increase speed over time, then decrease again and stop slowly, v1 being a power factor
+ /// Starts slow, increases speed over time, then decrease again and stop slowly, v1 being a power factor.
/// </summary>
Sinusoidal,
/// <summary>
- /// Starts fast and decrease speed over time, v1 being a power factor
+ /// Starts fast and decreases speed over time, v1 being a power factor.
/// </summary>
Decelerate,
/// <summary>
- /// Starts slow and increase speed over time, v1 being a power factor
+ /// Starts slow and increases speed over time, v1 being a power factor.
/// </summary>
Accelerate,
/// <summary>
- /// Start at gradient v1, interpolated via power of v2 curve
+ /// Starts at gradient v1, interpolated via power of v2 curve.
/// </summary>
DivisorInterpolate,
/// <summary>
- /// Start at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1
+ /// Starts at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1.
/// </summary>
Bounce,
/// <summary>
- /// Start at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1
+ /// Starts at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1.
/// </summary>
Spring,
/// <summary>
- /// Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2)
+ /// Follows the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2).
/// </summary>
BezierCurve,
}
public class BlendEffect : EffectBase
{
/// <summary>
- /// Creates and initializes a new instance of BlendEffect class.
+ /// Creates and initializes a new instance of the BlendEffect class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public BlendEffect()
Color _end;
/// <summary>
- /// Creates and initializes a new instance of ColorEffect class.
+ /// Creates and initializes a new instance of the ColorEffect class.
/// </summary>
- /// <param name="beginColor">The begin color of the effect</param>
- /// <param name="endColor">The end color of the effect</param>
+ /// <param name="beginColor">The begin color of the effect.</param>
+ /// <param name="endColor">The end color of the effect.</param>
/// <since_tizen> preview </since_tizen>
public ColorEffect(Color beginColor, Color endColor)
{
}
/// <summary>
- /// The begin color of the effect
+ /// The begin color of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color BeginColor
}
/// <summary>
- /// The end color of the effect
+ /// The end color of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Color EndColor
public class FadeEffect : EffectBase
{
/// <summary>
- /// Creates and initializes a new instance of FadeEffect class.
+ /// Creates and initializes a new instance of the FadeEffect class.
/// </summary>
/// <since_tizen> preview </since_tizen>
public FadeEffect()
bool _resizable;
/// <summary>
- /// Creates and initializes a new instance of FlipEffect class.
+ /// Creates and initializes a new instance of the FlipEffect class.
/// </summary>
- /// <param name="axis">Flipping Axis(X or Y).</param>
- /// <param name="clockWise">Flipping Direction. True is clock-wise.</param>
- /// <param name="resizable">Resizable effect with FlipEffect</param>
+ /// <param name="axis">Flipping axis (X or Y).</param>
+ /// <param name="clockWise">Flipping Direction. True is clockwise.</param>
+ /// <param name="resizable">Resizable effect with FlipEffect.</param>
/// <since_tizen> preview </since_tizen>
public FlipEffect(FlipAxis axis, bool clockWise, bool resizable = false)
{
}
/// <summary>
- /// Flipping Axis(X or Y).
+ /// Flipping axis (X or Y).
/// </summary>
/// <since_tizen> preview </since_tizen>
public FlipAxis Axis
}
/// <summary>
- /// Flipping Direction. True is clock-wise.
+ /// Flipping direction. True is clockwise.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ClockWise
Size _end;
/// <summary>
- /// Creates and initializes a new instance of FlipEffect class.
+ /// Creates and initializes a new instance of the ResizingEffect class.
/// </summary>
- /// <param name="beginSize">The begin Size of the effect</param>
- /// <param name="endSize">The end Size of the effect</param>
+ /// <param name="beginSize">The begin size of the effect.</param>
+ /// <param name="endSize">The end size of the effect.</param>
/// <since_tizen> preview </since_tizen>
public ResizingEffect(Size beginSize, Size endSize)
{
}
/// <summary>
- /// The begin Size of the effect
+ /// The begin size of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size BeginSize
}
/// <summary>
- /// The end Size of the effect
+ /// The end size of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size EndSize
float _end;
/// <summary>
- /// Creates and initializes a new instance of RotationEffect class.
+ /// Creates and initializes a new instance of the RotationEffect class.
/// </summary>
- /// <param name="beginDegree">The begin degree of the effect</param>
- /// <param name="endDegree">The end degree of the effect</param>
+ /// <param name="beginDegree">The begin degree of the effect.</param>
+ /// <param name="endDegree">The end degree of the effect.</param>
/// <since_tizen> preview </since_tizen>
public RotationEffect(float beginDegree, float endDegree)
{
}
/// <summary>
- /// The begin degree of the effect
+ /// The begin degree of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public float BeginDegree
}
/// <summary>
- /// The end degree of the effect
+ /// The end degree of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public float EndDegree
Point _end;
/// <summary>
- /// Creates and initializes a new instance of FlipEffect class.
+ /// Creates and initializes a new instance of the TranslationEffect class.
/// </summary>
- /// <param name="beginPoint">The begin Point of the effect</param>
- /// <param name="endPoint">The end Point of the effect</param>
+ /// <param name="beginPoint">The begin point of the effect.</param>
+ /// <param name="endPoint">The end point of the effect.</param>
/// <since_tizen> preview </since_tizen>
public TranslationEffect(Point beginPoint, Point endPoint)
{
}
/// <summary>
- /// The begin Point of the effect
+ /// The begin point of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point BeginPoint
}
/// <summary>
- /// The end Point of the effect
+ /// The end point of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point EndPoint
WipeDirection _direction;
/// <summary>
- /// Creates and initializes a new instance of WipeEffect class.
+ /// Creates and initializes a new instance of the WipeEffect class.
/// </summary>
/// <param name="type">Wipe type. Hide or show.</param>
- /// <param name="direction">Wipe Direction.</param>
+ /// <param name="direction">Wipe direction.</param>
/// <since_tizen> preview </since_tizen>
public WipeEffect(WipeType type, WipeDirection direction)
{
}
/// <summary>
- /// Wipe Direction.
+ /// Wipe direction.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WipeDirection Direction
float _end;
/// <summary>
- /// Creates and initializes a new instance of ZoomEffect class.
+ /// Creates and initializes a new instance of the ZoomEffect class.
/// </summary>
- /// <param name="beginRate">The begin rate of the effect</param>
- /// <param name="endRate">The end rate of the effect</param>
+ /// <param name="beginRate">The begin rate of the effect.</param>
+ /// <param name="endRate">The end rate of the effect.</param>
/// <since_tizen> preview </since_tizen>
public ZoomEffect(float beginRate, float endRate)
{
}
/// <summary>
- /// The begin rate of the effect
+ /// The begin rate of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public float BeginRate
}
/// <summary>
- /// The end rate of the effect
+ /// The end rate of the effect.
/// </summary>
/// <since_tizen> preview </since_tizen>
public float EndRate
namespace ElmSharp
{
/// <summary>
- /// This class is a static class for a utility methods.
+ /// This class is a static class for utility methods.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static class Utility
}
/// <summary>
- /// Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application.
+ /// Removes all font paths loaded into the memory by evas_font_path_app_* APIs for the application.
/// </summary>
/// <since_tizen> preview </since_tizen>
public static void ClearEvasGlobalFontPath()
}
/// <summary>
- /// Sets Edje color class.
+ /// Sets the Edje color class.
/// </summary>
- /// <param name="colorClass">Color class</param>
- /// <param name="red">Object Red value</param>
- /// <param name="green">Object Red value</param>
- /// <param name="blue">Object Red value</param>
- /// <param name="alpha">Object Red value</param>
- /// <param name="outlineRed">Outline Red value</param>
- /// <param name="outlineGreen">Outline Green value</param>
- /// <param name="outlineBlue">Outline Blue value</param>
- /// <param name="outlineAlpha">Outline Alpha value</param>
- /// <param name="shadowRed">Shadow Red value</param>
- /// <param name="shadowGreen">Shadow Green value</param>
- /// <param name="shadowBlue">Shadow Bluevalue</param>
- /// <param name="shadowAlpha">Shadow Alpha value</param>
+ /// <param name="colorClass">Color class.</param>
+ /// <param name="red">Object red value.</param>
+ /// <param name="green">Object green value.</param>
+ /// <param name="blue">Object blue value.</param>
+ /// <param name="alpha">Object alpha value.</param>
+ /// <param name="outlineRed">Outline red value.</param>
+ /// <param name="outlineGreen">Outline green value.</param>
+ /// <param name="outlineBlue">Outline blue value.</param>
+ /// <param name="outlineAlpha">Outline alpha value.</param>
+ /// <param name="shadowRed">Shadow red value.</param>
+ /// <param name="shadowGreen">Shadow green value.</param>
+ /// <param name="shadowBlue">Shadow blue value.</param>
+ /// <param name="shadowAlpha">Shadow alpha value.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
public static bool SetEdjeColorClass(string colorClass, int red, int green, int blue, int alpha, int outlineRed, int outlineGreen, int outlineBlue, int outlineAlpha,
}
/// <summary>
- /// Gets Edje color class.
+ /// Gets the Edje color class.
/// </summary>
- /// <param name="colorClass">Color class</param>
- /// <param name="red">Object Red value</param>
- /// <param name="green">Object Red value</param>
- /// <param name="blue">Object Red value</param>
- /// <param name="alpha">Object Red value</param>
- /// <param name="outlineRed">Outline Red value</param>
- /// <param name="outlineGreen">Outline Green value</param>
- /// <param name="outlineBlue">Outline Blue value</param>
- /// <param name="outlineAlpha">Outline Alpha value</param>
- /// <param name="shadowRed">Shadow Red value</param>
- /// <param name="shadowGreen">Shadow Green value</param>
- /// <param name="shadowBlue">Shadow Bluevalue</param>
- /// <param name="shadowAlpha">Shadow Alpha value</param>
+ /// <param name="colorClass">Color class.</param>
+ /// <param name="red">Object red value.</param>
+ /// <param name="green">Object green value.</param>
+ /// <param name="blue">Object blue value.</param>
+ /// <param name="alpha">Object alpha value.</param>
+ /// <param name="outlineRed">Outline red value.</param>
+ /// <param name="outlineGreen">Outline green value.</param>
+ /// <param name="outlineBlue">Outline blue value.</param>
+ /// <param name="outlineAlpha">Outline alpha value.</param>
+ /// <param name="shadowRed">Shadow red value.</param>
+ /// <param name="shadowGreen">Shadow green value.</param>
+ /// <param name="shadowBlue">Shadow blue value.</param>
+ /// <param name="shadowAlpha">Shadow alpha value.</param>
/// <returns></returns>
/// <since_tizen> preview </since_tizen>
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,
}
/// <summary>
- /// Processes all queued up edje messages.
+ /// Processes all the queued up edje messages.
/// This function triggers the processing of messages addressed to any (alive) edje objects.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets the Edje text class.
/// </summary>
- /// <param name="textClass">The text class name</param>
- /// <param name="font">The font name</param>
- /// <param name="size">The font size</param>
- /// <returns>True, on success or false, on error</returns>
+ /// <param name="textClass">The text class name.</param>
+ /// <param name="font">The font name.</param>
+ /// <param name="size">The font size.</param>
+ /// <returns>True on success, or False on error.</returns>
/// <since_tizen> preview </since_tizen>
public static bool SetEdjeTextClass(string textClass, string font, int size)
{
/// <summary>
/// Gets the Edje text class.
/// </summary>
- /// <param name="textClass">The text class name</param>
- /// <param name="font">The font name</param>
- /// <param name="size">The font size</param>
- /// <returns>True, on success or false, on error</returns>
+ /// <param name="textClass">The text class name.</param>
+ /// <param name="font">The font name.</param>
+ /// <param name="size">The font size.</param>
+ /// <returns>True on success, or False on error.</returns>
/// <since_tizen> preview </since_tizen>
public static bool GetEdjeTextClass(string textClass, out string font, out int size)
{
/// <summary>
/// Delete the text class.
/// </summary>
- /// <param name="textClass"></param>
+ /// <param name="textClass">The text class name.</param>
/// <since_tizen> preview </since_tizen>
public static void DeleteEdjeTextClass(string textClass)
{
}
/// <summary>
- /// Pre-multiplies a rgb triplet by an alpha factor.
+ /// Pre-multiplies the RGB triplet by an alpha factor.
/// </summary>
- /// <param name="alpha">The alpha factor</param>
- /// <param name="red">The Red component of the color</param>
- /// <param name="green">The Green component of the color</param>
- /// <param name="blue">The Blue component of the color</param>
+ /// <param name="alpha">The alpha factor.</param>
+ /// <param name="red">The red component of the color.</param>
+ /// <param name="green">The green component of the color.</param>
+ /// <param name="blue">The blue component of the color.</param>
/// <since_tizen> preview </since_tizen>
public static void PremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
{
}
/// <summary>
- /// Undoes pre-multiplies a rgb triplet by an alpha factor.
+ /// Undoes pre-multiplication of the RGB triplet by an alpha factor.
/// </summary>
- /// <param name="alpha">The alpha factor</param>
- /// <param name="red">The Red component of the color</param>
- /// <param name="green">The Green component of the color</param>
- /// <param name="blue">The Blue component of the color</param>
+ /// <param name="alpha">The alpha factor.</param>
+ /// <param name="red">The red component of the color.</param>
+ /// <param name="green">The green component of the color.</param>
+ /// <param name="blue">The blue component of the color.</param>
/// <since_tizen> preview </since_tizen>
public static void UnPremulityplyEvasColorByAlpha(int alpha, ref int red, ref int green, ref int blue)
{
public enum FocusDirection
{
/// <summary>
- /// Previous direction
+ /// Previous direction.
/// </summary>
Previous,
/// <summary>
- /// Next direction
+ /// Next direction.
/// </summary>
Next,
/// <summary>
- /// Up direction
+ /// Up direction.
/// </summary>
Up,
/// <summary>
- /// Down direction
+ /// Down direction.
/// </summary>
Down,
/// <summary>
- /// Right direction
+ /// Right direction.
/// </summary>
Right,
/// <summary>
- /// Left direction
+ /// Left direction.
/// </summary>
Left
}
/// <summary>
- /// The Widget is abstract class, it is the parent of other widgets.
+ /// The Widget is an abstract class and the parent of other widgets.
/// Inherits from <see cref="EvasObject"/>.
/// </summary>
/// <since_tizen> preview </since_tizen>
internal int _opacity = Color.Default.A;
/// <summary>
- /// Creates and initializes a new instance of Widget class.
+ /// Creates and initializes a new instance of the Widget class.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected Widget()
/// <summary>
/// Creates and initializes a new instance of the Widget class.
/// </summary>
- /// <param name="parent">The parent of new Widget instance</param>
+ /// <param name="parent">The parent of the new Widget instance.</param>
/// <since_tizen> preview </since_tizen>
protected Widget(EvasObject parent) : base(parent)
{
}
/// <summary>
- /// Update the part contents
+ /// Updates the part contents.
/// </summary>
- /// <param name="content">The content which put to the part</param>
- /// <param name="part">The updated part</param>
+ /// <param name="content">The content which is put into the part.</param>
+ /// <param name="part">The updated part.</param>
/// <since_tizen> preview </since_tizen>
protected void UpdatePartContents(EvasObject content, string part = "__default__")
{
/// <summary>
/// Gets whether a widget is focusable or not.
/// </summary>
- /// <remarks>Widgets which are meant to be interacted with by input events are created able to be focused, by default</remarks>
+ /// <remarks>Widgets which are meant to be interacted with by input events, are created able to be focused by default.</remarks>
/// <since_tizen> preview </since_tizen>
public bool IsFocusAllowed
{
/// <summary>
/// Sets or gets the text of the widget.
/// </summary>
- /// <remarks>It could be override by special child class</remarks>
+ /// <remarks>It could be overridden by special child class.</remarks>
/// <since_tizen> preview </since_tizen>
public virtual string Text
{
/// <summary>
/// Sets or gets the background color of the widget.
/// </summary>
- /// <remarks>It could be override by special child class</remarks>
+ /// <remarks>It could be overridden by special child class.</remarks>
/// <since_tizen> preview </since_tizen>
public virtual Color BackgroundColor
{
/// <summary>
/// Sets or gets the opacity of the widget.
/// </summary>
- /// <remarks>It could be override by special child class</remarks>
+ /// <remarks>It could be overridden by special child class.</remarks>
/// <since_tizen> preview </since_tizen>
public virtual int Opacity
{
/// <summary>
/// Sets or gets the widget's mirrored mode setting.
- /// When widget set automatic mode(true), it follows the system mirrored mode.
+ /// When widget is set to automatic mode(true), it follows the system mirrored mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsAutoMirroredMode
/// <summary>
/// Sets the widget to be focused or not.
/// </summary>
- /// <param name="isFocus">Weather be focused</param>
+ /// <param name="isFocus">Whether be focused.</param>
/// <since_tizen> preview </since_tizen>
public void SetFocus(bool isFocus)
{
/// <summary>
/// Sets the ability for a widget to be focused.
/// </summary>
- /// <param name="isAllowFocus">True if the object can be focused, false if not(and on errors)</param>
+ /// <param name="isAllowFocus">true if the object can be focused, false if not(and on errors).</param>
/// <since_tizen> preview </since_tizen>
public void AllowFocus(bool isAllowFocus)
{
}
/// <summary>
- /// Gives focus to next widget in widget tree.
+ /// Gives focus to the next widget in the widget tree.
/// </summary>
- /// <param name="direction">Direction to move the focus</param>
+ /// <param name="direction">Direction to move the focus.</param>
/// <since_tizen> preview </since_tizen>
public void FocusNext(FocusDirection direction)
{
}
/// <summary>
- /// Set next widget with specific focus direction.
+ /// Sets the next widget with specific focus direction.
/// </summary>
- /// <param name="next">Focus next widget</param>
- /// <param name="direction">Focus direction</param>
+ /// <param name="next">Focus next widget.</param>
+ /// <param name="direction">Focus direction.</param>
/// <since_tizen> preview </since_tizen>
public void SetNextFocusObject(EvasObject next, FocusDirection direction)
{
}
/// <summary>
- /// Sets content to particular part of the widget, and the preserve old content will not be unset.
+ /// Sets content to the particular part of the widget, and the preserve old content will not be unset.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <param name="content">The content</param>
+ /// <param name="part">The name of the particular part.</param>
+ /// <param name="content">The content.</param>
/// <seealso cref="SetPartContent(string, EvasObject, bool)"/>
/// <since_tizen> preview </since_tizen>
public virtual bool SetPartContent(string part, EvasObject content)
}
/// <summary>
- /// Sets content to particular part of the widget.
+ /// Sets content to the particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <param name="content">The content</param>
+ /// <param name="part">The name of the particular part.</param>
+ /// <param name="content">The content.</param>
/// <param name="preserveOldContent">true, preserve old content will be unset. false, preserve old content will not be unset.</param>
/// <seealso cref="SetPartContent(string, EvasObject)"/>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// Sets content to the widget, and the preserve old content will not be unset.
/// </summary>
- /// <param name="content">The content</param>
+ /// <param name="content">The content.</param>
/// <seealso cref="SetContent(EvasObject, bool)"/>
/// <since_tizen> preview </since_tizen>
public void SetContent(EvasObject content)
}
/// <summary>
- /// Sets content the widget.
+ /// Sets content to the widget.
/// </summary>
- /// <param name="content">The content</param>
+ /// <param name="content">The content.</param>
/// <param name="preserveOldContent">true, preserve old content will be unset. false, preserve old content will not be unset.</param>
/// <seealso cref="SetContent(EvasObject)"/>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets text to particular part of the widget.
+ /// Sets text to the particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <param name="text">The text</param>
+ /// <param name="part">The name of the particular part.</param>
+ /// <param name="text">The text.</param>
/// <since_tizen> preview </since_tizen>
public virtual bool SetPartText(string part, string text)
{
/// <summary>
/// Gets text of a particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <returns>Text of the particular part of the widget</returns>
+ /// <param name="part">The name of the particular part.</param>
+ /// <returns>Text of the particular part of the widget.</returns>
/// <since_tizen> preview </since_tizen>
public virtual string GetPartText(string part)
{
/// <summary>
/// Sets color of a particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <param name="color">The color be set to widget</param>
- /// <remarks>This method is a virtual method, it could be override by special child class</remarks>
+ /// <param name="part">The name of the particular part.</param>
+ /// <param name="color">The color to be set to the widget.</param>
+ /// <remarks>This method is a virtual method, it could be overridden by special child class.</remarks>
/// <since_tizen> preview </since_tizen>
public virtual void SetPartColor(string part, Color color)
{
/// <summary>
/// Gets color of the particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <returns>The color of the particular part</returns>
- /// <remarks>This method is a virtual method, it could be override by special child class</remarks>
+ /// <param name="part">The name of the particular part.</param>
+ /// <returns>The color of the particular part.</returns>
+ /// <remarks>This method is a virtual method, it could be overridden by special child class.</remarks>
/// <since_tizen> preview </since_tizen>
public virtual Color GetPartColor(string part)
{
/// <summary>
/// Sets opacity of the particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <param name="opacity">The opacity of the particular part</param>
+ /// <param name="part">The name of the particular part.</param>
+ /// <param name="opacity">The opacity of the particular part.</param>
/// <since_tizen> preview </since_tizen>
public void SetPartOpacity(string part, int opacity)
{
/// <summary>
/// Gets opacity of the particular part of the widget.
/// </summary>
- /// <param name="part">The name of particular part</param>
- /// <returns>Opacity value of the particular part</returns>
+ /// <param name="part">The name of the particular part.</param>
+ /// <returns>Opacity value of the particular part.</returns>
/// <since_tizen> preview </since_tizen>
public int GetPartOpacity(string part)
{
}
/// <summary>
- /// Send a signal to the edje object of the widget.
+ /// Sends a signal to the edje object of the widget.
/// </summary>
/// <param name="emission">The signal's name.</param>
/// <param name="source">The signal's source.</param>
}
/// <summary>
- /// The callback of Realized Event
+ /// The callback of the Realized event.
/// </summary>
/// <since_tizen> preview </since_tizen>
protected override void OnRealized()
public enum DisplayRotation
{
/// <summary>
- /// Rotation value of window is 0 degree
+ /// Rotation value of the window is 0 degree.
/// </summary>
Degree_0 = 1,
/// <summary>
- /// Rotation value of window is 90 degree
+ /// Rotation value of the window is 90 degrees.
/// </summary>
Degree_90 = 2,
/// <summary>
- /// Rotation value of window is 180 degree
+ /// Rotation value of the window is 180 degrees.
/// </summary>
Degree_180 = 4,
/// <summary>
- /// Rotation value of window is 270 degree
+ /// Rotation value of the window is 270 degrees.
/// </summary>
Degree_270 = 8
};
/// <summary>
- /// Enumeration for the indicator opacity
+ /// Enumeration for the indicator opacity.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum StatusBarMode
{
/// <summary>
- /// Opacifies the status bar
+ /// Opacifies the status bar.
/// </summary>
Opaque = 1,
/// <summary>
- /// Be translucent the status bar
+ /// Be translucent the status bar.
/// </summary>
/// <remarks>
/// Not supported.
Translucent = 2,
/// <summary>
- /// Transparentizes the status bar
+ /// Transparentizes the status bar.
/// </summary>
Transparent = 3,
}
/// <summary>
- /// Enumeration for the keygrab modes of window.
+ /// Enumeration for the keygrab modes of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum KeyGrabMode
{
/// <summary>
- /// Unknown keygrab mode
+ /// Unknown keygrab mode.
/// </summary>
Shared = 256,
Topmost = 512,
/// <summary>
- /// Getting the grabbed-key only when window is top of the stack.
+ /// Getting the grabbed-key only when the window is top of the stack.
/// </summary>
Exclusive = 1024,
/// <summary>
- /// Getting the grabbed-key exclusively regardless of window's position.
+ /// Getting the grabbed-key exclusively regardless of the window's position.
/// </summary>
OverrideExclusive = 2048,
}
};
/// <summary>
- /// Enumeration for the keyboard mode
+ /// Enumeration for the keyboard mode.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum KeyboardMode
{
/// <summary>
- /// Unknown keyboard state
+ /// Unknown keyboard state.
/// </summary>
Unknown,
/// <summary>
- /// Request to deactivate the keyboard
+ /// Request to deactivate the keyboard.
/// </summary>
Off,
/// <summary>
- /// Enable keyboard with default layout
+ /// Enable keyboard with default layout.
/// </summary>
On,
/// <summary>
- /// Alpha (a-z) keyboard layout
+ /// Alpha (a-z) keyboard layout.
/// </summary>
Alpha,
/// <summary>
- /// Numeric keyboard layout
+ /// Numeric keyboard layout.
/// </summary>
Numeric,
/// <summary>
- /// PIN keyboard layout
+ /// Pin keyboard layout.
/// </summary>
Pin,
/// <summary>
- /// Phone keyboard layout
+ /// Phone keyboard layout.
/// </summary>
PhoneNumber,
/// <summary>
- /// Hexadecimal numeric keyboard layout
+ /// Hexadecimal numeric keyboard layout.
/// </summary>
Hex,
/// <summary>
- /// Full (QWERTY) keyboard layout
+ /// Full (QWERTY) keyboard layout.
/// </summary>
QWERTY,
/// <summary>
- /// Password keyboard layout
+ /// Password keyboard layout.
/// </summary>
Password,
/// <summary>
- /// IP keyboard layout
+ /// IP keyboard layout.
/// </summary>
IP,
/// <summary>
- /// Host keyboard layout
+ /// Host keyboard layout.
/// </summary>
Host,
/// <summary>
- /// File keyboard layout
+ /// File keyboard layout.
/// </summary>
File,
/// <summary>
- /// URL keyboard layout
+ /// URL keyboard layout.
/// </summary>
URL,
/// <summary>
- /// Keypad layout
+ /// Keypad layout.
/// </summary>
Keypad,
/// <summary>
- /// J2ME keyboard layout
+ /// J2ME keyboard layout.
/// </summary>
J2ME,
};
/// <summary>
- /// Enumeration for the window type
+ /// Enumeration for the window type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WindowType
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown,
PopupMenu,
/// <summary>
- /// The window is a tooltip. A short piece of explanatory text that typically appear after the mouse cursor hovers over an object for a while.
+ /// The window is a tooltip. A short piece of explanatory text that typically appears after the mouse cursor hovers over an object for a while.
/// </summary>
Tooltip,
/// <summary>
- /// A notification window, like a warning about battery life or a new E-Mail received.
+ /// A notification window, like a warning about battery life or a new e-mail received.
/// </summary>
Notification,
Combo,
/// <summary>
- /// Used to indicate the window is a representation of an object being dragged across different windows, or even applications.
+ /// Used to indicate the window as a representation of an object being dragged across different windows, or even applications.
/// </summary>
DragAndDrop,
/// <summary>
/// The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer.
- /// This allows to have children window inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it.
+ /// This allows to have children windows inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it.
/// </summary>
InlinedImage,
};
/// <summary>
- /// The Window is container that contain the graphical user interface of a program.
+ /// The Window is a container that contains the graphical user interface of a program.
/// </summary>
/// <since_tizen> preview </since_tizen>
public class Window : Widget
/// Creates and initializes a new instance of the Window class.
/// </summary>
/// <param name="parent">
- /// Parent widget which this widow created on.
+ /// Parent widget which this window is created on.
/// </param>
/// <param name="name">
/// Window name.
/// </param>
/// <remarks>
- /// Window constructor.show window indicator,set callback
- /// When closing the window in any way outside the program control,
- /// and set callback when window rotation changed.
+ /// Window constructor.show window indicator, set callback
+ /// when closing the window in any way outside the program control,
+ /// and set callback when window rotation is changed.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public Window(Window parent, string name) : this(parent, name, WindowType.Basic)
/// Creates and initializes a new instance of the Window class.
/// </summary>
/// <param name="parent">
- /// Parent widget which this widow created on.
+ /// Parent widget which this window is created on.
/// </param>
/// <param name="name">
/// Window name.
/// </param>
/// <param name="type">
- /// Window type
+ /// Window type.
/// </param>
/// <remarks>
- /// Window constructor.show window indicator,set callback
- /// When closing the window in any way outside the program control,
- /// and set callback when window rotation changed.
+ /// Window constructor.show window indicator, set callback
+ /// when closing the window in any way outside the program control,
+ /// and set callback when window rotation is changed.
/// </remarks>
/// <since_tizen> preview </since_tizen>
public Window(Window parent, string name, WindowType type)
}
/// <summary>
- /// CloseRequested will be triggered when Window close.
+ /// CloseRequested will be triggered when window is closed.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler CloseRequested;
/// <summary>
- /// RotationChanged will be triggered when Window do rotation.
+ /// RotationChanged will be triggered when window is rotated.
/// </summary>
/// <since_tizen> preview </since_tizen>
public event EventHandler RotationChanged;
/// <summary>
- /// Sets or gets Window name.
+ /// Sets or gets the window name.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Name { get; set; }
/// <summary>
- /// Gets the Window type.
+ /// Gets the window type.
/// </summary>
/// <since_tizen> preview </since_tizen>
public WindowType Type { get; } = WindowType.Basic;
/// <summary>
- /// Gets Window size with Size value(w,h)
+ /// Gets the window size with Size value(w,h)
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size ScreenSize
}
/// <summary>
- /// Gets the screen dpi for the screen that a Window is on.
+ /// Gets the screen dpi for the screen that the window is on.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Point ScreenDpi
}
/// <summary>
- /// Gets the rotation of the Window.The rotation of the window in degrees (0-360).
+ /// Gets the rotation of the window. The rotation of the window in degrees (0-360).
/// </summary>
/// <since_tizen> preview </since_tizen>
public int Rotation
}
/// <summary>
- /// Gets whether window manager supports window rotation or not.
+ /// Gets whether the window manager supports window rotation or not.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool IsRotationSupported
}
/// <summary>
- /// Sets or gets available rotation degree.
+ /// Sets or gets the available rotation degree.
/// </summary>
/// <since_tizen> preview </since_tizen>
[Obsolete("Sorry, it's error typo of AvailableRotations, please use AvailableRotations")]
public DisplayRotation AavailableRotations { get; set; }
/// <summary>
- /// Sets or gets available rotation degree.
+ /// Sets or gets the available rotation degree.
/// </summary>
/// <since_tizen> preview </since_tizen>
public DisplayRotation AvailableRotations
}
/// <summary>
- /// Sets or gets whether auto deletion function is enable.
+ /// Sets or gets whether the auto deletion function is enabled.
/// </summary>
/// <remarks>
/// If you enable auto deletion, the window is automatically destroyed after the signal is emitted.
}
/// <summary>
- /// Sets or gets the alpha channel state of a window.
+ /// Sets or gets the alpha channel state of the window.
/// </summary>
/// <remarks>
- /// True if the window alpha channel is enabled, false otherwise.
+ /// 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Sets or gets the mode of status bar.
+ /// Sets or gets the mode of the status bar.
/// </summary>
/// <since_tizen> preview </since_tizen>
public StatusBarMode StatusBarMode
}
/// <summary>
- /// Sets or gets the iconified state of a window.
+ /// Sets or gets the iconified state of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
}
/// <summary>
- /// Gets or sets the aspect ratio of a window.
+ /// Gets or sets the aspect ratio of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public double Aspect
}
/// <summary>
- /// Get the borderless state of a window.
+ /// Gets the borderless state of the window.
/// This function requests the Window Manager to not draw any decoration around the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Gets or sets the demand attention state of a window.
+ /// Gets or sets the demand attention state of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool DemandAttention
}
/// <summary>
- /// Gets or sets the floating mode of a window.
+ /// Gets or sets the floating mode of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool FloatingMode
}
/// <summary>
- /// Gets or sets the enabled status for the focus highlight in a window.
+ /// Gets or sets the enabled status for the focus highlight in the window.
/// This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it.
/// </summary>
/// <since_tizen> preview </since_tizen>
/// <summary>
/// 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.
+ /// 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string FocusHighlightStyle
}
/// <summary>
- /// Get the keyboard mode of the window.
+ /// Gets the keyboard mode of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public KeyboardMode KeyboardMode
/// <summary>
/// Gets or sets the layer of the window.
/// What this means exactly will depend on the underlying engine used.
- /// In the case of X11 backed engines, the value in layer has the following meanings
+ /// In the case of X11 backed engines, the value in layer has the following meanings:
/// less than 3 means that the window will be placed below all others,
/// 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.
}
/// <summary>
- /// Gets or sets the modal state of a window.
+ /// Gets or sets the modal state of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Modal
}
/// <summary>
- /// Gets or sets the noblank property of a window.
- /// 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.
+ /// Gets or sets the noblank property of the window.
+ /// This is a way to request the display on which the window is shown is not blank, screensave, or otherwise hidden or obscure. It is intended for use 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.
/// </summary>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Get the profile of a window.
+ /// Gets the profile of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public string Profile
}
/// <summary>
- /// 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.
+ /// Gets the constraints on the maximum width and height of the window relative to the width and height of its screen.
+ /// When this function returns true, object will never resize larger than the screen.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool ScreenConstrain
}
/// <summary>
- /// Gets or sets the base size of a window.
+ /// Gets or sets the base size of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size BaseSize
}
/// <summary>
- /// Gets or sets the step size of a window.
+ /// Gets or sets the step size of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public Size StepSize
}
/// <summary>
- /// Get the screen position X of a window.
+ /// Gets the screen position X of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ScreenPositionX
}
/// <summary>
- /// Get the screen position Y of a window.
+ /// Gets the screen position Y of a window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public int ScreenPositionY
}
/// <summary>
- /// Gets or sets the urgent state of a window.
+ /// Gets or sets the urgent state of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Urgent
}
/// <summary>
- /// Gets or sets the withdrawn state of a window.
+ /// Gets or sets the withdrawn state of the window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public bool Withdrawn
}
/// <summary>
- /// Create a socket to provide the service for Plug widget.
+ /// Creates a socket to provide the service for the Plug widget.
/// </summary>
- /// <param name="name">A service name</param>
+ /// <param name="name">A service name.</param>
/// <param name="number">A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name.</param>
- /// <param name="systemWide">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.</param>
- /// <returns>If true, create successfull, otherwise false</returns>
+ /// <param name="systemWide">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.</param>
+ /// <returns>If true creates successful, otherwise false.</returns>
/// <since_tizen> preview </since_tizen>
public bool CreateServiceSocket(string name, int number, bool systemWide)
{
}
/// <summary>
- /// Set the rotation of the window.
+ /// Sets the rotation of the window.
/// </summary>
/// <param name="degree">The rotation of the window, in degrees (0-360), counter-clockwise.</param>
/// <param name="resize">Resizes the window's contents so that they fit inside the current window geometry.</param>
}
/// <summary>
- /// Set the window to be skipped by focus.
+ /// Sets the window to be skipped by focus.
/// This sets the window to be skipped by normal input.
- /// This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc.
- /// Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect.
+ /// This means the Windows Manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc.
+ /// Call this and enable it on the window BEFORE you show it for the first time, otherwise it may have no effect.
/// 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.
/// </summary>
}
/// <summary>
- /// 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.
+ /// Pulls up the window object.
+ /// Places the window pointed by object at the top of the stack, so that it's not covered by any other window.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void PullUp()
}
/// <summary>
- /// 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.
+ /// Brings down the window object.
+ /// Places the window pointed by object at the bottom of the stack, so that no other window is covered by it.
/// </summary>
/// <since_tizen> preview </since_tizen>
public void BringDown()
}
/// <summary>
- /// This function sends a request to the Windows Manager to activate the Window.
- /// If honored by the WM, the window receives the keyboard focus.
+ /// This function sends a request to the Windows Manager to activate the window.
+ /// If honored by the Windows Manager, the window receives the keyboard focus.
/// </summary>
/// <remarks>
- /// This is just a request that a Window Manager may ignore, so calling this function does not ensure
+ /// This is just a request that the Windows 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.
/// </remarks>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Delete subobj as a resize object of window obj.
- /// This function removes the object subobj from the resize objects of the window obj.
- /// 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.
+ /// Deletes the subobj as a resize object of the window object.
+ /// This function removes the object subobj from the resize objects of the window object.
+ /// 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.
/// </summary>
/// <param name="obj">Resize object.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Adds obj as a resize object of the Window.
+ /// Adds an object as a resize object of the window.
/// </summary>
/// <remarks>
- /// Setting an object as a resize object of the window means that the obj child's size and
- /// position is controlled by the window directly. That is, the obj is resized to match the window size
- /// and should never be moved or resized manually by the developer.In addition,
+ /// Setting an object as a resize object of the window means that the object child's size and
+ /// position is controlled by the window directly. That is, the object is resized to match the window size
+ /// and should never be moved or resized manually by the developer. In addition,
/// resize objects of the window control the minimum size of it as well as whether it can or cannot be resized by the user.
/// </remarks>
/// <param name="obj">
}
/// <summary>
- /// Set keygrab value of the window.
- /// This function grabs the key of window using grab_mode.
+ /// Sets the keygrab value of the window.
+ /// This function grabs the key of the window using grab_mode.
/// </summary>
/// <param name="keyname">The keyname to grab.</param>
- /// <param name="mode">According to the grabmode, it can grab key differently</param>
+ /// <param name="mode">According to the grabmode, it can grab key differently.</param>
/// <since_tizen> preview </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public void WinKeyGrab(string keyname, KeyGrabMode mode)
}
/// <summary>
- /// Unset keygrab value of the window.
- /// This function unset keygrab value.Ungrab key of window.
+ /// Unsets the keygrab value of the window.
+ /// This function unsets keygrab value. Ungrab key of the window.
/// </summary>
/// <param name="keyname">The keyname to grab.</param>
/// <since_tizen> preview </since_tizen>
}
/// <summary>
- /// Set the keygrab of the window.
+ /// Sets the keygrab of the window.
/// </summary>
- /// <param name="keyname">keyname string to set keygrab</param>
+ /// <param name="keyname">The keyname string to set keygrab.</param>
/// <since_tizen> preview </since_tizen>
public void KeyGrabEx(string keyname)
{
}
/// <summary>
- /// Unset the keygrab of the window.
+ /// Unsets the keygrab of the window.
/// </summary>
- /// <param name="keyname">keyname string to unset keygrab</param>
+ /// <param name="keyname">The keyname string to unset keygrab.</param>
/// <since_tizen> preview </since_tizen>
public void KeyUngrabEx(string keyname)
{
/// <summary>
/// Creates a widget handle.
/// </summary>
- /// <param name="parent">Parent EvasObject</param>
- /// <returns>Handle IntPtr</returns>
+ /// <param name="parent">Parent EvasObject.</param>
+ /// <returns>Handle IntPtr.</returns>
/// <since_tizen> preview </since_tizen>
protected override IntPtr CreateHandle(EvasObject parent)
{
namespace ElmSharp
{
/// <summary>
- /// Enumeration for the wrap type.
+ /// Enumeration for the wrap types.
/// </summary>
/// <since_tizen> preview </since_tizen>
public enum WrapType
/// </summary>
Char,
/// <summary>
- /// Word wrap - wrap within the allowed wrapping points
+ /// Word wrap - wrap within the allowed wrapping points.
/// (as defined in the unicode standard).
/// </summary>
Word,
/// <summary>
- /// Mixed wrap - Word wrap, if that fails, char wrap.
+ /// Mixed wrap - word wrap, if that fails, char wrap.
/// </summary>
Mixed
}
internal static partial class Elementary
{
/// <summary>
- /// Types of "Enter" keys available for different keyboards layout
+ /// Types of "Enter" keys available for different keyboard layouts.
/// </summary>
public enum ReturnKeyType
{
projects / platform / core / csapi / tizenfx.git / commitdiff