Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-02 01:03:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Miguel de Icaza
2018-02-20 23:08:22 -05:00
parent 46983d43bf
commit c3e45f7cbb
35 changed files with 227 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
ecmadocs/en/Mono.Terminal/MainLoop+Condition.xml
View File

@@ -15,14 +15,14 @@
</Attributes>
<Docs>
<summary>
Condition on which to wake up from file descriptor activity
Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="PollErr">
<MemberSignature Language="C#" Value="PollErr" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollErr = int32(8)" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollErr = int16(8)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -38,7 +38,7 @@
</Member>
<Member MemberName="PollHup">
<MemberSignature Language="C#" Value="PollHup" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollHup = int32(16)" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollHup = int16(16)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -54,7 +54,7 @@
</Member>
<Member MemberName="PollIn">
<MemberSignature Language="C#" Value="PollIn" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollIn = int32(1)" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollIn = int16(1)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -70,7 +70,7 @@
</Member>
<Member MemberName="PollNval">
<MemberSignature Language="C#" Value="PollNval" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollNval = int32(32)" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollNval = int16(32)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -86,7 +86,7 @@
</Member>
<Member MemberName="PollOut">
<MemberSignature Language="C#" Value="PollOut" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollOut = int32(2)" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollOut = int16(4)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -102,7 +102,7 @@
</Member>
<Member MemberName="PollPri">
<MemberSignature Language="C#" Value="PollPri" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollPri = int32(4)" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollPri = int16(2)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>

5
ecmadocs/en/Mono.Terminal/MainLoop.xml
View File

@@ -14,7 +14,10 @@
Simple main loop implementation that can be used to monitor
file descriptor, run timers and idle handlers.
</summary>
<remarks>To be added.</remarks>
<remarks>
Monitoring of file descriptors is only available on Unix, there
does not seem to be a way of supporting this on Windows.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">

40
ecmadocs/en/Terminal.Gui/Application.xml
View File

@@ -56,10 +56,19 @@
<Parameter Name="toplevel" Type="Terminal.Gui.Toplevel" />
</Parameters>
<Docs>
<param name="toplevel">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="toplevel">Toplevel to prepare execution for.</param>
<summary>
Building block API: Prepares the provided toplevel for execution.
</summary>
<returns>The runstate handle that needs to be passed to the End() method upon completion.</returns>
<remarks>
This method prepares the provided toplevel for running with the focus,
it adds this to the list of toplevels, sets up the mainloop to process the
event, lays out the subviews, focuses the first element, and draws the
toplevel in the screen. This is usually followed by executing
the <see cref="M:Terminal.Gui.Application.RunLoop(Terminal.Gui.Application.RunState,System.Boolean)" /> method, and then the <see cref="M:Terminal.Gui.Application.End(Terminal.Gui.Application.RunState)" /> method upon termination which will
undo these changes.
</remarks>
</Docs>
</Member>
<Member MemberName="Current">
@@ -112,7 +121,9 @@
</Parameters>
<Docs>
<param name="rs">To be added.</param>
<summary>To be added.</summary>
<summary>
Building block API: completes the exection of a Toplevel that was started with Begin.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -314,6 +325,17 @@
To make a toplevel stop execution, set the "Running"
property to false.
</para>
<para>
This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the
returned value, and then calling end on the return value.
</para>
<para>
Alternatively, if your program needs to control the main loop and needs to
process events manually, you can invoke Begin to set things up manually and then
repeatedly call RunLoop with the wait parameter set to false. By doing this
the RunLoop method will only process any pending events, timers, idle handlers and
then return control immediately.
</para>
</remarks>
</Docs>
</Member>
@@ -332,14 +354,14 @@
<Parameter Name="wait" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="state">To be added.</param>
<param name="wait">To be added.</param>
<param name="state">The state returned by the Begin method.</param>
<param name="wait">By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.</param>
<summary>
Runs the main loop for the created dialog
Building block API: Runs the main loop for the created dialog
</summary>
<remarks>
Use the wait parameter to control whether this is a
blocking or non-blocking call.
blocking or non-blocking call.
</remarks>
</Docs>
</Member>

