Terminal.Gui.MenuBar.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class MenuBar
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MenuBar
  11. ">
  12. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.MenuBar">
  73. <h1 id="Terminal_Gui_MenuBar" data-uid="Terminal.Gui.MenuBar" class="text-break">Class MenuBar
  74. </h1>
  75. <div class="markdown level0 summary">
  76. The MenuBar provides a menu for Terminal.Gui applications.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><span class="xref">MenuBar</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.Collections.IEnumerable</span></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  199. </div>
  200. <div>
  201. <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>
  202. </div>
  203. <div>
  204. <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>
  205. </div>
  206. <div>
  207. <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>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  292. </div>
  293. <div>
  294. <span class="xref">System.Object.Equals(System.Object)</span>
  295. </div>
  296. <div>
  297. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  298. </div>
  299. <div>
  300. <span class="xref">System.Object.GetHashCode()</span>
  301. </div>
  302. <div>
  303. <span class="xref">System.Object.GetType()</span>
  304. </div>
  305. <div>
  306. <span class="xref">System.Object.MemberwiseClone()</span>
  307. </div>
  308. <div>
  309. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  310. </div>
  311. </div>
  312. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  313. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  314. <h5 id="Terminal_Gui_MenuBar_syntax">Syntax</h5>
  315. <div class="codewrapper">
  316. <pre><code class="lang-csharp hljs">public class MenuBar : View, IEnumerable</code></pre>
  317. </div>
  318. <h5 id="Terminal_Gui_MenuBar_remarks"><strong>Remarks</strong></h5>
  319. <div class="markdown level0 remarks">
  320. <p>
  321. The <a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a> appears on the first row of the terminal.
  322. </p>
  323. <p>
  324. The <a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a> provides global hotkeys for the application.
  325. </p>
  326. </div>
  327. <h3 id="constructors">Constructors
  328. </h3>
  329. <a id="Terminal_Gui_MenuBar__ctor_" data-uid="Terminal.Gui.MenuBar.#ctor*"></a>
  330. <h4 id="Terminal_Gui_MenuBar__ctor_Terminal_Gui_MenuBarItem___" data-uid="Terminal.Gui.MenuBar.#ctor(Terminal.Gui.MenuBarItem[])">MenuBar(MenuBarItem[])</h4>
  331. <div class="markdown level1 summary">
  332. Initializes a new instance of the <a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a> class with the specified set of toplevel menu items.
  333. </div>
  334. <div class="markdown level1 conceptual"></div>
  335. <h5 class="decalaration">Declaration</h5>
  336. <div class="codewrapper">
  337. <pre><code class="lang-csharp hljs">public MenuBar(MenuBarItem[] menus)</code></pre>
  338. </div>
  339. <h5 class="parameters">Parameters</h5>
  340. <table class="table table-bordered table-striped table-condensed">
  341. <thead>
  342. <tr>
  343. <th>Type</th>
  344. <th>Name</th>
  345. <th>Description</th>
  346. </tr>
  347. </thead>
  348. <tbody>
  349. <tr>
  350. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>[]</td>
  351. <td><span class="parametername">menus</span></td>
  352. <td>Individual menu items; a null item will result in a separator being drawn.</td>
  353. </tr>
  354. </tbody>
  355. </table>
  356. <h3 id="properties">Properties
  357. </h3>
  358. <a id="Terminal_Gui_MenuBar_IsMenuOpen_" data-uid="Terminal.Gui.MenuBar.IsMenuOpen*"></a>
  359. <h4 id="Terminal_Gui_MenuBar_IsMenuOpen" data-uid="Terminal.Gui.MenuBar.IsMenuOpen">IsMenuOpen</h4>
  360. <div class="markdown level1 summary">
  361. True if the menu is open; otherwise false.
  362. </div>
  363. <div class="markdown level1 conceptual"></div>
  364. <h5 class="decalaration">Declaration</h5>
  365. <div class="codewrapper">
  366. <pre><code class="lang-csharp hljs">public bool IsMenuOpen { get; protected set; }</code></pre>
  367. </div>
  368. <h5 class="propertyValue">Property Value</h5>
  369. <table class="table table-bordered table-striped table-condensed">
  370. <thead>
  371. <tr>
  372. <th>Type</th>
  373. <th>Description</th>
  374. </tr>
  375. </thead>
  376. <tbody>
  377. <tr>
  378. <td><span class="xref">System.Boolean</span></td>
  379. <td></td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <a id="Terminal_Gui_MenuBar_LastFocused_" data-uid="Terminal.Gui.MenuBar.LastFocused*"></a>
  384. <h4 id="Terminal_Gui_MenuBar_LastFocused" data-uid="Terminal.Gui.MenuBar.LastFocused">LastFocused</h4>
  385. <div class="markdown level1 summary">
  386. Get the lasted focused view before open the menu.
  387. </div>
  388. <div class="markdown level1 conceptual"></div>
  389. <h5 class="decalaration">Declaration</h5>
  390. <div class="codewrapper">
  391. <pre><code class="lang-csharp hljs">public View LastFocused { get; }</code></pre>
  392. </div>
  393. <h5 class="propertyValue">Property Value</h5>
  394. <table class="table table-bordered table-striped table-condensed">
  395. <thead>
  396. <tr>
  397. <th>Type</th>
  398. <th>Description</th>
  399. </tr>
  400. </thead>
  401. <tbody>
  402. <tr>
  403. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  404. <td></td>
  405. </tr>
  406. </tbody>
  407. </table>
  408. <a id="Terminal_Gui_MenuBar_Menus_" data-uid="Terminal.Gui.MenuBar.Menus*"></a>
  409. <h4 id="Terminal_Gui_MenuBar_Menus" data-uid="Terminal.Gui.MenuBar.Menus">Menus</h4>
  410. <div class="markdown level1 summary">
  411. Gets or sets the array of <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>s for the menu. Only set this when the <a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a> is vislble.
  412. </div>
  413. <div class="markdown level1 conceptual"></div>
  414. <h5 class="decalaration">Declaration</h5>
  415. <div class="codewrapper">
  416. <pre><code class="lang-csharp hljs">public MenuBarItem[] Menus { get; set; }</code></pre>
  417. </div>
  418. <h5 class="propertyValue">Property Value</h5>
  419. <table class="table table-bordered table-striped table-condensed">
  420. <thead>
  421. <tr>
  422. <th>Type</th>
  423. <th>Description</th>
  424. </tr>
  425. </thead>
  426. <tbody>
  427. <tr>
  428. <td><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>[]</td>
  429. <td>The menu array.</td>
  430. </tr>
  431. </tbody>
  432. </table>
  433. <a id="Terminal_Gui_MenuBar_UseKeysUpDownAsKeysLeftRight_" data-uid="Terminal.Gui.MenuBar.UseKeysUpDownAsKeysLeftRight*"></a>
  434. <h4 id="Terminal_Gui_MenuBar_UseKeysUpDownAsKeysLeftRight" data-uid="Terminal.Gui.MenuBar.UseKeysUpDownAsKeysLeftRight">UseKeysUpDownAsKeysLeftRight</h4>
  435. <div class="markdown level1 summary">
  436. Used for change the navigation key style.
  437. </div>
  438. <div class="markdown level1 conceptual"></div>
  439. <h5 class="decalaration">Declaration</h5>
  440. <div class="codewrapper">
  441. <pre><code class="lang-csharp hljs">public bool UseKeysUpDownAsKeysLeftRight { get; set; }</code></pre>
  442. </div>
  443. <h5 class="propertyValue">Property Value</h5>
  444. <table class="table table-bordered table-striped table-condensed">
  445. <thead>
  446. <tr>
  447. <th>Type</th>
  448. <th>Description</th>
  449. </tr>
  450. </thead>
  451. <tbody>
  452. <tr>
  453. <td><span class="xref">System.Boolean</span></td>
  454. <td></td>
  455. </tr>
  456. </tbody>
  457. </table>
  458. <h3 id="methods">Methods
  459. </h3>
  460. <a id="Terminal_Gui_MenuBar_CloseMenu_" data-uid="Terminal.Gui.MenuBar.CloseMenu*"></a>
  461. <h4 id="Terminal_Gui_MenuBar_CloseMenu" data-uid="Terminal.Gui.MenuBar.CloseMenu">CloseMenu()</h4>
  462. <div class="markdown level1 summary">
  463. Closes the current Menu programatically, if open.
  464. </div>
  465. <div class="markdown level1 conceptual"></div>
  466. <h5 class="decalaration">Declaration</h5>
  467. <div class="codewrapper">
  468. <pre><code class="lang-csharp hljs">public void CloseMenu()</code></pre>
  469. </div>
  470. <a id="Terminal_Gui_MenuBar_MouseEvent_" data-uid="Terminal.Gui.MenuBar.MouseEvent*"></a>
  471. <h4 id="Terminal_Gui_MenuBar_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.MenuBar.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  472. <div class="markdown level1 summary">
  473. Method invoked when a mouse event is generated
  474. </div>
  475. <div class="markdown level1 conceptual"></div>
  476. <h5 class="decalaration">Declaration</h5>
  477. <div class="codewrapper">
  478. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  479. </div>
  480. <h5 class="parameters">Parameters</h5>
  481. <table class="table table-bordered table-striped table-condensed">
  482. <thead>
  483. <tr>
  484. <th>Type</th>
  485. <th>Name</th>
  486. <th>Description</th>
  487. </tr>
  488. </thead>
  489. <tbody>
  490. <tr>
  491. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  492. <td><span class="parametername">me</span></td>
  493. <td></td>
  494. </tr>
  495. </tbody>
  496. </table>
  497. <h5 class="returns">Returns</h5>
  498. <table class="table table-bordered table-striped table-condensed">
  499. <thead>
  500. <tr>
  501. <th>Type</th>
  502. <th>Description</th>
  503. </tr>
  504. </thead>
  505. <tbody>
  506. <tr>
  507. <td><span class="xref">System.Boolean</span></td>
  508. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  509. </tr>
  510. </tbody>
  511. </table>
  512. <h5 class="overrides">Overrides</h5>
  513. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  514. <a id="Terminal_Gui_MenuBar_OnKeyDown_" data-uid="Terminal.Gui.MenuBar.OnKeyDown*"></a>
  515. <h4 id="Terminal_Gui_MenuBar_OnKeyDown_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.MenuBar.OnKeyDown(Terminal.Gui.KeyEvent)">OnKeyDown(KeyEvent)</h4>
  516. <div class="markdown level1 summary"></div>
  517. <div class="markdown level1 conceptual"></div>
  518. <h5 class="decalaration">Declaration</h5>
  519. <div class="codewrapper">
  520. <pre><code class="lang-csharp hljs">public override bool OnKeyDown(KeyEvent keyEvent)</code></pre>
  521. </div>
  522. <h5 class="parameters">Parameters</h5>
  523. <table class="table table-bordered table-striped table-condensed">
  524. <thead>
  525. <tr>
  526. <th>Type</th>
  527. <th>Name</th>
  528. <th>Description</th>
  529. </tr>
  530. </thead>
  531. <tbody>
  532. <tr>
  533. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  534. <td><span class="parametername">keyEvent</span></td>
  535. <td>Contains the details about the key that produced the event.</td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. <h5 class="returns">Returns</h5>
  540. <table class="table table-bordered table-striped table-condensed">
  541. <thead>
  542. <tr>
  543. <th>Type</th>
  544. <th>Description</th>
  545. </tr>
  546. </thead>
  547. <tbody>
  548. <tr>
  549. <td><span class="xref">System.Boolean</span></td>
  550. <td></td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. <h5 class="overrides">Overrides</h5>
  555. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a></div>
  556. <a id="Terminal_Gui_MenuBar_OnKeyUp_" data-uid="Terminal.Gui.MenuBar.OnKeyUp*"></a>
  557. <h4 id="Terminal_Gui_MenuBar_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.MenuBar.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
  558. <div class="markdown level1 summary"></div>
  559. <div class="markdown level1 conceptual"></div>
  560. <h5 class="decalaration">Declaration</h5>
  561. <div class="codewrapper">
  562. <pre><code class="lang-csharp hljs">public override bool OnKeyUp(KeyEvent keyEvent)</code></pre>
  563. </div>
  564. <h5 class="parameters">Parameters</h5>
  565. <table class="table table-bordered table-striped table-condensed">
  566. <thead>
  567. <tr>
  568. <th>Type</th>
  569. <th>Name</th>
  570. <th>Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  576. <td><span class="parametername">keyEvent</span></td>
  577. <td>Contains the details about the key that produced the event.</td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <h5 class="returns">Returns</h5>
  582. <table class="table table-bordered table-striped table-condensed">
  583. <thead>
  584. <tr>
  585. <th>Type</th>
  586. <th>Description</th>
  587. </tr>
  588. </thead>
  589. <tbody>
  590. <tr>
  591. <td><span class="xref">System.Boolean</span></td>
  592. <td></td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <h5 class="overrides">Overrides</h5>
  597. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a></div>
  598. <a id="Terminal_Gui_MenuBar_OpenMenu_" data-uid="Terminal.Gui.MenuBar.OpenMenu*"></a>
  599. <h4 id="Terminal_Gui_MenuBar_OpenMenu" data-uid="Terminal.Gui.MenuBar.OpenMenu">OpenMenu()</h4>
  600. <div class="markdown level1 summary">
  601. Opens the current Menu programatically.
  602. </div>
  603. <div class="markdown level1 conceptual"></div>
  604. <h5 class="decalaration">Declaration</h5>
  605. <div class="codewrapper">
  606. <pre><code class="lang-csharp hljs">public void OpenMenu()</code></pre>
  607. </div>
  608. <a id="Terminal_Gui_MenuBar_PositionCursor_" data-uid="Terminal.Gui.MenuBar.PositionCursor*"></a>
  609. <h4 id="Terminal_Gui_MenuBar_PositionCursor" data-uid="Terminal.Gui.MenuBar.PositionCursor">PositionCursor()</h4>
  610. <div class="markdown level1 summary">
  611. Positions the cursor in the right position based on the currently focused view in the chain.
  612. </div>
  613. <div class="markdown level1 conceptual"></div>
  614. <h5 class="decalaration">Declaration</h5>
  615. <div class="codewrapper">
  616. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  617. </div>
  618. <h5 class="overrides">Overrides</h5>
  619. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  620. <a id="Terminal_Gui_MenuBar_ProcessHotKey_" data-uid="Terminal.Gui.MenuBar.ProcessHotKey*"></a>
  621. <h4 id="Terminal_Gui_MenuBar_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.MenuBar.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  622. <div class="markdown level1 summary">
  623. This method can be overwritten by view that
  624. want to provide accelerator functionality
  625. (Alt-key for example).
  626. </div>
  627. <div class="markdown level1 conceptual"></div>
  628. <h5 class="decalaration">Declaration</h5>
  629. <div class="codewrapper">
  630. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  631. </div>
  632. <h5 class="parameters">Parameters</h5>
  633. <table class="table table-bordered table-striped table-condensed">
  634. <thead>
  635. <tr>
  636. <th>Type</th>
  637. <th>Name</th>
  638. <th>Description</th>
  639. </tr>
  640. </thead>
  641. <tbody>
  642. <tr>
  643. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  644. <td><span class="parametername">kb</span></td>
  645. <td></td>
  646. </tr>
  647. </tbody>
  648. </table>
  649. <h5 class="returns">Returns</h5>
  650. <table class="table table-bordered table-striped table-condensed">
  651. <thead>
  652. <tr>
  653. <th>Type</th>
  654. <th>Description</th>
  655. </tr>
  656. </thead>
  657. <tbody>
  658. <tr>
  659. <td><span class="xref">System.Boolean</span></td>
  660. <td></td>
  661. </tr>
  662. </tbody>
  663. </table>
  664. <h5 class="overrides">Overrides</h5>
  665. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  666. <h5 id="Terminal_Gui_MenuBar_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  667. <div class="markdown level1 remarks">
  668. <p>
  669. Before keys are sent to the subview on the
  670. current view, all the views are
  671. processed and the key is passed to the widgets
  672. to allow some of them to process the keystroke
  673. as a hot-key. </p>
  674. <p>
  675. For example, if you implement a button that
  676. has a hotkey ok &quot;o&quot;, you would catch the
  677. combination Alt-o here. If the event is
  678. caught, you must return true to stop the
  679. keystroke from being dispatched to other
  680. views.
  681. </p>
  682. </div>
  683. <a id="Terminal_Gui_MenuBar_ProcessKey_" data-uid="Terminal.Gui.MenuBar.ProcessKey*"></a>
  684. <h4 id="Terminal_Gui_MenuBar_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.MenuBar.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  685. <div class="markdown level1 summary">
  686. If the view is focused, gives the view a
  687. chance to process the keystroke.
  688. </div>
  689. <div class="markdown level1 conceptual"></div>
  690. <h5 class="decalaration">Declaration</h5>
  691. <div class="codewrapper">
  692. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  693. </div>
  694. <h5 class="parameters">Parameters</h5>
  695. <table class="table table-bordered table-striped table-condensed">
  696. <thead>
  697. <tr>
  698. <th>Type</th>
  699. <th>Name</th>
  700. <th>Description</th>
  701. </tr>
  702. </thead>
  703. <tbody>
  704. <tr>
  705. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  706. <td><span class="parametername">kb</span></td>
  707. <td></td>
  708. </tr>
  709. </tbody>
  710. </table>
  711. <h5 class="returns">Returns</h5>
  712. <table class="table table-bordered table-striped table-condensed">
  713. <thead>
  714. <tr>
  715. <th>Type</th>
  716. <th>Description</th>
  717. </tr>
  718. </thead>
  719. <tbody>
  720. <tr>
  721. <td><span class="xref">System.Boolean</span></td>
  722. <td></td>
  723. </tr>
  724. </tbody>
  725. </table>
  726. <h5 class="overrides">Overrides</h5>
  727. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  728. <h5 id="Terminal_Gui_MenuBar_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  729. <div class="markdown level1 remarks">
  730. <p>
  731. Views can override this method if they are
  732. interested in processing the given keystroke.
  733. If they consume the keystroke, they must
  734. return true to stop the keystroke from being
  735. processed by other widgets or consumed by the
  736. widget engine. If they return false, the
  737. keystroke will be passed using the ProcessColdKey
  738. method to other views to process.
  739. </p>
  740. <p>
  741. The View implementation does nothing but return false,
  742. so it is not necessary to call base.ProcessKey if you
  743. derive directly from View, but you should if you derive
  744. other View subclasses.
  745. </p>
  746. </div>
  747. <a id="Terminal_Gui_MenuBar_Redraw_" data-uid="Terminal.Gui.MenuBar.Redraw*"></a>
  748. <h4 id="Terminal_Gui_MenuBar_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.MenuBar.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  749. <div class="markdown level1 summary">
  750. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  751. </div>
  752. <div class="markdown level1 conceptual"></div>
  753. <h5 class="decalaration">Declaration</h5>
  754. <div class="codewrapper">
  755. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  756. </div>
  757. <h5 class="parameters">Parameters</h5>
  758. <table class="table table-bordered table-striped table-condensed">
  759. <thead>
  760. <tr>
  761. <th>Type</th>
  762. <th>Name</th>
  763. <th>Description</th>
  764. </tr>
  765. </thead>
  766. <tbody>
  767. <tr>
  768. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  769. <td><span class="parametername">bounds</span></td>
  770. <td>The bounds (view-relative region) to redraw.</td>
  771. </tr>
  772. </tbody>
  773. </table>
  774. <h5 class="overrides">Overrides</h5>
  775. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  776. <h5 id="Terminal_Gui_MenuBar_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  777. <div class="markdown level1 remarks">
  778. <p>
  779. Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
  780. </p>
  781. <p>
  782. Views should set the color that they want to use on entry, as otherwise this will inherit
  783. the last color that was set globaly on the driver.
  784. </p>
  785. <p>
  786. Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
  787. larger than the <code>region</code> parameter.
  788. </p>
  789. </div>
  790. <h3 id="events">Events
  791. </h3>
  792. <h4 id="Terminal_Gui_MenuBar_OnCloseMenu" data-uid="Terminal.Gui.MenuBar.OnCloseMenu">OnCloseMenu</h4>
  793. <div class="markdown level1 summary">
  794. Raised when a menu is closing.
  795. </div>
  796. <div class="markdown level1 conceptual"></div>
  797. <h5 class="decalaration">Declaration</h5>
  798. <div class="codewrapper">
  799. <pre><code class="lang-csharp hljs">public event EventHandler OnCloseMenu</code></pre>
  800. </div>
  801. <h5 class="eventType">Event Type</h5>
  802. <table class="table table-bordered table-striped table-condensed">
  803. <thead>
  804. <tr>
  805. <th>Type</th>
  806. <th>Description</th>
  807. </tr>
  808. </thead>
  809. <tbody>
  810. <tr>
  811. <td><span class="xref">System.EventHandler</span></td>
  812. <td></td>
  813. </tr>
  814. </tbody>
  815. </table>
  816. <h4 id="Terminal_Gui_MenuBar_OnOpenMenu" data-uid="Terminal.Gui.MenuBar.OnOpenMenu">OnOpenMenu</h4>
  817. <div class="markdown level1 summary">
  818. Raised as a menu is opened.
  819. </div>
  820. <div class="markdown level1 conceptual"></div>
  821. <h5 class="decalaration">Declaration</h5>
  822. <div class="codewrapper">
  823. <pre><code class="lang-csharp hljs">public event EventHandler OnOpenMenu</code></pre>
  824. </div>
  825. <h5 class="eventType">Event Type</h5>
  826. <table class="table table-bordered table-striped table-condensed">
  827. <thead>
  828. <tr>
  829. <th>Type</th>
  830. <th>Description</th>
  831. </tr>
  832. </thead>
  833. <tbody>
  834. <tr>
  835. <td><span class="xref">System.EventHandler</span></td>
  836. <td></td>
  837. </tr>
  838. </tbody>
  839. </table>
  840. <h3 id="implements">Implements</h3>
  841. <div>
  842. <span class="xref">System.Collections.IEnumerable</span>
  843. </div>
  844. </article>
  845. </div>
  846. <div class="hidden-sm col-md-2" role="complementary">
  847. <div class="sideaffix">
  848. <div class="contribution">
  849. <ul class="nav">
  850. </ul>
  851. </div>
  852. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  853. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  854. </nav>
  855. </div>
  856. </div>
  857. </div>
  858. </div>
  859. <footer>
  860. <div class="grad-bottom"></div>
  861. <div class="footer">
  862. <div class="container">
  863. <span class="pull-right">
  864. <a href="#top">Back to top</a>
  865. </span>
  866. <span>Generated by <strong>DocFX</strong></span>
  867. </div>
  868. </div>
  869. </footer>
  870. </div>
  871. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  872. <script type="text/javascript" src="../../styles/docfx.js"></script>
  873. <script type="text/javascript" src="../../styles/main.js"></script>
  874. </body>
  875. </html>