Terminal.Gui.ColorScheme.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499
  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 ColorScheme
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ColorScheme
  11. ">
  12. <meta name="generator" content="docfx 2.59.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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.ColorScheme">
  73. <h1 id="Terminal_Gui_ColorScheme" data-uid="Terminal.Gui.ColorScheme" class="text-break">Class ColorScheme
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Color scheme definitions, they cover some common scenarios and are used
  77. typically in containers such as <a class="xref" href="Terminal.Gui.Window.html">Window</a> and <a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a> to set the scheme that is used by all the
  78. views contained inside.
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">ColorScheme</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.IEquatable</span>&lt;<a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>&gt;</div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetType()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.MemberwiseClone()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.ToString()</span>
  106. </div>
  107. </div>
  108. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  109. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  110. <h5 id="Terminal_Gui_ColorScheme_syntax">Syntax</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public class ColorScheme : IEquatable&lt;ColorScheme&gt;</code></pre>
  113. </div>
  114. <h3 id="properties">Properties
  115. </h3>
  116. <a id="Terminal_Gui_ColorScheme_Disabled_" data-uid="Terminal.Gui.ColorScheme.Disabled*"></a>
  117. <h4 id="Terminal_Gui_ColorScheme_Disabled" data-uid="Terminal.Gui.ColorScheme.Disabled">Disabled</h4>
  118. <div class="markdown level1 summary">
  119. The default color for text, when the view is disabled.
  120. </div>
  121. <div class="markdown level1 conceptual"></div>
  122. <h5 class="decalaration">Declaration</h5>
  123. <div class="codewrapper">
  124. <pre><code class="lang-csharp hljs">public Attribute Disabled { get; set; }</code></pre>
  125. </div>
  126. <h5 class="propertyValue">Property Value</h5>
  127. <table class="table table-bordered table-striped table-condensed">
  128. <thead>
  129. <tr>
  130. <th>Type</th>
  131. <th>Description</th>
  132. </tr>
  133. </thead>
  134. <tbody>
  135. <tr>
  136. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  137. <td></td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <a id="Terminal_Gui_ColorScheme_Focus_" data-uid="Terminal.Gui.ColorScheme.Focus*"></a>
  142. <h4 id="Terminal_Gui_ColorScheme_Focus" data-uid="Terminal.Gui.ColorScheme.Focus">Focus</h4>
  143. <div class="markdown level1 summary">
  144. The color for text when the view has the focus.
  145. </div>
  146. <div class="markdown level1 conceptual"></div>
  147. <h5 class="decalaration">Declaration</h5>
  148. <div class="codewrapper">
  149. <pre><code class="lang-csharp hljs">public Attribute Focus { get; set; }</code></pre>
  150. </div>
  151. <h5 class="propertyValue">Property Value</h5>
  152. <table class="table table-bordered table-striped table-condensed">
  153. <thead>
  154. <tr>
  155. <th>Type</th>
  156. <th>Description</th>
  157. </tr>
  158. </thead>
  159. <tbody>
  160. <tr>
  161. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  162. <td></td>
  163. </tr>
  164. </tbody>
  165. </table>
  166. <a id="Terminal_Gui_ColorScheme_HotFocus_" data-uid="Terminal.Gui.ColorScheme.HotFocus*"></a>
  167. <h4 id="Terminal_Gui_ColorScheme_HotFocus" data-uid="Terminal.Gui.ColorScheme.HotFocus">HotFocus</h4>
  168. <div class="markdown level1 summary">
  169. The color for the hotkey when the view is focused.
  170. </div>
  171. <div class="markdown level1 conceptual"></div>
  172. <h5 class="decalaration">Declaration</h5>
  173. <div class="codewrapper">
  174. <pre><code class="lang-csharp hljs">public Attribute HotFocus { get; set; }</code></pre>
  175. </div>
  176. <h5 class="propertyValue">Property Value</h5>
  177. <table class="table table-bordered table-striped table-condensed">
  178. <thead>
  179. <tr>
  180. <th>Type</th>
  181. <th>Description</th>
  182. </tr>
  183. </thead>
  184. <tbody>
  185. <tr>
  186. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  187. <td></td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <a id="Terminal_Gui_ColorScheme_HotNormal_" data-uid="Terminal.Gui.ColorScheme.HotNormal*"></a>
  192. <h4 id="Terminal_Gui_ColorScheme_HotNormal" data-uid="Terminal.Gui.ColorScheme.HotNormal">HotNormal</h4>
  193. <div class="markdown level1 summary">
  194. The color for the hotkey when a view is not focused
  195. </div>
  196. <div class="markdown level1 conceptual"></div>
  197. <h5 class="decalaration">Declaration</h5>
  198. <div class="codewrapper">
  199. <pre><code class="lang-csharp hljs">public Attribute HotNormal { get; set; }</code></pre>
  200. </div>
  201. <h5 class="propertyValue">Property Value</h5>
  202. <table class="table table-bordered table-striped table-condensed">
  203. <thead>
  204. <tr>
  205. <th>Type</th>
  206. <th>Description</th>
  207. </tr>
  208. </thead>
  209. <tbody>
  210. <tr>
  211. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  212. <td></td>
  213. </tr>
  214. </tbody>
  215. </table>
  216. <a id="Terminal_Gui_ColorScheme_Normal_" data-uid="Terminal.Gui.ColorScheme.Normal*"></a>
  217. <h4 id="Terminal_Gui_ColorScheme_Normal" data-uid="Terminal.Gui.ColorScheme.Normal">Normal</h4>
  218. <div class="markdown level1 summary">
  219. The default color for text, when the view is not focused.
  220. </div>
  221. <div class="markdown level1 conceptual"></div>
  222. <h5 class="decalaration">Declaration</h5>
  223. <div class="codewrapper">
  224. <pre><code class="lang-csharp hljs">public Attribute Normal { get; set; }</code></pre>
  225. </div>
  226. <h5 class="propertyValue">Property Value</h5>
  227. <table class="table table-bordered table-striped table-condensed">
  228. <thead>
  229. <tr>
  230. <th>Type</th>
  231. <th>Description</th>
  232. </tr>
  233. </thead>
  234. <tbody>
  235. <tr>
  236. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  237. <td></td>
  238. </tr>
  239. </tbody>
  240. </table>
  241. <h3 id="methods">Methods
  242. </h3>
  243. <a id="Terminal_Gui_ColorScheme_Equals_" data-uid="Terminal.Gui.ColorScheme.Equals*"></a>
  244. <h4 id="Terminal_Gui_ColorScheme_Equals_System_Object_" data-uid="Terminal.Gui.ColorScheme.Equals(System.Object)">Equals(Object)</h4>
  245. <div class="markdown level1 summary">
  246. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
  247. </div>
  248. <div class="markdown level1 conceptual"></div>
  249. <h5 class="decalaration">Declaration</h5>
  250. <div class="codewrapper">
  251. <pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
  252. </div>
  253. <h5 class="parameters">Parameters</h5>
  254. <table class="table table-bordered table-striped table-condensed">
  255. <thead>
  256. <tr>
  257. <th>Type</th>
  258. <th>Name</th>
  259. <th>Description</th>
  260. </tr>
  261. </thead>
  262. <tbody>
  263. <tr>
  264. <td><span class="xref">System.Object</span></td>
  265. <td><span class="parametername">obj</span></td>
  266. <td></td>
  267. </tr>
  268. </tbody>
  269. </table>
  270. <h5 class="returns">Returns</h5>
  271. <table class="table table-bordered table-striped table-condensed">
  272. <thead>
  273. <tr>
  274. <th>Type</th>
  275. <th>Description</th>
  276. </tr>
  277. </thead>
  278. <tbody>
  279. <tr>
  280. <td><span class="xref">System.Boolean</span></td>
  281. <td>true if the two objects are equal</td>
  282. </tr>
  283. </tbody>
  284. </table>
  285. <h5 class="overrides">Overrides</h5>
  286. <div><span class="xref">System.Object.Equals(System.Object)</span></div>
  287. <a id="Terminal_Gui_ColorScheme_Equals_" data-uid="Terminal.Gui.ColorScheme.Equals*"></a>
  288. <h4 id="Terminal_Gui_ColorScheme_Equals_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.Equals(Terminal.Gui.ColorScheme)">Equals(ColorScheme)</h4>
  289. <div class="markdown level1 summary">
  290. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
  291. </div>
  292. <div class="markdown level1 conceptual"></div>
  293. <h5 class="decalaration">Declaration</h5>
  294. <div class="codewrapper">
  295. <pre><code class="lang-csharp hljs">public bool Equals(ColorScheme other)</code></pre>
  296. </div>
  297. <h5 class="parameters">Parameters</h5>
  298. <table class="table table-bordered table-striped table-condensed">
  299. <thead>
  300. <tr>
  301. <th>Type</th>
  302. <th>Name</th>
  303. <th>Description</th>
  304. </tr>
  305. </thead>
  306. <tbody>
  307. <tr>
  308. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  309. <td><span class="parametername">other</span></td>
  310. <td></td>
  311. </tr>
  312. </tbody>
  313. </table>
  314. <h5 class="returns">Returns</h5>
  315. <table class="table table-bordered table-striped table-condensed">
  316. <thead>
  317. <tr>
  318. <th>Type</th>
  319. <th>Description</th>
  320. </tr>
  321. </thead>
  322. <tbody>
  323. <tr>
  324. <td><span class="xref">System.Boolean</span></td>
  325. <td>true if the two objects are equal</td>
  326. </tr>
  327. </tbody>
  328. </table>
  329. <a id="Terminal_Gui_ColorScheme_GetHashCode_" data-uid="Terminal.Gui.ColorScheme.GetHashCode*"></a>
  330. <h4 id="Terminal_Gui_ColorScheme_GetHashCode" data-uid="Terminal.Gui.ColorScheme.GetHashCode">GetHashCode()</h4>
  331. <div class="markdown level1 summary">
  332. Returns a hashcode for this instance.
  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 override int GetHashCode()</code></pre>
  338. </div>
  339. <h5 class="returns">Returns</h5>
  340. <table class="table table-bordered table-striped table-condensed">
  341. <thead>
  342. <tr>
  343. <th>Type</th>
  344. <th>Description</th>
  345. </tr>
  346. </thead>
  347. <tbody>
  348. <tr>
  349. <td><span class="xref">System.Int32</span></td>
  350. <td>hashcode for this instance</td>
  351. </tr>
  352. </tbody>
  353. </table>
  354. <h5 class="overrides">Overrides</h5>
  355. <div><span class="xref">System.Object.GetHashCode()</span></div>
  356. <h3 id="operators">Operators
  357. </h3>
  358. <a id="Terminal_Gui_ColorScheme_op_Equality_" data-uid="Terminal.Gui.ColorScheme.op_Equality*"></a>
  359. <h4 id="Terminal_Gui_ColorScheme_op_Equality_Terminal_Gui_ColorScheme_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.op_Equality(Terminal.Gui.ColorScheme,Terminal.Gui.ColorScheme)">Equality(ColorScheme, ColorScheme)</h4>
  360. <div class="markdown level1 summary">
  361. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
  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 static bool operator ==(ColorScheme left, ColorScheme right)</code></pre>
  367. </div>
  368. <h5 class="parameters">Parameters</h5>
  369. <table class="table table-bordered table-striped table-condensed">
  370. <thead>
  371. <tr>
  372. <th>Type</th>
  373. <th>Name</th>
  374. <th>Description</th>
  375. </tr>
  376. </thead>
  377. <tbody>
  378. <tr>
  379. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  380. <td><span class="parametername">left</span></td>
  381. <td></td>
  382. </tr>
  383. <tr>
  384. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  385. <td><span class="parametername">right</span></td>
  386. <td></td>
  387. </tr>
  388. </tbody>
  389. </table>
  390. <h5 class="returns">Returns</h5>
  391. <table class="table table-bordered table-striped table-condensed">
  392. <thead>
  393. <tr>
  394. <th>Type</th>
  395. <th>Description</th>
  396. </tr>
  397. </thead>
  398. <tbody>
  399. <tr>
  400. <td><span class="xref">System.Boolean</span></td>
  401. <td><code>true</code> if the two objects are equivalent</td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <a id="Terminal_Gui_ColorScheme_op_Inequality_" data-uid="Terminal.Gui.ColorScheme.op_Inequality*"></a>
  406. <h4 id="Terminal_Gui_ColorScheme_op_Inequality_Terminal_Gui_ColorScheme_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.op_Inequality(Terminal.Gui.ColorScheme,Terminal.Gui.ColorScheme)">Inequality(ColorScheme, ColorScheme)</h4>
  407. <div class="markdown level1 summary">
  408. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for inequality.
  409. </div>
  410. <div class="markdown level1 conceptual"></div>
  411. <h5 class="decalaration">Declaration</h5>
  412. <div class="codewrapper">
  413. <pre><code class="lang-csharp hljs">public static bool operator !=(ColorScheme left, ColorScheme right)</code></pre>
  414. </div>
  415. <h5 class="parameters">Parameters</h5>
  416. <table class="table table-bordered table-striped table-condensed">
  417. <thead>
  418. <tr>
  419. <th>Type</th>
  420. <th>Name</th>
  421. <th>Description</th>
  422. </tr>
  423. </thead>
  424. <tbody>
  425. <tr>
  426. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  427. <td><span class="parametername">left</span></td>
  428. <td></td>
  429. </tr>
  430. <tr>
  431. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  432. <td><span class="parametername">right</span></td>
  433. <td></td>
  434. </tr>
  435. </tbody>
  436. </table>
  437. <h5 class="returns">Returns</h5>
  438. <table class="table table-bordered table-striped table-condensed">
  439. <thead>
  440. <tr>
  441. <th>Type</th>
  442. <th>Description</th>
  443. </tr>
  444. </thead>
  445. <tbody>
  446. <tr>
  447. <td><span class="xref">System.Boolean</span></td>
  448. <td><code>true</code> if the two objects are not equivalent</td>
  449. </tr>
  450. </tbody>
  451. </table>
  452. <h3 id="implements">Implements</h3>
  453. <div>
  454. <span class="xref">System.IEquatable&lt;T&gt;</span>
  455. </div>
  456. </article>
  457. </div>
  458. <div class="hidden-sm col-md-2" role="complementary">
  459. <div class="sideaffix">
  460. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  461. <h5>In This Article</h5>
  462. <div></div>
  463. </nav>
  464. </div>
  465. </div>
  466. </div>
  467. </div>
  468. <footer>
  469. <div class="grad-bottom"></div>
  470. <div class="footer">
  471. <div class="container">
  472. <span class="pull-right">
  473. <a href="#top">Back to top</a>
  474. </span>
  475. <span>Generated by <strong>DocFX</strong></span>
  476. </div>
  477. </div>
  478. </footer>
  479. </div>
  480. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  481. <script type="text/javascript" src="../../styles/docfx.js"></script>
  482. <script type="text/javascript" src="../../styles/main.js"></script>
  483. </body>
  484. </html>