Terminal.Gui.ColorScheme.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  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. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.ColorScheme">
  74. <h1 id="Terminal_Gui_ColorScheme" data-uid="Terminal.Gui.ColorScheme" class="text-break">Class ColorScheme
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Color scheme definitions, they cover some common scenarios and are used
  78. 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
  79. views contained inside.
  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"><span class="xref">ColorScheme</span></div>
  86. </div>
  87. <div class="implements">
  88. <h5>Implements</h5>
  89. <div><span class="xref">System.IEquatable</span>&lt;<a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>&gt;</div>
  90. </div>
  91. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  92. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  93. <h5 id="Terminal_Gui_ColorScheme_syntax">Syntax</h5>
  94. <div class="codewrapper">
  95. <pre><code class="lang-csharp hljs">public class ColorScheme : Object</code></pre>
  96. </div>
  97. <h3 id="constructors">Constructors
  98. </h3>
  99. <a id="Terminal_Gui_ColorScheme__ctor_" data-uid="Terminal.Gui.ColorScheme.#ctor*"></a>
  100. <h4 id="Terminal_Gui_ColorScheme__ctor" data-uid="Terminal.Gui.ColorScheme.#ctor">ColorScheme()</h4>
  101. <div class="markdown level1 summary"></div>
  102. <div class="markdown level1 conceptual"></div>
  103. <h5 class="decalaration">Declaration</h5>
  104. <div class="codewrapper">
  105. <pre><code class="lang-csharp hljs">public ColorScheme()</code></pre>
  106. </div>
  107. <h3 id="properties">Properties
  108. </h3>
  109. <a id="Terminal_Gui_ColorScheme_Disabled_" data-uid="Terminal.Gui.ColorScheme.Disabled*"></a>
  110. <h4 id="Terminal_Gui_ColorScheme_Disabled" data-uid="Terminal.Gui.ColorScheme.Disabled">Disabled</h4>
  111. <div class="markdown level1 summary">
  112. The default color for text, when the view is disabled.
  113. </div>
  114. <div class="markdown level1 conceptual"></div>
  115. <h5 class="decalaration">Declaration</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public Attribute Disabled { get; set; }</code></pre>
  118. </div>
  119. <h5 class="propertyValue">Property Value</h5>
  120. <table class="table table-bordered table-striped table-condensed">
  121. <thead>
  122. <tr>
  123. <th>Type</th>
  124. <th>Description</th>
  125. </tr>
  126. </thead>
  127. <tbody>
  128. <tr>
  129. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  130. <td></td>
  131. </tr>
  132. </tbody>
  133. </table>
  134. <a id="Terminal_Gui_ColorScheme_Focus_" data-uid="Terminal.Gui.ColorScheme.Focus*"></a>
  135. <h4 id="Terminal_Gui_ColorScheme_Focus" data-uid="Terminal.Gui.ColorScheme.Focus">Focus</h4>
  136. <div class="markdown level1 summary">
  137. The color for text when the view has the focus.
  138. </div>
  139. <div class="markdown level1 conceptual"></div>
  140. <h5 class="decalaration">Declaration</h5>
  141. <div class="codewrapper">
  142. <pre><code class="lang-csharp hljs">public Attribute Focus { get; set; }</code></pre>
  143. </div>
  144. <h5 class="propertyValue">Property Value</h5>
  145. <table class="table table-bordered table-striped table-condensed">
  146. <thead>
  147. <tr>
  148. <th>Type</th>
  149. <th>Description</th>
  150. </tr>
  151. </thead>
  152. <tbody>
  153. <tr>
  154. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  155. <td></td>
  156. </tr>
  157. </tbody>
  158. </table>
  159. <a id="Terminal_Gui_ColorScheme_HotFocus_" data-uid="Terminal.Gui.ColorScheme.HotFocus*"></a>
  160. <h4 id="Terminal_Gui_ColorScheme_HotFocus" data-uid="Terminal.Gui.ColorScheme.HotFocus">HotFocus</h4>
  161. <div class="markdown level1 summary">
  162. The color for the hotkey when the view is focused.
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <pre><code class="lang-csharp hljs">public Attribute HotFocus { get; set; }</code></pre>
  168. </div>
  169. <h5 class="propertyValue">Property Value</h5>
  170. <table class="table table-bordered table-striped table-condensed">
  171. <thead>
  172. <tr>
  173. <th>Type</th>
  174. <th>Description</th>
  175. </tr>
  176. </thead>
  177. <tbody>
  178. <tr>
  179. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  180. <td></td>
  181. </tr>
  182. </tbody>
  183. </table>
  184. <a id="Terminal_Gui_ColorScheme_HotNormal_" data-uid="Terminal.Gui.ColorScheme.HotNormal*"></a>
  185. <h4 id="Terminal_Gui_ColorScheme_HotNormal" data-uid="Terminal.Gui.ColorScheme.HotNormal">HotNormal</h4>
  186. <div class="markdown level1 summary">
  187. The color for the hotkey when a view is not focused
  188. </div>
  189. <div class="markdown level1 conceptual"></div>
  190. <h5 class="decalaration">Declaration</h5>
  191. <div class="codewrapper">
  192. <pre><code class="lang-csharp hljs">public Attribute HotNormal { get; set; }</code></pre>
  193. </div>
  194. <h5 class="propertyValue">Property Value</h5>
  195. <table class="table table-bordered table-striped table-condensed">
  196. <thead>
  197. <tr>
  198. <th>Type</th>
  199. <th>Description</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  205. <td></td>
  206. </tr>
  207. </tbody>
  208. </table>
  209. <a id="Terminal_Gui_ColorScheme_Normal_" data-uid="Terminal.Gui.ColorScheme.Normal*"></a>
  210. <h4 id="Terminal_Gui_ColorScheme_Normal" data-uid="Terminal.Gui.ColorScheme.Normal">Normal</h4>
  211. <div class="markdown level1 summary">
  212. The default color for text, when the view is not focused.
  213. </div>
  214. <div class="markdown level1 conceptual"></div>
  215. <h5 class="decalaration">Declaration</h5>
  216. <div class="codewrapper">
  217. <pre><code class="lang-csharp hljs">public Attribute Normal { get; set; }</code></pre>
  218. </div>
  219. <h5 class="propertyValue">Property Value</h5>
  220. <table class="table table-bordered table-striped table-condensed">
  221. <thead>
  222. <tr>
  223. <th>Type</th>
  224. <th>Description</th>
  225. </tr>
  226. </thead>
  227. <tbody>
  228. <tr>
  229. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  230. <td></td>
  231. </tr>
  232. </tbody>
  233. </table>
  234. <h3 id="methods">Methods
  235. </h3>
  236. <a id="Terminal_Gui_ColorScheme_Equals_" data-uid="Terminal.Gui.ColorScheme.Equals*"></a>
  237. <h4 id="Terminal_Gui_ColorScheme_Equals_System_Object_" data-uid="Terminal.Gui.ColorScheme.Equals(System.Object)">Equals(Object)</h4>
  238. <div class="markdown level1 summary">
  239. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
  240. </div>
  241. <div class="markdown level1 conceptual"></div>
  242. <h5 class="decalaration">Declaration</h5>
  243. <div class="codewrapper">
  244. <pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
  245. </div>
  246. <h5 class="parameters">Parameters</h5>
  247. <table class="table table-bordered table-striped table-condensed">
  248. <thead>
  249. <tr>
  250. <th>Type</th>
  251. <th>Name</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><span class="xref">System.Object</span></td>
  258. <td><span class="parametername">obj</span></td>
  259. <td></td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <h5 class="returns">Returns</h5>
  264. <table class="table table-bordered table-striped table-condensed">
  265. <thead>
  266. <tr>
  267. <th>Type</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><span class="xref">System.Boolean</span></td>
  274. <td>true if the two objects are equal</td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. <a id="Terminal_Gui_ColorScheme_Equals_" data-uid="Terminal.Gui.ColorScheme.Equals*"></a>
  279. <h4 id="Terminal_Gui_ColorScheme_Equals_Terminal_Gui_ColorScheme_" data-uid="Terminal.Gui.ColorScheme.Equals(Terminal.Gui.ColorScheme)">Equals(ColorScheme)</h4>
  280. <div class="markdown level1 summary">
  281. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
  282. </div>
  283. <div class="markdown level1 conceptual"></div>
  284. <h5 class="decalaration">Declaration</h5>
  285. <div class="codewrapper">
  286. <pre><code class="lang-csharp hljs">public bool Equals(ColorScheme other)</code></pre>
  287. </div>
  288. <h5 class="parameters">Parameters</h5>
  289. <table class="table table-bordered table-striped table-condensed">
  290. <thead>
  291. <tr>
  292. <th>Type</th>
  293. <th>Name</th>
  294. <th>Description</th>
  295. </tr>
  296. </thead>
  297. <tbody>
  298. <tr>
  299. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  300. <td><span class="parametername">other</span></td>
  301. <td></td>
  302. </tr>
  303. </tbody>
  304. </table>
  305. <h5 class="returns">Returns</h5>
  306. <table class="table table-bordered table-striped table-condensed">
  307. <thead>
  308. <tr>
  309. <th>Type</th>
  310. <th>Description</th>
  311. </tr>
  312. </thead>
  313. <tbody>
  314. <tr>
  315. <td><span class="xref">System.Boolean</span></td>
  316. <td>true if the two objects are equal</td>
  317. </tr>
  318. </tbody>
  319. </table>
  320. <a id="Terminal_Gui_ColorScheme_GetHashCode_" data-uid="Terminal.Gui.ColorScheme.GetHashCode*"></a>
  321. <h4 id="Terminal_Gui_ColorScheme_GetHashCode" data-uid="Terminal.Gui.ColorScheme.GetHashCode">GetHashCode()</h4>
  322. <div class="markdown level1 summary">
  323. Returns a hashcode for this instance.
  324. </div>
  325. <div class="markdown level1 conceptual"></div>
  326. <h5 class="decalaration">Declaration</h5>
  327. <div class="codewrapper">
  328. <pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
  329. </div>
  330. <h5 class="returns">Returns</h5>
  331. <table class="table table-bordered table-striped table-condensed">
  332. <thead>
  333. <tr>
  334. <th>Type</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><span class="xref">System.Int32</span></td>
  341. <td>hashcode for this instance</td>
  342. </tr>
  343. </tbody>
  344. </table>
  345. <h3 id="operators">Operators
  346. </h3>
  347. <a id="Terminal_Gui_ColorScheme_op_Equality_" data-uid="Terminal.Gui.ColorScheme.op_Equality*"></a>
  348. <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>
  349. <div class="markdown level1 summary">
  350. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for equality.
  351. </div>
  352. <div class="markdown level1 conceptual"></div>
  353. <h5 class="decalaration">Declaration</h5>
  354. <div class="codewrapper">
  355. <pre><code class="lang-csharp hljs">public static bool operator ==(ColorScheme left, ColorScheme right)</code></pre>
  356. </div>
  357. <h5 class="parameters">Parameters</h5>
  358. <table class="table table-bordered table-striped table-condensed">
  359. <thead>
  360. <tr>
  361. <th>Type</th>
  362. <th>Name</th>
  363. <th>Description</th>
  364. </tr>
  365. </thead>
  366. <tbody>
  367. <tr>
  368. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  369. <td><span class="parametername">left</span></td>
  370. <td></td>
  371. </tr>
  372. <tr>
  373. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  374. <td><span class="parametername">right</span></td>
  375. <td></td>
  376. </tr>
  377. </tbody>
  378. </table>
  379. <h5 class="returns">Returns</h5>
  380. <table class="table table-bordered table-striped table-condensed">
  381. <thead>
  382. <tr>
  383. <th>Type</th>
  384. <th>Description</th>
  385. </tr>
  386. </thead>
  387. <tbody>
  388. <tr>
  389. <td><span class="xref">System.Boolean</span></td>
  390. <td><code>true</code> if the two objects are equivalent</td>
  391. </tr>
  392. </tbody>
  393. </table>
  394. <a id="Terminal_Gui_ColorScheme_op_Inequality_" data-uid="Terminal.Gui.ColorScheme.op_Inequality*"></a>
  395. <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>
  396. <div class="markdown level1 summary">
  397. Compares two <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> objects for inequality.
  398. </div>
  399. <div class="markdown level1 conceptual"></div>
  400. <h5 class="decalaration">Declaration</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public static bool operator !=(ColorScheme left, ColorScheme right)</code></pre>
  403. </div>
  404. <h5 class="parameters">Parameters</h5>
  405. <table class="table table-bordered table-striped table-condensed">
  406. <thead>
  407. <tr>
  408. <th>Type</th>
  409. <th>Name</th>
  410. <th>Description</th>
  411. </tr>
  412. </thead>
  413. <tbody>
  414. <tr>
  415. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  416. <td><span class="parametername">left</span></td>
  417. <td></td>
  418. </tr>
  419. <tr>
  420. <td><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></td>
  421. <td><span class="parametername">right</span></td>
  422. <td></td>
  423. </tr>
  424. </tbody>
  425. </table>
  426. <h5 class="returns">Returns</h5>
  427. <table class="table table-bordered table-striped table-condensed">
  428. <thead>
  429. <tr>
  430. <th>Type</th>
  431. <th>Description</th>
  432. </tr>
  433. </thead>
  434. <tbody>
  435. <tr>
  436. <td><span class="xref">System.Boolean</span></td>
  437. <td><code>true</code> if the two objects are not equivalent</td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. <h3 id="implements">Implements</h3>
  442. <div>
  443. <span class="xref">System.IEquatable&lt;&gt;</span>
  444. </div>
  445. </article>
  446. </div>
  447. <div class="hidden-sm col-md-2" role="complementary">
  448. <div class="sideaffix">
  449. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  450. <h5>In This Article</h5>
  451. <div></div>
  452. </nav>
  453. </div>
  454. </div>
  455. </div>
  456. </div>
  457. <footer>
  458. <div class="grad-bottom"></div>
  459. <div class="footer">
  460. <div class="container">
  461. <span class="pull-right">
  462. <a href="#top">Back to top</a>
  463. </span>
  464. <span>Generated by <strong>DocFX</strong></span>
  465. </div>
  466. </div>
  467. </footer>
  468. </div>
  469. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  470. <script type="text/javascript" src="../../styles/docfx.js"></script>
  471. <script type="text/javascript" src="../../styles/main.js"></script>
  472. </body>
  473. </html>