~ubuntu-branches/ubuntu/oneiric/codeblocks/oneiric

<a class="qindex" href="index.htm">Main Page</a> | <a class="qindex" href="modules.htm">Modules</a> | <a class="qindex" href="hierarchy.htm">Class Hierarchy</a> | <a class="qindex" href="classes.htm">Alphabetical List</a> | <a class="qindex" href="annotated.htm">Class List</a> | <a class="qindex" href="functions.htm">Class Members</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>

<h1>wxCustomPropertyClass Class Reference</h1>This is a rather inefficient but very versatile property class.

<p>

<code>#include <propdev.h></code>

<p>

<p>Inheritance diagram for wxCustomPropertyClass:

</map>

<a href="classwxCustomPropertyClass-members.htm">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>

<tr><td colspan=2><br><h2>Public Types</h2></td></tr>

typedef void * </td><td class="memItemRight" valign=bottom><b>ClientDataType</b></td></tr>

typedef short </td><td class="memItemRight" valign=bottom><b>FlagType</b></td></tr>

<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa0">AddChild</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *prop)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa1">AddChild2</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *prop, int index=-1, bool correct_mode=true)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa0">AppendChoice</a> (const wxString &label, int value=INT_MAX)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa1">CanHaveExtraChildren</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa5">ChildChanged</a> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p)</td></tr>

void </td><td class="memItemRight" valign=bottom><b>ClearFlag</b> (FlagType flag)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa3">DeleteChoice</a> (int index)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="classwxPGEditor.htm">wxPGEditor</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa4">DoGetEditorClass</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual wxValidator * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa5">DoGetValidator</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual wxPGVariant </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa9">DoGetValue</a> () const </td></tr>

void </td><td class="memItemRight" valign=bottom><b>DoSetName</b> (const wxString &str)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa11">DoSetValue</a> (wxPGVariant value)</td></tr>

void </td><td class="memItemRight" valign=bottom><b>FixIndexesOfChildren</b> (size_t starthere=0)</td></tr>

unsigned int </td><td class="memItemRight" valign=bottom><b>GetArrIndex</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>wxString </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa11">GetAttributes</a> (unsigned int flagmask=0xFFFF)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa12">GetChildCount</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual int </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa18">GetChoiceInfo</a> (wxPGChoiceInfo *choiceinfo)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="structwxPGPropertyClassInfo.htm">wxPGPropertyClassInfo</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa14">GetClassInfo</a> () const=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const wxChar * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa15">GetClassName</a> () const=0</td></tr>

ClientDataType </td><td class="memItemRight" valign=bottom><b>GetClientData</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa23">GetCount</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGPropertyDataExt.htm">wxPGPropertyDataExt</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa17">GetDataExt</a> ()</td></tr>

unsigned int </td><td class="memItemRight" valign=bottom><b>GetDepth</b> () const </td></tr>

wxString </td><td class="memItemRight" valign=bottom><b>GetDisplayedString</b> () const </td></tr>

const <a class="el" href="classwxPGEditor.htm">wxPGEditor</a> * </td><td class="memItemRight" valign=bottom><b>GetEditorClass</b> () const </td></tr>

unsigned int </td><td class="memItemRight" valign=bottom><b>GetFlags</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa22">GetGrid</a> () const </td></tr>

wxString </td><td class="memItemRight" valign=bottom><b>GetHelpString</b> () const </td></tr>

100

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGId.htm">wxPGId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa24">GetId</a> ()</td></tr>

101

102

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual wxSize </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa31">GetImageSize</a> () const </td></tr>

103

104

<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa26">GetIndexInParent</a> () const </td></tr>

105

106

107

<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td><td class="memItemRight" valign=bottom><b>GetItemAtY</b> (unsigned int y, unsigned int lh)</td></tr>

108

109

<tr><td class="memItemLeft" nowrap align=right valign=top>const wxString & </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa27">GetLabel</a> () const </td></tr>

110

111

<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa28">GetLastVisibleSubItem</a> () const </td></tr>

112

113

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa29">GetMainParent</a> () const </td></tr>

114

115

116

int </td><td class="memItemRight" valign=bottom><b>GetMaxLength</b> () const </td></tr>

117

118

119

120

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGPropertyWithChildren.htm">wxPGPropertyWithChildren</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa32">GetParent</a> () const </td></tr>

121

122

<tr><td class="memItemLeft" nowrap align=right valign=top>signed char </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa33">GetParentingType</a> () const </td></tr>

123

124

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa42">GetParentState</a> () const </td></tr>

125

126

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa43">GetPropertyByName</a> (const wxString &name) const </td></tr>

127

128

<tr><td class="memItemLeft" nowrap align=right valign=top>const wxChar * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa35">GetType</a> () const </td></tr>

129

130

<tr><td class="memItemLeft" nowrap align=right valign=top>wxValidator * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa36">GetValidator</a> () const </td></tr>

131

132

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual wxString </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa45">GetValueAsString</a> (int argFlags) const </td></tr>

133

134

<tr><td class="memItemLeft" nowrap align=right valign=top>wxVariant </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa38">GetValueAsVariant</a> () const </td></tr>

135

136

137

wxBitmap * </td><td class="memItemRight" valign=bottom><b>GetValueImage</b> () const </td></tr>

138

139

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="classwxPGValueType.htm">wxPGValueType</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa40">GetValueType</a> () const=0</td></tr>

140

141

142

const <a class="el" href="classwxPGValueType.htm">wxPGValueType</a> * </td><td class="memItemRight" valign=bottom><b>GetValueTypePtr</b> () const </td></tr>

143

144

145

146

147

bool </td><td class="memItemRight" valign=bottom><b>HasFlag</b> (FlagType flag) const </td></tr>

148

149

150

151

<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa56">Index</a> (const <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *p) const </td></tr>

152

153

154

155

<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa46">InsertChoice</a> (const wxString &label, int index, int value=INT_MAX)</td></tr>

156

157

158

bool </td><td class="memItemRight" valign=bottom><b>IsEnabled</b> () const </td></tr>

159

160

161

bool </td><td class="memItemRight" valign=bottom><b>IsExpanded</b> () const </td></tr>

162

163

164

bool </td><td class="memItemRight" valign=bottom><b>IsFlagSet</b> (FlagType flag) const </td></tr>

165

166

167

bool </td><td class="memItemRight" valign=bottom><b>IsKindOf</b> (<a class="el" href="structwxPGPropertyClassInfo.htm">wxPGPropertyClassInfo</a> &info)</td></tr>

168

169

170

171

172

bool </td><td class="memItemRight" valign=bottom><b>IsSomeParent</b> (<a class="el" href="classwxPGProperty.htm">wxPGProperty</a> *candidate_parent) const </td></tr>

173

174

175

176

177

bool </td><td class="memItemRight" valign=bottom><b>IsValueUnspecified</b> () const </td></tr>

178

179

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa67">Item</a> (size_t i) const </td></tr>

180

181

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa68">Last</a> () const </td></tr>

182

183

184

185

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa55">OnEvent</a> (<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> *propgrid, wxWindow *wnd_primary, wxEvent &event)</td></tr>

186

187

188

void </td><td class="memItemRight" valign=bottom><b>PrepareSubProperties</b> ()</td></tr>

189

190

191

192

193

194

195

196

197

void </td><td class="memItemRight" valign=bottom><b>SetAttrib</b> (int id, wxVariant value)</td></tr>

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

void </td><td class="memItemRight" valign=bottom><b>SetFlag</b> (FlagType flag)</td></tr>

219

220

221

void </td><td class="memItemRight" valign=bottom><b>SetHelpString</b> (const wxString &helpString)</td></tr>

222

223

224

void </td><td class="memItemRight" valign=bottom><b>SetLabel</b> (const wxString &label)</td></tr>

225

226

227

228

229

void </td><td class="memItemRight" valign=bottom><b>SetParentState</b> (<a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a> *pstate)</td></tr>

230

231

232

233

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa88">SetValueFromInt</a> (long value, int arg_flags)</td></tr>

234

235

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa89">SetValueFromString</a> (const wxString &text, int flags)</td></tr>

236

237

238

239

240

void </td><td class="memItemRight" valign=bottom><b>SetValueToUnspecified</b> ()</td></tr>

241

242

243

void </td><td class="memItemRight" valign=bottom><b>ShowError</b> (const wxString &msg)</td></tr>

244

245

246

bool </td><td class="memItemRight" valign=bottom><b>StdValidationProcedure</b> (wxPGVariant value)</td></tr>

