Terminal.Gui.TreeBuilder-1.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  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 TreeBuilder&lt;T&gt;
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TreeBuilder&lt;T&gt;
  11. ">
  12. <meta name="generator" content="docfx 2.56.7.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.TreeBuilder`1">
  73. <h1 id="Terminal_Gui_TreeBuilder_1" data-uid="Terminal.Gui.TreeBuilder`1" class="text-break">Class TreeBuilder&lt;T&gt;
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Abstract implementation of <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>.
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">TreeBuilder&lt;T&gt;</span></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.DelegateTreeBuilder-1.html">DelegateTreeBuilder&lt;T&gt;</a></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.TreeNodeBuilder.html">TreeNodeBuilder</a></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder</a>&lt;T&gt;</div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetHashCode()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.GetType()</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.MemberwiseClone()</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  109. </div>
  110. <div>
  111. <span class="xref">System.Object.ToString()</span>
  112. </div>
  113. </div>
  114. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  115. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  116. <h5 id="Terminal_Gui_TreeBuilder_1_syntax">Syntax</h5>
  117. <div class="codewrapper">
  118. <pre><code class="lang-csharp hljs">public abstract class TreeBuilder&lt;T&gt; : ITreeBuilder&lt;T&gt;</code></pre>
  119. </div>
  120. <h5 class="typeParameters">Type Parameters</h5>
  121. <table class="table table-bordered table-striped table-condensed">
  122. <thead>
  123. <tr>
  124. <th>Name</th>
  125. <th>Description</th>
  126. </tr>
  127. </thead>
  128. <tbody>
  129. <tr>
  130. <td><span class="parametername">T</span></td>
  131. <td></td>
  132. </tr>
  133. </tbody>
  134. </table>
  135. <h3 id="constructors">Constructors
  136. </h3>
  137. <a id="Terminal_Gui_TreeBuilder_1__ctor_" data-uid="Terminal.Gui.TreeBuilder`1.#ctor*"></a>
  138. <h4 id="Terminal_Gui_TreeBuilder_1__ctor_System_Boolean_" data-uid="Terminal.Gui.TreeBuilder`1.#ctor(System.Boolean)">TreeBuilder(Boolean)</h4>
  139. <div class="markdown level1 summary">
  140. Constructs base and initializes <a class="xref" href="Terminal.Gui.TreeBuilder-1.html#Terminal_Gui_TreeBuilder_1_SupportsCanExpand">SupportsCanExpand</a>
  141. </div>
  142. <div class="markdown level1 conceptual"></div>
  143. <h5 class="decalaration">Declaration</h5>
  144. <div class="codewrapper">
  145. <pre><code class="lang-csharp hljs">public TreeBuilder(bool supportsCanExpand)</code></pre>
  146. </div>
  147. <h5 class="parameters">Parameters</h5>
  148. <table class="table table-bordered table-striped table-condensed">
  149. <thead>
  150. <tr>
  151. <th>Type</th>
  152. <th>Name</th>
  153. <th>Description</th>
  154. </tr>
  155. </thead>
  156. <tbody>
  157. <tr>
  158. <td><span class="xref">System.Boolean</span></td>
  159. <td><span class="parametername">supportsCanExpand</span></td>
  160. <td>Pass true if you intend to
  161. implement <a class="xref" href="Terminal.Gui.TreeBuilder-1.html#Terminal_Gui_TreeBuilder_1_CanExpand__0_">CanExpand(T)</a> otherwise false</td>
  162. </tr>
  163. </tbody>
  164. </table>
  165. <h3 id="properties">Properties
  166. </h3>
  167. <a id="Terminal_Gui_TreeBuilder_1_SupportsCanExpand_" data-uid="Terminal.Gui.TreeBuilder`1.SupportsCanExpand*"></a>
  168. <h4 id="Terminal_Gui_TreeBuilder_1_SupportsCanExpand" data-uid="Terminal.Gui.TreeBuilder`1.SupportsCanExpand">SupportsCanExpand</h4>
  169. <div class="markdown level1 summary">
  170. Returns true if <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html#Terminal_Gui_ITreeBuilder_1_CanExpand__0_">CanExpand(T)</a> is implemented by this class
  171. </div>
  172. <div class="markdown level1 conceptual"></div>
  173. <h5 class="decalaration">Declaration</h5>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">public bool SupportsCanExpand { get; protected set; }</code></pre>
  176. </div>
  177. <h5 class="propertyValue">Property Value</h5>
  178. <table class="table table-bordered table-striped table-condensed">
  179. <thead>
  180. <tr>
  181. <th>Type</th>
  182. <th>Description</th>
  183. </tr>
  184. </thead>
  185. <tbody>
  186. <tr>
  187. <td><span class="xref">System.Boolean</span></td>
  188. <td></td>
  189. </tr>
  190. </tbody>
  191. </table>
  192. <h3 id="methods">Methods
  193. </h3>
  194. <a id="Terminal_Gui_TreeBuilder_1_CanExpand_" data-uid="Terminal.Gui.TreeBuilder`1.CanExpand*"></a>
  195. <h4 id="Terminal_Gui_TreeBuilder_1_CanExpand__0_" data-uid="Terminal.Gui.TreeBuilder`1.CanExpand(`0)">CanExpand(T)</h4>
  196. <div class="markdown level1 summary">
  197. Override this method to return a rapid answer as to whether <a class="xref" href="Terminal.Gui.TreeBuilder-1.html#Terminal_Gui_TreeBuilder_1_GetChildren__0_">GetChildren(T)</a>
  198. returns results. If you are implementing this method ensure you passed true in base
  199. constructor or set <a class="xref" href="Terminal.Gui.TreeBuilder-1.html#Terminal_Gui_TreeBuilder_1_SupportsCanExpand">SupportsCanExpand</a>
  200. </div>
  201. <div class="markdown level1 conceptual"></div>
  202. <h5 class="decalaration">Declaration</h5>
  203. <div class="codewrapper">
  204. <pre><code class="lang-csharp hljs">public virtual bool CanExpand(T toExpand)</code></pre>
  205. </div>
  206. <h5 class="parameters">Parameters</h5>
  207. <table class="table table-bordered table-striped table-condensed">
  208. <thead>
  209. <tr>
  210. <th>Type</th>
  211. <th>Name</th>
  212. <th>Description</th>
  213. </tr>
  214. </thead>
  215. <tbody>
  216. <tr>
  217. <td><span class="xref">T</span></td>
  218. <td><span class="parametername">toExpand</span></td>
  219. <td></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <h5 class="returns">Returns</h5>
  224. <table class="table table-bordered table-striped table-condensed">
  225. <thead>
  226. <tr>
  227. <th>Type</th>
  228. <th>Description</th>
  229. </tr>
  230. </thead>
  231. <tbody>
  232. <tr>
  233. <td><span class="xref">System.Boolean</span></td>
  234. <td></td>
  235. </tr>
  236. </tbody>
  237. </table>
  238. <a id="Terminal_Gui_TreeBuilder_1_GetChildren_" data-uid="Terminal.Gui.TreeBuilder`1.GetChildren*"></a>
  239. <h4 id="Terminal_Gui_TreeBuilder_1_GetChildren__0_" data-uid="Terminal.Gui.TreeBuilder`1.GetChildren(`0)">GetChildren(T)</h4>
  240. <div class="markdown level1 summary">
  241. Returns all children of a given <code data-dev-comment-type="paramref" class="paramref">forObject</code> which should be added to the
  242. tree as new branches underneath it
  243. </div>
  244. <div class="markdown level1 conceptual"></div>
  245. <h5 class="decalaration">Declaration</h5>
  246. <div class="codewrapper">
  247. <pre><code class="lang-csharp hljs">public abstract IEnumerable&lt;T&gt; GetChildren(T forObject)</code></pre>
  248. </div>
  249. <h5 class="parameters">Parameters</h5>
  250. <table class="table table-bordered table-striped table-condensed">
  251. <thead>
  252. <tr>
  253. <th>Type</th>
  254. <th>Name</th>
  255. <th>Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td><span class="xref">T</span></td>
  261. <td><span class="parametername">forObject</span></td>
  262. <td></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <h5 class="returns">Returns</h5>
  267. <table class="table table-bordered table-striped table-condensed">
  268. <thead>
  269. <tr>
  270. <th>Type</th>
  271. <th>Description</th>
  272. </tr>
  273. </thead>
  274. <tbody>
  275. <tr>
  276. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
  277. <td></td>
  278. </tr>
  279. </tbody>
  280. </table>
  281. <h3 id="implements">Implements</h3>
  282. <div>
  283. <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder&lt;T&gt;</a>
  284. </div>
  285. </article>
  286. </div>
  287. <div class="hidden-sm col-md-2" role="complementary">
  288. <div class="sideaffix">
  289. <div class="contribution">
  290. <ul class="nav">
  291. </ul>
  292. </div>
  293. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  294. <h5>In This Article</h5>
  295. <div></div>
  296. </nav>
  297. </div>
  298. </div>
  299. </div>
  300. </div>
  301. <footer>
  302. <div class="grad-bottom"></div>
  303. <div class="footer">
  304. <div class="container">
  305. <span class="pull-right">
  306. <a href="#top">Back to top</a>
  307. </span>
  308. <span>Generated by <strong>DocFX</strong></span>
  309. </div>
  310. </div>
  311. </footer>
  312. </div>
  313. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  314. <script type="text/javascript" src="../../styles/docfx.js"></script>
  315. <script type="text/javascript" src="../../styles/main.js"></script>
  316. </body>
  317. </html>