Terminal.Gui.ColorScheme.html 18 KB

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