247

248

249

void </td><td class="memItemRight" valign=bottom><b>SubPropsChanged</b> (int oldSelInd=-1)</td></tr>

250

251

252

void </td><td class="memItemRight" valign=bottom><b>UpdateControl</b> (wxWindow *primary)</td></tr>

253

254

255

256

257

 </td><td class="memItemRight" valign=bottom><b>wxCustomPropertyClass</b> (const wxString &label, const wxString &name=wxPG_LABEL)</td></tr>

258

259

<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>

260

261

void </td><td class="memItemRight" valign=bottom><b>Init</b> ()</td></tr>

262

263

<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>

264

265

unsigned int </td><td class="memItemRight" valign=bottom><b>m_arrIndex</b></td></tr>

266

267

268

unsigned char </td><td class="memItemRight" valign=bottom><b>m_bgColIndex</b></td></tr>

269

270

271

wxPGArrayProperty </td><td class="memItemRight" valign=bottom><b>m_children</b></td></tr>

272

273

274

<a class="el" href="classwxPGChoices.htm">wxPGChoices</a> </td><td class="memItemRight" valign=bottom><b>m_choices</b></td></tr>

275

276

277

ClientDataType </td><td class="memItemRight" valign=bottom><b>m_clientData</b></td></tr>

278

279

280

<a class="el" href="classwxPGPropertyDataExt.htm">wxPGPropertyDataExt</a> * </td><td class="memItemRight" valign=bottom><b>m_dataExt</b></td></tr>

281

282

283

unsigned char </td><td class="memItemRight" valign=bottom><b>m_depth</b></td></tr>

284

285

286

unsigned char </td><td class="memItemRight" valign=bottom><b>m_depthBgCol</b></td></tr>

287

288

289

unsigned char </td><td class="memItemRight" valign=bottom><b>m_expanded</b></td></tr>

290

291

292

unsigned char </td><td class="memItemRight" valign=bottom><b>m_fgColIndex</b></td></tr>

293

294

295

FlagType </td><td class="memItemRight" valign=bottom><b>m_flags</b></td></tr>

296

297

298

wxString </td><td class="memItemRight" valign=bottom><b>m_label</b></td></tr>

299

300

301

short </td><td class="memItemRight" valign=bottom><b>m_maxLen</b></td></tr>

302

303

304

wxString </td><td class="memItemRight" valign=bottom><b>m_name</b></td></tr>

305

306

307

<a class="el" href="group__miscellaneous.htm#ga1">wxPGPaintCallback</a> </td><td class="memItemRight" valign=bottom><b>m_paintCallback</b></td></tr>

308

309

310

<a class="el" href="classwxPGPropertyWithChildren.htm">wxPGPropertyWithChildren</a> * </td><td class="memItemRight" valign=bottom><b>m_parent</b></td></tr>

311

312

313

signed char </td><td class="memItemRight" valign=bottom><b>m_parentingType</b></td></tr>

314

315

316

<a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a> * </td><td class="memItemRight" valign=bottom><b>m_parentState</b></td></tr>

317

318

319

wxString </td><td class="memItemRight" valign=bottom><b>m_value</b></td></tr>

320

321

322

int </td><td class="memItemRight" valign=bottom><b>m_y</b></td></tr>

323

324

</table>

325

<hr><a name="_details"></a><h2>Detailed Description</h2>

326

This is a rather inefficient but very versatile property class.

327

<p>

328

Base class offers the following:<ul>

329

<li>Add any properties as children (i.e. like wxParentProperty)</li><li>Editor control can be set at run-time.</li><li>By default has string value type.</li><li>Has capacity to have choices.</li><li>Can have custom-paint bitmap.</li></ul>

330

<p>

331

Also note:<ul>

332

<li>Has m_parentingType of -2 (technical detail). </li></ul>

333

334

<p>

335

<hr><h2>Member Function Documentation</h2>

336

337

338

<tr>

339

340

341

<tr>

342

<td class="md" nowrap valign="top"> void wxPGPropertyWithChildren::AddChild </td>

343

344

<td class="md" nowrap valign="top"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td>

345

346

347

<td class="md" nowrap><code> [inherited]</code></td>

348

</tr>

349

350

</table>

351

</td>

352

</tr>

353

</table>

354

355

<tr>

356

<td>

357

358

</td>

359

<td>

360

361

<p>

362

This is used by properties that have fixed sub-properties.

363

<p>

364

</td>

365

</tr>

366

</table>

367

368

369

<tr>

370

371

372

<tr>

373

<td class="md" nowrap valign="top"> void wxPGPropertyWithChildren::AddChild2 </td>

374

375

<td class="md" nowrap valign="top"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td>

376

377

</tr>

378

<tr>

379

380

381

382

<td class="mdname" nowrap> <em>index</em> = -1, </td>

383

</tr>

384

<tr>

385

386

387

388

<td class="mdname" nowrap> <em>correct_mode</em> = true</td>

389

</tr>

390

<tr>

391

392

393

<td class="md" colspan="2"><code> [inherited]</code></td>

394

</tr>

395

396

</table>

397

</td>

398

</tr>

399

</table>

400

401

<tr>

402

<td>

403

404

</td>

405

<td>

406

407

<p>

408

This is used by Insert etc.

409

<p>

410

</td>

411

</tr>

412

</table>

413

414

415

<tr>

416

417

418

<tr>

419

<td class="md" nowrap valign="top"> int wxPGProperty::AppendChoice </td>

420

421

<td class="md" nowrap valign="top">const wxString & </td>

422

<td class="mdname" nowrap> <em>label</em>, </td>

423

</tr>

424

<tr>

425

426

427

428

<td class="mdname" nowrap> <em>value</em> = INT_MAX</td>

429

</tr>

430

<tr>

431

432

433

<td class="md" colspan="2"><code> [inline, inherited]</code></td>

434

</tr>

435

436

</table>

437

</td>

438

</tr>

439

</table>

440

441

<tr>

442

<td>

443

444

</td>

445

<td>

446

447

<p>

448

Adds entry to property's <a class="el" href="classwxPGChoices.htm">wxPGChoices</a> and editor control (if it is active).

449

<p>

450

Returns index of item added. </td>

451

</tr>

452

</table>

453

454

455

<tr>

456

457

458

<tr>

459

<td class="md" nowrap valign="top"> bool wxPGProperty::CanHaveExtraChildren </td>

460

461

462

463

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

464

</tr>

465

466

</table>

467

</td>

468

</tr>

469

</table>

470

471

<tr>

472

<td>

473

474

</td>

475

<td>

476

477

<p>

478

Returns true if extra children can be added for this property (i.e.

479

<p>

480

it is wxPropertyCategory or wxCustomProperty) </td>

481

</tr>

482

</table>

483

484

485

<tr>

486

487

488

<tr>

489

<td class="md" nowrap valign="top"> virtual void wxPGPropertyWithChildren::ChildChanged </td>

490

491

<td class="md" nowrap valign="top"><a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td>

492

493

494

<td class="md" nowrap><code> [virtual, inherited]</code></td>

495

</tr>

496

497

</table>

498

</td>

499

</tr>

500

</table>

501

502

<tr>

503

<td>

504

505

</td>

506

<td>

507

508

<p>

509

Called after child property p has been altered.

510

<p>

511

The value of this parent property should now be updated accordingly.

512

<p>

513

Reimplemented in <a class="el" href="classwxParentPropertyClass.htm#wxParentPropertyClassa4">wxParentPropertyClass</a>. </td>

514

</tr>

515

</table>

516

517

518

<tr>

519

520

521

<tr>

522

<td class="md" nowrap valign="top"> void wxPGProperty::DeleteChoice </td>

523

524

525

<td class="mdname1" valign="top" nowrap> <em>index</em> </td>

526

527

<td class="md" nowrap><code> [inherited]</code></td>

528

</tr>

529

530

</table>

531

</td>

532

</tr>

533

</table>

534

535

<tr>

536

<td>

537

538

</td>

539

<td>

540

541

<p>

542

Removes entry from property's <a class="el" href="classwxPGChoices.htm">wxPGChoices</a> and editor control (if it is active).

543

<p>

544

If selected item is deleted, then the value is set to unspecified. </td>

545

</tr>

546

</table>

547

548

549

<tr>

550

551

552

<tr>

553

<td class="md" nowrap valign="top"> virtual const <a class="el" href="classwxPGEditor.htm">wxPGEditor</a>* wxPGProperty::DoGetEditorClass </td>

