File: TreeNode.xml

package info (click to toggle)
gtk-sharp3 2.99.3-4.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 25,488 kB
  • sloc: xml: 308,885; cs: 38,796; sh: 11,336; perl: 1,295; makefile: 1,099; ansic: 903
file content (271 lines) | stat: -rw-r--r-- 11,664 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<Type Name="TreeNode" FullName="Gtk.TreeNode">
  <TypeSignature Language="C#" Maintainer="Mike Kestner" Value="public abstract class TreeNode : Gtk.ITreeNode" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TreeNode extends System.Object implements class Gtk.ITreeNode" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
  </AssemblyInfo>
  <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>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Gtk.ITreeNode</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>TreeNode abstract class</summary>
    <remarks>
      <para>
        Convenience class for deriving ITreeNode implementing objects for 
        <see cref="T:Gtk.NodeStore" /> implementations. This class can be subclassed
        to quickly implement a node type without having to implement the tree building
        and navigational aspects of the <see cref="T:Gtk.ITreeNode" /> interface.
      </para>
      <para>
        The following example shows a simple <see cref="T:Gtk.TreeNode" /> subclass:
      </para>
      <example>
        <code lang="C#">
[TreeNode(ColumnCount=1)]
public class MyTreeNode : TreeNode {
	string level;
    
	public MyTreeNode (string level)
	{
		this.level = level;
	}
    
