Terminal.Gui.Trees.TreeBuilder-1.html 12 KB

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