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

<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>

<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>

// 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);

}

public class MyClass : BaseClass {

[Export ("initWithFoo:")]

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

{

...

}

100

</code>

101

</example>

102

</remarks>

109

102

110

103

111

104

</AssemblyInfo>

105

106

107

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

108

</Attribute>

109

</Attributes>

112

110

113

111

114

112

</Parameters>

135

133

</Parameters>

136

134

<Docs>

137

135

<param name="date">Time at which the timer will be fired.</param>

138

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

139

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

136

<param name="when">This is the duration between when the timer will fire. </param>

137

<param name="action">The action to be performed when the timer fires.</param>

140

138

<param name="repeats">Whether this timer should repeat automatically (true) or will be invalidated after firing the first time (false).</param>

141

<summary>To be added.</summary>

142

<remarks>To be added.</remarks>

139

140

</summary>

141

<remarks>To be added.

142

</remarks>

143

</Docs>

144

</Member>

145

165

<Docs>

166

<param name="date">Time at which the timer will be fired.</param>

167

<param name="seconds">For repeating timers, the number of seconds to wait before firing the timer again.</param>

168

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

169

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

170

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

168

<param name="target">This is an object containing the method to be invoked when the timer fires.</param>

169

<param name="selector">The method on <paramref name="target" /> that will be invoked.</param>

170

171

<para>User info for the timer.</para>

172

<para tool="nullallowed">This parameter can be <see langword="null" />.</para>

173

</param>

171

174

<param name="repeats">Whether this timer should repeat automatically (true) or will be invalidated after firing the first time (false).</param>

172

<summary>To be added.</summary>

173

<remarks>To be added.</remarks>

175

176

</summary>

177

<remarks>To be added.

178

</remarks>

174

179

</Docs>

175

180

</Member>

176

181

204

209

205

210

</Parameters>

206

211

<Docs>

207

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

208

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

212

<param name="seconds">The number of seconds between the timer firing.</param>

213

<param name="action">Some action to be performed when the timer fires.</param>

209

214

<summary>Creates a repeating timer with the specified parameters and schedules it for execution on the current NSRunLoop in the default mode.</summary>

210

<returns>To be added.</returns>

211

<remarks>To be added.</remarks>

215

216

</returns>

217

<remarks>To be added.

218

</remarks>

212

219

</Docs>

213

220

</Member>

214

221

226

233

227

234

</Parameters>

228

235

<Docs>

229

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

230

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

236

<param name="when">The time when the timer will first fire.</param>

237

<param name="action">The action to be performed when the timer fires.</param>

231

238

<summary>Creates a repeating timer with the specified parameters and schedules it for execution on the current NSRunLoop in the default mode.</summary>

232

<returns>To be added.</returns>

233

<remarks>To be added.</remarks>

239

240

</returns>

241

<remarks>To be added.

242

</remarks>

234

243

</Docs>

235

244

</Member>

236

245

248

257

249

258

</Parameters>

250

259

<Docs>

251

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

252

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

260

<param name="seconds">The number of seconds between the timer firing.</param>

261

<param name="action">The action to be performed.</param>

253

262

<summary>Creates a repeating timer with the specified parameters that can later be added to an NSRunLoop.</summary>

254

<returns>To be added.</returns>

255

<remarks>To be added.</remarks>

263

264

</returns>

265

<remarks>To be added.

266

</remarks>

256

267

</Docs>

257

268

</Member>

258

269

273

284

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

274

285

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

275

286

<summary>Creates a repeating timer with the specified parameters that can later be added to an NSRunLoop.</summary>

276

<returns>To be added.</returns>

277

<remarks>To be added.</remarks>

287

<returns>The timespan between firings of the timer.</returns>

288

<remarks>To be added.

289

</remarks>

278

290

</Docs>

279

291

</Member>

280

292

292

304

293

305

</Parameters>

294

306

<Docs>

295

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

296

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

307

<param name="seconds">The number of seconds between the firings of the timer.</param>

308

<param name="action">The action to be performed.</param>

297

309

<summary>Creates a timer with the specified parameters and schedules it for execution on the current NSRunLoop in the default mode.</summary>

298

<returns>To be added.</returns>

299

<remarks>To be added.</remarks>

310

311

</returns>

312

<remarks>To be added.

313

</remarks>

300

314

</Docs>

301

315

</Member>

302

316

314

328

315

329

</Parameters>

316

330

<Docs>

317

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

318

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

331

<param name="when">The interval between firings of the timer.</param>

332

<param name="action">The action to be performed.</param>

319

333

<summary>Creates a timer with the specified parameters that can later be added to an NSRunLoop.</summary>

320

<returns>To be added.</returns>

321

<remarks>To be added.</remarks>

334

335

</returns>

336

<remarks>To be added.

337

</remarks>

322

338

</Docs>

323

339

</Member>

324

340

344

360

345

361

</Parameters>

346

362

<Docs>

347

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

348

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

349

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

350

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

363

<param name="seconds">The number of seconds between firings of the timer.</param>

364

<param name="target">An object that will be invoked when the timer fires.</param>

365

<param name="selector">The method to invoke on <paramref name="target" />.</param>

366

367

<para>Custom user info for the timer.</para>

368

<para tool="nullallowed">This parameter can be <see langword="null" />.</para>

369

</param>

351

370

<param name="repeats">Whether this timer should repeat automatically (true) or will be invalidated after firing the first time (false).</param>

352

371

<summary>Creates a timer with the specified parameters and schedules it for execution on the current NSRunLoop in the default mode. </summary>

353

<returns>To be added.</returns>

354

<remarks>To be added.</remarks>

372

373

</returns>

374

<remarks>To be added.

375

</remarks>

355

376

</Docs>

356

377

</Member>

357

378

369

390

370

391

</Parameters>

371

392

<Docs>

372

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

373

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

393

<param name="seconds">The number of seconds until the <paramref name="action" /> is invoked.</param>

394

<param name="action">Some action to be performed.</param>

374

395

<summary>Creates a timer object that can be later added to an NSRunLoop.</summary>

375

<returns>To be added.</returns>

376

<remarks>To be added.</remarks>

396

397

</returns>

398

<remarks>To be added.

399

</remarks>

377

400

</Docs>

378

401

</Member>

379

402

391

414

392

415

</Parameters>

393

416

<Docs>

394

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

395

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

417

<param name="when">The length of time until the <paramref name="action" /> is invoked.</param>

418

<param name="action">Some action to be performed.</param>

396

419

<summary>Creates a timer object that can be later added to an NSRunLoop.</summary>

397

<returns>To be added.</returns>

398

<remarks>To be added.</remarks>

420

421

</returns>

422

<remarks>To be added.

423

</remarks>

399

424

</Docs>

400

425

</Member>

401

426

421

446

422

447

</Parameters>

423

448

<Docs>

424

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

425

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

426

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

427

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

449

<param name="seconds">The number of seconds between firings of the timer.</param>

450

<param name="target">An object that will be invoked when the timer fires.</param>

451

<param name="selector">The method that will be invoked on <paramref name="target" />.</param>

452

453

<para>Custom user information.</para>

454

<para tool="nullallowed">This parameter can be <see langword="null" />.</para>

455

</param>

428

456

<param name="repeats">Whether this timer should repeat automatically (true) or will be invalidated after firing the first time (false).</param>

429

457

<summary>Creates a timer object that can be later added to an NSRunLoop.</summary>

430

<returns>To be added.</returns>

431

<remarks>To be added.</remarks>

458

459

</returns>

460

<remarks>To be added.

461

</remarks>

432

462

</Docs>

433

463

</Member>

434

464

448

478

449

479

<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>

450

480

</param>

451

<summary>Releases the resourced used by the NSTimer object.</summary>

481

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

452

482

453

483

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

454

484

<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>

474

504

</ReturnValue>

475

505

476

506

<Docs>

477

<summary>To be added.</summary>

478

<remarks>To be added.</remarks>

507

<summary>Causes the action to be performed.</summary>

508

<remarks>To be added.

509

</remarks>

479

510

</Docs>

480

511

</Member>

481

512

497

528

<ReturnType>MonoMac.Foundation.NSDate</ReturnType>

498

529

</ReturnValue>

499

530

<Docs>

500

<summary>To be added.</summary>

501

<value>To be added.</value>

502

<remarks>To be added.</remarks>

531

<summary>The date at with the action will be performed.</summary>

532

<value>

533

</value>

534

<remarks>If the timer is no longer valid, then this will return the last date the action was performed.</remarks>

503

535

</Docs>

504

536

</Member>

505

537

539

571

<ReturnType>System.Boolean</ReturnType>

540

572

</ReturnValue>

541

573

<Docs>

542

<summary>To be added.</summary>

543

<value>To be added.</value>

544

<remarks>To be added.</remarks>

574

<summary>Returns <see langword="true" /> if the the timer will still fire at some point in the future.</summary>

575

<value>

576

</value>

577

<remarks>To be added.

578

</remarks>

545

579

</Docs>

546

580

</Member>

547

581

560

594

<ReturnType>System.Double</ReturnType>

561

595

</ReturnValue>

562

596

<Docs>

563

<summary>To be added.</summary>

564

<value>To be added.</value>

565

<remarks>To be added.</remarks>

597

<summary>The time interval for the timer.</summary>

598

<value>

599

</value>

600

<remarks>Will return 0 for a non-repeating timer.</remarks>

566

601

</Docs>

567

602

</Member>

568

603

581

616

<ReturnType>MonoMac.Foundation.NSObject</ReturnType>

582

617

</ReturnValue>

583

618

<Docs>

584

<summary>To be added.</summary>

585

<value>To be added.</value>

586

<remarks>To be added.</remarks>

619

<summary>Custom user information that has been provided to the timer.</summary>

620

<value>

621

</value>

622

<remarks>To be added.

623

</remarks>

587

624

</Docs>

588

625

</Member>

589

626

</Members>

Older »