Terminal.Gui.Attribute.yml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580
  1. ### YamlMime:ManagedReference
  2. items:
  3. - uid: Terminal.Gui.Attribute
  4. commentId: T:Terminal.Gui.Attribute
  5. id: Attribute
  6. parent: Terminal.Gui
  7. children:
  8. - Terminal.Gui.Attribute.#ctor(System.Int32,Terminal.Gui.Color,Terminal.Gui.Color)
  9. - Terminal.Gui.Attribute.#ctor(Terminal.Gui.Color,Terminal.Gui.Color)
  10. - Terminal.Gui.Attribute.Make(Terminal.Gui.Color,Terminal.Gui.Color)
  11. - Terminal.Gui.Attribute.op_Implicit(System.Int32)~Terminal.Gui.Attribute
  12. - Terminal.Gui.Attribute.op_Implicit(Terminal.Gui.Attribute)~System.Int32
  13. langs:
  14. - csharp
  15. - vb
  16. name: Attribute
  17. nameWithType: Attribute
  18. fullName: Terminal.Gui.Attribute
  19. type: Struct
  20. source:
  21. remote:
  22. path: Terminal.Gui/Core/ConsoleDriver.cs
  23. branch: refactor_core
  24. repo: tig:tig/gui.cs.git
  25. id: Attribute
  26. path: ../Terminal.Gui/Core/ConsoleDriver.cs
  27. startLine: 90
  28. assemblies:
  29. - Terminal.Gui
  30. namespace: Terminal.Gui
  31. summary: "\nAttributes are used as elements that contain both a foreground and a background or platform specific features\n"
  32. remarks: "\n<xref href=\"Terminal.Gui.Attribute\" data-throw-if-not-resolved=\"false\"></xref>s are needed to map colors to terminal capabilities that might lack colors, on color\nscenarios, they encode both the foreground and the background color and are used in the <xref href=\"Terminal.Gui.ColorScheme\" data-throw-if-not-resolved=\"false\"></xref>\nclass to define color schemes that can be used in your application.\n"
  33. example: []
  34. syntax:
  35. content: public struct Attribute
  36. content.vb: Public Structure Attribute
  37. inheritedMembers:
  38. - System.ValueType.Equals(System.Object)
  39. - System.ValueType.GetHashCode
  40. - System.ValueType.ToString
  41. - System.Object.Equals(System.Object,System.Object)
  42. - System.Object.GetType
  43. - System.Object.ReferenceEquals(System.Object,System.Object)
  44. modifiers.csharp:
  45. - public
  46. - struct
  47. modifiers.vb:
  48. - Public
  49. - Structure
  50. - uid: Terminal.Gui.Attribute.#ctor(System.Int32,Terminal.Gui.Color,Terminal.Gui.Color)
  51. commentId: M:Terminal.Gui.Attribute.#ctor(System.Int32,Terminal.Gui.Color,Terminal.Gui.Color)
  52. id: '#ctor(System.Int32,Terminal.Gui.Color,Terminal.Gui.Color)'
  53. parent: Terminal.Gui.Attribute
  54. langs:
  55. - csharp
  56. - vb
  57. name: Attribute(Int32, Color, Color)
  58. nameWithType: Attribute.Attribute(Int32, Color, Color)
  59. fullName: Terminal.Gui.Attribute.Attribute(System.Int32, Terminal.Gui.Color, Terminal.Gui.Color)
  60. type: Constructor
  61. source:
  62. remote:
  63. path: Terminal.Gui/Core/ConsoleDriver.cs
  64. branch: refactor_core
  65. repo: tig:tig/gui.cs.git
  66. id: .ctor
  67. path: ../Terminal.Gui/Core/ConsoleDriver.cs
  68. startLine: 101
  69. assemblies:
  70. - Terminal.Gui
  71. namespace: Terminal.Gui
  72. summary: "\nInitializes a new instance of the <xref href=\"Terminal.Gui.Attribute\" data-throw-if-not-resolved=\"false\"></xref> struct.\n"
  73. example: []
  74. syntax:
  75. content: public Attribute(int value, Color foreground = Color.Black, Color background = Color.Black)
  76. parameters:
  77. - id: value
  78. type: System.Int32
  79. description: Value.
  80. - id: foreground
  81. type: Terminal.Gui.Color
  82. description: Foreground
  83. - id: background
  84. type: Terminal.Gui.Color
  85. description: Background
  86. content.vb: Public Sub New(value As Integer, foreground As Color = Color.Black, background As Color = Color.Black)
  87. overload: Terminal.Gui.Attribute.#ctor*
  88. modifiers.csharp:
  89. - public
  90. modifiers.vb:
  91. - Public
  92. - uid: Terminal.Gui.Attribute.#ctor(Terminal.Gui.Color,Terminal.Gui.Color)
  93. commentId: M:Terminal.Gui.Attribute.#ctor(Terminal.Gui.Color,Terminal.Gui.Color)
  94. id: '#ctor(Terminal.Gui.Color,Terminal.Gui.Color)'
  95. parent: Terminal.Gui.Attribute
  96. langs:
  97. - csharp
  98. - vb
  99. name: Attribute(Color, Color)
  100. nameWithType: Attribute.Attribute(Color, Color)
  101. fullName: Terminal.Gui.Attribute.Attribute(Terminal.Gui.Color, Terminal.Gui.Color)
  102. type: Constructor
  103. source:
  104. remote:
  105. path: Terminal.Gui/Core/ConsoleDriver.cs
  106. branch: refactor_core
  107. repo: tig:tig/gui.cs.git
  108. id: .ctor
  109. path: ../Terminal.Gui/Core/ConsoleDriver.cs
  110. startLine: 113
  111. assemblies:
  112. - Terminal.Gui
  113. namespace: Terminal.Gui
  114. summary: "\nInitializes a new instance of the <xref href=\"Terminal.Gui.Attribute\" data-throw-if-not-resolved=\"false\"></xref> struct.\n"
  115. example: []
  116. syntax:
  117. content: public Attribute(Color foreground = Color.Black, Color background = Color.Black)
  118. parameters:
  119. - id: foreground
  120. type: Terminal.Gui.Color
  121. description: Foreground
  122. - id: background
  123. type: Terminal.Gui.Color
  124. description: Background
  125. content.vb: Public Sub New(foreground As Color = Color.Black, background As Color = Color.Black)
  126. overload: Terminal.Gui.Attribute.#ctor*
  127. modifiers.csharp:
  128. - public
  129. modifiers.vb:
  130. - Public
  131. - uid: Terminal.Gui.Attribute.op_Implicit(Terminal.Gui.Attribute)~System.Int32
  132. commentId: M:Terminal.Gui.Attribute.op_Implicit(Terminal.Gui.Attribute)~System.Int32
  133. id: op_Implicit(Terminal.Gui.Attribute)~System.Int32
  134. parent: Terminal.Gui.Attribute
  135. langs:
  136. - csharp
  137. - vb
  138. name: Implicit(Attribute to Int32)
  139. nameWithType: Attribute.Implicit(Attribute to Int32)
  140. fullName: Terminal.Gui.Attribute.Implicit(Terminal.Gui.Attribute to System.Int32)
  141. type: Operator
  142. source:
  143. remote:
  144. path: Terminal.Gui/Core/ConsoleDriver.cs
  145. branch: refactor_core
  146. repo: tig:tig/gui.cs.git
  147. id: op_Implicit
  148. path: ../Terminal.Gui/Core/ConsoleDriver.cs
  149. startLine: 125
  150. assemblies:
  151. - Terminal.Gui
  152. namespace: Terminal.Gui
  153. summary: "\nImplicit conversion from an <xref href=\"Terminal.Gui.Attribute\" data-throw-if-not-resolved=\"false\"></xref> to the underlying Int32 representation\n"
  154. example: []
  155. syntax:
  156. content: public static implicit operator int (Attribute c)
  157. parameters:
  158. - id: c
  159. type: Terminal.Gui.Attribute
  160. description: The attribute to convert
  161. return:
  162. type: System.Int32
  163. description: The integer value stored in the attribute.
  164. content.vb: Public Shared Widening Operator CType(c As Attribute) As Integer
  165. overload: Terminal.Gui.Attribute.op_Implicit*
  166. nameWithType.vb: Attribute.Widening(Attribute to Int32)
  167. modifiers.csharp:
  168. - public
  169. - static
  170. modifiers.vb:
  171. - Public
  172. - Shared
  173. fullName.vb: Terminal.Gui.Attribute.Widening(Terminal.Gui.Attribute to System.Int32)
  174. name.vb: Widening(Attribute to Int32)
  175. - uid: Terminal.Gui.Attribute.op_Implicit(System.Int32)~Terminal.Gui.Attribute
  176. commentId: M:Terminal.Gui.Attribute.op_Implicit(System.Int32)~Terminal.Gui.Attribute
  177. id: op_Implicit(System.Int32)~Terminal.Gui.Attribute
  178. parent: Terminal.Gui.Attribute
  179. langs:
  180. - csharp
  181. - vb
  182. name: Implicit(Int32 to Attribute)
  183. nameWithType: Attribute.Implicit(Int32 to Attribute)
  184. fullName: Terminal.Gui.Attribute.Implicit(System.Int32 to Terminal.Gui.Attribute)
  185. type: Operator
  186. source:
  187. remote:
  188. path: Terminal.Gui/Core/ConsoleDriver.cs
  189. branch: refactor_core
  190. repo: tig:tig/gui.cs.git
  191. id: op_Implicit
  192. path: ../Terminal.Gui/Core/ConsoleDriver.cs
  193. startLine: 132
  194. assemblies:
  195. - Terminal.Gui
  196. namespace: Terminal.Gui
  197. summary: "\nImplicitly convert an integer value into an <xref href=\"Terminal.Gui.Attribute\" data-throw-if-not-resolved=\"false\"></xref>\n"
  198. example: []
  199. syntax:
  200. content: public static implicit operator Attribute(int v)
  201. parameters:
  202. - id: v
  203. type: System.Int32
  204. description: value
  205. return:
  206. type: Terminal.Gui.Attribute
  207. description: An attribute with the specified integer value.
  208. content.vb: Public Shared Widening Operator CType(v As Integer) As Attribute
  209. overload: Terminal.Gui.Attribute.op_Implicit*
  210. nameWithType.vb: Attribute.Widening(Int32 to Attribute)
  211. modifiers.csharp:
  212. - public
  213. - static
  214. modifiers.vb:
  215. - Public
  216. - Shared
  217. fullName.vb: Terminal.Gui.Attribute.Widening(System.Int32 to Terminal.Gui.Attribute)
  218. name.vb: Widening(Int32 to Attribute)
  219. - uid: Terminal.Gui.Attribute.Make(Terminal.Gui.Color,Terminal.Gui.Color)
  220. commentId: M:Terminal.Gui.Attribute.Make(Terminal.Gui.Color,Terminal.Gui.Color)
  221. id: Make(Terminal.Gui.Color,Terminal.Gui.Color)
  222. parent: Terminal.Gui.Attribute
  223. langs:
  224. - csharp
  225. - vb
  226. name: Make(Color, Color)
  227. nameWithType: Attribute.Make(Color, Color)
  228. fullName: Terminal.Gui.Attribute.Make(Terminal.Gui.Color, Terminal.Gui.Color)
  229. type: Method
  230. source:
  231. remote:
  232. path: Terminal.Gui/Core/ConsoleDriver.cs
  233. branch: refactor_core
  234. repo: tig:tig/gui.cs.git
  235. id: Make
  236. path: ../Terminal.Gui/Core/ConsoleDriver.cs
  237. startLine: 140
  238. assemblies:
  239. - Terminal.Gui
  240. namespace: Terminal.Gui
  241. summary: "\nCreates an <xref href=\"Terminal.Gui.Attribute\" data-throw-if-not-resolved=\"false\"></xref> from the specified foreground and background.\n"
  242. example: []
  243. syntax:
  244. content: public static Attribute Make(Color foreground, Color background)
  245. parameters:
  246. - id: foreground
  247. type: Terminal.Gui.Color
  248. description: Foreground color to use.
  249. - id: background
  250. type: Terminal.Gui.Color
  251. description: Background color to use.
  252. return:
  253. type: Terminal.Gui.Attribute
  254. description: The make.
  255. content.vb: Public Shared Function Make(foreground As Color, background As Color) As Attribute
  256. overload: Terminal.Gui.Attribute.Make*
  257. modifiers.csharp:
  258. - public
  259. - static
  260. modifiers.vb:
  261. - Public
  262. - Shared
  263. references:
  264. - uid: Terminal.Gui.Attribute
  265. commentId: T:Terminal.Gui.Attribute
  266. parent: Terminal.Gui
  267. name: Attribute
  268. nameWithType: Attribute
  269. fullName: Terminal.Gui.Attribute
  270. - uid: Terminal.Gui.ColorScheme
  271. commentId: T:Terminal.Gui.ColorScheme
  272. parent: Terminal.Gui
  273. name: ColorScheme
  274. nameWithType: ColorScheme
  275. fullName: Terminal.Gui.ColorScheme
  276. - uid: Terminal.Gui
  277. commentId: N:Terminal.Gui
  278. name: Terminal.Gui
  279. nameWithType: Terminal.Gui
  280. fullName: Terminal.Gui
  281. - uid: System.ValueType.Equals(System.Object)
  282. commentId: M:System.ValueType.Equals(System.Object)
  283. parent: System.ValueType
  284. isExternal: true
  285. name: Equals(Object)
  286. nameWithType: ValueType.Equals(Object)
  287. fullName: System.ValueType.Equals(System.Object)
  288. spec.csharp:
  289. - uid: System.ValueType.Equals(System.Object)
  290. name: Equals
  291. nameWithType: ValueType.Equals
  292. fullName: System.ValueType.Equals
  293. isExternal: true
  294. - name: (
  295. nameWithType: (
  296. fullName: (
  297. - uid: System.Object
  298. name: Object
  299. nameWithType: Object
  300. fullName: System.Object
  301. isExternal: true
  302. - name: )
  303. nameWithType: )
  304. fullName: )
  305. spec.vb:
  306. - uid: System.ValueType.Equals(System.Object)
  307. name: Equals
  308. nameWithType: ValueType.Equals
  309. fullName: System.ValueType.Equals
  310. isExternal: true
  311. - name: (
  312. nameWithType: (
  313. fullName: (
  314. - uid: System.Object
  315. name: Object
  316. nameWithType: Object
  317. fullName: System.Object
  318. isExternal: true
  319. - name: )
  320. nameWithType: )
  321. fullName: )
  322. - uid: System.ValueType.GetHashCode
  323. commentId: M:System.ValueType.GetHashCode
  324. parent: System.ValueType
  325. isExternal: true
  326. name: GetHashCode()
  327. nameWithType: ValueType.GetHashCode()
  328. fullName: System.ValueType.GetHashCode()
  329. spec.csharp:
  330. - uid: System.ValueType.GetHashCode
  331. name: GetHashCode
  332. nameWithType: ValueType.GetHashCode
  333. fullName: System.ValueType.GetHashCode
  334. isExternal: true
  335. - name: (
  336. nameWithType: (
  337. fullName: (
  338. - name: )
  339. nameWithType: )
  340. fullName: )
  341. spec.vb:
  342. - uid: System.ValueType.GetHashCode
  343. name: GetHashCode
  344. nameWithType: ValueType.GetHashCode
  345. fullName: System.ValueType.GetHashCode
  346. isExternal: true
  347. - name: (
  348. nameWithType: (
  349. fullName: (
  350. - name: )
  351. nameWithType: )
  352. fullName: )
  353. - uid: System.ValueType.ToString
  354. commentId: M:System.ValueType.ToString
  355. parent: System.ValueType
  356. isExternal: true
  357. name: ToString()
  358. nameWithType: ValueType.ToString()
  359. fullName: System.ValueType.ToString()
  360. spec.csharp:
  361. - uid: System.ValueType.ToString
  362. name: ToString
  363. nameWithType: ValueType.ToString
  364. fullName: System.ValueType.ToString
  365. isExternal: true
  366. - name: (
  367. nameWithType: (
  368. fullName: (
  369. - name: )
  370. nameWithType: )
  371. fullName: )
  372. spec.vb:
  373. - uid: System.ValueType.ToString
  374. name: ToString
  375. nameWithType: ValueType.ToString
  376. fullName: System.ValueType.ToString
  377. isExternal: true
  378. - name: (
  379. nameWithType: (
  380. fullName: (
  381. - name: )
  382. nameWithType: )
  383. fullName: )
  384. - uid: System.Object.Equals(System.Object,System.Object)
  385. commentId: M:System.Object.Equals(System.Object,System.Object)
  386. parent: System.Object
  387. isExternal: true
  388. name: Equals(Object, Object)
  389. nameWithType: Object.Equals(Object, Object)
  390. fullName: System.Object.Equals(System.Object, System.Object)
  391. spec.csharp:
  392. - uid: System.Object.Equals(System.Object,System.Object)
  393. name: Equals
  394. nameWithType: Object.Equals
  395. fullName: System.Object.Equals
  396. isExternal: true
  397. - name: (
  398. nameWithType: (
  399. fullName: (
  400. - uid: System.Object
  401. name: Object
  402. nameWithType: Object
  403. fullName: System.Object
  404. isExternal: true
  405. - name: ', '
  406. nameWithType: ', '
  407. fullName: ', '
  408. - uid: System.Object
  409. name: Object
  410. nameWithType: Object
  411. fullName: System.Object
  412. isExternal: true
  413. - name: )
  414. nameWithType: )
  415. fullName: )
  416. spec.vb:
  417. - uid: System.Object.Equals(System.Object,System.Object)
  418. name: Equals
  419. nameWithType: Object.Equals
  420. fullName: System.Object.Equals
  421. isExternal: true
  422. - name: (
  423. nameWithType: (
  424. fullName: (
  425. - uid: System.Object
  426. name: Object
  427. nameWithType: Object
  428. fullName: System.Object
  429. isExternal: true
  430. - name: ', '
  431. nameWithType: ', '
  432. fullName: ', '
  433. - uid: System.Object
  434. name: Object
  435. nameWithType: Object
  436. fullName: System.Object
  437. isExternal: true
  438. - name: )
  439. nameWithType: )
  440. fullName: )
  441. - uid: System.Object.GetType
  442. commentId: M:System.Object.GetType
  443. parent: System.Object
  444. isExternal: true
  445. name: GetType()
  446. nameWithType: Object.GetType()
  447. fullName: System.Object.GetType()
  448. spec.csharp:
  449. - uid: System.Object.GetType
  450. name: GetType
  451. nameWithType: Object.GetType
  452. fullName: System.Object.GetType
  453. isExternal: true
  454. - name: (
  455. nameWithType: (
  456. fullName: (
  457. - name: )
  458. nameWithType: )
  459. fullName: )
  460. spec.vb:
  461. - uid: System.Object.GetType
  462. name: GetType
  463. nameWithType: Object.GetType
  464. fullName: System.Object.GetType
  465. isExternal: true
  466. - name: (
  467. nameWithType: (
  468. fullName: (
  469. - name: )
  470. nameWithType: )
  471. fullName: )
  472. - uid: System.Object.ReferenceEquals(System.Object,System.Object)
  473. commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
  474. parent: System.Object
  475. isExternal: true
  476. name: ReferenceEquals(Object, Object)
  477. nameWithType: Object.ReferenceEquals(Object, Object)
  478. fullName: System.Object.ReferenceEquals(System.Object, System.Object)
  479. spec.csharp:
  480. - uid: System.Object.ReferenceEquals(System.Object,System.Object)
  481. name: ReferenceEquals
  482. nameWithType: Object.ReferenceEquals
  483. fullName: System.Object.ReferenceEquals
  484. isExternal: true
  485. - name: (
  486. nameWithType: (
  487. fullName: (
  488. - uid: System.Object
  489. name: Object
  490. nameWithType: Object
  491. fullName: System.Object
  492. isExternal: true
  493. - name: ', '
  494. nameWithType: ', '
  495. fullName: ', '
  496. - uid: System.Object
  497. name: Object
  498. nameWithType: Object
  499. fullName: System.Object
  500. isExternal: true
  501. - name: )
  502. nameWithType: )
  503. fullName: )
  504. spec.vb:
  505. - uid: System.Object.ReferenceEquals(System.Object,System.Object)
  506. name: ReferenceEquals
  507. nameWithType: Object.ReferenceEquals
  508. fullName: System.Object.ReferenceEquals
  509. isExternal: true
  510. - name: (
  511. nameWithType: (
  512. fullName: (
  513. - uid: System.Object
  514. name: Object
  515. nameWithType: Object
  516. fullName: System.Object
  517. isExternal: true
  518. - name: ', '
  519. nameWithType: ', '
  520. fullName: ', '
  521. - uid: System.Object
  522. name: Object
  523. nameWithType: Object
  524. fullName: System.Object
  525. isExternal: true
  526. - name: )
  527. nameWithType: )
  528. fullName: )
  529. - uid: System.ValueType
  530. commentId: T:System.ValueType
  531. parent: System
  532. isExternal: true
  533. name: ValueType
  534. nameWithType: ValueType
  535. fullName: System.ValueType
  536. - uid: System.Object
  537. commentId: T:System.Object
  538. parent: System
  539. isExternal: true
  540. name: Object
  541. nameWithType: Object
  542. fullName: System.Object
  543. - uid: System
  544. commentId: N:System
  545. isExternal: true
  546. name: System
  547. nameWithType: System
  548. fullName: System
  549. - uid: Terminal.Gui.Attribute.#ctor*
  550. commentId: Overload:Terminal.Gui.Attribute.#ctor
  551. name: Attribute
  552. nameWithType: Attribute.Attribute
  553. fullName: Terminal.Gui.Attribute.Attribute
  554. - uid: System.Int32
  555. commentId: T:System.Int32
  556. parent: System
  557. isExternal: true
  558. name: Int32
  559. nameWithType: Int32
  560. fullName: System.Int32
  561. - uid: Terminal.Gui.Color
  562. commentId: T:Terminal.Gui.Color
  563. parent: Terminal.Gui
  564. name: Color
  565. nameWithType: Color
  566. fullName: Terminal.Gui.Color
  567. - uid: Terminal.Gui.Attribute.op_Implicit*
  568. commentId: Overload:Terminal.Gui.Attribute.op_Implicit
  569. name: Implicit
  570. nameWithType: Attribute.Implicit
  571. fullName: Terminal.Gui.Attribute.Implicit
  572. nameWithType.vb: Attribute.Widening
  573. fullName.vb: Terminal.Gui.Attribute.Widening
  574. name.vb: Widening
  575. - uid: Terminal.Gui.Attribute.Make*
  576. commentId: Overload:Terminal.Gui.Attribute.Make
  577. name: Make
  578. nameWithType: Attribute.Make
  579. fullName: Terminal.Gui.Attribute.Make
  580. shouldSkipMarkup: true