Class Shortcut

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

Displays a command, help text, and a key binding. When the key specified by Key is pressed, the command will be invoked. Useful for displaying a command in Bar such as a menu, toolbar, or status bar.

public class Shortcut : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IOrientation, IDesignable

Inheritance: object

Responder

View

Shortcut

Implements: IDisposable

ISupportInitializeNotification

ISupportInitialize

IOrientation

IDesignable

Inherited Members: View.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.OnBorderStyleChanging(CancelEventArgs<LineStyle>)

View.SetBorderStyle(LineStyle)

View.BorderStyleChanging

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.SetContentSize(Size?)

View.GetContentSize()

View.ContentSizeTracksViewport

View.OnContentSizeChanged(SizeChangedEventArgs)

View.ContentSizeChanged

View.ContentToScreen(in Point)

View.ScreenToContent(in Point)

View.ViewportSettings

View.Viewport

View.ViewportChanged

View.OnViewportChanged(DrawEventArgs)

View.ViewportToScreen(in Rectangle)

View.ViewportToScreen(in Point)

View.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Accept

View.Data

View.Id

View.ToString()

View.OnAccept()

View.Driver

View.Initialized

View.IsInitialized

View.BeginInit()

View.EndInit()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanged()

View.VisibleChanged

View.Title

View.OnTitleChanged()

View.OnTitleChanging(ref string)

View.TitleChanged

View.TitleChanging

View.CursorVisibility

View.PositionCursor()

View.Diagnostics

View.LineCanvas

View.NeedsDisplay

View.SubViewNeedsDisplay

View.SuperViewRendersLineCanvas

View.AddRune(int, int, Rune)

View.Clear()

View.FillRect(Rectangle, Color?)

View.SetClip()

View.Draw()

View.DrawContent

View.DrawContentComplete

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.GetFocusColor()

View.GetHotFocusColor()

View.GetHotNormalColor()

View.GetNormalColor()

View.Move(int, int)

View.OnDrawAdornments()

View.OnDrawContent(Rectangle)

View.OnDrawContentComplete(Rectangle)

View.OnRenderLineCanvas()

View.SetNeedsDisplay()

View.SetNeedsDisplay(Rectangle)

View.SetSubViewNeedsDisplay()

View.ClearNeedsDisplay()

View.Subviews

View.SuperView

View.IsAdded

View.Add(View)

View.Add(params View[])

View.Added

View.OnAdded(SuperViewChangedEventArgs)

View.OnRemoved(SuperViewChangedEventArgs)

View.Remove(View)

View.RemoveAll()

View.Removed

View.GetTopSuperView(View, View)

View.MoveSubviewTowardsEnd(View)

View.MoveSubviewToEnd(View)

View.MoveSubviewTowardsStart(View)

View.MoveSubviewToStart(View)

View.HotKeyChanged

View.HotKey

View.AddKeyBindingsForHotKey(Key, Key, object)

View.HotKeySpecifier

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnProcessKeyDown(Key)

View.ProcessKeyDown

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.KeyUp

View.KeyBindings

View.OnInvokingKeyBindings(Key, KeyBindingScope)

View.IsHotKeyKeyBound(Key, out View)

View.InvokingKeyBindings

View.InvokeKeyBindings(Key, KeyBindingScope)

View.InvokeCommands(Command[], Key, KeyBinding?)

View.InvokeCommand(Command, Key, KeyBinding?)

View.AddCommand(Command, Func<CommandContext, bool?>)

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.Contains(in Point)

View.Frame

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.Width

View.LayoutComplete

View.LayoutStarted

View.LayoutSubviews()

View.ClearLayoutNeeded()

View.ValidatePosDim

View.OnMouseEnter(CancelEventArgs)

View.MouseEnter

View.OnMouseLeave()

View.MouseLeave

View.MouseEvent

View.NewMouseEvent(MouseEvent)

View.WantContinuousButtonPressed

View.WantMousePositionReports

View.OnMouseEvent(MouseEvent)

View.MouseClick

View.OnMouseClick(MouseEventEventArgs)

View.HighlightStyle

View.Highlight

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.CanFocus

View.CanFocusChanged

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.Focused

View.IsCurrentTop

View.MostFocused

View.OnCanFocusChanged()

View.HasFocus

View.SetFocus()

View.OnHasFocusChanging(bool, bool, View, View)

View.HasFocusChanging

View.HasFocusChanged

View.TabStop

View.OnTextChanged()

View.PreserveTrailingSpaces

View.TextAlignment

View.TextChanged

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

View.UpdateTextFormatterText()

Responder.Dispose()

Responder.Disposing

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

The following user actions will invoke the Accept, causing the Accept event to be fired: - Clicking on the Shortcut. - Pressing the key specified by Key. - Pressing the HotKey specified by CommandView.

If KeyBindingScope is Application, Key will invoked Accept command regardless of what View has focus, enabling an application-wide keyboard shortcut.

By default, a Shortcut displays the command text on the left side, the help text in the middle, and the key binding on the right side. Set AlignmentModes to EndToStart to reverse the order.

The command text can be set by setting the CommandView's Text property or by setting Title.

The help text can be set by setting the HelpText property or by setting Text.

The key text is set by setting the Key property. If the Key is Empty, the Key text is not displayed.

Constructors

Shortcut(): Creates a new instance of Shortcut.

Shortcut(Key, string, Action, string): Creates a new instance of Shortcut.

Properties

Action: Gets or sets the action to be invoked when the shortcut key is pressed or the shortcut is clicked on with the mouse.

AlignmentModes: Gets or sets the AlignmentModes for this Shortcut.

ColorScheme: The color scheme for this view, if it is not defined, it returns the SuperView's color scheme.

CommandView: Gets or sets the View that displays the command text and hotkey.

HelpText: Gets or sets the help text displayed in the middle of the Shortcut.

Key: Gets or sets the Key that will be bound to the Accept command.

KeyBindingScope: Gets or sets the scope for the key binding for how Key is bound to Command.

MinimumKeyTextSize: Gets or sets the minimum size of the key text. Useful for aligning the key text with other Shortcuts.

Orientation: Gets or sets the Orientation for this Bar. The default is Horizontal.

Text: Gets or sets the help text displayed in the middle of the Shortcut. Identical in function to HelpText .

Methods

Dispose(bool): Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

EnableForDesign(): Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

OnAccept(CommandContext)

Called when the Accept command is received. This occurs

if the user clicks anywhere on the shortcut with the mouse
if the user presses Key
if the user presses the HotKey specified by CommandView
if HasFocus and the user presses Space or Enter (or any other key bound to Command.Accept).

OnHasFocusChanged(bool, View, View): Invoked after HasFocus has changed. This method is called before the HasFocusChanged event is raised.

OnHighlight(CancelEventArgs<HighlightStyle>): Called when the view is to be highlighted. The HighlightStyle passed in the event indicates the highlight style that will be applied. The view can modify the highlight style by setting the NewValue property.

OnOrientationChanged(Orientation): Called when Orientation has changed.

Events

OrientationChanged: Raised when Orientation has changed.