Some docs updates

This commit is contained in:
Miguel de Icaza
2018-02-08 22:41:38 -05:00
parent af05d158e2
commit c5325c5527
4 changed files with 31 additions and 5 deletions

View File

@@ -3,8 +3,8 @@
This is a simple UI toolkit for .NET.
It is an updated version of
[gui.cs](https://github.com/mono/mono-curses/blob/master/gui.cs) that
I wrote for [mono-curses](https://github.com/mono/mono-curses).
[gui.cs](http://tirania.org/blog/archive/2007/Apr-16.html) that
I wrote for [mono-curses](https://github.com/mono/mono-curses) in 2007.
The toolkit contains various controls (labesl, text entry, buttons,
radio buttons, checkboxes, dialog boxes, windows, menus) for building

View File

@@ -106,7 +106,11 @@ namespace Terminal.Gui {
return false;
}
// Mouse events
/// <summary>
/// Method invoked when a mouse event is generated
/// </summary>
/// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
/// <param name="me">Me.</param>
public virtual bool MouseEvent (MouseEvent me)
{
return false;

View File

@@ -93,9 +93,14 @@ namespace Terminal.Gui {
/// </remarks>
public struct Attribute {
internal int value;
public Attribute (int v)
/// <summary>
/// Initializes a new instance of the <see cref="T:Terminal.Gui.Attribute"/> struct.
/// </summary>
/// <param name="value">Value.</param>
public Attribute (int value)
{
value = v;
this.value = value;
}
public static implicit operator int (Attribute c) => c.value;

View File

@@ -256,6 +256,10 @@ namespace Terminal.Gui {
CanFocus = true;
}
/// <summary>
/// Redraws the ListView
/// </summary>
/// <param name="region">Region.</param>
public override void Redraw(Rect region)
{
var current = ColorScheme.Focus;
@@ -287,6 +291,11 @@ namespace Terminal.Gui {
/// </summary>
public event Action SelectedChanged;
/// <summary>
/// Handles cursor movement for this view, passes all other events.
/// </summary>
/// <returns><c>true</c>, if key was processed, <c>false</c> otherwise.</returns>
/// <param name="kb">Keyboard event.</param>
public override bool ProcessKey (KeyEvent kb)
{
switch (kb.Key) {
@@ -346,5 +355,13 @@ namespace Terminal.Gui {
}
return base.ProcessKey (kb);
}
/// <summary>
/// Positions the cursor in this view
/// </summary>
public override void PositionCursor()
{
Driver.Move (0, selected);
}
}
}