2
0

Terminal.Gui.StatusBar.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731
  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 StatusBar
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class StatusBar
  11. ">
  12. <meta name="generator" content="docfx 2.56.2.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.StatusBar">
  73. <h1 id="Terminal_Gui_StatusBar" data-uid="Terminal.Gui.StatusBar" class="text-break">Class StatusBar
  74. </h1>
  75. <div class="markdown level0 summary">
  76. A status bar is a <a class="xref" href="Terminal.Gui.View.html">View</a> that snaps to the bottom of a <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> displaying set of <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a>s.
  77. The <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will
  78. be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help.
  79. So for each context must be a new instance of a statusbar.
  80. </div>
  81. <div class="markdown level0 conceptual"></div>
  82. <div class="inheritance">
  83. <h5>Inheritance</h5>
  84. <div class="level0"><span class="xref">System.Object</span></div>
  85. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  86. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  87. <div class="level3"><span class="xref">StatusBar</span></div>
  88. </div>
  89. <div classs="implements">
  90. <h5>Implements</h5>
  91. <div><span class="xref">System.IDisposable</span></div>
  92. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  93. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  94. </div>
  95. <div class="inheritedMembers">
  96. <h5>Inherited Members</h5>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  237. </div>
  238. <div>
  239. <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>
  240. </div>
  241. <div>
  242. <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>
  243. </div>
  244. <div>
  245. <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>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  378. </div>
  379. <div>
  380. <span class="xref">System.Object.Equals(System.Object)</span>
  381. </div>
  382. <div>
  383. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  384. </div>
  385. <div>
  386. <span class="xref">System.Object.GetHashCode()</span>
  387. </div>
  388. <div>
  389. <span class="xref">System.Object.GetType()</span>
  390. </div>
  391. <div>
  392. <span class="xref">System.Object.MemberwiseClone()</span>
  393. </div>
  394. <div>
  395. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  396. </div>
  397. </div>
  398. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  399. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  400. <h5 id="Terminal_Gui_StatusBar_syntax">Syntax</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  403. </div>
  404. <h3 id="constructors">Constructors
  405. </h3>
  406. <a id="Terminal_Gui_StatusBar__ctor_" data-uid="Terminal.Gui.StatusBar.#ctor*"></a>
  407. <h4 id="Terminal_Gui_StatusBar__ctor" data-uid="Terminal.Gui.StatusBar.#ctor">StatusBar()</h4>
  408. <div class="markdown level1 summary">
  409. Initializes a new instance of the <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> class.
  410. </div>
  411. <div class="markdown level1 conceptual"></div>
  412. <h5 class="decalaration">Declaration</h5>
  413. <div class="codewrapper">
  414. <pre><code class="lang-csharp hljs">public StatusBar()</code></pre>
  415. </div>
  416. <a id="Terminal_Gui_StatusBar__ctor_" data-uid="Terminal.Gui.StatusBar.#ctor*"></a>
  417. <h4 id="Terminal_Gui_StatusBar__ctor_Terminal_Gui_StatusItem___" data-uid="Terminal.Gui.StatusBar.#ctor(Terminal.Gui.StatusItem[])">StatusBar(StatusItem[])</h4>
  418. <div class="markdown level1 summary">
  419. Initializes a new instance of the <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> class with the specified set of <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a>s.
  420. The <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> will be drawn on the lowest line of the terminal or <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a> (if not null).
  421. </div>
  422. <div class="markdown level1 conceptual"></div>
  423. <h5 class="decalaration">Declaration</h5>
  424. <div class="codewrapper">
  425. <pre><code class="lang-csharp hljs">public StatusBar(StatusItem[] items)</code></pre>
  426. </div>
  427. <h5 class="parameters">Parameters</h5>
  428. <table class="table table-bordered table-striped table-condensed">
  429. <thead>
  430. <tr>
  431. <th>Type</th>
  432. <th>Name</th>
  433. <th>Description</th>
  434. </tr>
  435. </thead>
  436. <tbody>
  437. <tr>
  438. <td><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a>[]</td>
  439. <td><span class="parametername">items</span></td>
  440. <td>A list of statusbar items.</td>
  441. </tr>
  442. </tbody>
  443. </table>
  444. <h3 id="properties">Properties
  445. </h3>
  446. <a id="Terminal_Gui_StatusBar_Items_" data-uid="Terminal.Gui.StatusBar.Items*"></a>
  447. <h4 id="Terminal_Gui_StatusBar_Items" data-uid="Terminal.Gui.StatusBar.Items">Items</h4>
  448. <div class="markdown level1 summary">
  449. The items that compose the <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a>
  450. </div>
  451. <div class="markdown level1 conceptual"></div>
  452. <h5 class="decalaration">Declaration</h5>
  453. <div class="codewrapper">
  454. <pre><code class="lang-csharp hljs">public StatusItem[] Items { get; set; }</code></pre>
  455. </div>
  456. <h5 class="propertyValue">Property Value</h5>
  457. <table class="table table-bordered table-striped table-condensed">
  458. <thead>
  459. <tr>
  460. <th>Type</th>
  461. <th>Description</th>
  462. </tr>
  463. </thead>
  464. <tbody>
  465. <tr>
  466. <td><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a>[]</td>
  467. <td></td>
  468. </tr>
  469. </tbody>
  470. </table>
  471. <h3 id="methods">Methods
  472. </h3>
  473. <a id="Terminal_Gui_StatusBar_Dispose_" data-uid="Terminal.Gui.StatusBar.Dispose*"></a>
  474. <h4 id="Terminal_Gui_StatusBar_Dispose_System_Boolean_" data-uid="Terminal.Gui.StatusBar.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  475. <div class="markdown level1 summary">
  476. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  477. </div>
  478. <div class="markdown level1 conceptual"></div>
  479. <h5 class="decalaration">Declaration</h5>
  480. <div class="codewrapper">
  481. <pre><code class="lang-csharp hljs">protected override void Dispose(bool disposing)</code></pre>
  482. </div>
  483. <h5 class="parameters">Parameters</h5>
  484. <table class="table table-bordered table-striped table-condensed">
  485. <thead>
  486. <tr>
  487. <th>Type</th>
  488. <th>Name</th>
  489. <th>Description</th>
  490. </tr>
  491. </thead>
  492. <tbody>
  493. <tr>
  494. <td><span class="xref">System.Boolean</span></td>
  495. <td><span class="parametername">disposing</span></td>
  496. <td></td>
  497. </tr>
  498. </tbody>
  499. </table>
  500. <h5 class="overrides">Overrides</h5>
  501. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a></div>
  502. <h5 id="Terminal_Gui_StatusBar_Dispose_System_Boolean__remarks">Remarks</h5>
  503. <div class="markdown level1 remarks">
  504. If disposing equals true, the method has been called directly
  505. or indirectly by a user&apos;s code. Managed and unmanaged resources
  506. can be disposed.
  507. If disposing equals false, the method has been called by the
  508. runtime from inside the finalizer and you should not reference
  509. other objects. Only unmanaged resources can be disposed.
  510. </div>
  511. <a id="Terminal_Gui_StatusBar_MouseEvent_" data-uid="Terminal.Gui.StatusBar.MouseEvent*"></a>
  512. <h4 id="Terminal_Gui_StatusBar_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.StatusBar.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  513. <div class="markdown level1 summary">
  514. Method invoked when a mouse event is generated
  515. </div>
  516. <div class="markdown level1 conceptual"></div>
  517. <h5 class="decalaration">Declaration</h5>
  518. <div class="codewrapper">
  519. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  520. </div>
  521. <h5 class="parameters">Parameters</h5>
  522. <table class="table table-bordered table-striped table-condensed">
  523. <thead>
  524. <tr>
  525. <th>Type</th>
  526. <th>Name</th>
  527. <th>Description</th>
  528. </tr>
  529. </thead>
  530. <tbody>
  531. <tr>
  532. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  533. <td><span class="parametername">me</span></td>
  534. <td></td>
  535. </tr>
  536. </tbody>
  537. </table>
  538. <h5 class="returns">Returns</h5>
  539. <table class="table table-bordered table-striped table-condensed">
  540. <thead>
  541. <tr>
  542. <th>Type</th>
  543. <th>Description</th>
  544. </tr>
  545. </thead>
  546. <tbody>
  547. <tr>
  548. <td><span class="xref">System.Boolean</span></td>
  549. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  550. </tr>
  551. </tbody>
  552. </table>
  553. <h5 class="overrides">Overrides</h5>
  554. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  555. <a id="Terminal_Gui_StatusBar_ProcessHotKey_" data-uid="Terminal.Gui.StatusBar.ProcessHotKey*"></a>
  556. <h4 id="Terminal_Gui_StatusBar_ProcessHotKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.StatusBar.ProcessHotKey(Terminal.Gui.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
  557. <div class="markdown level1 summary">
  558. This method can be overwritten by view that
  559. want to provide accelerator functionality
  560. (Alt-key for example).
  561. </div>
  562. <div class="markdown level1 conceptual"></div>
  563. <h5 class="decalaration">Declaration</h5>
  564. <div class="codewrapper">
  565. <pre><code class="lang-csharp hljs">public override bool ProcessHotKey(KeyEvent kb)</code></pre>
  566. </div>
  567. <h5 class="parameters">Parameters</h5>
  568. <table class="table table-bordered table-striped table-condensed">
  569. <thead>
  570. <tr>
  571. <th>Type</th>
  572. <th>Name</th>
  573. <th>Description</th>
  574. </tr>
  575. </thead>
  576. <tbody>
  577. <tr>
  578. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  579. <td><span class="parametername">kb</span></td>
  580. <td></td>
  581. </tr>
  582. </tbody>
  583. </table>
  584. <h5 class="returns">Returns</h5>
  585. <table class="table table-bordered table-striped table-condensed">
  586. <thead>
  587. <tr>
  588. <th>Type</th>
  589. <th>Description</th>
  590. </tr>
  591. </thead>
  592. <tbody>
  593. <tr>
  594. <td><span class="xref">System.Boolean</span></td>
  595. <td></td>
  596. </tr>
  597. </tbody>
  598. </table>
  599. <h5 class="overrides">Overrides</h5>
  600. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a></div>
  601. <h5 id="Terminal_Gui_StatusBar_ProcessHotKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  602. <div class="markdown level1 remarks">
  603. <p>
  604. Before keys are sent to the subview on the
  605. current view, all the views are
  606. processed and the key is passed to the widgets
  607. to allow some of them to process the keystroke
  608. as a hot-key. </p>
  609. <p>
  610. For example, if you implement a button that
  611. has a hotkey ok &quot;o&quot;, you would catch the
  612. combination Alt-o here. If the event is
  613. caught, you must return true to stop the
  614. keystroke from being dispatched to other
  615. views.
  616. </p>
  617. </div>
  618. <a id="Terminal_Gui_StatusBar_Redraw_" data-uid="Terminal.Gui.StatusBar.Redraw*"></a>
  619. <h4 id="Terminal_Gui_StatusBar_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.StatusBar.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  620. <div class="markdown level1 summary">
  621. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  622. </div>
  623. <div class="markdown level1 conceptual"></div>
  624. <h5 class="decalaration">Declaration</h5>
  625. <div class="codewrapper">
  626. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  627. </div>
  628. <h5 class="parameters">Parameters</h5>
  629. <table class="table table-bordered table-striped table-condensed">
  630. <thead>
  631. <tr>
  632. <th>Type</th>
  633. <th>Name</th>
  634. <th>Description</th>
  635. </tr>
  636. </thead>
  637. <tbody>
  638. <tr>
  639. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  640. <td><span class="parametername">bounds</span></td>
  641. <td>The bounds (view-relative region) to redraw.</td>
  642. </tr>
  643. </tbody>
  644. </table>
  645. <h5 class="overrides">Overrides</h5>
  646. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  647. <h5 id="Terminal_Gui_StatusBar_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  648. <div class="markdown level1 remarks">
  649. <p>
  650. 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).
  651. </p>
  652. <p>
  653. Views should set the color that they want to use on entry, as otherwise this will inherit
  654. the last color that was set globally on the driver.
  655. </p>
  656. <p>
  657. 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
  658. larger than the <code>region</code> parameter.
  659. </p>
  660. </div>
  661. <h3 id="implements">Implements</h3>
  662. <div>
  663. <span class="xref">System.IDisposable</span>
  664. </div>
  665. <div>
  666. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  667. </div>
  668. <div>
  669. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  670. </div>
  671. </article>
  672. </div>
  673. <div class="hidden-sm col-md-2" role="complementary">
  674. <div class="sideaffix">
  675. <div class="contribution">
  676. <ul class="nav">
  677. </ul>
  678. </div>
  679. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  680. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  681. </nav>
  682. </div>
  683. </div>
  684. </div>
  685. </div>
  686. <footer>
  687. <div class="grad-bottom"></div>
  688. <div class="footer">
  689. <div class="container">
  690. <span class="pull-right">
  691. <a href="#top">Back to top</a>
  692. </span>
  693. <span>Generated by <strong>DocFX</strong></span>
  694. </div>
  695. </div>
  696. </footer>
  697. </div>
  698. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  699. <script type="text/javascript" src="../../styles/docfx.js"></script>
  700. <script type="text/javascript" src="../../styles/main.js"></script>
  701. </body>
  702. </html>