24
ecmadocs/en/Terminal.Gui/Button.xml
View File

@@ -28,8 +28,8 @@
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (string s);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string s) cil managed" />
<MemberSignature Language="C#" Value="public Button (string text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string text) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -38,7 +38,7 @@
<Parameter Name="s" Type="System.String" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="text">To be added.</param>
<summary>
Public constructor, creates a button based on
the given text at position 0,0
@@ -50,8 +50,8 @@
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (string s, bool is_default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string s, bool is_default) cil managed" />
<MemberSignature Language="C#" Value="public Button (string text, bool is_default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string text, bool is_default) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -61,7 +61,7 @@
<Parameter Name="is_default" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="text">To be added.</param>
<param name="is_default">To be added.</param>
<summary>
Public constructor, creates a button based on
@@ -75,8 +75,8 @@
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (int x, int y, string s);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string s) cil managed" />
<MemberSignature Language="C#" Value="public Button (int x, int y, string text);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string text) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -89,7 +89,7 @@
<Docs>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="s">To be added.</param>
<param name="text">To be added.</param>
<summary>
Public constructor, creates a button based on
the given text at the given position.
@@ -101,8 +101,8 @@
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Button (int x, int y, string s, bool is_default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string s, bool is_default) cil managed" />
<MemberSignature Language="C#" Value="public Button (int x, int y, string text, bool is_default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string text, bool is_default) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -116,7 +116,7 @@
<Docs>
<param name="x">To be added.</param>
<param name="y">To be added.</param>
<param name="s">To be added.</param>
<param name="text">To be added.</param>
<param name="is_default">To be added.</param>
<summary>
Public constructor, creates a button based on

16
ecmadocs/en/Terminal.Gui/ConsoleDriver.xml
View File

@@ -229,10 +229,12 @@
<Parameter Name="fill" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="region">To be added.</param>
<param name="padding">To be added.</param>
<param name="fill">To be added.</param>
<summary>To be added.</summary>
<param name="region">Region where the frame will be drawn..</param>
<param name="padding">Padding to add on the sides.</param>
<param name="fill">If set to <c>true</c> it will clear the contents with the current color, otherwise the contents will be left untouched.</param>
<summary>
Draws a frame on the specified region with the specified padding around the frame.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
@@ -472,8 +474,10 @@
<Parameter Name="c" Type="Terminal.Gui.Attribute" />
</Parameters>
<Docs>
<param name="c">To be added.</param>
<summary>To be added.</summary>
<param name="c">C.</param>
<summary>
Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>

4
ecmadocs/en/Terminal.Gui/FrameView.xml
View File

@@ -78,8 +78,8 @@
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public virtual void Remove (Terminal.Gui.View view);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
<MemberSignature Language="C#" Value="public override void Remove (Terminal.Gui.View view);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>

23
ecmadocs/en/Terminal.Gui/ListView.xml
View File

@@ -13,7 +13,28 @@
<summary>
ListView widget renders a list of data.
</summary>
<remarks>To be added.</remarks>
<remarks>
<para>
The ListView displays lists of data and allows the user to scroll through the data
and optionally mark elements of the list (controlled by the AllowsMark property).
</para>
<para>
The ListView can either render an arbitrary IList object (for example, arrays, List&lt;T&gt;
and other collections) which are drawn by drawing the string/ustring contents or the
result of calling ToString(). Alternatively, you can provide you own IListDataSource
object that gives you full control of what is rendered.
</para>
<para>
The ListView can display any object that implements the System.Collection.IList interface,
string values are converted into ustring values before rendering, and other values are
converted into ustrings by calling ToString() and then converting to ustring.
</para>
<para>
If you must change the contents of the ListView, set the Source property (when you are
providing your own rendering via the IListDataSource implementation) or call SetSource
when you are providing an IList.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">

