~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

<list type="bullet"><item><term><see cref="M:MonoMac.Foundation.NSInputStream.SetCFClientFlags(MonoMac.CoreFoundation.CFStreamEventType,IntPtr,IntPtr)" />:

This method is called to register a client to notify of events in your

stream. You must call the base implementation, with the exact arguments passed

in.

</term></item><item><term><see cref="M:MonoMac.Foundation.NSInputStream.ScheduleInCFRunLoop(IntPtr,string)" />:

Depending on what you're doing to provide the data, you will need to schedule

in a run loop when this method is called. You should not call the base

implementation for this method.

</term></item><item><term><see cref="M:MonoMac.Foundation.NSInputStream.UnscheduleInCFRunLoop(IntPtr,string)" />:

This is called when you need to unschedule from a run loop. You should not call

the base implementation for this method.

</term></item></list>

You must call also <see cref="M:MonoMac.Foundation.NSInputStream.Notify((valuetype MonoMac.CoreFoundation.CFStreamEventType)" />

to inform the client when you have data available (or when you have any other relevant

event), otherwise your input stream won't be read from.

</para>

</remarks>

</Docs>

<AttributeName>MonoMac.Foundation.Export("init")</AttributeName>

</Attribute>

<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>

</Attribute>

</Attributes>

<Docs>

105

106

<AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>

107

</Attribute>

108

109

<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>

110

</Attribute>

111

</Attributes>

112

113

125

126

127

</AssemblyInfo>

128

129

130

<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>

131

</Attribute>

132

</Attributes>

133

134

135

</Parameters>

136

<Docs>

137

<param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>

<summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>

138

<summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>

139

<para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When you invoke the constructor that takes the NSObjectFlag.Empty you taking advatnage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to you.</para>

<para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>

<para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>

<para>In general, if your constructors invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method. If this is not the case, you should instead chain to the proper constructor in your class. </para>

<para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:</para>

140

<para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>

141

142

// The NSObjectFlag merely allocates the object and registers the

// C# class with the Objective-C runtime if necessary, but no actual

// initXxx method is invoked, that is done later in the constructor

// This is taken from MonoMac's source code:

[Export ("initWithFrame:")]

public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)

{

// Invoke the init method now.

var initWithFrame = new Selector ("initWithFrame:").Handle;

if (IsDirectBinding)

Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);

else

Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);

}

143

