1<Type Name="TreePath" FullName="Gtk.TreePath"> 2 <TypeSignature Language="C#" Maintainer="auto" Value="public class TreePath : GLib.Opaque" /> 3 <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TreePath extends GLib.Opaque" /> 4 <AssemblyInfo> 5 <AssemblyName>gtk-sharp</AssemblyName> 6 <AssemblyPublicKey> 7 </AssemblyPublicKey> 8 <AssemblyVersion>2.12.0.0</AssemblyVersion> 9 </AssemblyInfo> 10 <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> 11 <Base> 12 <BaseTypeName>GLib.Opaque</BaseTypeName> 13 </Base> 14 <Interfaces> 15 </Interfaces> 16 <Docs> 17 <summary>Represents a particular node of a <see cref="T:Gtk.TreeView" />.</summary> 18 <remarks>A TreePath can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.</remarks> 19 </Docs> 20 <Members> 21 <Member MemberName=".ctor"> 22 <MemberSignature Language="C#" Value="public TreePath ();" /> 23 <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> 24 <MemberType>Constructor</MemberType> 25 <AssemblyInfo> 26 <AssemblyVersion>2.12.0.0</AssemblyVersion> 27 </AssemblyInfo> 28 <ReturnValue /> 29 <Parameters /> 30 <Docs> 31 <summary>Constructor; builds an empty TreePath.</summary> 32 <remarks /> 33 </Docs> 34 </Member> 35 <Member MemberName=".ctor"> 36 <MemberSignature Language="C#" Value="public TreePath (int[] indices);" /> 37 <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32[] indices) cil managed" /> 38 <MemberType>Constructor</MemberType> 39 <AssemblyInfo> 40 <AssemblyVersion>2.12.0.0</AssemblyVersion> 41 </AssemblyInfo> 42 <ReturnValue /> 43 <Parameters> 44 <Parameter Name="indices" Type="System.Int32[]" /> 45 </Parameters> 46 <Docs> 47 <param name="indices">a <see cref="T:System.Int32" /></param> 48 <summary>Creates a path for a set of indices.</summary> 49 <remarks /> 50 <since version="Gtk# 2.4" /> 51 </Docs> 52 </Member> 53 <Member MemberName=".ctor"> 54 <MemberSignature Language="C#" Value="public TreePath (IntPtr raw);" /> 55 <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" /> 56 <MemberType>Constructor</MemberType> 57 <AssemblyInfo> 58 <AssemblyVersion>2.12.0.0</AssemblyVersion> 59 </AssemblyInfo> 60 <ReturnValue /> 61 <Parameters> 62 <Parameter Name="raw" Type="System.IntPtr" /> 63 </Parameters> 64 <Docs> 65 <param name="raw">Pointer to the C object.</param> 66 <summary>Internal constructor</summary> 67 <remarks> 68 <para>This is an internal constructor, and should not be used by user code.</para> 69 </remarks> 70 </Docs> 71 </Member> 72 <Member MemberName=".ctor"> 73 <MemberSignature Language="C#" Value="public TreePath (string path);" /> 74 <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path) cil managed" /> 75 <MemberType>Constructor</MemberType> 76 <AssemblyInfo> 77 <AssemblyVersion>2.12.0.0</AssemblyVersion> 78 </AssemblyInfo> 79 <ReturnValue /> 80 <Parameters> 81 <Parameter Name="path" Type="System.String" /> 82 </Parameters> 83 <Docs> 84 <param name="path">an object of type <see cref="T:System.String" /></param> 85 <summary>Creates a new <see cref="T:Gtk.TreePath" /> object.</summary> 86 <remarks>The <paramref name="path" /> is expressed in the form "3:2:5". The toplevel or root path would thus be "0".</remarks> 87 </Docs> 88 </Member> 89 <Member MemberName="AppendIndex"> 90 <MemberSignature Language="C#" Value="public void AppendIndex (int index_);" /> 91 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AppendIndex(int32 index_) cil managed" /> 92 <MemberType>Method</MemberType> 93 <AssemblyInfo> 94 <AssemblyVersion>2.12.0.0</AssemblyVersion> 95 </AssemblyInfo> 96 <ReturnValue> 97 <ReturnType>System.Void</ReturnType> 98 </ReturnValue> 99 <Parameters> 100 <Parameter Name="index_" Type="System.Int32" /> 101 </Parameters> 102 <Docs> 103 <param name="index_">a <see cref="T:System.Int32" />, the index to append</param> 104 <summary>Appends a new index to a path. As a result, the depth of the path is increased.</summary> 105 <remarks /> 106 </Docs> 107 </Member> 108 <Member MemberName="Compare"> 109 <MemberSignature Language="C#" Value="public int Compare (Gtk.TreePath b);" /> 110 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance int32 Compare(class Gtk.TreePath b) cil managed" /> 111 <MemberType>Method</MemberType> 112 <AssemblyInfo> 113 <AssemblyVersion>2.12.0.0</AssemblyVersion> 114 </AssemblyInfo> 115 <ReturnValue> 116 <ReturnType>System.Int32</ReturnType> 117 </ReturnValue> 118 <Parameters> 119 <Parameter Name="b" Type="Gtk.TreePath" /> 120 </Parameters> 121 <Docs> 122 <param name="b">an object of type <see cref="T:Gtk.TreePath" />, the path to compare</param> 123 <summary>Compares two paths. If this path appears before <see cref="T:Gtk.TreePath" /> b in a tree, then -1 is returned. If the parameter path appears before this path, then 1 is returned. If the two nodes are equal, then 0 is returned.</summary> 124 <returns>an object of type <see cref="T:System.Int32" /></returns> 125 <remarks /> 126 </Docs> 127 </Member> 128 <Member MemberName="Copy"> 129 <MemberSignature Language="C#" Value="public Gtk.TreePath Copy ();" /> 130 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Gtk.TreePath Copy() cil managed" /> 131 <MemberType>Method</MemberType> 132 <AssemblyInfo> 133 <AssemblyVersion>2.12.0.0</AssemblyVersion> 134 </AssemblyInfo> 135 <ReturnValue> 136 <ReturnType>Gtk.TreePath</ReturnType> 137 </ReturnValue> 138 <Parameters /> 139 <Docs> 140 <summary>Copies a TreePath into a new TreePath object.</summary> 141 <returns>an object of type <see cref="T:Gtk.TreePath" />, the new copy</returns> 142 <remarks /> 143 </Docs> 144 </Member> 145 <Member MemberName="Depth"> 146 <MemberSignature Language="C#" Value="public int Depth { get; }" /> 147 <MemberSignature Language="ILAsm" Value=".property instance int32 Depth" /> 148 <MemberType>Property</MemberType> 149 <AssemblyInfo> 150 <AssemblyVersion>2.12.0.0</AssemblyVersion> 151 </AssemblyInfo> 152 <ReturnValue> 153 <ReturnType>System.Int32</ReturnType> 154 </ReturnValue> 155 <Docs> 156 <summary>Returns the current depth of the TreePath.</summary> 157 <value>an object of type <see cref="T:System.Int32" /></value> 158 <remarks /> 159 </Docs> 160 </Member> 161 <Member MemberName="Down"> 162 <MemberSignature Language="C#" Value="public void Down ();" /> 163 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Down() cil managed" /> 164 <MemberType>Method</MemberType> 165 <AssemblyInfo> 166 <AssemblyVersion>2.12.0.0</AssemblyVersion> 167 </AssemblyInfo> 168 <ReturnValue> 169 <ReturnType>System.Void</ReturnType> 170 </ReturnValue> 171 <Parameters /> 172 <Docs> 173 <summary>Changes this TreePath object to refer to its own first child.</summary> 174 <remarks>FIXME: make sure this is right.</remarks> 175 </Docs> 176 </Member> 177 <Member MemberName="Equals"> 178 <MemberSignature Language="C#" Value="public override bool Equals (object o);" /> 179 <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object o) cil managed" /> 180 <MemberType>Method</MemberType> 181 <AssemblyInfo> 182 <AssemblyVersion>2.12.0.0</AssemblyVersion> 183 </AssemblyInfo> 184 <ReturnValue> 185 <ReturnType>System.Boolean</ReturnType> 186 </ReturnValue> 187 <Parameters> 188 <Parameter Name="o" Type="System.Object" /> 189 </Parameters> 190 <Docs> 191 <param name="o">To be added.</param> 192 <summary>To be added.</summary> 193 <returns>To be added.</returns> 194 <remarks>To be added.</remarks> 195 </Docs> 196 </Member> 197 <Member MemberName="Finalize"> 198 <MemberSignature Language="C#" Value="~TreePath ();" /> 199 <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" /> 200 <MemberType>Method</MemberType> 201 <AssemblyInfo> 202 <AssemblyVersion>2.12.0.0</AssemblyVersion> 203 </AssemblyInfo> 204 <ReturnValue> 205 <ReturnType>System.Void</ReturnType> 206 </ReturnValue> 207 <Parameters /> 208 <Docs> 209 <summary>To be added.</summary> 210 <remarks>To be added.</remarks> 211 </Docs> 212 </Member> 213 <Member MemberName="Free"> 214 <MemberSignature Language="C#" Value="public void Free ();" /> 215 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Free() cil managed" /> 216 <MemberType>Method</MemberType> 217 <AssemblyInfo> 218 <AssemblyVersion>2.12.0.0</AssemblyVersion> 219 </AssemblyInfo> 220 <Attributes> 221 <Attribute> 222 <AttributeName>System.Obsolete("Gtk.TreePath is now freed automatically")</AttributeName> 223 </Attribute> 224 </Attributes> 225 <ReturnValue> 226 <ReturnType>System.Void</ReturnType> 227 </ReturnValue> 228 <Parameters /> 229 <Docs> 230 <summary>Disposes of the TreePath object and any resources it was using.</summary> 231 <remarks /> 232 </Docs> 233 </Member> 234 <Member MemberName="Free"> 235 <MemberSignature Language="C#" Value="protected override void Free (IntPtr raw);" /> 236 <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Free(native int raw) cil managed" /> 237 <MemberType>Method</MemberType> 238 <AssemblyInfo> 239 <AssemblyVersion>2.12.0.0</AssemblyVersion> 240 </AssemblyInfo> 241 <ReturnValue> 242 <ReturnType>System.Void</ReturnType> 243 </ReturnValue> 244 <Parameters> 245 <Parameter Name="raw" Type="System.IntPtr" /> 246 </Parameters> 247 <Docs> 248 <param name="raw">To be added.</param> 249 <summary>To be added.</summary> 250 <remarks>To be added.</remarks> 251 </Docs> 252 </Member> 253 <Member MemberName="GType"> 254 <MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" /> 255 <MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" /> 256 <MemberType>Property</MemberType> 257 <AssemblyInfo> 258 <AssemblyVersion>2.12.0.0</AssemblyVersion> 259 </AssemblyInfo> 260 <ReturnValue> 261 <ReturnType>GLib.GType</ReturnType> 262 </ReturnValue> 263 <Parameters /> 264 <Docs> 265 <summary>GType Property.</summary> 266 <value>a <see cref="T:GLib.GType" /></value> 267 <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.TreePath" />.</remarks> 268 </Docs> 269 </Member> 270 <Member MemberName="Indices"> 271 <MemberSignature Language="C#" Value="public int[] Indices { get; }" /> 272 <MemberSignature Language="ILAsm" Value=".property instance int32[] Indices" /> 273 <MemberType>Property</MemberType> 274 <AssemblyInfo> 275 <AssemblyVersion>2.12.0.0</AssemblyVersion> 276 </AssemblyInfo> 277 <ReturnValue> 278 <ReturnType>System.Int32[]</ReturnType> 279 </ReturnValue> 280 <Parameters /> 281 <Docs> 282 <summary>Returns the current indices of the TreePath. This is an array of integers, each representing a node in a tree. This value should not be freed.</summary> 283 <value>a <see cref="T:System.Int32[]" /></value> 284 <remarks /> 285 </Docs> 286 </Member> 287 <Member MemberName="IsAncestor"> 288 <MemberSignature Language="C#" Value="public bool IsAncestor (Gtk.TreePath descendant);" /> 289 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsAncestor(class Gtk.TreePath descendant) cil managed" /> 290 <MemberType>Method</MemberType> 291 <AssemblyInfo> 292 <AssemblyVersion>2.12.0.0</AssemblyVersion> 293 </AssemblyInfo> 294 <ReturnValue> 295 <ReturnType>System.Boolean</ReturnType> 296 </ReturnValue> 297 <Parameters> 298 <Parameter Name="descendant" Type="Gtk.TreePath" /> 299 </Parameters> 300 <Docs> 301 <param name="descendant">an object of type <see cref="T:Gtk.TreePath" />, the potential descendant</param> 302 <summary>Tests whether this TreePath is an ancestor of a given TreePath</summary> 303 <returns>an object of type <see cref="T:System.Boolean" />, returns true if this TreePath is an ancestor of the given TreePath.</returns> 304 <remarks /> 305 </Docs> 306 </Member> 307 <Member MemberName="IsDescendant"> 308 <MemberSignature Language="C#" Value="public bool IsDescendant (Gtk.TreePath ancestor);" /> 309 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsDescendant(class Gtk.TreePath ancestor) cil managed" /> 310 <MemberType>Method</MemberType> 311 <AssemblyInfo> 312 <AssemblyVersion>2.12.0.0</AssemblyVersion> 313 </AssemblyInfo> 314 <ReturnValue> 315 <ReturnType>System.Boolean</ReturnType> 316 </ReturnValue> 317 <Parameters> 318 <Parameter Name="ancestor" Type="Gtk.TreePath" /> 319 </Parameters> 320 <Docs> 321 <param name="ancestor">an object of type <see cref="T:Gtk.TreePath" />, the potential ancestor to test</param> 322 <summary>Tests whether this TreePath is a descendant of a particular TreePath.</summary> 323 <returns>an object of type <see cref="T:System.Boolean" />, true if this TreePath is the other TreePath's descendant.</returns> 324 <remarks /> 325 </Docs> 326 </Member> 327 <Member MemberName="NewFirst"> 328 <MemberSignature Language="C#" Value="public static Gtk.TreePath NewFirst ();" /> 329 <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gtk.TreePath NewFirst() cil managed" /> 330 <MemberType>Method</MemberType> 331 <AssemblyInfo> 332 <AssemblyVersion>2.12.0.0</AssemblyVersion> 333 </AssemblyInfo> 334 <ReturnValue> 335 <ReturnType>Gtk.TreePath</ReturnType> 336 </ReturnValue> 337 <Parameters /> 338 <Docs> 339 <summary>Creates a new GtkTreePath.</summary> 340 <returns>an object of type <see cref="T:Gtk.TreePath" /></returns> 341 <remarks>The string representation of this path is "0".</remarks> 342 </Docs> 343 </Member> 344 <Member MemberName="Next"> 345 <MemberSignature Language="C#" Value="public void Next ();" /> 346 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Next() cil managed" /> 347 <MemberType>Method</MemberType> 348 <AssemblyInfo> 349 <AssemblyVersion>2.12.0.0</AssemblyVersion> 350 </AssemblyInfo> 351 <ReturnValue> 352 <ReturnType>System.Void</ReturnType> 353 </ReturnValue> 354 <Parameters /> 355 <Docs> 356 <summary>Moves the TreePath to point to the next node at the current depth.</summary> 357 <remarks /> 358 </Docs> 359 </Member> 360 <Member MemberName="PrependIndex"> 361 <MemberSignature Language="C#" Value="public void PrependIndex (int index_);" /> 362 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void PrependIndex(int32 index_) cil managed" /> 363 <MemberType>Method</MemberType> 364 <AssemblyInfo> 365 <AssemblyVersion>2.12.0.0</AssemblyVersion> 366 </AssemblyInfo> 367 <ReturnValue> 368 <ReturnType>System.Void</ReturnType> 369 </ReturnValue> 370 <Parameters> 371 <Parameter Name="index_" Type="System.Int32" /> 372 </Parameters> 373 <Docs> 374 <param name="index_">a <see cref="T:System.Int32" />, the index to prepend</param> 375 <summary>Prepends a new index to a path. As a result, the depth of the path is increased.</summary> 376 <remarks /> 377 </Docs> 378 </Member> 379 <Member MemberName="Prev"> 380 <MemberSignature Language="C#" Value="public bool Prev ();" /> 381 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Prev() cil managed" /> 382 <MemberType>Method</MemberType> 383 <AssemblyInfo> 384 <AssemblyVersion>2.12.0.0</AssemblyVersion> 385 </AssemblyInfo> 386 <ReturnValue> 387 <ReturnType>System.Boolean</ReturnType> 388 </ReturnValue> 389 <Parameters /> 390 <Docs> 391 <summary>Moves the TreePath to point to the previous node at the current depth, if it exists.</summary> 392 <returns>an object of type <see cref="T:System.Boolean" />, true if the path has a previous node and the move was made successfully.</returns> 393 <remarks /> 394 </Docs> 395 </Member> 396 <Member MemberName="ToString"> 397 <MemberSignature Language="C#" Value="public override string ToString ();" /> 398 <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" /> 399 <MemberType>Method</MemberType> 400 <AssemblyInfo> 401 <AssemblyVersion>2.12.0.0</AssemblyVersion> 402 </AssemblyInfo> 403 <ReturnValue> 404 <ReturnType>System.String</ReturnType> 405 </ReturnValue> 406 <Parameters /> 407 <Docs> 408 <summary>To be added.</summary> 409 <returns>To be added.</returns> 410 <remarks>To be added.</remarks> 411 </Docs> 412 </Member> 413 <Member MemberName="Up"> 414 <MemberSignature Language="C#" Value="public bool Up ();" /> 415 <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Up() cil managed" /> 416 <MemberType>Method</MemberType> 417 <AssemblyInfo> 418 <AssemblyVersion>2.12.0.0</AssemblyVersion> 419 </AssemblyInfo> 420 <ReturnValue> 421 <ReturnType>System.Boolean</ReturnType> 422 </ReturnValue> 423 <Parameters /> 424 <Docs> 425 <summary>Moves the TreePath to point to its parent node, if it has a parent.</summary> 426 <returns>an object of type <see cref="T:System.Boolean" />, true if the path has a previous node and the move was made successfully.</returns> 427 <remarks /> 428 </Docs> 429 </Member> 430 </Members> 431</Type> 432