18
ecmadocs/en/Terminal.Gui/Responder.xml
View File

@@ -60,8 +60,8 @@
</Docs>
</Member>
<Member MemberName="MouseEvent">
<MemberSignature Language="C#" Value="public virtual bool MouseEvent (Terminal.Gui.MouseEvent me);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent me) cil managed" />
<MemberSignature Language="C#" Value="public virtual bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent mouseEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -73,7 +73,7 @@
<Parameter Name="me" Type="Terminal.Gui.MouseEvent" />
</Parameters>
<Docs>
<param name="me">Me.</param>
<param name="mouseEvent">Contains the details about the mouse event.</param>
<summary>
Method invoked when a mouse event is generated
</summary>
@@ -83,8 +83,8 @@
</Docs>
</Member>
<Member MemberName="ProcessColdKey">
<MemberSignature Language="C#" Value="public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent kb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
<MemberSignature Language="C#" Value="public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -96,7 +96,7 @@
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
</Parameters>
<Docs>
<param name="kb">To be added.</param>
<param name="keyEvent">Contains the details about the key that produced the event.</param>
<summary>
This method can be overwritten by views that
want to provide accelerator functionality
@@ -161,8 +161,8 @@
</Docs>
</Member>
<Member MemberName="ProcessKey">
<MemberSignature Language="C#" Value="public virtual bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
<MemberSignature Language="C#" Value="public virtual bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -174,7 +174,7 @@
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
</Parameters>
<Docs>
<param name="kb">To be added.</param>
<param name="keyEvent">Contains the details about the key that produced the event.</param>
<summary>
If the view is focused, gives the view a
chance to process the keystroke.

6
ecmadocs/en/Terminal.Gui/Toplevel.xml
View File

@@ -75,8 +75,8 @@
</Docs>
</Member>
<Member MemberName="ProcessKey">
<MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
<MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -88,7 +88,7 @@
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
</Parameters>
<Docs>
<param name="kb">To be added.</param>
<param name="keyEvent">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>

18
ecmadocs/en/Terminal.Gui/View.xml
View File

@@ -741,8 +741,8 @@
</Docs>
</Member>
<Member MemberName="ProcessColdKey">
<MemberSignature Language="C#" Value="public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
<MemberSignature Language="C#" Value="public override bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -754,15 +754,15 @@
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
</Parameters>
<Docs>
<param name="kb">To be added.</param>
<param name="keyEvent">Contains the details about the key that produced the event.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProcessHotKey">
<MemberSignature Language="C#" Value="public override bool ProcessHotKey (Terminal.Gui.KeyEvent kb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessHotKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
<MemberSignature Language="C#" Value="public override bool ProcessHotKey (Terminal.Gui.KeyEvent keyEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessHotKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -774,15 +774,15 @@
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
</Parameters>
<Docs>
<param name="kb">To be added.</param>
<param name="keyEvent">Contains the details about the key that produced the event.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProcessKey">
<MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
<MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -794,7 +794,7 @@
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
</Parameters>
<Docs>
<param name="kb">To be added.</param>
<param name="keyEvent">Contains the details about the key that produced the event.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>

10
ecmadocs/en/Terminal.Gui/Window.xml
View File

@@ -122,8 +122,8 @@
</Docs>
</Member>
<Member MemberName="MouseEvent">
<MemberSignature Language="C#" Value="public override bool MouseEvent (Terminal.Gui.MouseEvent me);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent me) cil managed" />
<MemberSignature Language="C#" Value="public override bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent mouseEvent) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -135,7 +135,7 @@
<Parameter Name="me" Type="Terminal.Gui.MouseEvent" />
</Parameters>
<Docs>
<param name="me">To be added.</param>
<param name="mouseEvent">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
@@ -161,8 +161,8 @@
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public virtual void Remove (Terminal.Gui.View view);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
<MemberSignature Language="C#" Value="public override void Remove (Terminal.Gui.View view);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>