554

555

556

557

<td class="md" nowrap> const<code> [virtual, inherited]</code></td>

558

</tr>

559

560

</table>

561

</td>

562

</tr>

563

</table>

564

565

<tr>

566

<td>

567

568

</td>

569

<td>

570

571

<p>

572

Returns pointer to an instance of editor class.

573

<p>

574

575

<p>

576

Reimplemented in <a class="el" href="classwxPGRootPropertyClass.htm#wxPGRootPropertyClassa7">wxPGRootPropertyClass</a>, and <a class="el" href="classwxPropertyCategoryClass.htm#wxPropertyCategoryClassa8">wxPropertyCategoryClass</a>. </td>

577

</tr>

578

</table>

579

580

581

<tr>

582

583

584

<tr>

585

<td class="md" nowrap valign="top"> virtual wxValidator* wxPGProperty::DoGetValidator </td>

586

587

588

589

<td class="md" nowrap> const<code> [virtual, inherited]</code></td>

590

</tr>

591

592

</table>

593

</td>

594

</tr>

595

</table>

596

597

<tr>

598

<td>

599

600

</td>

601

<td>

602

603

<p>

604

Returns pointer to the wxValidator that should be used with the editor of this property (NULL for no validator).

605

<p>

606

Setting validator explicitly via SetPropertyValidator will override this.<p>

607

In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):<p>

608

<pre class="fragment"><div> wxValidator* wxMyPropertyClass::DoGetValidator ()<span class="keyword"> const</span>

609

<span class="keyword"> </span>{

610

WX_PG_DOGETVALIDATOR_ENTRY()

611

612

wxMyValidator* validator = <span class="keyword">new</span> wxMyValidator(...);

613

614

... prepare validator...

615

616

WX_PG_DOGETVALIDATOR_EXIT(validator)

617

}

618

</div></pre><p>

619

<dl compact><dt><b>Remarks:</b></dt><dd>You can get common filename validator by returning wxFilePropertyClass::GetClassValidator(). wxDirProperty, for example, uses it. </dd></dl>

620

</td>

621

</tr>

622

</table>

623

624

625

<tr>

626

627

628

<tr>

629

<td class="md" nowrap valign="top"> virtual wxPGVariant wxCustomPropertyClass::DoGetValue </td>

630

631

632

633

<td class="md" nowrap> const<code> [virtual]</code></td>

634

</tr>

635

636

</table>

637

</td>

638

</tr>

639

</table>

640

641

<tr>

642

<td>

643

644

</td>

645

<td>

646

647

<p>

648

Returns properly constructed wxPGVariant.

649

<p>

650

651

<p>

652

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxPropertyCategoryClassa10">wxPGProperty</a>. </td>

653

</tr>

654

</table>

655

656

657

<tr>

658

659

660

<tr>

661

<td class="md" nowrap valign="top"> virtual void wxCustomPropertyClass::DoSetValue </td>

662

663

<td class="md" nowrap valign="top">wxPGVariant </td>

664

<td class="mdname1" valign="top" nowrap> <em>value</em> </td>

665

666

<td class="md" nowrap><code> [virtual]</code></td>

667

</tr>

668

669

</table>

670

</td>

671

</tr>

672

</table>

673

674

<tr>

675

<td>

676

677

</td>

678

<td>

679

680

<p>

681

Sets property's internal value.

682

<p>

683

<dl compact><dt><b>Parameters:</b></dt><dd>

684

685

<tr><td valign=top><em>value</em> </td><td>Simple container with GetString(), GetLong() etc. methods. Currently recommended means to extract value is to use wxPGVariantToXXX(value) macro. </td></tr>

686

</table>

687

</dl>

688

<dl compact><dt><b>Remarks:</b></dt><dd>Example pseudo-implementation with comments: <pre class="fragment"><div> <span class="keywordtype">void</span> wxMyProperty::DoSetValue ( wxPGVariant value )

689

{

690

<span class="comment">// A) Get value. For example</span>

691

<span class="keyword">const</span> wxMyValueType* pvalue = wxPGVariantToWxObjectPtr(value,wxMyValueType);

692

693

<span class="keyword">const</span> wxString& str = wxPGVariantToString(value);

694

695

<span class="keywordtype">long</span> val = wxPGVariantToLong(value);

696

697

<span class="comment">// B) If value is wxObject or void based with NULL default, then handle that:</span>

698

<span class="keywordflow">if</span> ( pvalue )

699

m_value = *pvalue;

700

701

pmyvalue->SetToDefault();

702

703

<span class="comment">// Otherwise</span>

704

<span class="comment">// m_value = *pvalue;</span>

705

<span class="comment">// is sufficient.</span>

706

707

<span class="comment">// C) If has children, this should be here (before displaying in control).</span>

708

RefreshChildren();

709

710

}

711

</div></pre></dd></dl>

712

713

<p>

714

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxPropertyCategoryClassa12">wxPGProperty</a>. </td>

715

</tr>

716

</table>

717

718

719

<tr>

720

721

722

<tr>

723

<td class="md" nowrap valign="top"> void wxPGPropertyWithChildren::Empty </td>

724

725

726

727

<td class="md" nowrap><code> [inherited]</code></td>

728

</tr>

729

730

</table>

731

</td>

732

</tr>

733

</table>

734

735

<tr>

736

<td>

737

738

</td>

739

<td>

740

741

<p>

742

Deletes all sub-properties.

743

<p>

744

</td>

745

</tr>

746

</table>

747

748

749

<tr>

750

751

752

<tr>

753

<td class="md" nowrap valign="top"> bool wxPGProperty::EnsureDataExt </td>

754

755

756

757

<td class="md" nowrap><code> [inherited]</code></td>

758

</tr>

759

760

</table>

761

</td>

762

</tr>

763

</table>

764

765

<tr>

766

<td>

767

768

</td>

769

<td>

770

771

<p>

772

If property did not have data extension, one is created now (returns true in that case).

773

<p>

774

</td>

775

</tr>

776

</table>

777

778

779

<tr>

780

781

782

<tr>

783

<td class="md" nowrap valign="top"> wxString wxPGProperty::GetAttributes </td>

784

785

<td class="md" nowrap valign="top">unsigned int </td>

786

<td class="mdname1" valign="top" nowrap> <em>flagmask</em> = 0xFFFF </td>

787

788

<td class="md" nowrap><code> [inherited]</code></td>

789

</tr>

790

791

</table>

792

</td>

793

</tr>

794

</table>

795

796

<tr>

797

<td>

798

799

</td>

800

<td>

801

802

<p>

803

Returns comma-delimited string of property attributes.

804

<p>

805

</td>

806

</tr>

807

</table>

808

809

810

<tr>

811

812

813

<tr>

814

<td class="md" nowrap valign="top"> size_t wxPGProperty::GetChildCount </td>

815

816

817

818

<td class="md" nowrap> const<code> [inherited]</code></td>

819

</tr>

820

821

</table>

822

</td>

823

</tr>

824

</table>

825

826

<tr>

827

<td>

828

829

</td>

830

<td>

831

832

<p>

833

Returns number of children (always 0 for normal properties).

834

<p>

835

</td>

836

</tr>

837

</table>

838

839

840

<tr>

841

842

843

<tr>

844

<td class="md" nowrap valign="top"> virtual int wxCustomPropertyClass::GetChoiceInfo </td>

845

846

<td class="md" nowrap valign="top">wxPGChoiceInfo * </td>

847

<td class="mdname1" valign="top" nowrap> <em>choiceinfo</em> </td>

848

849

<td class="md" nowrap><code> [virtual]</code></td>

850

</tr>

851

852

</table>

853

</td>

854

</tr>

855

</table>

856

857

<tr>

858

<td>

859

860

</td>

861

<td>

862

863

<p>

864

Returns current value's index to the choice control.

865

<p>

866

May also return, through pointer arguments, strings that should be inserted to that control. Irrelevant to classes which do not employ wxPG_EDITOR(Choice) or similar. <dl compact><dt><b>Remarks:</b></dt><dd><ul>

867

