|
@@ -1,890 +0,0 @@
|
|
|
-<Type Name="View" FullName="Terminal.Gui.View">
|
|
|
- <TypeSignature Language="C#" Value="public class View : Terminal.Gui.Responder, System.Collections.IEnumerable" />
|
|
|
- <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit View extends Terminal.Gui.Responder implements class System.Collections.IEnumerable" />
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyName>Terminal</AssemblyName>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <Base>
|
|
|
- <BaseTypeName>Terminal.Gui.Responder</BaseTypeName>
|
|
|
- </Base>
|
|
|
- <Interfaces>
|
|
|
- <Interface>
|
|
|
- <InterfaceName>System.Collections.IEnumerable</InterfaceName>
|
|
|
- </Interface>
|
|
|
- </Interfaces>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.
|
|
|
- </summary>
|
|
|
- <remarks>
|
|
|
- <para>
|
|
|
- The View defines the base functionality for user interface elements in Terminal/gui.cs. Views
|
|
|
- can contain one or more subviews, can respond to user input and render themselves on the screen.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Views are created with a specified rectangle region (the frame) that is relative to the container
|
|
|
- that they are added into.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Subviews can be added to a View by calling the Add method. The container of a view is the
|
|
|
- Superview.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view
|
|
|
- as requiring to be redrawn.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Views have a ColorScheme property that defines the default colors that subviews
|
|
|
- should use for rendering. This ensures that the views fit in the context where
|
|
|
- they are being used, and allows for themes to be plugged in. For example, the
|
|
|
- default colors for windows and toplevels uses a blue background, while it uses
|
|
|
- a white background for dialog boxes and a red background for errors.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- If a ColorScheme is not set on a view, the result of the ColorScheme is the
|
|
|
- value of the SuperView and the value might only be valid once a view has been
|
|
|
- added to a SuperView, so your subclasses should not rely on ColorScheme being
|
|
|
- set at construction time.
|
|
|
- </para>
|
|
|
- <para>
|
|
|
- Using ColorSchemes has the advantage that your application will work both
|
|
|
- in color as well as black and white displays.
|
|
|
- </para>
|
|
|
- </remarks>
|
|
|
- </Docs>
|
|
|
- <Members>
|
|
|
- <Member MemberName=".ctor">
|
|
|
- <MemberSignature Language="C#" Value="public View (Terminal.Gui.Rect frame);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Terminal.Gui.Rect frame) cil managed" />
|
|
|
- <MemberType>Constructor</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="frame" Type="Terminal.Gui.Rect" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="frame">The region covered by this view.</param>
|
|
|
- <summary>
|
|
|
- Initializes a new instance of the <see cref="T:Terminal.View" /> class with the specified frame. This is the default constructor.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Add">
|
|
|
- <MemberSignature Language="C#" Value="public virtual void Add (Terminal.Gui.View view);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Add(class Terminal.Gui.View view) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="view" Type="Terminal.Gui.View" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="view">To be added.</param>
|
|
|
- <summary>
|
|
|
- Adds a subview to this view.
|
|
|
- </summary>
|
|
|
- <remarks />
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Add">
|
|
|
- <MemberSignature Language="C#" Value="public void Add (Terminal.Gui.View[] views);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(class Terminal.Gui.View[] views) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="views" Type="Terminal.Gui.View[]">
|
|
|
- <Attributes>
|
|
|
- <Attribute>
|
|
|
- <AttributeName>System.ParamArray</AttributeName>
|
|
|
- </Attribute>
|
|
|
- </Attributes>
|
|
|
- </Parameter>
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="views">Array of one or more views (can be optional parameter).</param>
|
|
|
- <summary>
|
|
|
- Adds the specified views to the view.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="AddCh">
|
|
|
- <MemberSignature Language="C#" Value="public void AddCh (int col, int row, int ch);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddCh(int32 col, int32 row, int32 ch) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="col" Type="System.Int32" />
|
|
|
- <Parameter Name="row" Type="System.Int32" />
|
|
|
- <Parameter Name="ch" Type="System.Int32" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="col">Col.</param>
|
|
|
- <param name="row">Row.</param>
|
|
|
- <param name="ch">Ch.</param>
|
|
|
- <summary>
|
|
|
- Displays the specified character in the specified column and row.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Bounds">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.Rect Bounds { get; set; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance valuetype Terminal.Gui.Rect Bounds" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.Rect</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame.
|
|
|
- </summary>
|
|
|
- <value>The bounds.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="ChildNeedsDisplay">
|
|
|
- <MemberSignature Language="C#" Value="public void ChildNeedsDisplay ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ChildNeedsDisplay() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Flags this view for requiring the children views to be repainted.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Clear">
|
|
|
- <MemberSignature Language="C#" Value="public void Clear ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Clear() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Clears the view region with the current color.
|
|
|
- </summary>
|
|
|
- <remarks>
|
|
|
- <para>
|
|
|
- This clears the entire region used by this view.
|
|
|
- </para>
|
|
|
- </remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="ClearNeedsDisplay">
|
|
|
- <MemberSignature Language="C#" Value="protected void ClearNeedsDisplay ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void ClearNeedsDisplay() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="ColorScheme">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.ColorScheme ColorScheme { get; set; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance class Terminal.Gui.ColorScheme ColorScheme" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.ColorScheme</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- The color scheme for this view, if it is not defined, it returns the parent's
|
|
|
- color scheme.
|
|
|
- </summary>
|
|
|
- <value>To be added.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="DrawFrame">
|
|
|
- <MemberSignature Language="C#" Value="public void DrawFrame (Terminal.Gui.Rect rect, bool fill = false);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DrawFrame(valuetype Terminal.Gui.Rect rect, bool fill) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="rect" Type="Terminal.Gui.Rect" />
|
|
|
- <Parameter Name="fill" Type="System.Boolean" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="rect">Rectangular region for the frame to be drawn.</param>
|
|
|
- <param name="fill">If set to <c>true</c> it fill will the contents.</param>
|
|
|
- <summary>
|
|
|
- Draws a frame in the current view, clipped by the boundary of this view
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="DrawHotString">
|
|
|
- <MemberSignature Language="C#" Value="public void DrawHotString (string text, bool focused, Terminal.Gui.ColorScheme scheme);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DrawHotString(string text, bool focused, class Terminal.Gui.ColorScheme scheme) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="text" Type="System.String" />
|
|
|
- <Parameter Name="focused" Type="System.Boolean" />
|
|
|
- <Parameter Name="scheme" Type="Terminal.Gui.ColorScheme" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
|
|
|
- <param name="focused">If set to <c>true</c> this uses the focused colors from the color scheme, otherwise the regular ones.</param>
|
|
|
- <param name="scheme">The color scheme to use.</param>
|
|
|
- <summary>
|
|
|
- Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="DrawHotString">
|
|
|
- <MemberSignature Language="C#" Value="public void DrawHotString (string text, Terminal.Gui.Attribute hotColor, Terminal.Gui.Attribute normalColor);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void DrawHotString(string text, valuetype Terminal.Gui.Attribute hotColor, valuetype Terminal.Gui.Attribute normalColor) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="text" Type="System.String" />
|
|
|
- <Parameter Name="hotColor" Type="Terminal.Gui.Attribute" />
|
|
|
- <Parameter Name="normalColor" Type="Terminal.Gui.Attribute" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
|
|
|
- <param name="hotColor">Hot color.</param>
|
|
|
- <param name="normalColor">Normal color.</param>
|
|
|
- <summary>
|
|
|
- Utility function to draw strings that contain a hotkey
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Driver">
|
|
|
- <MemberSignature Language="C#" Value="public static Terminal.Gui.ConsoleDriver Driver;" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".field public static class Terminal.Gui.ConsoleDriver Driver" />
|
|
|
- <MemberType>Field</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.ConsoleDriver</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Points to the current driver in use by the view, it is a convenience property
|
|
|
- for simplifying the development of new views.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="EnsureFocus">
|
|
|
- <MemberSignature Language="C#" Value="public void EnsureFocus ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnsureFocus() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Focused">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.View Focused { get; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance class Terminal.Gui.View Focused" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.View</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Returns the currently focused view inside this view, or null if nothing is focused.
|
|
|
- </summary>
|
|
|
- <value>The focused.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="FocusFirst">
|
|
|
- <MemberSignature Language="C#" Value="public void FocusFirst ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void FocusFirst() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Focuses the first focusable subview if one exists.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="FocusLast">
|
|
|
- <MemberSignature Language="C#" Value="public void FocusLast ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void FocusLast() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Focuses the last focusable subview if one exists.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="FocusNext">
|
|
|
- <MemberSignature Language="C#" Value="public bool FocusNext ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FocusNext() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Focuses the next view.
|
|
|
- </summary>
|
|
|
- <returns>
|
|
|
- <c>true</c>, if next was focused, <c>false</c> otherwise.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="FocusPrev">
|
|
|
- <MemberSignature Language="C#" Value="public bool FocusPrev ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool FocusPrev() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Focuses the previous view.
|
|
|
- </summary>
|
|
|
- <returns>
|
|
|
- <c>true</c>, if previous was focused, <c>false</c> otherwise.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Frame">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.Rect Frame { get; set; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance valuetype Terminal.Gui.Rect Frame" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.Rect</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Gets or sets the frame for the view.
|
|
|
- </summary>
|
|
|
- <value>The frame.</value>
|
|
|
- <remarks>
|
|
|
- Altering the Frame of a view will trigger the redrawing of the
|
|
|
- view as well as the redrawing of the affected regions in the superview.
|
|
|
- </remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="GetEnumerator">
|
|
|
- <MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.IEnumerator GetEnumerator() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <Attributes>
|
|
|
- <Attribute>
|
|
|
- <AttributeName>System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.Gui.View/<GetEnumerator>d__23))</AttributeName>
|
|
|
- </Attribute>
|
|
|
- </Attributes>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Collections.IEnumerator</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Gets an enumerator that enumerates the subviews in this view.
|
|
|
- </summary>
|
|
|
- <returns>The enumerator.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="HasFocus">
|
|
|
- <MemberSignature Language="C#" Value="public override bool HasFocus { get; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance bool HasFocus" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Gets or sets a value indicating whether this <see cref="T:Terminal.View" /> has focus.
|
|
|
- </summary>
|
|
|
- <value>
|
|
|
- <c>true</c> if has focus; otherwise, <c>false</c>.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Id">
|
|
|
- <MemberSignature Language="C#" Value="public string Id { get; set; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance string Id" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.String</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Gets or sets an identifier for the view;
|
|
|
- </summary>
|
|
|
- <value>The identifier.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="LayoutSubviews">
|
|
|
- <MemberSignature Language="C#" Value="public virtual void LayoutSubviews ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LayoutSubviews() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- This virtual method is invoked when a view starts executing or
|
|
|
- when the dimensions of the view have changed, for example in
|
|
|
- response to the container view or terminal resizing.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="MostFocused">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.View MostFocused { get; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance class Terminal.Gui.View MostFocused" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.View</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Returns the most focused view in the chain of subviews (the leaf view that has the focus).
|
|
|
- </summary>
|
|
|
- <value>The most focused.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Move">
|
|
|
- <MemberSignature Language="C#" Value="public void Move (int col, int row);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Move(int32 col, int32 row) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="col" Type="System.Int32" />
|
|
|
- <Parameter Name="row" Type="System.Int32" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="col">Col.</param>
|
|
|
- <param name="row">Row.</param>
|
|
|
- <summary>
|
|
|
- This moves the cursor to the specified column and row in the view.
|
|
|
- </summary>
|
|
|
- <returns>The move.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="PositionCursor">
|
|
|
- <MemberSignature Language="C#" Value="public virtual void PositionCursor ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void PositionCursor() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Positions the cursor in the right position based on the currently focused view in the chain.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </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" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="kb">To be added.</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" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="kb">To be added.</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" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="kb">To be added.</param>
|
|
|
- <summary>To be added.</summary>
|
|
|
- <returns>To be added.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Redraw">
|
|
|
- <MemberSignature Language="C#" Value="public virtual void Redraw (Terminal.Gui.Rect region);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Redraw(valuetype Terminal.Gui.Rect region) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="region" Type="Terminal.Gui.Rect" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="region">To be added.</param>
|
|
|
- <summary>
|
|
|
- Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.
|
|
|
- </summary>
|
|
|
- <remarks>
|
|
|
- The region argument is relative to the view itself.
|
|
|
- </remarks>
|
|
|
- </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" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="view" Type="Terminal.Gui.View" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="view">To be added.</param>
|
|
|
- <summary>
|
|
|
- Removes a widget from this container.
|
|
|
- </summary>
|
|
|
- <remarks />
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="RemoveAll">
|
|
|
- <MemberSignature Language="C#" Value="public virtual void RemoveAll ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RemoveAll() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Removes all the widgets from this container.
|
|
|
- </summary>
|
|
|
- <remarks />
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="ScreenToView">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.Point ScreenToView (int x, int y);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype Terminal.Gui.Point ScreenToView(int32 x, int32 y) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.Point</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="x" Type="System.Int32" />
|
|
|
- <Parameter Name="y" Type="System.Int32" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="x">X screen-coordinate point.</param>
|
|
|
- <param name="y">Y screen-coordinate point.</param>
|
|
|
- <summary>
|
|
|
- Converts a point from screen coordinates into the view coordinate space.
|
|
|
- </summary>
|
|
|
- <returns>The mapped point.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="SetFocus">
|
|
|
- <MemberSignature Language="C#" Value="public void SetFocus (Terminal.Gui.View view);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFocus(class Terminal.Gui.View view) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="view" Type="Terminal.Gui.View" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="view">View.</param>
|
|
|
- <summary>
|
|
|
- Focuses the specified sub-view.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="SetNeedsDisplay">
|
|
|
- <MemberSignature Language="C#" Value="public void SetNeedsDisplay ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetNeedsDisplay() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Invoke to flag that this view needs to be redisplayed, by any code
|
|
|
- that alters the state of the view.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="SetNeedsDisplay">
|
|
|
- <MemberSignature Language="C#" Value="public void SetNeedsDisplay (Terminal.Gui.Rect region);" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetNeedsDisplay(valuetype Terminal.Gui.Rect region) cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Void</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters>
|
|
|
- <Parameter Name="region" Type="Terminal.Gui.Rect" />
|
|
|
- </Parameters>
|
|
|
- <Docs>
|
|
|
- <param name="region">The region that must be flagged for repaint.</param>
|
|
|
- <summary>
|
|
|
- Flags the specified rectangle region on this view as needing to be repainted.
|
|
|
- </summary>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="Subviews">
|
|
|
- <MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Terminal.Gui.View> Subviews { get; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Terminal.Gui.View> Subviews" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Collections.Generic.IList<Terminal.Gui.View></ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- This returns a list of the subviews contained by this view.
|
|
|
- </summary>
|
|
|
- <value>The subviews.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="SuperView">
|
|
|
- <MemberSignature Language="C#" Value="public Terminal.Gui.View SuperView { get; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance class Terminal.Gui.View SuperView" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>Terminal.Gui.View</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Returns the container for this view, or null if this view has not been added to a container.
|
|
|
- </summary>
|
|
|
- <value>The super view.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="ToString">
|
|
|
- <MemberSignature Language="C#" Value="public override string ToString ();" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
|
|
|
- <MemberType>Method</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.String</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Parameters />
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Returns a <see cref="T:System.String" /> that represents the current <see cref="T:Terminal.View" />.
|
|
|
- </summary>
|
|
|
- <returns>A <see cref="T:System.String" /> that represents the current <see cref="T:Terminal.View" />.</returns>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- <Member MemberName="WantMousePositionReports">
|
|
|
- <MemberSignature Language="C#" Value="public virtual bool WantMousePositionReports { get; set; }" />
|
|
|
- <MemberSignature Language="ILAsm" Value=".property instance bool WantMousePositionReports" />
|
|
|
- <MemberType>Property</MemberType>
|
|
|
- <AssemblyInfo>
|
|
|
- <AssemblyVersion>0.0.0.0</AssemblyVersion>
|
|
|
- </AssemblyInfo>
|
|
|
- <ReturnValue>
|
|
|
- <ReturnType>System.Boolean</ReturnType>
|
|
|
- </ReturnValue>
|
|
|
- <Docs>
|
|
|
- <summary>
|
|
|
- Gets or sets a value indicating whether this <see cref="T:Terminal.View" /> want mouse position reports.
|
|
|
- </summary>
|
|
|
- <value>
|
|
|
- <c>true</c> if want mouse position reports; otherwise, <c>false</c>.</value>
|
|
|
- <remarks>To be added.</remarks>
|
|
|
- </Docs>
|
|
|
- </Member>
|
|
|
- </Members>
|
|
|
-</Type>
|