public class MyClass : BaseClass {

144

[Export ("initWithFoo:")]

145

public MyClass (string foo) : base (NSObjectFlag.Empty)

146

{

147

...

148

}

100

149

</code>

101

150

</example>

102

151

</remarks>

109

158

110

159

111

160

</AssemblyInfo>

161

162

163

<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>

164

</Attribute>

165

</Attributes>

112

166

113

167

114

168

</Parameters>

157

211

<remarks>Each MonoMac class mirrors an unmanaged Objective-C class. This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>

158

212

</Docs>

159

213

</Member>

214

215

216

217

<MemberType>Method</MemberType>

218

219

220

</AssemblyInfo>

221

222

<ReturnType>System.Void</ReturnType>

223

</ReturnValue>

224

225

226

</Parameters>

227

<Docs>

228

229

<para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources; If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>

230

</param>

231

<summary>Releases the resources used by the NSInputStream object.</summary>

232

233

<para>This Dispose method releases the resources used by the NSInputStream class.</para>

234

<para>This method is called by both the Dispose() method and the object finalizer (Finalize). When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released; when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>

235

<para>Calling the Dispose method when you are finished using the NSInputStream ensures that all external resources used by this managed object are released as soon as possible. Once you have invoked the Dispose method, the object is no longer useful and you should no longer make any calls to it.</para>

236

<para> For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at http://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>

237

</remarks>

238

</Docs>

239

</Member>

160

240

161

241

162

242

207

287

<remarks>To be added.</remarks>

208

288

</Docs>

209

289

</Member>

290

291

292

293

<MemberType>Method</MemberType>

294

295

296

</AssemblyInfo>

297

298

299

<AttributeName>MonoMac.Foundation.Export("getBuffer:length:")</AttributeName>

300

</Attribute>

301

</Attributes>

302

303

<ReturnType>System.Boolean</ReturnType>

304

</ReturnValue>

305

306

307

308

</Parameters>

309

<Docs>

310

<param name="buffer">Upon return points to the first of an array of bytes where the caller can read bytes from. The buffer is only valid until the next stream operation.</param>

311

<param name="len">Upon return specifies how many bytes can be written to the buffer.</param>

312

<summary>This method can return a pointer to a buffer the caller can read data from.</summary>

313

<returns>A boolean value indicating whether the returned buffer is valid or not.</returns>

314

<remarks>It is recommended to just return false from this method. An implementation must ensure that the returned byte pointer is not moved or collected by the garbage collector until the next stream operation is performed. One way of accomplishing this is with a pinned byte array (pinned with a GCHandle).</remarks>

315

</Docs>

316

</Member>

210

317

211

318

212

319

224

331

</ReturnValue>

225

332

226

333

<Docs>

227

<summary>To be added.</summary>

228

<returns>To be added.</returns>

229

<remarks>To be added.</remarks>

334

<summary>Returna a boolean value indicating whether the stream has bytes available to be read.</summary>

335

<returns>A boolean value indicating whether the stream has bytes available to be read.</returns>

336

<remarks>This method should return true if it does not know if there are available bytes or not.</remarks>

337

</Docs>

338

</Member>

339

340

341

342

<MemberType>Method</MemberType>

343

344

345

</AssemblyInfo>

346

347

<ReturnType>System.Void</ReturnType>

348

</ReturnValue>

349

350

351

</Parameters>

352

<Docs>

353

<param name="eventType">The events to notify.</param>

354

<summary>Notifies consumers of events in the stream.</summary>

355

356

</remarks>

230

357

</Docs>

231

358

</Member>

232

359

244

371

245

372

</Parameters>

246

373

<Docs>

247

<param name="buffer">To be added.</param>

248

<param name="len">To be added.</param>

249

<summary>To be added.</summary>

250

<returns>To be added.</returns>

251

<remarks>To be added.</remarks>

374

<param name="buffer">The buffer where data should be put.</param>

375

<param name="len">The size of the buffer (in bytes).</param>

376

<summary>Reads data from the stream into the provided buffer.</summary>

377

<returns>The number of bytes actually written.</returns>

378

379

</remarks>

380

</Docs>

381

</Member>

382

383

384

385

<MemberType>Method</MemberType>

386

387

388

</AssemblyInfo>

389

390

391

<AttributeName>MonoMac.Foundation.Export("read:maxLength:")</AttributeName>

392

</Attribute>

393

</Attributes>

394

395

<ReturnType>System.Int32</ReturnType>

396

</ReturnValue>

397

398

399

400

</Parameters>

401

<Docs>

402

<param name="buffer">The buffer where data should be put.</param>

403

<param name="len">The size of the buffer (in bytes).</param>

404

<summary>Reads data from the stream into the provided buffer. You should not call this method directly, you should call <see cref="M:MonoMac.Foundation.NSInputStream.Read(byte[],uint)" />

405

instead. This method is for NSInputStream subclasses to implement.</summary>

406

<returns>The number of bytes actually written.</returns>

407

<remarks>You can use methods in <see cref="T:System.Runtime.InteropServices.Marshal" /> to write to the buffer (for instance: <see cref="M:System.Runtime.InteropServices.Marshal.Copy(byte[],int,IntPtr,int)" /> to write from a byte array).</remarks>

408

</Docs>

409

</Member>

410

411

412

413

<MemberType>Method</MemberType>

414

415

416

</AssemblyInfo>

417

418

419

<AttributeName>MonoMac.Foundation.Export("_scheduleInCFRunLoop:forMode:")</AttributeName>

420

</Attribute>

421

</Attributes>

422

423

<ReturnType>System.Void</ReturnType>

424

</ReturnValue>

425

426

427

428

</Parameters>

429

<Docs>

430

<param name="runloop">The RunLoop to schedule in.</param>

431

<param name="mode">The RunLoop mode to schedule in.</param>

432

<summary>Schedules the stream in a RunLoop.</summary>

433

434

</remarks>

435

</Docs>

436

</Member>

437

438

439

440

<MemberType>Method</MemberType>

441

442

443

</AssemblyInfo>

444

445

446

<AttributeName>MonoMac.Foundation.Export("_setCFClientFlags:callback:context:")</AttributeName>

447

</Attribute>

448

</Attributes>

449

450

<ReturnType>System.Boolean</ReturnType>

451

</ReturnValue>

452

453

454

455

456

</Parameters>

457

<Docs>

458

<param name="inFlags">Flags.</param>

459

<param name="inCallback">The callbacks to call when events occur.</param>

460

<param name="inContextPtr">User-defined data for the callback.</param>

461

<summary>Adds a client for the stream. This method is not supposed to be called by managed code, it will be called by consumers of the straem. When overriding it make sure to call the base implementation.</summary>

462

463

</returns>

464

465

</remarks>

466

</Docs>

467

</Member>

468

469

470

471

<MemberType>Method</MemberType>

472

473

474

</AssemblyInfo>

475

476

477

<AttributeName>MonoMac.Foundation.Export("_unscheduleFromCFRunLoop:forMode:")</AttributeName>

478

</Attribute>

479

</Attributes>

480

481

<ReturnType>System.Void</ReturnType>

482

</ReturnValue>

483

484

485

486

</Parameters>

487

<Docs>

488

<param name="runloop">The RunLoop to unschedule.</param>

489

<param name="mode">The mode to unschedule.</param>

490

<summary>Unschedules the stream from a RunLoop.</summary>

491

492

</remarks>

252

493

</Docs>

253

494

</Member>

254

495

</Members>

Older »