	[TreeNodeValue(Column=0)]
	public string Level { 
		get { 
			return level; 
		} 
		set {
			level = value;
			OnChanged ();
		}
	}
}
        </code>
      </example>
      <para>
        The <see cref="T:Gtk.TreeNode" /> base class provides all the <see cref="T:Gtk.ITreeNode" /> 
        details and MyTreeNode uses <see cref="T:Gtk.TreeNode.OnChanged" /> to notify of tree related 
        node changes.
      </para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TreeNode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>TreeNode constructor</summary>
        <remarks>Default constructor..</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddChild">
      <MemberSignature Language="C#" Value="public void AddChild (Gtk.TreeNode child);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddChild(class Gtk.TreeNode child) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="child" Type="Gtk.TreeNode" />
      </Parameters>
      <Docs>
        <param name="child">a <see cref="T:Gtk.TreeNode" /></param>
        <summary>Appends a child to the node</summary>
        <remarks>Adds the specified <paramref name="child" /> to this <see cref="T:Gtk.ITreeNode" />. 
          The <paramref name="child" /> is added to the end of the children list, the 
          <see cref="P:Gtk.TreeNode.Parent" /> property of <paramref name="child" /> is set to 
          this node, and the <see cref="E:Gtk.TreeNode.ChildAdded" /> event is raised.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddChild">
      <MemberSignature Language="C#" Value="public void AddChild (Gtk.TreeNode child, int position);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddChild(class Gtk.TreeNode child, int32 position) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="child" Type="Gtk.TreeNode" />
        <Parameter Name="position" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="child">a <see cref="T:Gtk.TreeNode" /></param>
        <param name="position">Position among the node's children to insert <paramref name="child" /></param>
        <summary>Inserts a child at the given position</summary>
        <remarks>Adds the specified <paramref name="child" /> to this <see cref="T:Gtk.ITreeNode" />. 
          The <paramref name="child" /> is added to the children list before the child currently
	  at position <paramref name="position" />, the <see cref="P:Gtk.TreeNode.Parent" />
	  property of <paramref name="child" /> is set to this node, and the
	  <see cref="E:Gtk.TreeNode.ChildAdded" /> event is raised.</remarks>
        <since version="Gtk# 2.4" />
      </Docs>
    </Member>
    <Member MemberName="Changed">
      <MemberSignature Language="C#" Value="public event EventHandler Changed;" />
      <MemberSignature Language="ILAsm" Value=".event class System.EventHandler Changed" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Changed event</summary>
        <remarks>
          Raised when the contents of the <see cref="T:Gtk.ITreeNode" /> change.
          Use <see cref="M:Gtk.ITreeNode.OnChange" /> for a convenient way to raise the event.
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ChildAdded">
      <MemberSignature Language="C#" Value="public event Gtk.TreeNodeAddedHandler ChildAdded;" />
      <MemberSignature Language="ILAsm" Value=".event class Gtk.TreeNodeAddedHandler ChildAdded" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.TreeNodeAddedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>ChildAdded event</summary>
        <remarks>Raised when a child <see cref="T:Gtk.ITreeNode" /> is added to the node.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ChildCount">
      <MemberSignature Language="C#" Value="public int ChildCount { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 ChildCount" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>ChildCount</summary>
        <value>a <see cref="T:System.Int32" /></value>
        <remarks>Read-only.  The number of <see cref="T:Gtk.ITreeNode" /> children of this node.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ChildRemoved">
      <MemberSignature Language="C#" Value="public event Gtk.TreeNodeRemovedHandler ChildRemoved;" />
      <MemberSignature Language="ILAsm" Value=".event class Gtk.TreeNodeRemovedHandler ChildRemoved" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.TreeNodeRemovedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>ChildRemoved event</summary>
        <remarks>Raised when a child <see cref="T:Gtk.ITreeNode" /> is removed from the node.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ID">
      <MemberSignature Language="C#" Value="public int ID { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 ID" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>ID property</summary>
        <value>a <see cref="T:System.Int32" /></value>
        <remarks>Read-only.  Provides a unique identifier for all <see cref="T:Gtk.TreeNode" /> instances.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IndexOf">
      <MemberSignature Language="C#" Value="public int IndexOf (object o);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 IndexOf(object o) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="o" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="o">a <see cref="T:System.Object" /></param>
        <summary>IndexOf method</summary>
        <returns>a <see cref="T:System.Int32" /></returns>
        <remarks>
          Returns the child index of <paramref name="o" /> 
          or -1 if <paramref name="o" /> is not a child of this <see cref="T:Gtk.TreeNode" />.
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Item">
      <MemberSignature Language="C#" Value="public Gtk.ITreeNode this[int index] { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Gtk.ITreeNode Item(int32)" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.ITreeNode</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="index" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="index">a <see cref="T:System.Int32" /></param>
        <summary>Child indexer</summary>
        <value>a <see cref="T:Gtk.ITreeNode" /></value>
        <remarks>
          Returns the child at position <paramref name="index" /> in the list of children
          for this <see cref="T:Gtk.ITreeNode" />.
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="OnChanged">
      <MemberSignature Language="C#" Value="protected void OnChanged ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void OnChanged() cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>OnChanged method</summary>
        <remarks>Raises the Changed event. Call this method if any column values of the node change.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Parent">
      <MemberSignature Language="C#" Value="public Gtk.ITreeNode Parent { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Gtk.ITreeNode Parent" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.ITreeNode</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Parent property</summary>
        <value>a <see cref="T:Gtk.ITreeNode" /></value>
        <remarks>Read-only.  The parent <see cref="T:Gtk.ITreeNode" /> for this node.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveChild">
      <MemberSignature Language="C#" Value="public void RemoveChild (Gtk.TreeNode child);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveChild(class Gtk.TreeNode child) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="child" Type="Gtk.TreeNode" />
      </Parameters>
      <Docs>
        <param name="child">a <see cref="T:Gtk.TreeNode" /></param>
        <summary>RemoveChild method</summary>
        <remarks>Removes the specified <paramref name="child" /> from this <see cref="T:Gtk.ITreeNode" />.
          The <see cref="P:Gtk.TreeNode.Parent" /> property of <paramref name="child" /> is set to 
          <see langword="null" /> and the <see cref="E:Gtk.TreeNode.ChildRemoved" /> event is raised.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>