Terminal.Gui
1.0.0.0
Terminal.Gui.Responder
System.Collections.IEnumerable
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.
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.
Views can either be created with an absolute position, by calling the constructor that takes a
Rect parameter to specify the absolute position and size (the Frame of the View) or by setting the
X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative
to the container they are being added to.
When you do not specify a Rect frame you can use the more flexible
Dim and Pos objects that can dynamically update the position of a view.
The X and Y properties are of type
and you can use either absolute positions, percentages or anchor
points. The Width and Height properties are of type
and can use absolute position,
percentages and anchors. These are useful as they will take
care of repositioning your views if your view's frames are resized
or if the terminal size changes.
When you specify the Rect parameter to a view, you are setting the LayoutStyle to Absolute, and the
view will always stay in the position that you placed it. To change the position change the
Frame property to the new position.
Subviews can be added to a View by calling the Add method. The container of a view is the
Superview.
Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view
as requiring to be redrawn.
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.
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.
Using ColorSchemes has the advantage that your application will work both
in color as well as black and white displays.
Views that are focusable should implement the PositionCursor to make sure that
the cursor is placed in a location that makes sense. Unix terminals do not have
a way of hiding the cursor, so it can be distracting to have the cursor left at
the last focused view. So views should make sure that they place the cursor
in a visually sensible place.
The metnod LayoutSubviews is invoked when the size or layout of a view has
changed. The default processing system will keep the size and dimensions
for views that use the LayoutKind.Absolute, and will recompute the
frames for the vies that use LayoutKind.Computed.
Constructor
1.0.0.0
Initializes a new instance of the class and sets the
view up for Computed layout, which will use the values in X, Y, Width and Height to
compute the View's Frame.
To be added.
Constructor
1.0.0.0
The region covered by this view.
Initializes a new instance of the class with the absolute
dimensions specified in the frame. If you want to have Views that can be positioned with
Pos and Dim properties on X, Y, Width and Height, use the empty constructor.
To be added.
Method
1.0.0.0
System.Void
To be added.
Adds a subview to this view.
Method
1.0.0.0
System.Void
System.ParamArray
Array of one or more views (can be optional parameter).
Adds the specified views to the view.
To be added.
Method
1.0.0.0
System.Void
Col.
Row.
Ch.
Displays the specified character in the specified column and row.
To be added.
Property
1.0.0.0
Terminal.Gui.Rect
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.
The bounds.
To be added.
Method
1.0.0.0
System.Void
Flags this view for requiring the children views to be repainted.
To be added.
Method
1.0.0.0
System.Void
Clears the view region with the current color.
This clears the entire region used by this view.
Method
1.0.0.0
System.Void
To be added.
Clears the specfied rectangular region with the current color
To be added.
Method
1.0.0.0
System.Void
Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.
To be added.
Method
1.0.0.0
Terminal.Gui.Rect
Sets the Console driver's clip region to the current View's Bounds.
The existing driver's Clip region, which can be then set by setting the Driver.Clip property.
To be added.
Property
1.0.0.0
Terminal.Gui.ColorScheme
The color scheme for this view, if it is not defined, it returns the parent's
color scheme.
To be added.
To be added.
Method
1.0.0.0
System.Void
Rectangular region for the frame to be drawn.
The padding to add to the drawn frame.
If set to true it fill will the contents.
Draws a frame in the current view, clipped by the boundary of this view
To be added.
Method
1.0.0.0
System.Void
String to display, the underscoore before a letter flags the next letter as the hotkey.
If set to true this uses the focused colors from the color scheme, otherwise the regular ones.
The color scheme to use.
Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.
To be added.
Method
1.0.0.0
System.Void
String to display, the underscoore before a letter flags the next letter as the hotkey.
Hot color.
Normal color.
Utility function to draw strings that contain a hotkey
To be added.
Field
1.0.0.0
Terminal.Gui.ConsoleDriver
Points to the current driver in use by the view, it is a convenience property
for simplifying the development of new views.
To be added.
Method
1.0.0.0
System.Void
Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
To be added.
Property
1.0.0.0
Terminal.Gui.View
Returns the currently focused view inside this view, or null if nothing is focused.
The focused.
To be added.
Method
1.0.0.0
System.Void
Focuses the first focusable subview if one exists.
To be added.
Method
1.0.0.0
System.Void
Focuses the last focusable subview if one exists.
To be added.
Method
1.0.0.0
System.Boolean
Focuses the next view.
true, if next was focused, false otherwise.
To be added.
Method
1.0.0.0
System.Boolean
Focuses the previous view.
true, if previous was focused, false otherwise.
To be added.
Property
1.0.0.0
Terminal.Gui.Rect
Gets or sets the frame for the view.
The frame.
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.
Method
1.0.0.0
System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.Gui.View/<GetEnumerator>d__23))
System.Collections.IEnumerator
Gets an enumerator that enumerates the subviews in this view.
The enumerator.
To be added.
Property
1.0.0.0
System.Boolean
Gets or sets a value indicating whether this has focus.
true if has focus; otherwise, false.
To be added.
Property
1.0.0.0
Terminal.Gui.Dim
Gets or sets the height for the view. This is only used when the LayoutStyle is Computed, if the
LayoutStyle is set to Absolute, this value is ignored.
The height.
To be added.
Property
1.0.0.0
NStack.ustring
Gets or sets an identifier for the view;
The identifier.
To be added.
Property
1.0.0.0
Terminal.Gui.LayoutStyle
Controls how the view's Frame is computed during the LayoutSubviews method, if Absolute, then
LayoutSubviews does not change the Frame properties, otherwise the Frame is updated from the
values in X, Y, Width and Height properties.
The layout style.
To be added.
Method
1.0.0.0
System.Void
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.
To be added.
Property
1.0.0.0
Terminal.Gui.View
Returns the most focused view in the chain of subviews (the leaf view that has the focus).
The most focused.
To be added.
Method
1.0.0.0
System.Void
Col.
Row.
This moves the cursor to the specified column and row in the view.
The move.
To be added.
Method
1.0.0.0
System.Void
Positions the cursor in the right position based on the currently focused view in the chain.
To be added.
Method
1.0.0.0
System.Boolean
Contains the details about the key that produced the event.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
Contains the details about the key that produced the event.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
Contains the details about the key that produced the event.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Void
The region to redraw, this is relative to the view itself.
Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.
Views should set the color that they want to use on entry, as otherwise this will inherit
the last color that was set globaly on the driver.
Method
1.0.0.0
System.Void
To be added.
Removes a widget from this container.
Method
1.0.0.0
System.Void
Removes all the widgets from this container.
Method
1.0.0.0
Terminal.Gui.Point
X screen-coordinate point.
Y screen-coordinate point.
Converts a point from screen coordinates into the view coordinate space.
The mapped point.
To be added.
Method
1.0.0.0
Terminal.Gui.Rect
Rectangle region to clip into, the region is view-relative.
Sets the clipping region to the specified region, the region is view-relative
The previous clip region.
To be added.
Method
1.0.0.0
System.Void
View.
Focuses the specified sub-view.
To be added.
Method
1.0.0.0
System.Void
Invoke to flag that this view needs to be redisplayed, by any code
that alters the state of the view.
To be added.
Method
1.0.0.0
System.Void
The region that must be flagged for repaint.
Flags the specified rectangle region on this view as needing to be repainted.
To be added.
Property
1.0.0.0
System.Collections.Generic.IList<Terminal.Gui.View>
This returns a list of the subviews contained by this view.
The subviews.
To be added.
Property
1.0.0.0
Terminal.Gui.View
Returns the container for this view, or null if this view has not been added to a container.
The super view.
To be added.
Method
1.0.0.0
System.String
Returns a that represents the current .
A that represents the current .
To be added.
Property
1.0.0.0
System.Boolean
Gets or sets a value indicating whether this want mouse position reports.
true if want mouse position reports; otherwise, false.
To be added.
Property
1.0.0.0
Terminal.Gui.Dim
Gets or sets the width for the view. This is only used when the LayoutStyle is Computed, if the
LayoutStyle is set to Absolute, this value is ignored.
The width.
To be added.
Property
1.0.0.0
Terminal.Gui.Pos
Gets or sets the X position for the view (the column). This is only used when the LayoutStyle is Computed, if the
LayoutStyle is set to Absolute, this value is ignored.
The X Position.
To be added.
Property
1.0.0.0
Terminal.Gui.Pos
Gets or sets the Y position for the view (line). This is only used when the LayoutStyle is Computed, if the
LayoutStyle is set to Absolute, this value is ignored.
The y position (line).
To be added.