/[TS3.SkuReader]/tags/1.0.0.13216/s3pi.GenericRCOLResource.xml
ViewVC logotype

Contents of /tags/1.0.0.13216/s3pi.GenericRCOLResource.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 82 - (show annotations) (download) (as text)
Mon Feb 10 21:30:07 2014 UTC (6 years ago) by william
File MIME type: text/xml
File size: 41525 byte(s)
tag 1.0.0.13216
1 <?xml version="1.0"?>
2 <doc>
3 <assembly>
4 <name>s3pi.GenericRCOLResource</name>
5 </assembly>
6 <members>
7 <member name="T:s3pi.Interfaces.ARCOLBlock">
8 <summary>
9 Represents the abstract RCOL block within a <see cref="N:s3pi.GenericRCOLResource"/>.
10 </summary>
11 </member>
12 <member name="T:s3pi.Interfaces.IRCOLBlock">
13 <summary>
14 Defines the interface exposed by an RCOL block.
15 </summary>
16 </member>
17 <member name="M:s3pi.Interfaces.IRCOLBlock.UnParse">
18 <summary>
19 Writes the content of the RCOL block to a stream
20 </summary>
21 <returns>A stream containing the current content of the RCOL block</returns>
22 </member>
23 <member name="P:s3pi.Interfaces.IRCOLBlock.Tag">
24 <summary>
25 The four byte tag for the RCOL block, may be null if none present
26 </summary>
27 </member>
28 <member name="P:s3pi.Interfaces.IRCOLBlock.ResourceType">
29 <summary>
30 The ResourceType for the RCOL block, used to determine which specific RCOL handlers are available
31 </summary>
32 </member>
33 <member name="F:s3pi.Interfaces.ARCOLBlock.requestedAPIversion">
34 <summary>
35 Holds the requested API version.
36 </summary>
37 </member>
38 <member name="F:s3pi.Interfaces.ARCOLBlock.stream">
39 <summary>
40 Holds the stream from which the block was read.
41 </summary>
42 <remarks>Note that the state of the stream may change once the <see cref="M:s3pi.Interfaces.ARCOLBlock.Parse(System.IO.Stream)"/> method completes.</remarks>
43 </member>
44 <member name="M:s3pi.Interfaces.ARCOLBlock.#ctor(System.Int32,System.EventHandler,System.IO.Stream)">
45 <summary>
46 Create a new instance based on the data in the supplied <see cref="P:s3pi.Interfaces.ARCOLBlock.Stream"/>.
47 </summary>
48 <param name="APIversion">The requested API version.</param>
49 <param name="handler">The change event handler for the resource.</param>
50 <param name="s">The <see cref="P:s3pi.Interfaces.ARCOLBlock.Stream"/> containing the data.</param>
51 <seealso cref="M:s3pi.Interfaces.ARCOLBlock.Parse(System.IO.Stream)"/>
52 </member>
53 <member name="M:s3pi.Interfaces.ARCOLBlock.Parse(System.IO.Stream)">
54 <summary>
55 Any implementation must provide a method of reading data from the resource.
56 </summary>
57 <param name="s">The <see cref="P:s3pi.Interfaces.ARCOLBlock.Stream"/> referencing the data in the resource, position to the start of this block.</param>
58 <remarks>Any implementation must ensure the stream position ends at the first byte of the next block.</remarks>
59 </member>
60 <member name="M:s3pi.Interfaces.ARCOLBlock.Clone(System.EventHandler)">
61 <summary>
62 Implementing classes must provide a means of creating a copy of themselves.
63 </summary>
64 <param name="handler">The <see cref="T:System.EventHandler"/> for the new instance.</param>
65 <returns>A new instance of the class with identical values, with the given change <see cref="T:System.EventHandler"/>.</returns>
66 </member>
67 <member name="M:s3pi.Interfaces.ARCOLBlock.UnParse">
68 <summary>
69 Implementing classes must provide a means of storing themselves in a <see cref="P:s3pi.Interfaces.ARCOLBlock.Stream"/>.
70 </summary>
71 <returns>The <see cref="P:s3pi.Interfaces.ARCOLBlock.Stream"/> containing the data from the RCOL block.</returns>
72 </member>
73 <member name="M:s3pi.Interfaces.ARCOLBlock.Equals(s3pi.Interfaces.ARCOLBlock)">
74 <summary>
75 Indicates whether the current <see cref="T:s3pi.Interfaces.ARCOLBlock"/> is equal to another instance.
76 </summary>
77 <param name="other">Another instance to compare with this <see cref="T:s3pi.Interfaces.ARCOLBlock"/>.</param>
78 <returns><c>true</c> if the current <see cref="T:s3pi.Interfaces.ARCOLBlock"/> is equal to the <paramref name="other"/> parameter;
79 otherwise, <c>false</c>.</returns>
80 </member>
81 <member name="M:s3pi.Interfaces.ARCOLBlock.Equals(System.Object)">
82 <summary>
83 Indicates whether the current <see cref="T:s3pi.Interfaces.ARCOLBlock"/> is equal to another object of the same type.
84 </summary>
85 <param name="obj">An object to compare with this <see cref="T:s3pi.Interfaces.ARCOLBlock"/>.</param>
86 <returns><c>true</c> if the current <see cref="T:s3pi.Interfaces.ARCOLBlock"/> is equal to the <paramref name="obj"/> parameter;
87 otherwise, <c>false</c>.</returns>
88 </member>
89 <member name="M:s3pi.Interfaces.ARCOLBlock.GetHashCode">
90 <summary>
91 Serves as a hash function for an <see cref="T:s3pi.Interfaces.ARCOLBlock"/>.
92 </summary>
93 <returns>A hash code for the current <see cref="T:s3pi.Interfaces.ARCOLBlock"/>.</returns>
94 </member>
95 <member name="M:s3pi.Interfaces.ARCOLBlock.OnRCOLChanged(System.Object,System.EventArgs)">
96 <summary>
97 Used to indicate the RCOL has changed.
98 </summary>
99 </member>
100 <member name="P:s3pi.Interfaces.ARCOLBlock.ValueBuilderFields">
101 <summary>
102 Remove the additional &quot;banned&quot; fields for an RCOL block.
103 </summary>
104 </member>
105 <member name="P:s3pi.Interfaces.ARCOLBlock.ContentFields">
106 <summary>
107 The list of available field names on this API object
108 </summary>
109 </member>
110 <member name="P:s3pi.Interfaces.ARCOLBlock.RecommendedApiVersion">
111 <summary>
112 Unless overridden in an implementing class, returns <c>1</c>.
113 </summary>
114 </member>
115 <member name="P:s3pi.Interfaces.ARCOLBlock.Tag">
116 <summary>
117 The &quot;FOUR CC&quot; tag identifying this RCOL block; may be <c>null</c> if not present.
118 </summary>
119 </member>
120 <member name="P:s3pi.Interfaces.ARCOLBlock.ResourceType">
121 <summary>
122 The Resource Type identifying this block format.
123 </summary>
124 </member>
125 <member name="P:s3pi.Interfaces.ARCOLBlock.Stream">
126 <summary>
127 The resource content as a Stream
128 </summary>
129 </member>
130 <member name="P:s3pi.Interfaces.ARCOLBlock.AsBytes">
131 <summary>
132 The resource content as a byte array
133 </summary>
134 </member>
135 <member name="E:s3pi.Interfaces.ARCOLBlock.ResourceChanged">
136 <summary>
137 Raised if the resource is changed
138 </summary>
139 </member>
140 <member name="P:s3pi.Interfaces.ARCOLBlock.Data">
141 <summary>
142 To allow editor import/export as a minimum.
143 </summary>
144 </member>
145 <member name="T:s3pi.GenericRCOLResource.GenericRCOLResource">
146 <summary>
147 A resource wrapper that understands RCOL resources and manages the blocks within.
148 </summary>
149 </member>
150 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.#ctor(System.Int32,System.IO.Stream)">
151 <summary>
152 Instantiate a new GenericRCOLResource from the supplied <see cref="T:System.IO.Stream"/>.
153 </summary>
154 <param name="APIversion">Unused; requested API version.</param>
155 <param name="s">The <see cref="T:System.IO.Stream"/> to read the resource in from.</param>
156 </member>
157 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.UnParse">
158 <summary>
159 Return a <see cref="T:System.IO.Stream"/> containing the data in this GenericRCOLResource instance.
160 </summary>
161 <returns>A <see cref="T:System.IO.Stream"/> containing the data in this GenericRCOLResource instance.</returns>
162 </member>
163 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.RecommendedApiVersion">
164 <summary>
165 Return the version number that this wrapper prefers to be called with (the default if passed zero).
166 </summary>
167 <remarks>This wrapper returns <c>1</c> and is not sensitive to API version.</remarks>
168 </member>
169 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.Version">
170 <summary>
171 The version of this RCOL resource.
172 </summary>
173 </member>
174 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.PublicChunks">
175 <summary>
176 The number of &quot;public&quot; RCOL blocks in the resource.
177 </summary>
178 </member>
179 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.Unused">
180 <summary>
181 Unknown.
182 </summary>
183 </member>
184 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.Resources">
185 <summary>
186 The list of <see cref="T:s3pi.Interfaces.TGIBlock"/>s referenced for resources external to this resource.
187 </summary>
188 </member>
189 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntries">
190 <summary>
191 The list of <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> values for RCOL blocks within this resource.
192 </summary>
193 </member>
194 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.Value">
195 <summary>
196 A displayable string representing the content of this resource.
197 </summary>
198 </member>
199 <member name="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry">
200 <summary>
201 <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> couples the
202 <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.TGIBlock"/> identifier with the <see cref="T:s3pi.Interfaces.ARCOLBlock"/> for ease of handling in a single list.
203 </summary>
204 </member>
205 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.#ctor(System.Int32,System.EventHandler,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry)">
206 <summary>
207 Create a ChunkEntry from an existing <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/>.
208 </summary>
209 <param name="APIversion">Unused; the requested API version.</param>
210 <param name="handler">The change event handler.</param>
211 <param name="basis">An existing <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> to use as a basis.</param>
212 </member>
213 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.TGIBlock,s3pi.Interfaces.ARCOLBlock)">
214 <summary>
215 Create a ChunkEntry from an existing <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.TGIBlock"/> and an existing <see cref="T:s3pi.Interfaces.ARCOLBlock"/>.
216 </summary>
217 <param name="APIversion">Unused; the requested API version.</param>
218 <param name="handler">The change event handler.</param>
219 <param name="tgiBlock">An existing <see cref="T:TGIBlock"/>.</param>
220 <param name="rcolBlock">An existing <see cref="T:s3pi.Interfaces.ARCOLBlock"/>.</param>
221 </member>
222 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.Clone(System.EventHandler)">
223 <summary>
224 Get a copy of the <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> but with a new change <see cref="T:System.EventHandler"/>.
225 </summary>
226 <param name="handler">The replacement <see cref="T:System.EventHandler"/> delegate.</param>
227 <returns>Return a copy of the <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> but with a new change <see cref="T:System.EventHandler"/>.</returns>
228 </member>
229 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.Equals(s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry)">
230 <summary>
231 Indicates whether the current <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> is equal to another instance.
232 </summary>
233 <param name="other">Another instance to compare with this <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/>.</param>
234 <returns><c>true</c> if the current <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> is equal to the <paramref name="other"/> parameter;
235 otherwise, <c>false</c>.</returns>
236 </member>
237 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.Equals(System.Object)">
238 <summary>
239 Indicates whether the current <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> is equal to another object of the same type.
240 </summary>
241 <param name="obj">An object to compare with this <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/>.</param>
242 <returns><c>true</c> if the current <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> is equal to the <paramref name="obj"/> parameter;
243 otherwise, <c>false</c>.</returns>
244 </member>
245 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.GetHashCode">
246 <summary>
247 Serves as a hash function for an <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/>.
248 </summary>
249 <returns>A hash code for the current <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/>.</returns>
250 </member>
251 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.RecommendedApiVersion">
252 <summary>
253 Return the version number that this class prefers to be called with (the default if passed zero).
254 </summary>
255 <remarks>This class returns <c>1</c> and is not sensitive to API version.</remarks>
256 </member>
257 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.ContentFields">
258 <summary>
259 The visible-to-API list of fields in this class.
260 </summary>
261 </member>
262 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.TGIBlock">
263 <summary>
264 The <see cref="T:TGIBlock"/> that identifies the RCOL block.
265 </summary>
266 </member>
267 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.RCOLBlock">
268 <summary>
269 The RCOL block.
270 </summary>
271 </member>
272 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.Value">
273 <summary>
274 Returns a formatted string containing the <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.TGIBlock"/> and, where possible, <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry.RCOLBlock"/> values.
275 </summary>
276 </member>
277 <member name="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList">
278 <summary>
279 A <see cref="T:s3pi.Interfaces.DependentList`1"/> containing <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> values.
280 </summary>
281 </member>
282 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList.#ctor(System.EventHandler)">
283 <summary>
284 Create an empty list.
285 </summary>
286 <param name="handler">The list change <see cref="T:System.EventHandler"/> delegate.</param>
287 </member>
288 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList.#ctor(System.EventHandler,System.Collections.Generic.IEnumerable{s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry})">
289 <summary>
290 Create a new list, with the contents from the provided enumeration.
291 </summary>
292 <param name="handler">The list change <see cref="T:System.EventHandler"/> delegate.</param>
293 <param name="ice">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry"/> values.</param>
294 </member>
295 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList.CreateElement(System.IO.Stream)">
296 <summary>
297 CreateElement is not implemented.
298 </summary>
299 <param name="s">Unused.</param>
300 <returns>Not implemented.</returns>
301 <exception cref="T:System.NotImplementedException">Thrown if CreateElement is invoked.</exception>
302 </member>
303 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList.WriteElement(System.IO.Stream,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntry)">
304 <summary>
305 WriteElement is not implemented.
306 </summary>
307 <param name="s">Unused.</param>
308 <param name="element">Unused.</param>
309 <exception cref="T:System.NotImplementedException">Thrown if WriteElement is invoked.</exception>
310 </member>
311 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList.Add">
312 <summary>
313 <see cref="M:s3pi.Interfaces.IGenericAdd.Add"/> is not implemented.
314 </summary>
315 <exception cref="T:System.NotImplementedException">Thrown if <see cref="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntryList.Add"/> is invoked.</exception>
316 </member>
317 <member name="T:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType">
318 <summary>
319 The indicator bits for a <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.
320 </summary>
321 </member>
322 <member name="F:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType.Public">
323 <summary>
324 Indicates the reference is to this resource, in <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntries"/>, below <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.PublicChunks"/>.
325 </summary>
326 </member>
327 <member name="F:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType.Private">
328 <summary>
329 Indicates the reference is to this resource, in <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntries"/>, at or above <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.PublicChunks"/>.
330 </summary>
331 </member>
332 <member name="F:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType.External">
333 <summary>
334 No known usage.
335 </summary>
336 </member>
337 <member name="F:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType.Delayed">
338 <summary>
339 Indicates the reference is to another resource, via <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.Resources"/>
340 </summary>
341 </member>
342 <member name="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference">
343 <summary>
344 Manages RCOL references to other RCOL blocks or other resources.
345 </summary>
346 </member>
347 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.#ctor(System.Int32,System.EventHandler,System.IO.Stream)">
348 <summary>
349 Create a new instance from data in the provided <see cref="T:System.IO.Stream"/>.
350 </summary>
351 <param name="APIversion">Unused; requested API version.</param>
352 <param name="handler">Change <see cref="T:System.EventHandler"/> delegate.</param>
353 <param name="s">The <see cref="T:System.IO.Stream"/> containing the data.</param>
354 </member>
355 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.#ctor(System.Int32,System.EventHandler,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
356 <summary>
357 Create a new instance based on the provided existing instance.
358 </summary>
359 <param name="APIversion">Unused; requested API version.</param>
360 <param name="handler">Change <see cref="T:System.EventHandler"/> delegate.</param>
361 <param name="basis">An existing instance.</param>
362 </member>
363 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.#ctor(System.Int32,System.EventHandler,System.UInt32)">
364 <summary>
365 Create a new instance from the provided <see cref="T:System.UInt32"/> value.
366 </summary>
367 <param name="APIversion">Unused; requested API version.</param>
368 <param name="handler">Change <see cref="T:System.EventHandler"/> delegate.</param>
369 <param name="chunkReference">The chunk reference as a "raw" <see cref="T:System.UInt32"/>.</param>
370 </member>
371 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.UnParse(System.IO.Stream)">
372 <summary>
373 Write this instance to the provided <see cref="T:System.IO.Stream"/>.
374 </summary>
375 <param name="s">The <see cref="T:System.IO.Stream"/> to write out to.</param>
376 </member>
377 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.Clone(System.EventHandler)">
378 <summary>
379 Return a new instance with the same value as the current instance but with the given change <see cref="T:System.EventHandler"/>.
380 </summary>
381 <param name="handler">The change <see cref="T:System.EventHandler"/>.</param>
382 <returns>A new instance with the same value as the current instance but with the given change <see cref="T:System.EventHandler"/>.</returns>
383 </member>
384 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.Equals(s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
385 <summary>
386 Returns a value indicating whether this instance is equal to a specified
387 <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.
388 </summary>
389 <param name="other">A <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> value to compare to this instance.</param>
390 <returns>
391 <c>true</c> if obj has the same value as this instance;
392 otherwise, <c>false</c>.
393 </returns>
394 </member>
395 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.Equals(System.Object)">
396 <summary>
397 Returns a value indicating whether this instance is equal to a specified
398 <see cref="T:System.Object"/>.
399 </summary>
400 <param name="obj">An <see cref="T:System.Object"/> to compare with this instance.</param>
401 <returns>
402 <c>true</c> if <paramref name="obj"/> is an instance of <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>
403 and equals the value of this instance;
404 otherwise, <c>false</c>.
405 </returns>
406 </member>
407 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.GetHashCode">
408 <summary>
409 Returns the hash code for this instance.
410 </summary>
411 <returns>A 32-bit signed integer hash code.</returns>
412 </member>
413 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.Equals(s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
414 <summary>
415 Determines whether the specified <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> instances are equal.
416 </summary>
417 <param name="x">The first <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> to compare.</param>
418 <param name="y">The second <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> to compare.</param>
419 <returns>
420 <c>true</c> if the specified <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> instances are equal;
421 otherwise, <c>false</c>.
422 </returns>
423 </member>
424 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.GetHashCode(s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
425 <summary>
426 Returns a hash code for the specified object.
427 </summary>
428 <param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param>
429 <returns>A hash code for the specified object.</returns>
430 <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is <c>null</c>.</exception>
431 </member>
432 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.CompareTo(s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
433 <summary>
434 Compares the current <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> with another <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.
435 </summary>
436 <param name="other">Another <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> to compare with this one.</param>
437 <returns>
438 A 32-bit signed integer that indicates the relative order of the <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> instances
439 being compared. The return value has the following meanings:
440 <table>
441 <thead>
442 <tr><td>Value</td><td>Meaning</td></tr>
443 </thead>
444 <tbody>
445 <tr><td>Less than zero</td><td>This object is less than the <paramref name="other"/> parameter.</td></tr>
446 <tr><td>Zero</td><td>This object is equal to <paramref name="other"/>.</td></tr>
447 <tr><td>Greater than zero</td><td>This object is greater than <paramref name="other"/>.</td></tr>
448 </tbody>
449 </table>
450 </returns>
451 </member>
452 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.Compare(s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
453 <summary>
454 Compares two <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> instances and returns a value indicating whether one is
455 less than, equal to, or greater than the other.
456 </summary>
457 <param name="x">The first <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> instance to compare.</param>
458 <param name="y">The second <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> instance to compare.</param>
459 <returns>
460 <table>
461 <thead>
462 <tr><td>Value</td><td>Condition</td></tr>
463 </thead>
464 <tbody>
465 <tr><td>Less than zero</td><td><paramref name="x"/> is less than <paramref name="y"/>.</td></tr>
466 <tr><td>Zero</td><td><paramref name="x"/> equals <paramref name="y"/>.</td></tr>
467 <tr><td>Greater than zero</td><td><paramref name="x"/> is greater than <paramref name="y"/>.</td></tr>
468 </tbody>
469 </table>
470 </returns>
471 </member>
472 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.GetKey(s3pi.GenericRCOLResource.GenericRCOLResource,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
473 <summary>
474 Return the <see cref="T:s3pi.Interfaces.IResourceKey"/> indexed by the given <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.
475 </summary>
476 <param name="rcol">The RCOL resource to inspect.</param>
477 <param name="reference">The <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> to look up.</param>
478 <returns>The <see cref="T:s3pi.Interfaces.IResourceKey"/> indexed by the given <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.</returns>
479 <exception cref="T:System.NotImplementedException">The <paramref name="reference"/> passed
480 does not have a supported <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType"/> value.</exception>
481 </member>
482 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.GetBlock(s3pi.GenericRCOLResource.GenericRCOLResource,s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference)">
483 <summary>
484 Return the RCOL block indexed by the given <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.
485 </summary>
486 <param name="rcol">The RCOL resource to inspect.</param>
487 <param name="reference">The <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> to look up.</param>
488 <returns>The RCOL block indexed by the given <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/>.</returns>
489 <exception cref="T:System.NotImplementedException">The <paramref name="reference"/> passed
490 does not have a supported <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType"/> value.</exception>
491 <remarks>Only <see cref="F:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType.Public"/> and <see cref="F:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType.Private"/>
492 are "sane" types.</remarks>
493 </member>
494 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.CreateReference(s3pi.GenericRCOLResource.GenericRCOLResource,s3pi.Interfaces.IResourceKey)">
495 <summary>
496 Determine the <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> value for the given <see cref="T:s3pi.Interfaces.IResourceKey"/> value.
497 </summary>
498 <param name="rcol">The RCOL resource to inspect.</param>
499 <param name="rk">The <see cref="T:s3pi.Interfaces.IResourceKey"/> to encode.</param>
500 <returns>The <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference"/> value for the given <see cref="T:s3pi.Interfaces.IResourceKey"/> value.</returns>
501 <remarks>Note that the value will be zero (i.e. indicating an invalid entry) if the <paramref name="rk"/>
502 value supplied is not found either in the <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntries"/> or
503 <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.Resources"/> lists.</remarks>
504 </member>
505 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.ParentTGIBlocks">
506 <summary>
507 Reference to <see cref="T:s3pi.Interfaces.TGIBlockList"/> into which <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.TGIBlockIndex"/> is an index.
508 </summary>
509 </member>
510 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.ContentFields">
511 <summary>
512 Returns the list of fields for the type.
513 </summary>
514 </member>
515 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.RecommendedApiVersion">
516 <summary>
517 Return the version number that this wrapper prefers to be called with (the default if passed zero).
518 </summary>
519 <remarks>This wrapper returns <c>1</c> and is not sensitive to API version.</remarks>
520 </member>
521 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.TGIBlockIndex">
522 <summary>
523 The index into either the <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.Resources"/>
524 or <see cref="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkEntries"/> lists.
525 </summary>
526 </member>
527 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.RefType">
528 <summary>
529 The <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource.ReferenceType"/> of the instance.
530 </summary>
531 </member>
532 <member name="P:s3pi.GenericRCOLResource.GenericRCOLResource.ChunkReference.Value">
533 <summary>
534 A displayable string for the instance.
535 </summary>
536 </member>
537 <member name="T:s3pi.GenericRCOLResource.GenericRCOLResourceHandler">
538 <summary>
539 ResourceHandler for GenericRCOLResource wrapper.
540 </summary>
541 <remarks>
542 It has a pluggable API to support handlers for the blocks within an RCOL resource,
543 similar to WrapperDealer's support for resources within a package.
544 </remarks>
545 </member>
546 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResourceHandler.CreateRCOLBlock(System.Int32,System.EventHandler,System.UInt32)">
547 <summary>
548 Invoke the "default" constructor for an RCOL block.
549 </summary>
550 <param name="APIversion">Requested API version.</param>
551 <param name="handler">Change <see cref="T:System.EventHandler"/> delegate.</param>
552 <param name="type">Resource type of RCOL block.</param>
553 <returns>A new, initialised instance of the requested RCOL block <paramref name="type"/>,
554 or <c>null</c> if the <paramref name="type"/> is not supported.</returns>
555 </member>
556 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResourceHandler.RCOLDealer(System.Int32,System.EventHandler,System.UInt32,System.IO.Stream)">
557 <summary>
558 Return a new instance of the requested RCOL block <paramref name="type"/>,
559 initialised from the content of the supplied <see cref="T:System.IO.Stream"/>.
560 </summary>
561 <param name="APIversion">Requested API version.</param>
562 <param name="handler">Change <see cref="T:System.EventHandler"/> delegate.</param>
563 <param name="type">Resource type of RCOL block.</param>
564 <param name="s"><see cref="T:System.IO.Stream"/> containing data content for the RCOL block.</param>
565 <returns>A new instance of the requested RCOL block <paramref name="type"/>,
566 initialised from the supplied <see cref="T:System.IO.Stream"/>,
567 or <c>null</c> if the <paramref name="type"/> is not supported.</returns>
568 </member>
569 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResourceHandler.RCOLDealer(System.Int32,System.EventHandler,System.UInt32,System.Object[])">
570 <summary>
571 Return a new instance of the requested RCOL block <paramref name="type"/>,
572 initialised from the supplied <paramref name="fields"/>.
573 </summary>
574 <param name="APIversion">Requested API version.</param>
575 <param name="handler">Change <see cref="T:System.EventHandler"/> delegate.</param>
576 <param name="type">Resource type of RCOL block.</param>
577 <param name="fields">The fields to pass to the RCOL block constructor.</param>
578 <returns>A new instance of the requested RCOL block <paramref name="type"/>,
579 initialised from the supplied <paramref name="fields"/>,
580 or <c>null</c> if the <paramref name="type"/> is not supported.</returns>
581 </member>
582 <member name="M:s3pi.GenericRCOLResource.GenericRCOLResourceHandler.#ctor">
583 <summary>
584 ResourceHandler for GenericRCOLResource wrapper
585 </summary>
586 </member>
587 <member name="T:s3pi.GenericRCOLResource.DefaultRCOL">
588 <summary>
589 An RCOL block handler that "does nothing", providing the minimal support required for any RCOL block in a <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResource"/>.
590 </summary>
591 </member>
592 <member name="M:s3pi.GenericRCOLResource.DefaultRCOL.#ctor(System.Int32,System.EventHandler)">
593 <summary>
594 <see cref="T:s3pi.GenericRCOLResource.DefaultRCOL"/> does not provide a constructor that <see cref="M:s3pi.GenericRCOLResource.GenericRCOLResourceHandler.CreateRCOLBlock(System.Int32,System.EventHandler,System.UInt32)"/> can call.
595 <para>Calling this constructor throws a <see cref="T:System.NotImplementedException"/>.</para>
596 </summary>
597 <param name="APIversion">Unused.</param>
598 <param name="handler">Unused.</param>
599 <exception cref="T:System.NotImplementedException">Thrown if this constructor is called.</exception>
600 </member>
601 <member name="M:s3pi.GenericRCOLResource.DefaultRCOL.#ctor(System.Int32,System.EventHandler,System.IO.Stream)">
602 <summary>
603 Read the block data from the <see cref="T:System.IO.Stream"/> provided.
604 </summary>
605 <param name="APIversion">Unused; requested API version.</param>
606 <param name="handler">Unused; change <see cref="T:System.EventHandler"/>.</param>
607 <param name="s"><see cref="T:System.IO.Stream"/> containing the data to read.</param>
608 </member>
609 <member name="M:s3pi.GenericRCOLResource.DefaultRCOL.#ctor(System.Int32,System.EventHandler,s3pi.GenericRCOLResource.DefaultRCOL)">
610 <summary>
611 Create a new instance from an existing instance.
612 </summary>
613 <param name="APIversion">Unused; requested API version.</param>
614 <param name="handler">Unused; change <see cref="T:System.EventHandler"/>.</param>
615 <param name="basis">An existing <see cref="T:s3pi.GenericRCOLResource.DefaultRCOL"/> to use as a basis.</param>
616 </member>
617 <member name="M:s3pi.GenericRCOLResource.DefaultRCOL.Parse(System.IO.Stream)">
618 <summary>
619 Read the data.
620 </summary>
621 <param name="s">The <see cref="T:System.IO.Stream"/> containing the data.</param>
622 </member>
623 <member name="M:s3pi.GenericRCOLResource.DefaultRCOL.Clone(System.EventHandler)">
624 <summary>
625 Creating a copy of this instance with a new change <see cref="T:System.EventHandler"/>.
626 </summary>
627 <param name="handler">The <see cref="T:System.EventHandler"/> for the new instance.</param>
628 <returns>A new instance with a copy of the data and the given change <see cref="T:System.EventHandler"/>.</returns>
629 </member>
630 <member name="M:s3pi.GenericRCOLResource.DefaultRCOL.UnParse">
631 <summary>
632 Return the data in a <see cref="T:System.IO.Stream"/>.
633 </summary>
634 <returns>The data in a <see cref="T:System.IO.Stream"/>.</returns>
635 </member>
636 <member name="P:s3pi.GenericRCOLResource.DefaultRCOL.Tag">
637 <summary>
638 DefaultRCOL only supplies "Tag" for <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResourceHandler"/>.
639 <para>It returns "*" to indicate it is the default RCOL block handler.</para>
640 </summary>
641 </member>
642 <member name="P:s3pi.GenericRCOLResource.DefaultRCOL.ResourceType">
643 <summary>
644 DefaultRCOL only supplies "ResourceType" for <see cref="T:s3pi.GenericRCOLResource.GenericRCOLResourceHandler"/>.
645 <para>It returns <c>(uint)-1</c>.</para>
646 </summary>
647 </member>
648 <member name="P:s3pi.GenericRCOLResource.DefaultRCOL.Value">
649 <summary>
650 A default string to display, identifying any tag within the data and the length of the data block.
651 </summary>
652 </member>
653 </members>
654 </doc>

  ViewVC Help
Powered by ViewVC 1.1.22