123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class Toplevel
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class Toplevel
- ">
- <meta name="generator" content="docfx 2.59.3.0">
-
- <link rel="shortcut icon" href="../../favicon.ico">
- <link rel="stylesheet" href="../../styles/docfx.vendor.css">
- <link rel="stylesheet" href="../../styles/docfx.css">
- <link rel="stylesheet" href="../../styles/main.css">
- <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
- <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
- <meta property="docfx:navrel" content="../../toc.html">
- <meta property="docfx:tocrel" content="toc.html">
-
- <meta property="docfx:rel" content="../../">
-
- </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
- <div id="wrapper">
- <header>
-
- <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
- <div class="container">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a class="navbar-brand" href="../../index.html">
- <img id="logo" class="svg" src="../../images/logo48.png" alt="">
- </a>
- </div>
- <div class="collapse navbar-collapse" id="navbar">
- <form class="navbar-form navbar-right" role="search" id="search">
- <div class="form-group">
- <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
- </div>
- </form>
- </div>
- </div>
- </nav>
-
- <div class="subnav navbar navbar-default">
- <div class="container hide-when-search" id="breadcrumb">
- <ul class="breadcrumb">
- <li></li>
- </ul>
- </div>
- </div>
- </header>
- <div class="container body-content">
-
- <div id="search-results">
- <div class="search-list">Search Results for <span></span></div>
- <div class="sr-items">
- <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
- </div>
- <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
- </div>
- </div>
- <div role="main" class="container body-content hide-when-search">
-
- <div class="sidenav hide-when-search">
- <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
- <div class="sidetoggle collapse" id="sidetoggle">
- <div id="sidetoc"></div>
- </div>
- </div>
- <div class="article row grid-right">
- <div class="col-md-10">
- <article class="content wrap" id="_content" data-uid="Terminal.Gui.Toplevel">
-
-
- <h1 id="Terminal_Gui_Toplevel" data-uid="Terminal.Gui.Toplevel" class="text-break">Class Toplevel
- </h1>
- <div class="markdown level0 summary">
- Toplevel views can be modally executed. They are used for both an application's main view (filling the entire screeN and
- for pop-up views such as <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>, <a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a>, and <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a>.
- </div>
- <div class="markdown level0 conceptual"></div>
- <div class="inheritance">
- <h5>Inheritance</h5>
- <div class="level0"><span class="xref">System.Object</span></div>
- <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
- <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
- <div class="level3"><span class="xref">Toplevel</span></div>
- <div class="level4"><a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html">Border.ToplevelContainer</a></div>
- <div class="level4"><a class="xref" href="Terminal.Gui.Window.html">Window</a></div>
- </div>
- <div class="implements">
- <h5>Implements</h5>
- <div><span class="xref">System.IDisposable</span></div>
- <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
- <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
- </div>
- <h5 id="Terminal_Gui_Toplevel_remarks"><strong>Remarks</strong></h5>
- <div class="markdown level0 remarks">
- <p>
- Toplevels can be modally executing views, started by calling <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_Terminal_Gui_Toplevel_System_Func_System_Exception_System_Boolean__">Run(Toplevel, Func<Exception, Boolean>)</a>.
- They return control to the caller when <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> has
- been called (which sets the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Running">Running</a> property to <code>false</code>).
- </p>
- <p>
- A Toplevel is created when an application initializes Terminal.Gui by calling <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Init_Terminal_Gui_ConsoleDriver_Terminal_Gui_IMainLoopDriver_">Init(ConsoleDriver, IMainLoopDriver)</a>.
- The application Toplevel can be accessed via <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Top">Top</a>. Additional Toplevels can be created
- and run (e.g. <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>s. To run a Toplevel, create the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> and
- call <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_Terminal_Gui_Toplevel_System_Func_System_Exception_System_Boolean__">Run(Toplevel, Func<Exception, Boolean>)</a>.
- </p>
- <p>
- Toplevels can also opt-in to more sophisticated initialization
- by implementing <span class="xref">System.ComponentModel.ISupportInitialize</span>. When they do
- so, the <span class="xref">System.ComponentModel.ISupportInitialize.BeginInit</span> and
- <span class="xref">System.ComponentModel.ISupportInitialize.EndInit</span> methods will be called
- before running the view.
- If first-run-only initialization is preferred, the <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
- can be implemented too, in which case the <span class="xref">System.ComponentModel.ISupportInitialize</span>
- methods will only be called if <span class="xref">System.ComponentModel.ISupportInitializeNotification.IsInitialized</span>
- is <span class="xref">false</span>. This allows proper <a class="xref" href="Terminal.Gui.View.html">View</a> inheritance hierarchies
- to override base class layout code optimally by doing so only on first run,
- instead of on every run.
- </p>
- </div>
- <div class="inheritedMembers">
- <h5>Inherited Members</h5>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, Int32, Boolean)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(ustring, Attribute, Attribute)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, Boolean, ColorScheme)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func<Nullable<Boolean>>)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
- </div>
- <div>
- <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
- </div>
- </div>
- <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
- <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
- <h5 id="Terminal_Gui_Toplevel_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public class Toplevel : View</code></pre>
- </div>
- <h3 id="constructors">Constructors
- </h3>
- <a id="Terminal_Gui_Toplevel__ctor_" data-uid="Terminal.Gui.Toplevel.#ctor*"></a>
- <h4 id="Terminal_Gui_Toplevel__ctor" data-uid="Terminal.Gui.Toplevel.#ctor">Toplevel()</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> class with <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout,
- defaulting to full screen.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Toplevel()</code></pre>
- </div>
- <a id="Terminal_Gui_Toplevel__ctor_" data-uid="Terminal.Gui.Toplevel.#ctor*"></a>
- <h4 id="Terminal_Gui_Toplevel__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Toplevel.#ctor(Terminal.Gui.Rect)">Toplevel(Rect)</h4>
- <div class="markdown level1 summary">
- Initializes a new instance of the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> class with the specified <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public Toplevel(Rect frame)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">frame</span></td>
- <td>A superview-relative rectangle specifying the location and size for the new Toplevel</td>
- </tr>
- </tbody>
- </table>
- <h3 id="properties">Properties
- </h3>
- <a id="Terminal_Gui_Toplevel_CanFocus_" data-uid="Terminal.Gui.Toplevel.CanFocus*"></a>
- <h4 id="Terminal_Gui_Toplevel_CanFocus" data-uid="Terminal.Gui.Toplevel.CanFocus">CanFocus</h4>
- <div class="markdown level1 summary">
- Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> can focus.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool CanFocus { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a></div>
- <a id="Terminal_Gui_Toplevel_IsMdiChild_" data-uid="Terminal.Gui.Toplevel.IsMdiChild*"></a>
- <h4 id="Terminal_Gui_Toplevel_IsMdiChild" data-uid="Terminal.Gui.Toplevel.IsMdiChild">IsMdiChild</h4>
- <div class="markdown level1 summary">
- Gets or sets if this Toplevel is a Mdi child.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool IsMdiChild { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_IsMdiContainer_" data-uid="Terminal.Gui.Toplevel.IsMdiContainer*"></a>
- <h4 id="Terminal_Gui_Toplevel_IsMdiContainer" data-uid="Terminal.Gui.Toplevel.IsMdiContainer">IsMdiContainer</h4>
- <div class="markdown level1 summary">
- Gets or sets if this Toplevel is a Mdi container.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool IsMdiContainer { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_MenuBar_" data-uid="Terminal.Gui.Toplevel.MenuBar*"></a>
- <h4 id="Terminal_Gui_Toplevel_MenuBar" data-uid="Terminal.Gui.Toplevel.MenuBar">MenuBar</h4>
- <div class="markdown level1 summary">
- Gets or sets the menu for this Toplevel.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual MenuBar MenuBar { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_Modal_" data-uid="Terminal.Gui.Toplevel.Modal*"></a>
- <h4 id="Terminal_Gui_Toplevel_Modal" data-uid="Terminal.Gui.Toplevel.Modal">Modal</h4>
- <div class="markdown level1 summary">
- Determines whether the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> is modal or not.
- If set to <code>false</code> (the default):
- <ul><li><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a> events will propagate keys upwards.</li><li>The Toplevel will act as an embedded view (not a modal/pop-up).</li></ul>
- If set to <code>true</code>:
- <ul><li><a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_">ProcessKey(KeyEvent)</a> events will NOT propogate keys upwards.</li><li>The Toplevel will and look like a modal (pop-up) (e.g. see <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>.</li></ul>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool Modal { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_Running_" data-uid="Terminal.Gui.Toplevel.Running*"></a>
- <h4 id="Terminal_Gui_Toplevel_Running" data-uid="Terminal.Gui.Toplevel.Running">Running</h4>
- <div class="markdown level1 summary">
- Gets or sets whether the <a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a> for this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> is running or not.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public bool Running { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_StatusBar_" data-uid="Terminal.Gui.Toplevel.StatusBar*"></a>
- <h4 id="Terminal_Gui_Toplevel_StatusBar" data-uid="Terminal.Gui.Toplevel.StatusBar">StatusBar</h4>
- <div class="markdown level1 summary">
- Gets or sets the status bar for this Toplevel.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual StatusBar StatusBar { get; set; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h3 id="methods">Methods
- </h3>
- <a id="Terminal_Gui_Toplevel_Add_" data-uid="Terminal.Gui.Toplevel.Add*"></a>
- <h4 id="Terminal_Gui_Toplevel_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.Toplevel.Add(Terminal.Gui.View)">Add(View)</h4>
- <div class="markdown level1 summary">
- Adds a subview (child) to this view.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override void Add(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a></div>
- <a id="Terminal_Gui_Toplevel_Create_" data-uid="Terminal.Gui.Toplevel.Create*"></a>
- <h4 id="Terminal_Gui_Toplevel_Create" data-uid="Terminal.Gui.Toplevel.Create">Create()</h4>
- <div class="markdown level1 summary">
- Convenience factory method that creates a new Toplevel with the current terminal dimensions.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public static Toplevel Create()</code></pre>
- </div>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
- <td>The created Toplevel.</td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_GetTopMdiChild_" data-uid="Terminal.Gui.Toplevel.GetTopMdiChild*"></a>
- <h4 id="Terminal_Gui_Toplevel_GetTopMdiChild_System_Type_System_String___" data-uid="Terminal.Gui.Toplevel.GetTopMdiChild(System.Type,System.String[])">GetTopMdiChild(Type, String[])</h4>
- <div class="markdown level1 summary">
- Gets the current visible Toplevel Mdi child that matches the arguments pattern.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public View GetTopMdiChild(Type type = null, string[] exclude = null)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Type</span></td>
- <td><span class="parametername">type</span></td>
- <td>The type.</td>
- </tr>
- <tr>
- <td><span class="xref">System.String</span>[]</td>
- <td><span class="parametername">exclude</span></td>
- <td>The strings to exclude.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td>The matched view.</td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_MouseEvent_" data-uid="Terminal.Gui.Toplevel.MouseEvent*"></a>
- <h4 id="Terminal_Gui_Toplevel_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.Toplevel.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
- <div class="markdown level1 summary">
- Method invoked when a mouse event is generated
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent mouseEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
- <td><span class="parametername">mouseEvent</span></td>
- <td>Contains the details about the mouse event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
- <a id="Terminal_Gui_Toplevel_MoveNext_" data-uid="Terminal.Gui.Toplevel.MoveNext*"></a>
- <h4 id="Terminal_Gui_Toplevel_MoveNext" data-uid="Terminal.Gui.Toplevel.MoveNext">MoveNext()</h4>
- <div class="markdown level1 summary">
- Move to the next Mdi child from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiTop">MdiTop</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void MoveNext()</code></pre>
- </div>
- <a id="Terminal_Gui_Toplevel_MovePrevious_" data-uid="Terminal.Gui.Toplevel.MovePrevious*"></a>
- <h4 id="Terminal_Gui_Toplevel_MovePrevious" data-uid="Terminal.Gui.Toplevel.MovePrevious">MovePrevious()</h4>
- <div class="markdown level1 summary">
- Move to the previous Mdi child from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiTop">MdiTop</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void MovePrevious()</code></pre>
- </div>
- <a id="Terminal_Gui_Toplevel_OnAlternateBackwardKeyChanged_" data-uid="Terminal.Gui.Toplevel.OnAlternateBackwardKeyChanged*"></a>
- <h4 id="Terminal_Gui_Toplevel_OnAlternateBackwardKeyChanged_Terminal_Gui_Key_" data-uid="Terminal.Gui.Toplevel.OnAlternateBackwardKeyChanged(Terminal.Gui.Key)">OnAlternateBackwardKeyChanged(Key)</h4>
- <div class="markdown level1 summary">
- Virtual method to invoke the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AlternateBackwardKeyChanged">AlternateBackwardKeyChanged</a> event.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnAlternateBackwardKeyChanged(Key oldKey)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td><span class="parametername">oldKey</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_OnAlternateForwardKeyChanged_" data-uid="Terminal.Gui.Toplevel.OnAlternateForwardKeyChanged*"></a>
- <h4 id="Terminal_Gui_Toplevel_OnAlternateForwardKeyChanged_Terminal_Gui_Key_" data-uid="Terminal.Gui.Toplevel.OnAlternateForwardKeyChanged(Terminal.Gui.Key)">OnAlternateForwardKeyChanged(Key)</h4>
- <div class="markdown level1 summary">
- Virtual method to invoke the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_AlternateForwardKeyChanged">AlternateForwardKeyChanged</a> event.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnAlternateForwardKeyChanged(Key oldKey)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td><span class="parametername">oldKey</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_OnKeyDown_" data-uid="Terminal.Gui.Toplevel.OnKeyDown*"></a>
- <h4 id="Terminal_Gui_Toplevel_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
- <div class="markdown level1 summary">
- Method invoked when a key is pressed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnKeyDown(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td>true if the event was handled</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a></div>
- <a id="Terminal_Gui_Toplevel_OnKeyUp_" data-uid="Terminal.Gui.Toplevel.OnKeyUp*"></a>
- <h4 id="Terminal_Gui_Toplevel_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
- <div class="markdown level1 summary">
- Method invoked when a key is released.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool OnKeyUp(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td>true if the event was handled</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a></div>
- <a id="Terminal_Gui_Toplevel_OnLoaded_" data-uid="Terminal.Gui.Toplevel.OnLoaded*"></a>
- <h4 id="Terminal_Gui_Toplevel_OnLoaded" data-uid="Terminal.Gui.Toplevel.OnLoaded">OnLoaded()</h4>
- <div class="markdown level1 summary">
- Called from <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel_">Begin(Toplevel)</a> before the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> redraws for the first time.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnLoaded()</code></pre>
- </div>
- <a id="Terminal_Gui_Toplevel_OnQuitKeyChanged_" data-uid="Terminal.Gui.Toplevel.OnQuitKeyChanged*"></a>
- <h4 id="Terminal_Gui_Toplevel_OnQuitKeyChanged_Terminal_Gui_Key_" data-uid="Terminal.Gui.Toplevel.OnQuitKeyChanged(Terminal.Gui.Key)">OnQuitKeyChanged(Key)</h4>
- <div class="markdown level1 summary">
- Virtual method to invoke the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_QuitKeyChanged">QuitKeyChanged</a> event.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void OnQuitKeyChanged(Key oldKey)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Key.html">Key</a></td>
- <td><span class="parametername">oldKey</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_PositionCursor_" data-uid="Terminal.Gui.Toplevel.PositionCursor*"></a>
- <h4 id="Terminal_Gui_Toplevel_PositionCursor" data-uid="Terminal.Gui.Toplevel.PositionCursor">PositionCursor()</h4>
- <div class="markdown level1 summary">
- Positions the cursor in the right position based on the currently focused view in the chain.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
- </div>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
- <a id="Terminal_Gui_Toplevel_PositionToplevel_" data-uid="Terminal.Gui.Toplevel.PositionToplevel*"></a>
- <h4 id="Terminal_Gui_Toplevel_PositionToplevel_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Toplevel.PositionToplevel(Terminal.Gui.Toplevel)">PositionToplevel(Toplevel)</h4>
- <div class="markdown level1 summary">
- Virtual method enabling implementation of specific positions for inherited <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> views.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void PositionToplevel(Toplevel top)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
- <td><span class="parametername">top</span></td>
- <td>The toplevel.</td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_ProcessColdKey_" data-uid="Terminal.Gui.Toplevel.ProcessColdKey*"></a>
- <h4 id="Terminal_Gui_Toplevel_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
- <div class="markdown level1 summary">
- This method can be overwritten by views that
- want to provide accelerator functionality
- (Alt-key for example), but without
- interefering with normal ProcessKey behavior.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
- <a id="Terminal_Gui_Toplevel_ProcessKey_" data-uid="Terminal.Gui.Toplevel.ProcessKey*"></a>
- <h4 id="Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
- <div class="markdown level1 summary">
- If the view is focused, gives the view a
- chance to process the keystroke.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent keyEvent)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
- <td><span class="parametername">keyEvent</span></td>
- <td>Contains the details about the key that produced the event.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
- <a id="Terminal_Gui_Toplevel_Redraw_" data-uid="Terminal.Gui.Toplevel.Redraw*"></a>
- <h4 id="Terminal_Gui_Toplevel_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Toplevel.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
- <div class="markdown level1 summary">
- Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
- <td><span class="parametername">bounds</span></td>
- <td>The bounds (view-relative region) to redraw.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
- <a id="Terminal_Gui_Toplevel_Remove_" data-uid="Terminal.Gui.Toplevel.Remove*"></a>
- <h4 id="Terminal_Gui_Toplevel_Remove_Terminal_Gui_View_" data-uid="Terminal.Gui.Toplevel.Remove(Terminal.Gui.View)">Remove(View)</h4>
- <div class="markdown level1 summary">
- Removes a subview added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override void Remove(View view)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
- <td><span class="parametername">view</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a></div>
- <a id="Terminal_Gui_Toplevel_RemoveAll_" data-uid="Terminal.Gui.Toplevel.RemoveAll*"></a>
- <h4 id="Terminal_Gui_Toplevel_RemoveAll" data-uid="Terminal.Gui.Toplevel.RemoveAll">RemoveAll()</h4>
- <div class="markdown level1 summary">
- Removes all subviews (children) added via <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">Add(View)</a> or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">Add(View[])</a> from this View.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public override void RemoveAll()</code></pre>
- </div>
- <h5 class="overrides">Overrides</h5>
- <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a></div>
- <a id="Terminal_Gui_Toplevel_RequestStop_" data-uid="Terminal.Gui.Toplevel.RequestStop*"></a>
- <h4 id="Terminal_Gui_Toplevel_RequestStop" data-uid="Terminal.Gui.Toplevel.RequestStop">RequestStop()</h4>
- <div class="markdown level1 summary">
- Stops and closes this <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>. If this Toplevel is the top-most Toplevel,
- <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> will be called, causing the application to exit.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void RequestStop()</code></pre>
- </div>
- <a id="Terminal_Gui_Toplevel_RequestStop_" data-uid="Terminal.Gui.Toplevel.RequestStop*"></a>
- <h4 id="Terminal_Gui_Toplevel_RequestStop_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Toplevel.RequestStop(Terminal.Gui.Toplevel)">RequestStop(Toplevel)</h4>
- <div class="markdown level1 summary">
- Stops and closes the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> specified by <code data-dev-comment-type="paramref" class="paramref">top</code>. If <code data-dev-comment-type="paramref" class="paramref">top</code> is the top-most Toplevel,
- <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a> will be called, causing the application to exit.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void RequestStop(Toplevel top)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
- <td><span class="parametername">top</span></td>
- <td>The toplevel to request stop.</td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_ShowChild_" data-uid="Terminal.Gui.Toplevel.ShowChild*"></a>
- <h4 id="Terminal_Gui_Toplevel_ShowChild_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Toplevel.ShowChild(Terminal.Gui.Toplevel)">ShowChild(Toplevel)</h4>
- <div class="markdown level1 summary">
- Shows the Mdi child indicated by <code data-dev-comment-type="paramref" class="paramref">top</code>, setting it as <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Current">Current</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual bool ShowChild(Toplevel top = null)</code></pre>
- </div>
- <h5 class="parameters">Parameters</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Name</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
- <td><span class="parametername">top</span></td>
- <td>The Toplevel.</td>
- </tr>
- </tbody>
- </table>
- <h5 class="returns">Returns</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Boolean</span></td>
- <td><code>true</code> if the toplevel can be shown or <code>false</code> if not.</td>
- </tr>
- </tbody>
- </table>
- <a id="Terminal_Gui_Toplevel_WillPresent_" data-uid="Terminal.Gui.Toplevel.WillPresent*"></a>
- <h4 id="Terminal_Gui_Toplevel_WillPresent" data-uid="Terminal.Gui.Toplevel.WillPresent">WillPresent()</h4>
- <div class="markdown level1 summary">
- Invoked by <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel_">Begin(Toplevel)</a> as part of <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_Terminal_Gui_Toplevel_System_Func_System_Exception_System_Boolean__">Run(Toplevel, Func<Exception, Boolean>)</a>
- after the views have been laid out, and before the views are drawn for the first time.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public virtual void WillPresent()</code></pre>
- </div>
- <h3 id="events">Events
- </h3>
- <h4 id="Terminal_Gui_Toplevel_Activate" data-uid="Terminal.Gui.Toplevel.Activate">Activate</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> becomes the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Current">Current</a> Toplevel.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Toplevel> Activate</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_AllChildClosed" data-uid="Terminal.Gui.Toplevel.AllChildClosed">AllChildClosed</h4>
- <div class="markdown level1 summary">
- Invoked when the last child of the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is closed from
- by <span class="xref">Terminal.Gui.Application.End(Terminal.Gui.View)</span>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action AllChildClosed</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_AlternateBackwardKeyChanged" data-uid="Terminal.Gui.Toplevel.AlternateBackwardKeyChanged">AlternateBackwardKeyChanged</h4>
- <div class="markdown level1 summary">
- Invoked when the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_AlternateBackwardKey">AlternateBackwardKey</a> is changed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Key> AlternateBackwardKeyChanged</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Key.html">Key</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_AlternateForwardKeyChanged" data-uid="Terminal.Gui.Toplevel.AlternateForwardKeyChanged">AlternateForwardKeyChanged</h4>
- <div class="markdown level1 summary">
- Invoked when the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_AlternateForwardKey">AlternateForwardKey</a> is changed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Key> AlternateForwardKeyChanged</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Key.html">Key</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_ChildClosed" data-uid="Terminal.Gui.Toplevel.ChildClosed">ChildClosed</h4>
- <div class="markdown level1 summary">
- Invoked when a child of the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is closed by
- <span class="xref">Terminal.Gui.Application.End(Terminal.Gui.View)</span>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Toplevel> ChildClosed</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_ChildLoaded" data-uid="Terminal.Gui.Toplevel.ChildLoaded">ChildLoaded</h4>
- <div class="markdown level1 summary">
- Invoked when a child Toplevel's <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has been loaded.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Toplevel> ChildLoaded</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_ChildUnloaded" data-uid="Terminal.Gui.Toplevel.ChildUnloaded">ChildUnloaded</h4>
- <div class="markdown level1 summary">
- Invoked when a cjhild Toplevel's <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has been unloaded.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Toplevel> ChildUnloaded</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Closed" data-uid="Terminal.Gui.Toplevel.Closed">Closed</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel's <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is closed by <span class="xref">Terminal.Gui.Application.End(Terminal.Gui.View)</span>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Toplevel> Closed</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Closing" data-uid="Terminal.Gui.Toplevel.Closing">Closing</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel's <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> is being closed by
- <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RequestStop_Terminal_Gui_Toplevel_">RequestStop(Toplevel)</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<ToplevelClosingEventArgs> Closing</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.ToplevelClosingEventArgs.html">ToplevelClosingEventArgs</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Deactivate" data-uid="Terminal.Gui.Toplevel.Deactivate">Deactivate</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel<a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> ceases to be the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Current">Current</a> Toplevel.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Toplevel> Deactivate</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Loaded" data-uid="Terminal.Gui.Toplevel.Loaded">Loaded</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has begin loaded.
- A Loaded event handler is a good place to finalize initialization before calling
- <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RunLoop_Terminal_Gui_Application_RunState_System_Boolean_">RunLoop(Application.RunState, Boolean)</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action Loaded</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_QuitKeyChanged" data-uid="Terminal.Gui.Toplevel.QuitKeyChanged">QuitKeyChanged</h4>
- <div class="markdown level1 summary">
- Invoked when the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_QuitKey">QuitKey</a> is changed.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Key> QuitKeyChanged</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Key.html">Key</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Ready" data-uid="Terminal.Gui.Toplevel.Ready">Ready</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel <a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a> has started it's first iteration.
- Subscribe to this event to perform tasks when the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> has been laid out and focus has been set.
- changes.
- <p>A Ready event handler is a good place to finalize initialization after calling
- <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Run_System_Func_System_Exception_System_Boolean__">Run(Func<Exception, Boolean>)</a> on this Toplevel.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action Ready</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Resized" data-uid="Terminal.Gui.Toplevel.Resized">Resized</h4>
- <div class="markdown level1 summary">
- Invoked when the terminal has been resized. The new <a class="xref" href="Terminal.Gui.Size.html">Size</a> of the terminal is provided.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action<Size> Resized</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span><<a class="xref" href="Terminal.Gui.Size.html">Size</a>></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h4 id="Terminal_Gui_Toplevel_Unloaded" data-uid="Terminal.Gui.Toplevel.Unloaded">Unloaded</h4>
- <div class="markdown level1 summary">
- Invoked when the Toplevel <a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a> has been unloaded.
- A Unloaded event handler is a good place to dispose objects after calling <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_End_Terminal_Gui_Application_RunState_">End(Application.RunState)</a>.
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public event Action Unloaded</code></pre>
- </div>
- <h5 class="eventType">Event Type</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><span class="xref">System.Action</span></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h3 id="implements">Implements</h3>
- <div>
- <span class="xref">System.IDisposable</span>
- </div>
- <div>
- <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
- </div>
- <div>
- <span class="xref">System.ComponentModel.ISupportInitialize</span>
- </div>
- </article>
- </div>
-
- <div class="hidden-sm col-md-2" role="complementary">
- <div class="sideaffix">
- <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
- <h5>In This Article</h5>
- <div></div>
- </nav>
- </div>
- </div>
- </div>
- </div>
-
- <footer>
- <div class="grad-bottom"></div>
- <div class="footer">
- <div class="container">
- <span class="pull-right">
- <a href="#top">Back to top</a>
- </span>
-
- <span>Generated by <strong>DocFX</strong></span>
- </div>
- </div>
- </footer>
- </div>
-
- <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
- <script type="text/javascript" src="../../styles/docfx.js"></script>
- <script type="text/javascript" src="../../styles/main.js"></script>
- </body>
- </html>
|