<li>If returns -1 in choiceinfo->m_itemCount, then in that case this class be derived from wxBaseEnumPropertyClass (see <a class="el" href="propdev_8h.htm">propdev.h</a>) and GetEntry is used to fill an array (slower, but handier if you don't store your labels as arrays of strings).</li><li>Must not crash even if property's set of choices is uninitialized (i.e. it points to wxPGGlobalVars->m_emptyConstants). </li></ul>

868

</dd></dl>

869

870

<p>

871

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa13">wxPGProperty</a>. </td>

872

</tr>

873

</table>

874

875

876

<tr>

877

878

879

<tr>

880

<td class="md" nowrap valign="top"> virtual const <a class="el" href="structwxPGPropertyClassInfo.htm">wxPGPropertyClassInfo</a>* wxPGProperty::GetClassInfo </td>

881

882

883

884

<td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>

885

</tr>

886

887

</table>

888

</td>

889

</tr>

890

</table>

891

892

<tr>

893

<td>

894

895

</td>

896

<td>

897

898

<p>

899

Returns classinfo of the property class.

900

<p>

901

902

<p>

903

Implemented in <a class="el" href="classwxPGRootPropertyClass.htm#wxPGRootPropertyClassa19">wxPGRootPropertyClass</a>, and <a class="el" href="classwxPropertyCategoryClass.htm#wxPropertyCategoryClassa20">wxPropertyCategoryClass</a>. </td>

904

</tr>

905

</table>

906

907

908

<tr>

909

910

911

<tr>

912

<td class="md" nowrap valign="top"> virtual const wxChar* wxPGProperty::GetClassName </td>

913

914

915

916

<td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>

917

</tr>

918

919

</table>

920

</td>

921

</tr>

922

</table>

923

924

<tr>

925

<td>

926

927

</td>

928

<td>

929

930

<p>

931

Returns classname (for example, "wxStringProperty" for wxStringProperty) of a property class.

932

<p>

933

934

<p>

935

Implemented in <a class="el" href="classwxPGRootPropertyClass.htm#wxPGRootPropertyClassa20">wxPGRootPropertyClass</a>, and <a class="el" href="classwxPropertyCategoryClass.htm#wxPropertyCategoryClassa21">wxPropertyCategoryClass</a>. </td>

936

</tr>

937

</table>

938

939

940

<tr>

941

942

943

<tr>

944

<td class="md" nowrap valign="top"> size_t wxPGPropertyWithChildren::GetCount </td>

945

946

947

948

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

949

</tr>

950

951

</table>

952

</td>

953

</tr>

954

</table>

955

956

<tr>

957

<td>

958

959

</td>

960

<td>

961

962

<p>

963

Returns number of sub-properties.

964

<p>

965

</td>

966

</tr>

967

</table>

968

969

970

<tr>

971

972

973

<tr>

974

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGPropertyDataExt.htm">wxPGPropertyDataExt</a>* wxPGProperty::GetDataExt </td>

975

976

977

978

<td class="md" nowrap><code> [inline, inherited]</code></td>

979

</tr>

980

981

</table>

982

</td>

983

</tr>

984

</table>

985

986

<tr>

987

<td>

988

989

</td>

990

<td>

991

992

<p>

993

Returns property's data extension (NULL if none).

994

<p>

995

</td>

996

</tr>

997

</table>

998

999

1000

<tr>

1001

1002

1003

<tr>

1004

<td class="md" nowrap valign="top"> <a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a>* wxPGProperty::GetGrid </td>

1005

1006

1007

1008

<td class="md" nowrap> const<code> [inherited]</code></td>

1009

</tr>

1010

1011

</table>

1012

</td>

1013

</tr>

1014

</table>

1015

1016

<tr>

1017

<td>

1018

1019

</td>

1020

<td>

1021

1022

<p>

1023

Returns property grid where property lies.

1024

<p>

1025

</td>

1026

</tr>

1027

</table>

1028

1029

1030

<tr>

1031

1032

1033

<tr>

1034

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGId.htm">wxPGId</a> wxPGProperty::GetId </td>

1035

1036

1037

1038

<td class="md" nowrap><code> [inline, inherited]</code></td>

1039

</tr>

1040

1041

</table>

1042

</td>

1043

</tr>

1044

</table>

1045

1046

<tr>

1047

<td>

1048

1049

</td>

1050

<td>

1051

1052

<p>

1053

Returns property id.

1054

<p>

1055

</td>

1056

</tr>

1057

</table>

1058

1059

1060

<tr>

1061

1062

1063

<tr>

1064

<td class="md" nowrap valign="top"> virtual wxSize wxCustomPropertyClass::GetImageSize </td>

1065

1066

1067

1068

<td class="md" nowrap> const<code> [virtual]</code></td>

1069

</tr>

1070

1071

</table>

1072

</td>

1073

</tr>

1074

</table>

1075

1076

<tr>

1077

<td>

1078

1079

</td>

1080

<td>

1081

1082

<p>

1083

Returns size of the custom painted image in front of property.

1084

<p>

1085

This method must be overridden to return non-default value if OnCustomPaint is to be called. <dl compact><dt><b>Remarks:</b></dt><dd><ul>

1086

<li>If flexible image size is desired, return <a class="el" href="group__miscellaneous.htm#ga9">wxPG_FLEXIBLE_SIZE(wid,hei)</a>. OnCustomPaint is then called to measure items as well (see for <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa54">wxPGProperty::OnCustomPaint</a> for measure call specs).</li><li>If entire property, including text, is to be custom painted, then <a class="el" href="group__miscellaneous.htm#ga11">wxPG_FULL_CUSTOM_PAINT_SIZE(hei)</a> or <a class="el" href="group__miscellaneous.htm#ga12">wxPG_FULL_CUSTOM_PAINT_FLEXIBLE_SIZE(hei)</a> is to be returned.</li><li>Default behaviour is to return wxSize(0,0), which means no image.</li><li>Default image width or height is indicated with dimension -1. </li></ul>

1087

</dd></dl>

1088

1089

<p>

1090

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa25">wxPGProperty</a>. </td>

1091

</tr>

1092

</table>

1093

1094

1095

<tr>

1096

1097

1098

<tr>

1099

<td class="md" nowrap valign="top"> unsigned int wxPGProperty::GetIndexInParent </td>

1100

1101

1102

1103

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1104

</tr>

1105

1106

</table>

1107

</td>

1108

</tr>

1109

</table>

1110

1111

<tr>

1112

<td>

1113

1114

</td>

1115

<td>

1116

1117

<p>

1118

Returns position in parent's array.

1119

<p>

1120

</td>

1121

</tr>

1122

</table>

1123

1124

1125

<tr>

1126

1127

1128

<tr>

1129

<td class="md" nowrap valign="top"> const wxString& wxPGProperty::GetLabel </td>

1130

1131

1132

1133

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1134

</tr>

1135

1136

</table>

1137

</td>

1138

</tr>

1139

</table>

1140

1141

<tr>

1142

<td>

1143

1144

</td>

1145

<td>

1146

1147

<p>

1148

Returns property's label.

1149

<p>

1150

</td>

1151

</tr>

1152

</table>

1153

1154

1155

<tr>

1156

1157

1158

<tr>

1159

<td class="md" nowrap valign="top"> const <a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* wxPGProperty::GetLastVisibleSubItem </td>

1160

1161

1162

1163

<td class="md" nowrap> const<code> [inherited]</code></td>

1164

</tr>

1165

1166

</table>

1167

</td>

1168

</tr>

1169

</table>

1170

1171

<tr>

1172

<td>

1173

1174

</td>

1175

<td>

1176

1177

<p>

1178

Returns last visible sub-property, recursively.

1179

<p>

1180

</td>

1181

</tr>

1182

</table>

1183

1184

1185

<tr>

1186

1187

1188

<tr>

1189

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* wxPGProperty::GetMainParent </td>

1190

1191

1192

1193

<td class="md" nowrap> const<code> [inherited]</code></td>

1194

</tr>

1195

1196

</table>

1197

</td>

1198

</tr>

1199

</table>

1200

1201

<tr>

1202

<td>

1203

1204

</td>

1205

<td>

1206

1207

<p>

1208

Returns highest level non-category, non-root parent.

1209

<p>

1210

Useful when you have nested wxCustomProperties/wxParentProperties. <dl compact><dt><b>Remarks:</b></dt><dd>Thus, if immediate parent is root or category, this will return the property itself. </dd></dl>

1211

</td>

1212

</tr>

1213

</table>

1214

1215

1216

<tr>

1217

1218

1219

<tr>

1220

<td class="md" nowrap valign="top"> const wxString& wxPGProperty::GetName </td>

1221

1222

1223

1224

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1225

</tr>

1226

1227

</table>

1228

</td>

1229

</tr>

1230

</table>

1231

1232

<tr>

1233

<td>

1234

1235

</td>

1236

<td>

1237

1238

<p>

1239

Returns property's name (alternate way to access property).

1240

<p>

1241

</td>

1242

</tr>

1243

</table>

1244

1245

1246

<tr>

1247

1248

1249

<tr>

1250

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGPropertyWithChildren.htm">wxPGPropertyWithChildren</a>* wxPGProperty::GetParent </td>

1251

1252

1253

1254

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1255

</tr>

1256

1257

</table>

1258

</td>

1259

</tr>

1260

</table>

1261

1262

<tr>

1263

<td>

1264

1265

</td>

1266

<td>

1267

1268

<p>

1269

Return parent of property.

1270

<p>

1271

</td>

1272

</tr>

1273

</table>

1274

1275

1276

<tr>

1277

1278

1279

<tr>

1280

<td class="md" nowrap valign="top"> signed char wxPGProperty::GetParentingType </td>

1281

1282

1283

1284

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1285

</tr>

1286

1287

</table>

1288

</td>

1289

</tr>

1290

</table>

1291

1292

<tr>

1293

<td>

1294

1295

</td>

1296

<td>

1297

1298

<p>

1299

Returns 0 for normal items.

1300

<p>

1301

1 for categories, -1 for other properties with children, -2 for wxCustomProperty (mostly like -1 ones but with few expections). <dl compact><dt><b>Remarks:</b></dt><dd>Should not be overridden by new custom properties. Usually only used internally. </dd></dl>

1302

</td>

1303

</tr>

1304

</table>

1305

1306

1307

<tr>

1308

1309

1310

<tr>

1311

<td class="md" nowrap valign="top"> <a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a>* wxPGPropertyWithChildren::GetParentState </td>

1312

1313

1314

1315

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1316

</tr>

1317

1318

</table>

1319

</td>

1320

</tr>

1321

</table>

1322

1323

<tr>

1324

<td>

1325

1326

</td>

1327

<td>

1328

1329

<p>

1330

Returns <a class="el" href="classwxPropertyGridState.htm">wxPropertyGridState</a> to which this property belongs.

1331

<p>

1332

1333

<p>

1334

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa34">wxPGProperty</a>. </td>

1335

</tr>

1336

</table>

1337

1338

1339

<tr>

1340

1341

1342

<tr>

1343

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* wxPGPropertyWithChildren::GetPropertyByName </td>

1344

1345

<td class="md" nowrap valign="top">const wxString & </td>

1346

1347

1348

<td class="md" nowrap> const<code> [inherited]</code></td>

1349

</tr>

1350

1351

</table>

1352

</td>

1353

</tr>

1354

</table>

1355

1356

<tr>

1357

<td>

1358

1359

</td>

1360

<td>

1361

1362

<p>

1363

Returns (direct) child property with given name (or NULL if not found).

1364

<p>

1365

</td>

1366

</tr>

1367

</table>

1368

1369

1370

<tr>

1371

1372

1373

<tr>

1374

<td class="md" nowrap valign="top"> const wxChar* wxPGProperty::GetType </td>

1375

1376

1377

1378

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1379

</tr>

1380

1381

</table>

1382

</td>

1383

</tr>

1384

</table>

1385

1386

<tr>

1387

<td>

1388

1389

</td>

1390

<td>

1391

1392

<p>

1393

Returns type name of property that is compatible with CreatePropertyByType.

1394

<p>

1395

and wxVariant::GetType. </td>

1396

</tr>

1397

</table>

1398

1399

1400

<tr>

1401

1402

1403

<tr>

1404

<td class="md" nowrap valign="top"> wxValidator* wxPGProperty::GetValidator </td>

1405

1406

1407

1408

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1409

</tr>

1410

1411

</table>

1412

</td>

1413

</tr>

1414

</table>

1415

1416

<tr>

1417

<td>

1418

1419

</td>

1420

<td>

1421

1422

<p>

1423

Gets assignable version of property's validator.

1424

<p>

1425

</td>

1426

</tr>

1427

</table>

1428

1429

1430

<tr>

1431

1432

1433

<tr>

1434

<td class="md" nowrap valign="top"> virtual wxString wxCustomPropertyClass::GetValueAsString </td>

1435

1436

1437

<td class="mdname1" valign="top" nowrap> <em>argFlags</em> </td>

1438

1439

<td class="md" nowrap> const<code> [virtual]</code></td>

1440

</tr>

1441

1442

</table>

1443

</td>

1444

</tr>

1445

</table>

1446

1447

<tr>

1448

<td>

1449

1450

</td>

1451

<td>

1452

1453

<p>

1454

Advanced variant of <a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa45">GetValueAsString()</a> that forms a string that contains sequence of text representations of sub-properties.

1455

<p>

1456

1457

<p>

1458

Reimplemented from <a class="el" href="classwxPGPropertyWithChildren.htm#wxPGRootPropertyClassa45">wxPGPropertyWithChildren</a>. </td>

1459

</tr>

1460

</table>

1461

1462

1463

<tr>

1464

1465

1466

<tr>

1467

<td class="md" nowrap valign="top"> wxVariant wxPGProperty::GetValueAsVariant </td>

1468

1469

1470

1471

<td class="md" nowrap> const<code> [inherited]</code></td>

1472

</tr>

1473

1474

</table>

1475

</td>

1476

</tr>

1477

</table>

1478

1479

<tr>

1480

<td>

1481

1482

</td>

1483

<td>

1484

1485

<p>

1486

Returns value as wxVariant.

1487

<p>

1488

</td>

1489

</tr>

1490

</table>

1491

1492

1493

<tr>

1494

1495

1496

<tr>

1497

<td class="md" nowrap valign="top"> virtual const <a class="el" href="classwxPGValueType.htm">wxPGValueType</a>* wxPGProperty::GetValueType </td>

1498

1499

1500

1501

<td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>

1502

</tr>

1503

1504

</table>

1505

</td>

1506

</tr>

1507

</table>

1508

1509

<tr>

1510

<td>

1511

1512

</td>

1513

<td>

1514

1515

<p>

1516

Returns pointer to the object that has methods related to the value type of this property.

1517

<p>

1518

Keep atleast this method abstract so the class is kept abstract.

1519

<p>

1520

Implemented in <a class="el" href="classwxPGRootPropertyClass.htm#wxPGRootPropertyClassa48">wxPGRootPropertyClass</a>, and <a class="el" href="classwxPropertyCategoryClass.htm#wxPropertyCategoryClassa51">wxPropertyCategoryClass</a>. </td>

1521

</tr>

1522

</table>

1523

1524

1525

<tr>

1526

1527

1528

<tr>

1529

<td class="md" nowrap valign="top"> int wxPGProperty::GetY </td>

1530

1531

1532

1533

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1534

</tr>

1535

1536

</table>

1537

</td>

1538

</tr>

1539

</table>

1540

1541

<tr>

1542

<td>

1543

1544

</td>

1545

<td>

1546

1547

<p>

1548

Gets pre-calculated top y coordinate of property graphics.

1549

<p>

1550

This cannot be relied on all times (<a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> knows when :) ), and value is -1 if property is not visible. </td>

1551

</tr>

1552

</table>

1553

1554

1555

<tr>

1556

1557

1558

<tr>

1559

<td class="md" nowrap valign="top"> bool wxPGProperty::Hide </td>

1560

1561

1562

1563

1564

<td class="md" nowrap><code> [inline, inherited]</code></td>

1565

</tr>

1566

1567

</table>

1568

</td>

1569

</tr>

1570

</table>

1571

1572

<tr>

1573

<td>

1574

1575

</td>

1576

<td>

1577

1578

<p>

1579

Hides or reveals the property.

1580

<p>

1581

<dl compact><dt><b>Parameters:</b></dt><dd>

1582

1583

<tr><td valign=top><em>hide</em> </td><td>true for hide, false for reveal. </td></tr>

1584

</table>

1585

</dl>

1586

</td>

1587

</tr>

1588

</table>

1589

1590

1591

<tr>

1592

1593

1594

<tr>

1595

<td class="md" nowrap valign="top"> int wxPGPropertyWithChildren::Index </td>

1596

1597

<td class="md" nowrap valign="top">const <a class="el" href="classwxPGProperty.htm">wxPGProperty</a> * </td>

1598

1599

1600

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1601

</tr>

1602

1603

</table>

1604

</td>

1605

</tr>

1606

</table>

1607

1608

<tr>

1609

<td>

1610

1611

</td>

1612

<td>

1613

1614

<p>

1615

Returns index of given sub-property.

1616

<p>

1617

</td>

1618

</tr>

1619

</table>

1620

1621

1622

<tr>

1623

1624

1625

<tr>

1626

<td class="md" nowrap valign="top"> void wxPGProperty::Init </td>

1627

1628

<td class="md" nowrap valign="top">const wxString & </td>

1629

<td class="mdname" nowrap> <em>label</em>, </td>

1630

</tr>

1631

<tr>

1632

1633

1634

<td class="md" nowrap>const wxString & </td>

1635

1636

</tr>

1637

<tr>

1638

1639

1640

<td class="md" colspan="2"><code> [inherited]</code></td>

1641

</tr>

1642

1643

</table>

1644

</td>

1645

</tr>

1646

</table>

1647

1648

<tr>

1649

<td>

1650

1651

</td>

1652

<td>

1653

1654

<p>

1655

Initializes the property.

1656

<p>

1657

Usually only called in the constructor. </td>

1658

</tr>

1659

</table>

1660

1661

1662

<tr>

1663

1664

1665

<tr>

1666

<td class="md" nowrap valign="top"> int wxPGProperty::InsertChoice </td>

1667

1668

<td class="md" nowrap valign="top">const wxString & </td>

1669

<td class="mdname" nowrap> <em>label</em>, </td>

1670

</tr>

1671

<tr>

1672

1673

1674

1675

<td class="mdname" nowrap> <em>index</em>, </td>

1676

</tr>

1677

<tr>

1678

1679

1680

1681

<td class="mdname" nowrap> <em>value</em> = INT_MAX</td>

1682

</tr>

1683

<tr>

1684

1685

1686

<td class="md" colspan="2"><code> [inherited]</code></td>

1687

</tr>

1688

1689

</table>

1690

</td>

1691

</tr>

1692

</table>

1693

1694

<tr>

1695

<td>

1696

1697

</td>

1698

<td>

1699

1700

<p>

1701

Adds entry to property's <a class="el" href="classwxPGChoices.htm">wxPGChoices</a> and editor control (if it is active).

1702

<p>

1703

Returns index of item added. </td>

1704

</tr>

1705

</table>

1706

1707

1708

<tr>

1709

1710

1711

<tr>

1712

<td class="md" nowrap valign="top"> bool wxPGProperty::IsOk </td>

1713

1714

1715

1716

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1717

</tr>

1718

1719

</table>

1720

</td>

1721

</tr>

1722

</table>

1723

1724

<tr>

1725

<td>

1726

1727

</td>

1728

<td>

1729

1730

<p>

1731

Returns true if property is valid and <a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> methods can operate on it safely.

1732

<p>

1733

</td>

1734

</tr>

1735

</table>

1736

1737

1738

<tr>

1739

1740

1741

<tr>

1742

<td class="md" nowrap valign="top"> bool wxPGProperty::IsSubProperty </td>

1743

1744

1745

1746

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1747

</tr>

1748

1749

</table>

1750

</td>

1751

</tr>

1752

</table>

1753

1754

<tr>

1755

<td>

1756

1757

</td>

1758

<td>

1759

1760

<p>

1761

Returns true if this is a sub-property.

1762

<p>

1763

</td>

1764

</tr>

1765

</table>

1766

1767

1768

<tr>

1769

1770

1771

<tr>

1772

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* wxPGPropertyWithChildren::Item </td>

1773

1774

1775

1776

1777

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1778

</tr>

1779

1780

</table>

1781

</td>

1782

</tr>

1783

</table>

1784

1785

<tr>

1786

<td>

1787

1788

</td>

1789

<td>

1790

1791

<p>

1792

Returns sub-property at index i.

1793

<p>

1794

</td>

1795

</tr>

1796

</table>

1797

1798

1799

<tr>

1800

1801

1802

<tr>

1803

<td class="md" nowrap valign="top"> <a class="el" href="classwxPGProperty.htm">wxPGProperty</a>* wxPGPropertyWithChildren::Last </td>

1804

1805

1806

1807

<td class="md" nowrap> const<code> [inline, inherited]</code></td>

1808

</tr>

1809

1810

</table>

1811

</td>

1812

</tr>

1813

</table>

1814

1815

<tr>

1816

<td>

1817

1818

</td>

1819

<td>

1820

1821

<p>

1822

Returns last sub-property.

1823

<p>

1824

</td>

1825

</tr>

1826

</table>

1827

1828

1829

<tr>

1830

1831

1832

<tr>

1833

<td class="md" nowrap valign="top"> virtual void wxCustomPropertyClass::OnCustomPaint </td>

1834

1835

1836

1837

</tr>

1838

<tr>

1839

1840

1841

<td class="md" nowrap>const wxRect & </td>

1842

1843

</tr>

1844

<tr>

1845

1846

1847

<td class="md" nowrap><a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> & </td>

1848

<td class="mdname" nowrap> <em>paintdata</em></td>

1849

</tr>

1850

<tr>

1851

1852

1853

<td class="md" colspan="2"><code> [virtual]</code></td>

1854

</tr>

1855

1856

</table>

1857

</td>

1858

</tr>

1859

</table>

1860

1861

<tr>

1862

<td>

1863

1864

</td>

1865

<td>

1866

1867

<p>

1868

Override to paint an image in front of the property value text or drop-down list item (but only if <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa25">wxPGProperty::GetImageSize</a> is overridden as well).

1869

<p>

1870

If property's <a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa31">GetImageSize()</a> returns size that has height != 0 but less than row height ( < 0 has special meanings), <a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case <a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa31">GetImageSize()</a> returned higher height than row height).<p>

1871

NOTE: Following applies when <a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa31">GetImageSize()</a> returns a "flexible" height ( using <a class="el" href="group__miscellaneous.htm#ga9">wxPG_FLEXIBLE_SIZE(W,H)</a> macro), which implies variable height items: If rect.x is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.<p>

1872

<dl compact><dt><b>Parameters:</b></dt><dd>

1873

1874

<tr><td valign=top><em>dc</em> </td><td>wxDC to paint on. </td></tr>

1875

<tr><td valign=top><em>rect</em> </td><td>Box reserved for custom graphics. Includes surrounding rectangle, if any. If x is < 0, then this is a measure item call (see above). </td></tr>

1876

<tr><td valign=top><em>paintdata</em> </td><td><a class="el" href="structwxPGPaintData.htm">wxPGPaintData</a> structure with much useful data.</td></tr>

1877

</table>

1878

</dl>

1879

<dl compact><dt><b>Remarks:</b></dt><dd><ul>

1880

<li>You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.</li><li>Due to technical reasons, rect's height will be default even if custom height was reported during measure call.</li><li>Changing font and text colour affects the text drawn next to the painted image (which is done immediately after the OnCustomPaint call finishes).</li><li>Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.</li><li>Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well. </li></ul>

1881

</dd></dl>

1882

1883

1884

<p>

1885

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa54">wxPGProperty</a>. </td>

1886

</tr>

1887

</table>

1888

1889

1890

<tr>

1891

1892

1893

<tr>

1894

<td class="md" nowrap valign="top"> virtual bool wxPGProperty::OnEvent </td>

1895

1896

<td class="md" nowrap valign="top"><a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> * </td>

1897

<td class="mdname" nowrap> <em>propgrid</em>, </td>

1898

</tr>

1899

<tr>

1900

1901

1902

<td class="md" nowrap>wxWindow * </td>

1903

<td class="mdname" nowrap> <em>wnd_primary</em>, </td>

1904

</tr>

1905

<tr>

1906

1907

1908

<td class="md" nowrap>wxEvent & </td>

1909

<td class="mdname" nowrap> <em>event</em></td>

1910

</tr>

1911

<tr>

1912

1913

1914

<td class="md" colspan="2"><code> [virtual, inherited]</code></td>

1915

</tr>

1916

1917

</table>

1918

</td>

1919

</tr>

1920

</table>

1921

1922

<tr>

1923

<td>

1924

1925

</td>

1926

<td>

1927

1928

<p>

1929

Events received by editor widgets are processed here.

1930

<p>

1931

Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, should be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, wxSystemColourProperty custom handles wxEVT_COMMAND_CHOICE_SELECTED). <dl compact><dt><b>Parameters:</b></dt><dd>

1932

1933

<tr><td valign=top><em>event</em> </td><td>Associated wxEvent. </td></tr>

1934

</table>

1935

</dl>

1936

<dl compact><dt><b>Return values:</b></dt><dd>

1937

1938

<tr><td valign=top><em>Should</em> </td><td>return true if any changes in value should be reported. This is case, for example, when enter is pressed in wxTextCtrl. </td></tr>

1939

</table>

1940

</dl>

1941

</td>

1942

</tr>

1943

</table>

1944

1945

1946

<tr>

1947

1948

1949

<tr>

1950

<td class="md" nowrap valign="top"> bool wxPGProperty::PrepareValueForDialogEditing </td>

1951

1952

<td class="md" nowrap valign="top"><a class="el" href="classwxPropertyGrid.htm">wxPropertyGrid</a> * </td>

1953

<td class="mdname1" valign="top" nowrap> <em>propgrid</em> </td>

1954

1955

<td class="md" nowrap><code> [inherited]</code></td>

1956

</tr>

1957

1958

</table>

1959

</td>

1960

</tr>

1961

</table>

1962

1963

<tr>

1964

<td>

1965

1966

</td>

1967

<td>

1968

1969

<p>

1970

Updates property value in case there were last minute changes.

1971

<p>

1972

If value was unspecified, it will be set to default. Use only for properties that have TextCtrl-based editor. <dl compact><dt><b>Remarks:</b></dt><dd>If you have code similar to <pre class="fragment"><div> <span class="comment">// Update the value in case of last minute changes</span>

1973

<span class="keywordflow">if</span> ( primary && propgrid->IsEditorsValueModified() )

1974

GetEditorClass()-><a class="code" href="classwxPGEditor.htm#wxPGEditora1">CopyValueFromControl</a>( <span class="keyword">this</span>, primary );

1975

</div></pre>in <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa55">wxPGProperty::OnEvent</a> wxEVT_COMMAND_BUTTON_CLICKED handler, then replace it with call to this method. </dd></dl>

1976

<dl compact><dt><b>Return values:</b></dt><dd>

1977

1978

<tr><td valign=top><em>True</em> </td><td>if value changed. </td></tr>

1979

</table>

1980

</dl>

1981

</td>

1982

</tr>

1983

</table>

1984

1985

1986

<tr>

1987

1988

1989

<tr>

1990

<td class="md" nowrap valign="top"> bool wxPGProperty::RecreateEditor </td>

1991

1992

1993

1994

<td class="md" nowrap><code> [inherited]</code></td>

1995

</tr>

1996

1997

</table>

1998

</td>

1999

</tr>

2000

</table>

2001

2002

<tr>

2003

<td>

2004

2005

</td>

2006

<td>

2007

2008

<p>

2009

If property's editor is created this forces its recreation.

2010

<p>

2011

Useful in SetAttribute etc. Returns true if actually did anything. </td>

2012

</tr>

2013

</table>

2014

2015

2016

<tr>

2017

2018

2019

<tr>

2020

<td class="md" nowrap valign="top"> virtual void wxPGPropertyWithChildren::RefreshChildren </td>

2021

2022

2023

2024

<td class="md" nowrap><code> [virtual, inherited]</code></td>

2025

</tr>

2026

2027

</table>

2028

</td>

2029

</tr>

2030

</table>

2031

2032

<tr>

2033

<td>

2034

2035

</td>

2036

<td>

2037

2038

<p>

2039

Refresh values of child properties.

2040

<p>

2041

</td>

2042

</tr>

2043

</table>

2044

2045

2046

<tr>

2047

2048

2049

<tr>

2050

<td class="md" nowrap valign="top"> virtual void wxCustomPropertyClass::SetAttribute </td>

2051

2052

2053

2054

</tr>

2055

<tr>

2056

2057

2058

<td class="md" nowrap>wxVariant & </td>

2059

<td class="mdname" nowrap> <em>value</em></td>

2060

</tr>

2061

<tr>

2062

2063

2064

<td class="md" colspan="2"><code> [virtual]</code></td>

2065

</tr>

2066

2067

</table>

2068

</td>

2069

</tr>

2070

</table>

2071

2072

<tr>

2073

<td>

2074

2075

</td>

2076

<td>

2077

2078

<p>

2079

Sets an attribute of this property.

2080

<p>

2081

This is quite property class specific, and there are no common attributes. Note that attribute may be specific to a property instance, or it may affect all properties of its class. <dl compact><dt><b>Parameters:</b></dt><dd>

2082

2083

<tr><td valign=top><em>id</em> </td><td>Identifier of attribute </td></tr>

2084

<tr><td valign=top><em>value</em> </td><td>Value for that attribute. </td></tr>

2085

</table>

2086

</dl>

2087

2088

<p>

2089

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxPropertyCategoryClassa76">wxPGProperty</a>. </td>

2090

</tr>

2091

</table>

2092

2093

2094

<tr>

2095

2096

2097

<tr>

2098

<td class="md" nowrap valign="top"> void wxPGProperty::SetAttributes </td>

2099

2100

<td class="md" nowrap valign="top">const wxString & </td>

2101

<td class="mdname1" valign="top" nowrap> <em>attributes</em> </td>

2102

2103

<td class="md" nowrap><code> [inherited]</code></td>

2104

</tr>

2105

2106

</table>

2107

</td>

2108

</tr>

2109

</table>

2110

2111

<tr>

2112

<td>

2113

2114

</td>

2115

<td>

2116

2117

<p>

2118

Sets attributes from a comma-delimited string.

2119

<p>

2120

</td>

2121

</tr>

2122

</table>

2123

2124

2125

<tr>

2126

2127

2128

<tr>

2129

<td class="md" nowrap valign="top"> bool wxPGProperty::SetChoices </td>

2130

2131

<td class="md" nowrap valign="top">const wxArrayString & </td>

2132

<td class="mdname" nowrap> <em>labels</em>, </td>

2133

</tr>

2134

<tr>

2135

2136

2137

<td class="md" nowrap>const wxArrayInt & </td>

2138

<td class="mdname" nowrap> <em>values</em> = (*((wxArrayInt *) NULL))</td>

2139

</tr>

2140

<tr>

2141

2142

2143

<td class="md" colspan="2"><code> [inline, inherited]</code></td>

2144

</tr>

2145

2146

</table>

2147

</td>

2148

</tr>

2149

</table>

2150

2151

<tr>

2152

<td>

2153

2154

</td>

2155

<td>

2156

2157

<p>

2158

Sets new set of choices for property.

2159

<p>

2160

</td>

2161

</tr>

2162

</table>

2163

2164

2165

<tr>

2166

2167

2168

<tr>

2169

<td class="md" nowrap valign="top"> bool wxPGProperty::SetChoices </td>

2170

2171

<td class="md" nowrap valign="top"><a class="el" href="classwxPGChoices.htm">wxPGChoices</a> & </td>

2172

<td class="mdname1" valign="top" nowrap> <em>choices</em> </td>

2173

2174

<td class="md" nowrap><code> [inherited]</code></td>

2175

</tr>

2176

2177

</table>

2178

</td>

2179

</tr>

2180

</table>

2181

2182

<tr>

2183

<td>

2184

2185

</td>

2186

<td>

2187

2188

<p>

2189

Sets new set of choices for property.

2190

<p>

2191

</td>

2192

</tr>

2193

</table>

2194

2195

2196

<tr>

2197

2198

2199

<tr>

2200

<td class="md" nowrap valign="top"> void wxPGProperty::SetChoiceSelection </td>

2201

2202

2203

<td class="mdname" nowrap> <em>newValue</em>, </td>

2204

</tr>

2205

<tr>

2206

2207

2208

<td class="md" nowrap>const wxPGChoiceInfo & </td>

2209

<td class="mdname" nowrap> <em>choiceInfo</em></td>

2210

</tr>

2211

<tr>

2212

2213

2214

<td class="md" colspan="2"><code> [inherited]</code></td>

2215

</tr>

2216

2217

</table>

2218

</td>

2219

</tr>

2220

</table>

2221

2222

<tr>

2223

<td>

2224

2225

</td>

2226

<td>

2227

2228

<p>

2229

Changes value of a property with choices, but only works if the value type is long or string.

2230

<p>

2231

</td>

2232

</tr>

2233

</table>

2234

2235

2236

<tr>

2237

2238

2239

<tr>

2240

<td class="md" nowrap valign="top"> void wxPGProperty::SetChoicesExclusive </td>

2241

2242

2243

2244

<td class="md" nowrap><code> [inherited]</code></td>

2245

</tr>

2246

2247

</table>

2248

</td>

2249

</tr>

2250

</table>

2251

2252

<tr>

2253

<td>

2254

2255

</td>

2256

<td>

2257

2258

<p>

2259

If property has choices and they are not yet exclusive, new such copy of them will be created.

2260

<p>

2261

</td>

2262

</tr>

2263

</table>

2264

2265

2266

<tr>

2267

2268

2269

<tr>

2270

<td class="md" nowrap valign="top"> void wxPGProperty::SetClientData </td>

2271

2272

<td class="md" nowrap valign="top">ClientDataType </td>

2273

<td class="mdname1" valign="top" nowrap> <em>clientData</em> </td>

2274

2275

<td class="md" nowrap><code> [inline, inherited]</code></td>

2276

</tr>

2277

2278

</table>

2279

</td>

2280

</tr>

2281

</table>

2282

2283

<tr>

2284

<td>

2285

2286

</td>

2287

<td>

2288

2289

<p>

2290

Sets client data (void*) of a property.

2291

<p>

2292

<dl compact><dt><b>Remarks:</b></dt><dd>This untyped client data has to be deleted manually. </dd></dl>

2293

</td>

2294

</tr>

2295

</table>

2296

2297

2298

<tr>

2299

2300

2301

<tr>

2302

<td class="md" nowrap valign="top"> void wxPGProperty::SetEditor </td>

2303

2304

<td class="md" nowrap valign="top">const wxString & </td>

2305

<td class="mdname1" valign="top" nowrap> <em>editorName</em> </td>

2306

2307

<td class="md" nowrap><code> [inline, inherited]</code></td>

2308

</tr>

2309

2310

</table>

2311

</td>

2312

</tr>

2313

</table>

2314

2315

<tr>

2316

<td>

2317

2318

</td>

2319

<td>

2320

2321

<p>

2322

Sets editor for a property.

2323

<p>

2324

</td>

2325

</tr>

2326

</table>

2327

2328

2329

<tr>

2330

2331

2332

<tr>

2333

<td class="md" nowrap valign="top"> void wxPGProperty::SetEditor </td>

2334

2335

<td class="md" nowrap valign="top">const <a class="el" href="classwxPGEditor.htm">wxPGEditor</a> * </td>

2336

<td class="mdname1" valign="top" nowrap> <em>editor</em> </td>

2337

2338

<td class="md" nowrap><code> [inline, inherited]</code></td>

2339

</tr>

2340

2341

</table>

2342

</td>

2343

</tr>

2344

</table>

2345

2346

<tr>

2347

<td>

2348

2349

</td>

2350

<td>

2351

2352

<p>

2353

Sets editor for a property.

2354

<p>

2355

</td>

2356

</tr>

2357

</table>

2358

2359

2360

<tr>

2361

2362

2363

<tr>

2364

<td class="md" nowrap valign="top"> bool wxPGProperty::SetMaxLength </td>

2365

2366

2367

<td class="mdname1" valign="top" nowrap> <em>maxLen</em> </td>

2368

2369

<td class="md" nowrap><code> [inline, inherited]</code></td>

2370

</tr>

2371

2372

</table>

2373

</td>

2374

</tr>

2375

</table>

2376

2377

<tr>

2378

<td>

2379

2380

</td>

2381

<td>

2382

2383

<p>

2384

Set max length of text editor.

2385

<p>

2386

</td>

2387

</tr>

2388

</table>

2389

2390

2391

<tr>

2392

2393

2394

<tr>

2395

<td class="md" nowrap valign="top"> void wxPGProperty::SetValidator </td>

2396

2397

<td class="md" nowrap valign="top">const wxValidator & </td>

2398

<td class="mdname1" valign="top" nowrap> <em>validator</em> </td>

2399

2400

<td class="md" nowrap><code> [inline, inherited]</code></td>

2401

</tr>

2402

2403

</table>

2404

</td>

2405

</tr>

2406

</table>

2407

2408

<tr>

2409

<td>

2410

2411

</td>

2412

<td>

2413

2414

<p>

2415

Sets wxValidator for a property.

2416

<p>

2417

</td>

2418

</tr>

2419

</table>

2420

2421

2422

<tr>

2423

2424

2425

<tr>

2426

<td class="md" nowrap valign="top"> virtual bool wxCustomPropertyClass::SetValueFromInt </td>

2427

2428

2429

<td class="mdname" nowrap> <em>value</em>, </td>

2430

</tr>

2431

<tr>

2432

2433

2434

2435

<td class="mdname" nowrap> <em>arg_flags</em></td>

2436

</tr>

2437

<tr>

2438

2439

2440

<td class="md" colspan="2"><code> [virtual]</code></td>

2441

</tr>

2442

2443

</table>

2444

</td>

2445

</tr>

2446

</table>

2447

2448

<tr>

2449

<td>

2450

2451

</td>

2452

<td>

2453

2454

<p>

2455

Converts integer to a value, and if succesfull, calls <a class="el" href="classwxCustomPropertyClass.htm#wxCustomPropertyClassa11">DoSetValue()</a> on it.

2456

<p>

2457

Default behaviour is to do nothing. <dl compact><dt><b>Parameters:</b></dt><dd>

2458

2459

<tr><td valign=top><em>value</em> </td><td>Int to get the value from. </td></tr>

2460

<tr><td valign=top><em>flags</em> </td><td>If has wxPG_FULL_VALUE, then the value given is a actual value and not an index. </td></tr>

2461

</table>

2462

</dl>

2463

<dl compact><dt><b>Return values:</b></dt><dd>

2464

2465

<tr><td valign=top><em>true</em> </td><td>if value was changed. </td></tr>

2466

</table>

2467

</dl>

2468

2469

<p>

2470

Reimplemented from <a class="el" href="classwxPGProperty.htm#wxStringPropertyClassa73">wxPGProperty</a>. </td>

2471

</tr>

2472

</table>

2473

2474

2475

<tr>

2476

2477

2478

<tr>

2479

<td class="md" nowrap valign="top"> virtual bool wxCustomPropertyClass::SetValueFromString </td>

2480

2481

<td class="md" nowrap valign="top">const wxString & </td>

2482

2483

</tr>

2484

<tr>

2485

2486

2487

2488

<td class="mdname" nowrap> <em>flags</em></td>

2489

</tr>

2490

<tr>

2491

2492

2493

<td class="md" colspan="2"><code> [virtual]</code></td>

2494

</tr>

2495

2496

</table>

2497

</td>

2498

</tr>

2499

</table>

2500

2501

<tr>

2502

<td>

2503

2504

</td>

2505

<td>

2506

2507

<p>

2508

This overridden version converts comma or semicolon separated tokens into child values.

2509

<p>

2510

2511

<p>

2512

Reimplemented from <a class="el" href="classwxPGPropertyWithChildren.htm#wxPropertyCategoryClassa93">wxPGPropertyWithChildren</a>. </td>

2513

</tr>

2514

</table>

2515

2516

2517

<tr>

2518

2519

2520

<tr>

2521

<td class="md" nowrap valign="top"> void wxPGProperty::SetValueImage </td>

2522

2523

<td class="md" nowrap valign="top">wxBitmap & </td>

2524

2525

2526

<td class="md" nowrap><code> [inherited]</code></td>

2527

</tr>

2528

2529

</table>

2530

</td>

2531

</tr>

2532

</table>

2533

2534

<tr>

2535

<td>

2536

2537

</td>

2538

<td>

2539

2540

<p>

2541

Set wxBitmap in front of the value.

2542

<p>

2543

This bitmap will be ignored if property class has implemented OnCustomPaint. </td>

2544

</tr>

2545

</table>

2546

2547

2548

<tr>

2549

2550

2551

<tr>

2552

<td class="md" nowrap valign="top"> bool wxPGProperty::UsesAutoUnspecified </td>

2553

2554

2555

2556

<td class="md" nowrap> const<code> [inherited]</code></td>

2557

</tr>

2558

2559

</table>

2560

</td>

2561

</tr>

2562

</table>

2563

2564

<tr>

2565

<td>

2566

2567

</td>

2568

<td>

2569

2570

<p>

2571

Returns true if containing grid uses wxPG_EX_AUTO_UNSPECIFIED_VALUES.

2572

<p>

2573

</td>

2574

</tr>

2575

</table>

2576

<hr>The documentation for this class was generated from the following file:<ul>

2577

<li>propdev.h</ul>

2578

<hr size="1"><address style="align: right;"><small>Generated on Mon Oct 29 16:56:23 2007 for wxPropertyGrid by

2579

2580

2581

</a>1.3.6 </small></address>

2582

</body>

2583

</html>

Older »