~elementary-os/elementaryos/os-patch-at-spi2-core-xenial

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-COORD-TYPE-COUNT:CAPS" title="ATSPI_COORD_TYPE_COUNT">ATSPI_COORD_TYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-SORTORDER-COUNT:CAPS" title="ATSPI_SORTORDER_COUNT">ATSPI_SORTORDER_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-MATCHTYPES-COUNT:CAPS" title="ATSPI_MATCHTYPES_COUNT">ATSPI_MATCHTYPES_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-COMPONENTLAYER-COUNT:CAPS" title="ATSPI_COMPONENTLAYER_COUNT">ATSPI_COMPONENTLAYER_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-TEXT-BOUNDARY-TYPE-COUNT:CAPS" title="ATSPI_TEXT_BOUNDARY_TYPE_COUNT">ATSPI_TEXT_BOUNDARY_TYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-TEXT-CLIP-TYPE-COUNT:CAPS" title="ATSPI_TEXT_CLIP_TYPE_COUNT">ATSPI_TEXT_CLIP_TYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-STATETYPE-COUNT:CAPS" title="ATSPI_STATETYPE_COUNT">ATSPI_STATETYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-KEYEVENTTYPE-COUNT:CAPS" title="ATSPI_KEYEVENTTYPE_COUNT">ATSPI_KEYEVENTTYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-EVENTTYPE-COUNT:CAPS" title="ATSPI_EVENTTYPE_COUNT">ATSPI_EVENTTYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-KEYSYNTHTYPE-COUNT:CAPS" title="ATSPI_KEYSYNTHTYPE_COUNT">ATSPI_KEYSYNTHTYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-MODIFIERTYPE-COUNT:CAPS" title="ATSPI_MODIFIERTYPE_COUNT">ATSPI_MODIFIERTYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-RELATIONTYPE-COUNT:CAPS" title="ATSPI_RELATIONTYPE_COUNT">ATSPI_RELATIONTYPE_COUNT</a></td>

</tr>

<tr>

<td class="define_keyword">#define</td>

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-ROLE-COUNT:CAPS" title="ATSPI_ROLE_COUNT">ATSPI_ROLE_COUNT</a></td>

</tr>

</tbody>

</table></div>

</div>

<a name="libatspi-atspi-constants.other"></a><h2>Types and Values</h2>

100

101

102

103

</colgroup>

104

<tbody>

105

<tr>

106

107

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiLocaleType" title="enum AtspiLocaleType">AtspiLocaleType</a></td>

108

</tr>

109

<tr>

110

<td class="define_keyword">#define</td>

111

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-LOCALE-TYPE:CAPS" title="ATSPI_LOCALE_TYPE">ATSPI_LOCALE_TYPE</a></td>

112

</tr>

113

<tr>

114

115

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType">AtspiCoordType</a></td>

116

</tr>

117

<tr>

118

119

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder">AtspiCollectionSortOrder</a></td>

120

</tr>

121

<tr>

122

123

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType">AtspiCollectionMatchType</a></td>

124

</tr>

125

<tr>

126

127

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType">AtspiCollectionTreeTraversalType</a></td>

128

</tr>

129

<tr>

130

<td class="define_keyword">#define</td>

131

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#ATSPI-TREETRAVERSALTYPE:CAPS" title="ATSPI_TREETRAVERSALTYPE">ATSPI_TREETRAVERSALTYPE</a></td>

132

</tr>

133

<tr>

134

135

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer">AtspiComponentLayer</a></td>

136

</tr>

137

<tr>

138

139

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType">AtspiTextBoundaryType</a></td>

140

</tr>

141

<tr>

142

143

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType">AtspiTextClipType</a></td>

144

</tr>

145

<tr>

146

147

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType">AtspiStateType</a></td>

148

</tr>

149

<tr>

150

151

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiKeyEventType" title="enum AtspiKeyEventType">AtspiKeyEventType</a></td>

152

</tr>

153

<tr>

154

155

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiEventType" title="enum AtspiEventType">AtspiEventType</a></td>

156

</tr>

157

<tr>

158

159

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType">AtspiKeySynthType</a></td>

160

</tr>

161

<tr>

162

163

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiModifierType" title="enum AtspiModifierType">AtspiModifierType</a></td>

164

</tr>

165

<tr>

166

167

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType">AtspiRelationType</a></td>

168

</tr>

169

<tr>

170

171

<td class="function_name"><a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole">AtspiRole</a></td>

172

</tr>

173

</tbody>

174

</table></div>

175

</div>

176

177

<a name="libatspi-atspi-constants.description"></a><h2>Description</h2>

178

<p>

179

Constant definitions needed by multiple interfaces.

180

</p>

181

</div>

182

183

<a name="libatspi-atspi-constants.functions_details"></a><h2>Functions</h2>

184

185

<a name="ATSPI-COORD-TYPE-COUNT:CAPS"></a><h3>ATSPI_COORD_TYPE_COUNT</h3>

186

<pre class="programlisting">#define ATSPI_COORD_TYPE_COUNT (1+1)

187

</pre>

188

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a>.</p>

189

</div>

190

<hr>

191

192

<a name="ATSPI-SORTORDER-COUNT:CAPS"></a><h3>ATSPI_SORTORDER_COUNT</h3>

193

<pre class="programlisting">#define ATSPI_SORTORDER_COUNT (7+1)

194

</pre>

195

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a>.</p>

196

</div>

197

<hr>

198

199

<a name="ATSPI-MATCHTYPES-COUNT:CAPS"></a><h3>ATSPI_MATCHTYPES_COUNT</h3>

200

<pre class="programlisting">#define ATSPI_MATCHTYPES_COUNT (5+1)

201

</pre>

202

<p>

203

</p>

204

</div>

205

<hr>

206

207

<a name="ATSPI-COMPONENTLAYER-COUNT:CAPS"></a><h3>ATSPI_COMPONENTLAYER_COUNT</h3>

208

<pre class="programlisting">#define ATSPI_COMPONENTLAYER_COUNT (8+1)

209

</pre>

210

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>.</p>

211

</div>

212

<hr>

213

214

<a name="ATSPI-TEXT-BOUNDARY-TYPE-COUNT:CAPS"></a><h3>ATSPI_TEXT_BOUNDARY_TYPE_COUNT</h3>

215

<pre class="programlisting">#define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)

216

</pre>

217

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a>.</p>

218

</div>

219

<hr>

220

221

<a name="ATSPI-TEXT-CLIP-TYPE-COUNT:CAPS"></a><h3>ATSPI_TEXT_CLIP_TYPE_COUNT</h3>

222

<pre class="programlisting">#define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)

223

</pre>

224

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a>.</p>

225

</div>

226

<hr>

227

228

<a name="ATSPI-STATETYPE-COUNT:CAPS"></a><h3>ATSPI_STATETYPE_COUNT</h3>

229

<pre class="programlisting">#define ATSPI_STATETYPE_COUNT (41+1)

230

</pre>

231

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a>.</p>

232

</div>

233

<hr>

234

235

<a name="ATSPI-KEYEVENTTYPE-COUNT:CAPS"></a><h3>ATSPI_KEYEVENTTYPE_COUNT</h3>

236

<pre class="programlisting">#define ATSPI_KEYEVENTTYPE_COUNT (1+1)

237

</pre>

238

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiKeyEventType" title="enum AtspiKeyEventType"><span class="type">AtspiKeyEventType</span></a>.</p>

239

</div>

240

<hr>

241

242

<a name="ATSPI-EVENTTYPE-COUNT:CAPS"></a><h3>ATSPI_EVENTTYPE_COUNT</h3>

243

<pre class="programlisting">#define ATSPI_EVENTTYPE_COUNT (3+1)

244

</pre>

245

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiEventType" title="enum AtspiEventType"><span class="type">AtspiEventType</span></a>.</p>

246

</div>

247

<hr>

248

249

<a name="ATSPI-KEYSYNTHTYPE-COUNT:CAPS"></a><h3>ATSPI_KEYSYNTHTYPE_COUNT</h3>

250

<pre class="programlisting">#define ATSPI_KEYSYNTHTYPE_COUNT (4+1)

251

</pre>

252

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a>.</p>

253

</div>

254

<hr>

255

256

<a name="ATSPI-MODIFIERTYPE-COUNT:CAPS"></a><h3>ATSPI_MODIFIERTYPE_COUNT</h3>

257

<pre class="programlisting">#define ATSPI_MODIFIERTYPE_COUNT (7+1)

258

</pre>

259

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiModifierType" title="enum AtspiModifierType"><span class="type">AtspiModifierType</span></a>.</p>

260

</div>

261

<hr>

262

263

<a name="ATSPI-RELATIONTYPE-COUNT:CAPS"></a><h3>ATSPI_RELATIONTYPE_COUNT</h3>

264

<pre class="programlisting">#define ATSPI_RELATIONTYPE_COUNT (19+1)

265

</pre>

266

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a>.</p>

267

</div>

268

<hr>

269

270

<a name="ATSPI-ROLE-COUNT:CAPS"></a><h3>ATSPI_ROLE_COUNT</h3>

271

<pre class="programlisting">#define ATSPI_ROLE_COUNT (121+1)

272

</pre>

273

<p>One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a>.</p>

274

</div>

275

</div>

276

277

<a name="libatspi-atspi-constants.other_details"></a><h2>Types and Values</h2>

278

279

<a name="AtspiLocaleType"></a><h3>enum AtspiLocaleType</h3>

280

<p>Used by interfaces <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> and <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a>, this

281

enumeration corresponds to the POSIX 'setlocale' enum values.</p>

282

283

<a name="id-1.2.25.7.2.4"></a><h4>Members</h4>

284

285

286

287

288

289

</colgroup>

290

<tbody>

291

<tr>

292

<td class="enum_member_name"><p><a name="ATSPI-LOCALE-TYPE-MESSAGES:CAPS"></a>ATSPI_LOCALE_TYPE_MESSAGES</p></td>

293

294

<p>For localizable natural-language messages.</p>

295

</td>

296

297

</tr>

298

<tr>

299

<td class="enum_member_name"><p><a name="ATSPI-LOCALE-TYPE-COLLATE:CAPS"></a>ATSPI_LOCALE_TYPE_COLLATE</p></td>

300

301

<p>For regular expression matching and string

302

collation. </p>

303

</td>

304

305

</tr>

306

<tr>

307

<td class="enum_member_name"><p><a name="ATSPI-LOCALE-TYPE-CTYPE:CAPS"></a>ATSPI_LOCALE_TYPE_CTYPE</p></td>

308

309

<p>For regular expression matching, character

310

classification, conversion, case-sensitive comparison, and wide character

311

functions. </p>

312

</td>

313

314

</tr>

315

<tr>

316

<td class="enum_member_name"><p><a name="ATSPI-LOCALE-TYPE-MONETARY:CAPS"></a>ATSPI_LOCALE_TYPE_MONETARY</p></td>

317

318

<p>For monetary formatting.</p>

319

</td>

320

321

</tr>

322

<tr>

323

<td class="enum_member_name"><p><a name="ATSPI-LOCALE-TYPE-NUMERIC:CAPS"></a>ATSPI_LOCALE_TYPE_NUMERIC</p></td>

324

325

<p>For number formatting (such as the decimal

326

point and the thousands separator).</p>

327

</td>

328

329

</tr>

330

<tr>

331

<td class="enum_member_name"><p><a name="ATSPI-LOCALE-TYPE-TIME:CAPS"></a>ATSPI_LOCALE_TYPE_TIME</p></td>

332

333

<p>For time and date formatting.</p>

334

</td>

335

336

</tr>

337

</tbody>

338

</table></div>

339

</div>

340

</div>

341

<hr>

342

343

<a name="ATSPI-LOCALE-TYPE:CAPS"></a><h3>ATSPI_LOCALE_TYPE</h3>

344

<pre class="programlisting">#define ATSPI_LOCALE_TYPE _COUNT(5+1)

345

</pre>

346

<p>

347

</p>

348

</div>

349

<hr>

350

351

<a name="AtspiCoordType"></a><h3>enum AtspiCoordType</h3>

352

<p>Enumeration used by <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>, <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a>, and <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interfaces

353

to specify whether coordinates are relative to the window or the screen.</p>

354

355

<a name="id-1.2.25.7.4.4"></a><h4>Members</h4>

356

357

358

359

360

361

</colgroup>

362

<tbody>

363

<tr>

364

<td class="enum_member_name"><p><a name="ATSPI-COORD-TYPE-SCREEN:CAPS"></a>ATSPI_COORD_TYPE_SCREEN</p></td>

365

366

<p>Specifies xy coordinates relative to the screen.</p>

367

</td>

368

369

</tr>

370

<tr>

371

<td class="enum_member_name"><p><a name="ATSPI-COORD-TYPE-WINDOW:CAPS"></a>ATSPI_COORD_TYPE_WINDOW</p></td>

372

373

<p>Specifies xy coordinates relative to the widget's

374

top-level window.</p>

375

</td>

376

377

</tr>

378

</tbody>

379

</table></div>

380

</div>

381

</div>

382

<hr>

383

384

<a name="AtspiCollectionSortOrder"></a><h3>enum AtspiCollectionSortOrder</h3>

385

<p>Enumeration used by interface <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to specify

386

the way <span class="type">AtspiAccesible</span> objects should be sorted.</p>

387

388

<a name="id-1.2.25.7.5.4"></a><h4>Members</h4>

389

390

391

392

393

394

</colgroup>

395

<tbody>

396

<tr>

397

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-INVALID"></a>ATSPI_Collection_SORT_ORDER_INVALID</p></td>

398

399

400

</tr>

401

<tr>

402

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-CANONICAL"></a>ATSPI_Collection_SORT_ORDER_CANONICAL</p></td>

403

404

405

</tr>

406

<tr>

407

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-FLOW"></a>ATSPI_Collection_SORT_ORDER_FLOW</p></td>

408

409

410

</tr>

411

<tr>

412

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-TAB"></a>ATSPI_Collection_SORT_ORDER_TAB</p></td>

413

414

415

</tr>

416

<tr>

417

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-CANONICAL"></a>ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL</p></td>

418

419

420

</tr>

421

<tr>

422

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-FLOW"></a>ATSPI_Collection_SORT_ORDER_REVERSE_FLOW</p></td>

423

424

425

</tr>

426

<tr>

427

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-TAB"></a>ATSPI_Collection_SORT_ORDER_REVERSE_TAB</p></td>

428

429

430

</tr>

431

<tr>

432

<td class="enum_member_name"><p><a name="ATSPI-Collection-SORT-ORDER-LAST-DEFINED"></a>ATSPI_Collection_SORT_ORDER_LAST_DEFINED</p></td>

433

434

435

</tr>

436

</tbody>

437

</table></div>

438

</div>

439

</div>

440

<hr>

441

442

<a name="AtspiCollectionMatchType"></a><h3>enum AtspiCollectionMatchType</h3>

443

<p>Enumeration used by <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> to specify

444

how to interpret <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects.</p>

445

446

<a name="id-1.2.25.7.6.4"></a><h4>Members</h4>

447

448

449

450

451

452

</colgroup>

453

<tbody>

454

<tr>

455

<td class="enum_member_name"><p><a name="ATSPI-Collection-MATCH-INVALID"></a>ATSPI_Collection_MATCH_INVALID</p></td>

456

457

<p>Indicates an error condition or

458

uninitialized value.</p>

459

</td>

460

461

</tr>

462

<tr>

463

<td class="enum_member_name"><p><a name="ATSPI-Collection-MATCH-ALL"></a>ATSPI_Collection_MATCH_ALL</p></td>

464

465

<p><span class="type">TRUE</span> if all of the criteria are met.</p>

466

</td>

467

468

</tr>

469

<tr>

470

<td class="enum_member_name"><p><a name="ATSPI-Collection-MATCH-ANY"></a>ATSPI_Collection_MATCH_ANY</p></td>

471

472

<p><span class="type">TRUE</span> if any of the criteria are met.</p>

473

</td>

474

475

</tr>

476

<tr>

477

<td class="enum_member_name"><p><a name="ATSPI-Collection-MATCH-NONE"></a>ATSPI_Collection_MATCH_NONE</p></td>

478

479

<p><span class="type">TRUE</span> if none of the criteria are met.</p>

480

</td>

481

482

</tr>

483

<tr>

484

<td class="enum_member_name"><p><a name="ATSPI-Collection-MATCH-EMPTY"></a>ATSPI_Collection_MATCH_EMPTY</p></td>

485

486

<p>Same as <em class="parameter"><code>ATSPI_Collection_MATCH_ALL</code></em>

487

488

the criteria is non-empty; for empty criteria this rule requires returned

489

value to also have empty set. </p>

490

</td>

491

492

</tr>

493

<tr>

494

<td class="enum_member_name"><p><a name="ATSPI-Collection-MATCH-LAST-DEFINED"></a>ATSPI_Collection_MATCH_LAST_DEFINED</p></td>

495

496

<p>Used only to determine the end of the

497

enumeration.</p>

498

</td>

499

500

</tr>

501

</tbody>

502

</table></div>

503

</div>

504

</div>

505

<hr>

506

507

<a name="AtspiCollectionTreeTraversalType"></a><h3>enum AtspiCollectionTreeTraversalType</h3>

508

<p>Enumeration used by interface <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to specify

509

restrictions on <span class="type">AtspiAccesible</span> objects to be traversed.</p>

510

511

<a name="id-1.2.25.7.7.4"></a><h4>Members</h4>

512

513

514

515

516

517

</colgroup>

518

<tbody>

519

<tr>

520

<td class="enum_member_name"><p><a name="ATSPI-Collection-TREE-RESTRICT-CHILDREN"></a>ATSPI_Collection_TREE_RESTRICT_CHILDREN</p></td>

521

522

523

</tr>

524

<tr>

525

<td class="enum_member_name"><p><a name="ATSPI-Collection-TREE-RESTRICT-SIBLING"></a>ATSPI_Collection_TREE_RESTRICT_SIBLING</p></td>

526

527

528

</tr>

529

<tr>

530

<td class="enum_member_name"><p><a name="ATSPI-Collection-TREE-INORDER"></a>ATSPI_Collection_TREE_INORDER</p></td>

531

532

533

</tr>

534

<tr>

535

<td class="enum_member_name"><p><a name="ATSPI-Collection-TREE-LAST-DEFINED"></a>ATSPI_Collection_TREE_LAST_DEFINED</p></td>

536

537

538

</tr>

539

</tbody>

540

</table></div>

541

</div>

542

</div>

543

<hr>

544

545

<a name="ATSPI-TREETRAVERSALTYPE:CAPS"></a><h3>ATSPI_TREETRAVERSALTYPE</h3>

546

<pre class="programlisting">#define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)

547

</pre>

548

<p>

549

</p>

550

</div>

551

<hr>

552

553

<a name="AtspiComponentLayer"></a><h3>enum AtspiComponentLayer</h3>

554

<p>The <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a> of an <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> instance indicates its

555

relative stacking order with respect to the onscreen visual representation

556

of the UI. <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>, in combination with <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> bounds

557

information, can be used to compute the visibility of all or part of a

558

component. This is important in programmatic determination of

559

region-of-interest for magnification, and in

560

flat screen review models of the screen, as well as

561

for other uses. Objects residing in two of the <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>

562

categories support further z-ordering information, with respect to their

563

peers in the same layer: namely, <em class="parameter"><code>ATSPI_LAYER_WINDOW</code></em>

564

and

565

<em class="parameter"><code>ATSPI_LAYER_MDI</code></em>

566

. Relative stacking order for other objects within the

567

same layer is not available; the recommended heuristic is

568

first child paints first. In other words, assume that the

569

first siblings in the child list are subject to being overpainted by later

570

siblings if their bounds intersect. The order of layers, from bottom to top,

571

is: <em class="parameter"><code>ATSPI_LAYER_BACKGROUND</code></em>

572

, <em class="parameter"><code>ATSPI_LAYER_WINDOW</code></em>

573

, <em class="parameter"><code>ATSPI_LAYER_MDI</code></em>

574

575

<em class="parameter"><code>ATSPI_LAYER_CANVAS</code></em>

576

, <em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>

577

, <em class="parameter"><code>ATSPI_LAYER_POPUP</code></em>

578

, and

579

<em class="parameter"><code>ATSPI_LAYER_OVERLAY</code></em>

580

.</p>

581

582

<a name="id-1.2.25.7.9.4"></a><h4>Members</h4>

583

584

585

586

587

588

</colgroup>

589

<tbody>

590

<tr>

591

<td class="enum_member_name"><p><a name="ATSPI-LAYER-INVALID:CAPS"></a>ATSPI_LAYER_INVALID</p></td>

592

593

<p>Indicates an error condition or uninitialized value.</p>

594

</td>

595

596

</tr>

597

<tr>

598

<td class="enum_member_name"><p><a name="ATSPI-LAYER-BACKGROUND:CAPS"></a>ATSPI_LAYER_BACKGROUND</p></td>

599

600

<p>The bottom-most layer, over which everything else

601

is painted. The 'desktop background' is generally in this layer.</p>

602

</td>

603

604

</tr>

605

<tr>

606

<td class="enum_member_name"><p><a name="ATSPI-LAYER-CANVAS:CAPS"></a>ATSPI_LAYER_CANVAS</p></td>

607

608

<p>The 'background' layer for most content renderers and

609

UI <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> containers.</p>

610

</td>

611

612

</tr>

613

<tr>

614

<td class="enum_member_name"><p><a name="ATSPI-LAYER-WIDGET:CAPS"></a>ATSPI_LAYER_WIDGET</p></td>

615

616

<p>The layer in which the majority of ordinary

617

'foreground' widgets reside.</p>

618

</td>

619

620

</tr>

621

<tr>

622

<td class="enum_member_name"><p><a name="ATSPI-LAYER-MDI:CAPS"></a>ATSPI_LAYER_MDI</p></td>

623

624

<p>A special layer between <em class="parameter"><code>ATSPI_LAYER_CANVAS</code></em>

625

and

626

<em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>

627

, in which the 'pseudo windows' (e.g. the MDI frames)

628

reside. See <a class="link" href="libatspi-atspi-component.html#atspi-component-get-mdi-z-order" title="atspi_component_get_mdi_z_order ()"><span class="type">atspi_component_get_mdi_z_order</span></a>. </p>

629

</td>

630

631

</tr>

632

<tr>

633

<td class="enum_member_name"><p><a name="ATSPI-LAYER-POPUP:CAPS"></a>ATSPI_LAYER_POPUP</p></td>

634

635

<p>A layer for popup window content, above

636

<em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>

637

.</p>

638

</td>

639

640

</tr>

641

<tr>

642

<td class="enum_member_name"><p><a name="ATSPI-LAYER-OVERLAY:CAPS"></a>ATSPI_LAYER_OVERLAY</p></td>

643

644

<p>The topmost layer.</p>

645

</td>

646

647

</tr>

648

<tr>

649

<td class="enum_member_name"><p><a name="ATSPI-LAYER-WINDOW:CAPS"></a>ATSPI_LAYER_WINDOW</p></td>

650

651

<p>The layer in which a toplevel window background usually

652

resides.</p>

653

</td>

654

655

</tr>

656

<tr>

657

<td class="enum_member_name"><p><a name="ATSPI-LAYER-LAST-DEFINED:CAPS"></a>ATSPI_LAYER_LAST_DEFINED</p></td>

658

659

<p>Used only to determine the end of the

660

enumeration.</p>

661

</td>

662

663

</tr>

664

</tbody>

665

</table></div>

666

</div>

667

</div>

668

<hr>

669

670

<a name="AtspiTextBoundaryType"></a><h3>enum AtspiTextBoundaryType</h3>

671

<p>Specifies the boundary conditions determining a run of text as returned from

672

<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-at-offset" title="atspi_text_get_text_at_offset ()"><span class="type">atspi_text_get_text_at_offset</span></a>, <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-after-offset" title="atspi_text_get_text_after_offset ()"><span class="type">atspi_text_get_text_after_offset</span></a>, and

673

<a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-before-offset" title="atspi_text_get_text_before_offset ()"><span class="type">atspi_text_get_text_before_offset</span></a>.</p>

674

<p>This enumerationis deprecated since 2.9.90 and should not be used. Use

675

AtspiTextGranularity with <span class="type">atspi_text_get_string_at_offset</span> instead.</p>

676

677

<a name="id-1.2.25.7.10.5"></a><h4>Members</h4>

678

679

680

681

682

683

</colgroup>

684

<tbody>

685

<tr>

686

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-CHAR:CAPS"></a>ATSPI_TEXT_BOUNDARY_CHAR</p></td>

687

688

<p>An <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> instance is bounded by this

689

character only. Start and end offsets differ by one, by definition,

690

for this value.</p>

691

</td>

692

693

</tr>

694

<tr>

695

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-WORD-START:CAPS"></a>ATSPI_TEXT_BOUNDARY_WORD_START</p></td>

696

697

<p>Boundary condition is start of a word; i.e.

698

range is from start of one word to the start of another word.</p>

699

</td>

700

701

</tr>

702

<tr>

703

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-WORD-END:CAPS"></a>ATSPI_TEXT_BOUNDARY_WORD_END</p></td>

704

705

<p>Boundary condition is the end of a word; i.e.

706

range is from the end of one word to the end of another. Some locales

707

may not distinguish between words and characters or glyphs. In particular,

708

those locales which use wholly or partially ideographic character sets.

709

In these cases, characters may be returned in lieu of multi-character

710

substrings.</p>

711

</td>

712

713

</tr>

714

<tr>

715

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a>ATSPI_TEXT_BOUNDARY_SENTENCE_START</p></td>

716

717

<p>Boundary condition is start of a

718

sentence, as determined by the application. Some locales or

719

character sets may not include explicit sentence delimiters, so this

720

boundary type can not always be honored. Some locales will return lines

721

of text instead of grammatical sentences.</p>

722

</td>

723

724

</tr>

725

<tr>

726

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a>ATSPI_TEXT_BOUNDARY_SENTENCE_END</p></td>

727

728

<p>Boundary condition is end of a sentence,

729

as determined by the application, including the sentence-delimiting

730

character, for instance '.' Some locales or character sets may not

731

include explicit sentence delimiters, so this boundary type can not

732

always be honored. Some locales will return lines of text instead of

733

grammatical sentences.</p>

734

</td>

735

736

</tr>

737

<tr>

738

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-LINE-START:CAPS"></a>ATSPI_TEXT_BOUNDARY_LINE_START</p></td>

739

740

<p>Boundary condition is the start of a line;

741

i.e. range is from start of one line to the start of another. This

742

generally means that an end-of-line character will appear at the end of

743

the range.</p>

744

</td>

745

746

</tr>

747

<tr>

748

<td class="enum_member_name"><p><a name="ATSPI-TEXT-BOUNDARY-LINE-END:CAPS"></a>ATSPI_TEXT_BOUNDARY_LINE_END</p></td>

749

750

<p>Boundary condition is the end of a line; i.e.

751

range is from start of one line to the start of another. This generally

752

means that an end-of-line character will be the first character of the

753

range.</p>

754

</td>

755

756

</tr>

757

</tbody>

758

</table></div>

759

</div>

760

</div>

761

<hr>

762

763

<a name="AtspiTextClipType"></a><h3>enum AtspiTextClipType</h3>

764

<p>Enumeration used by interface <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> to indicate

765

how to treat characters intersecting bounding boxes.</p>

766

767

<a name="id-1.2.25.7.11.4"></a><h4>Members</h4>

768

769

770

771

772

773

</colgroup>

774

<tbody>

775

<tr>

776

<td class="enum_member_name"><p><a name="ATSPI-TEXT-CLIP-NONE:CAPS"></a>ATSPI_TEXT_CLIP_NONE</p></td>

777

778

<p>No characters/glyphs are omitted.</p>

779

</td>

780

781

</tr>

782

<tr>

783

<td class="enum_member_name"><p><a name="ATSPI-TEXT-CLIP-MIN:CAPS"></a>ATSPI_TEXT_CLIP_MIN</p></td>

784

785

<p>Characters/glyphs clipped by the minimum coordinate

786

are omitted.</p>

787

</td>

788

789

</tr>

790

<tr>

791

<td class="enum_member_name"><p><a name="ATSPI-TEXT-CLIP-MAX:CAPS"></a>ATSPI_TEXT_CLIP_MAX</p></td>

792

793

<p>Characters/glyphs which intersect the maximum

794

coordinate are omitted.</p>

795

</td>

796

797

</tr>

798

<tr>

799

<td class="enum_member_name"><p><a name="ATSPI-TEXT-CLIP-BOTH:CAPS"></a>ATSPI_TEXT_CLIP_BOTH</p></td>

800

801

<p>Only glyphs falling entirely within the region

802

bounded by min and max are retained.</p>

803

</td>

804

805

</tr>

806

</tbody>

807

</table></div>

808

</div>

809

</div>

810

<hr>

811

812

<a name="AtspiStateType"></a><h3>enum AtspiStateType</h3>

813

<p>Enumeration used by various interfaces indicating every possible state

814

an <span class="type">AtspiAccesible</span> object can assume.</p>

815

816

<a name="id-1.2.25.7.12.4"></a><h4>Members</h4>

817

818

819

820

821

822

</colgroup>

823

<tbody>

824

<tr>

825

<td class="enum_member_name"><p><a name="ATSPI-STATE-INVALID:CAPS"></a>ATSPI_STATE_INVALID</p></td>

826

827

<p>Indicates an invalid state - probably an error

828

condition.</p>

829

</td>

830

831

</tr>

832

<tr>

833

<td class="enum_member_name"><p><a name="ATSPI-STATE-ACTIVE:CAPS"></a>ATSPI_STATE_ACTIVE</p></td>

834

835

<p>Indicates a window is currently the active window, or

836

an object is the active subelement within a container or table.

837

<em class="parameter"><code>ATSPI_STATE_ACTIVE</code></em>

838

should not be used for objects which have

839

<em class="parameter"><code>ATSPI_STATE_FOCUSABLE</code></em>

840

or <em class="parameter"><code>ATSPI_STATE_SELECTABLE</code></em>

841

: Those objects should use

842

<em class="parameter"><code>ATSPI_STATE_FOCUSED</code></em>

843

and <em class="parameter"><code>ATSPI_STATE_SELECTED</code></em>

844

respectively.

845

<em class="parameter"><code>ATSPI_STATE_ACTIVE</code></em>

846

is a means to indicate that an object which is not

847

focusable and not selectable is the currently-active item within its

848

parent container.</p>

849

</td>

850

851

</tr>

852

<tr>

853

<td class="enum_member_name"><p><a name="ATSPI-STATE-ARMED:CAPS"></a>ATSPI_STATE_ARMED</p></td>

854

855

<p>Indicates that the object is armed.</p>

856

</td>

857

858

</tr>

859

<tr>

860

<td class="enum_member_name"><p><a name="ATSPI-STATE-BUSY:CAPS"></a>ATSPI_STATE_BUSY</p></td>

861

862

<p>Indicates the current object is busy, i.e. onscreen

863

representation is in the process of changing, or the object is

864

temporarily unavailable for interaction due to activity already in progress.</p>

865

</td>

866

867

</tr>

868

<tr>

869

<td class="enum_member_name"><p><a name="ATSPI-STATE-CHECKED:CAPS"></a>ATSPI_STATE_CHECKED</p></td>

870

871

<p>Indicates this object is currently checked.</p>

872

</td>

873

874

</tr>

875

<tr>

876

<td class="enum_member_name"><p><a name="ATSPI-STATE-COLLAPSED:CAPS"></a>ATSPI_STATE_COLLAPSED</p></td>

877

878

<p>Indicates this object is collapsed.</p>

879

</td>

880

881

</tr>

882

<tr>

883

<td class="enum_member_name"><p><a name="ATSPI-STATE-DEFUNCT:CAPS"></a>ATSPI_STATE_DEFUNCT</p></td>

884

885

<p>Indicates that this object no longer has a valid

886

backing widget (for instance, if its peer object has been destroyed).</p>

887

</td>

888

889

</tr>

890

<tr>

891

<td class="enum_member_name"><p><a name="ATSPI-STATE-EDITABLE:CAPS"></a>ATSPI_STATE_EDITABLE</p></td>

892

893

<p>Indicates the user can change the contents of this

894

object.</p>

895

</td>

896

897

</tr>

898

<tr>

899

<td class="enum_member_name"><p><a name="ATSPI-STATE-ENABLED:CAPS"></a>ATSPI_STATE_ENABLED</p></td>

900

901

<p>Indicates that this object is enabled, i.e. that it

902

currently reflects some application state. Objects that are "greyed out"

903

may lack this state, and may lack the <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>

904

if direct

905

user interaction cannot cause them to acquire <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>

906

907

See <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>

908

.</p>

909

</td>

910

911

</tr>

912

<tr>

913

<td class="enum_member_name"><p><a name="ATSPI-STATE-EXPANDABLE:CAPS"></a>ATSPI_STATE_EXPANDABLE</p></td>

914

915

<p>Indicates this object allows progressive

916

disclosure of its children.</p>

917

</td>

918

919

</tr>

920

<tr>

921

<td class="enum_member_name"><p><a name="ATSPI-STATE-EXPANDED:CAPS"></a>ATSPI_STATE_EXPANDED</p></td>

922

923

<p>Indicates this object is expanded.</p>

924

</td>

925

926

</tr>

927

<tr>

928

<td class="enum_member_name"><p><a name="ATSPI-STATE-FOCUSABLE:CAPS"></a>ATSPI_STATE_FOCUSABLE</p></td>

929

930

<p>Indicates this object can accept keyboard focus,

931

which means all events resulting from typing on the keyboard will

932

normally be passed to it when it has focus.</p>

933

</td>

934

935

</tr>

936

<tr>

937

<td class="enum_member_name"><p><a name="ATSPI-STATE-FOCUSED:CAPS"></a>ATSPI_STATE_FOCUSED</p></td>

938

939

<p>Indicates this object currently has the keyboard

940

focus.</p>

941

</td>

942

943

</tr>

944

<tr>

945

<td class="enum_member_name"><p><a name="ATSPI-STATE-HAS-TOOLTIP:CAPS"></a>ATSPI_STATE_HAS_TOOLTIP</p></td>

946

947

<p>Indicates that the object has an associated

948

tooltip.</p>

949

</td>

950

951

</tr>

952

<tr>

953

<td class="enum_member_name"><p><a name="ATSPI-STATE-HORIZONTAL:CAPS"></a>ATSPI_STATE_HORIZONTAL</p></td>

954

955

<p>Indicates the orientation of this object is

956

horizontal.</p>

957

</td>

958

959

</tr>

960

<tr>

961

<td class="enum_member_name"><p><a name="ATSPI-STATE-ICONIFIED:CAPS"></a>ATSPI_STATE_ICONIFIED</p></td>

962

963

<p>Indicates this object is minimized and is

964

represented only by an icon.</p>

965

</td>

966

967

</tr>

968

<tr>

969

<td class="enum_member_name"><p><a name="ATSPI-STATE-MODAL:CAPS"></a>ATSPI_STATE_MODAL</p></td>

970

971

<p>Indicates something must be done with this object

972

before the user can interact with an object in a different window.</p>

973

</td>

974

975

</tr>

976

<tr>

977

<td class="enum_member_name"><p><a name="ATSPI-STATE-MULTI-LINE:CAPS"></a>ATSPI_STATE_MULTI_LINE</p></td>

978

979

<p>Indicates this (text) object can contain multiple

980

lines of text.</p>

981

</td>

982

983

</tr>

984

<tr>

985

<td class="enum_member_name"><p><a name="ATSPI-STATE-MULTISELECTABLE:CAPS"></a>ATSPI_STATE_MULTISELECTABLE</p></td>

986

987

<p>Indicates this object allows more than one of

988

its children to be selected at the same time, or in the case of text

989

objects, that the object supports non-contiguous text selections.</p>

990

</td>

991

992

</tr>

993

<tr>

994

<td class="enum_member_name"><p><a name="ATSPI-STATE-OPAQUE:CAPS"></a>ATSPI_STATE_OPAQUE</p></td>

995

996

<p>Indicates this object paints every pixel within its

997

rectangular region. It also indicates an alpha value of unity, if it

998

supports alpha blending.</p>

999

</td>

1000

1001

</tr>

1002

<tr>

1003

<td class="enum_member_name"><p><a name="ATSPI-STATE-PRESSED:CAPS"></a>ATSPI_STATE_PRESSED</p></td>

1004

1005

<p>Indicates this object is currently pressed.</p>

1006

</td>

1007

1008

</tr>

1009

<tr>

1010

<td class="enum_member_name"><p><a name="ATSPI-STATE-RESIZABLE:CAPS"></a>ATSPI_STATE_RESIZABLE</p></td>

1011

1012

<p>Indicates the size of this object's size is not

1013

fixed.</p>

1014

</td>

1015

1016

</tr>

1017

<tr>

1018

<td class="enum_member_name"><p><a name="ATSPI-STATE-SELECTABLE:CAPS"></a>ATSPI_STATE_SELECTABLE</p></td>

1019

1020

<p>Indicates this object is the child of an object

1021

that allows its children to be selected and that this child is one of

1022

those children that can be selected.</p>

1023

</td>

1024

1025

</tr>

1026

<tr>

1027

<td class="enum_member_name"><p><a name="ATSPI-STATE-SELECTED:CAPS"></a>ATSPI_STATE_SELECTED</p></td>

1028

1029

<p>Indicates this object is the child of an object that

1030

allows its children to be selected and that this child is one of those

1031

children that has been selected.</p>

1032

</td>

1033

1034

</tr>

1035

<tr>

1036

<td class="enum_member_name"><p><a name="ATSPI-STATE-SENSITIVE:CAPS"></a>ATSPI_STATE_SENSITIVE</p></td>

1037

1038

<p>Indicates this object is sensitive, e.g. to user

1039

interaction. <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>

1040

usually accompanies.

1041

<em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>

1042

for user-actionable controls, but may be found in the

1043

absence of <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>

1044

if the current visible state of the control

1045

is "disconnected" from the application state. In such cases, direct user

1046

interaction can often result in the object gaining <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>

1047

1048

for instance if a user makes an explicit selection using an object whose

1049

current state is ambiguous or undefined. See <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>

1050

1051

<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em>

1052

.</p>

1053

</td>

1054

1055

</tr>

1056

<tr>

1057

<td class="enum_member_name"><p><a name="ATSPI-STATE-SHOWING:CAPS"></a>ATSPI_STATE_SHOWING</p></td>

1058

1059

<p>Indicates this object, the object's parent, the

1060

object's parent's parent, and so on, are all 'shown' to the end-user,

1061

i.e. subject to "exposure" if blocking or obscuring objects do not

1062

interpose between this object and the top of the window stack.</p>

1063

</td>

1064

1065

</tr>

1066

<tr>

1067

<td class="enum_member_name"><p><a name="ATSPI-STATE-SINGLE-LINE:CAPS"></a>ATSPI_STATE_SINGLE_LINE</p></td>

1068

1069

<p>Indicates this (text) object can contain only a

1070

single line of text.</p>

1071

</td>

1072

1073

</tr>

1074

<tr>

1075

<td class="enum_member_name"><p><a name="ATSPI-STATE-STALE:CAPS"></a>ATSPI_STATE_STALE</p></td>

1076

1077

<p>Indicates that the information returned for this object

1078

may no longer be synchronized with the application state. This can occur

1079

if the object has <em class="parameter"><code>ATSPI_STATE_TRANSIENT</code></em>

1080

, and can also occur towards the

1081

end of the object peer's lifecycle.</p>

1082

</td>

1083

1084

</tr>

1085

<tr>

1086

<td class="enum_member_name"><p><a name="ATSPI-STATE-TRANSIENT:CAPS"></a>ATSPI_STATE_TRANSIENT</p></td>

1087

1088

<p>Indicates this object is transient.</p>

1089

</td>

1090

1091

</tr>

1092

<tr>

1093

<td class="enum_member_name"><p><a name="ATSPI-STATE-VERTICAL:CAPS"></a>ATSPI_STATE_VERTICAL</p></td>

1094

1095

<p>Indicates the orientation of this object is vertical;

1096

for example this state may appear on such objects as scrollbars, text

1097

objects (with vertical text flow), separators, etc.</p>

1098

</td>

1099

1100

</tr>

1101

<tr>

1102

<td class="enum_member_name"><p><a name="ATSPI-STATE-VISIBLE:CAPS"></a>ATSPI_STATE_VISIBLE</p></td>

1103

1104

<p>Indicates this object is visible, e.g. has been

1105

explicitly marked for exposure to the user. <em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em>

1106

is no

1107

guarantee that the object is actually unobscured on the screen, only that

1108

it is 'potentially' visible, barring obstruction, being scrolled or clipped

1109

out of the field of view, or having an ancestor container that has not yet

1110

made visible. A widget is potentially onscreen if it has both

1111

<em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em>

1112

and <em class="parameter"><code>ATSPI_STATE_SHOWING</code></em>

1113

. The absence of

1114

<em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em>

1115

and <em class="parameter"><code>ATSPI_STATE_SHOWING</code></em>

1116

1117

semantically equivalent to saying that an object is 'hidden'.</p>

1118

</td>

1119

1120

</tr>

1121

<tr>

1122

<td class="enum_member_name"><p><a name="ATSPI-STATE-MANAGES-DESCENDANTS:CAPS"></a>ATSPI_STATE_MANAGES_DESCENDANTS</p></td>

1123

1124

<p>Indicates that "active-descendant-changed"

1125

event is sent when children become 'active' (i.e. are selected or

1126

navigated to onscreen). Used to prevent need to enumerate all children

1127

in very large containers, like tables. The presence of

1128

<em class="parameter"><code>ATSPI_STATE_MANAGES_DESCENDANTS</code></em>

1129

is an indication to the client that the

1130

children should not, and need not, be enumerated by the client.

1131

Objects implementing this state are expected to provide relevant state

1132

notifications to listening clients, for instance notifications of

1133

visibility changes and activation of their contained child objects, without

1134

the client having previously requested references to those children.</p>

1135

</td>

1136

1137

</tr>

1138

<tr>

1139

<td class="enum_member_name"><p><a name="ATSPI-STATE-INDETERMINATE:CAPS"></a>ATSPI_STATE_INDETERMINATE</p></td>

1140

1141

<p>Indicates that a check box or other boolean

1142

indicator is in a state other than checked or not checked. This

1143

usually means that the boolean value reflected or controlled by the

1144

object does not apply consistently to the entire current context.

1145

For example, a checkbox for the "Bold" attribute of text may have

1146

<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em>

1147

if the currently selected text contains a mixture

1148

of weight attributes. In many cases interacting with a

1149

<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em>

1150

object will cause the context's corresponding

1151

boolean attribute to be homogenized, whereupon the object will lose

1152

<em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em>

1153

and a corresponding state-changed event will be

1154

fired.</p>

1155

</td>

1156

1157

</tr>

1158

<tr>

1159

<td class="enum_member_name"><p><a name="ATSPI-STATE-REQUIRED:CAPS"></a>ATSPI_STATE_REQUIRED</p></td>

1160

1161

<p>Indicates that user interaction with this object is

1162

'required' from the user, for instance before completing the

1163

processing of a form.</p>

1164

</td>

1165

1166

</tr>

1167

<tr>

1168

<td class="enum_member_name"><p><a name="ATSPI-STATE-TRUNCATED:CAPS"></a>ATSPI_STATE_TRUNCATED</p></td>

1169

1170

<p>Indicates that an object's onscreen content

1171

is truncated, e.g. a text value in a spreadsheet cell.</p>

1172

</td>

1173

1174

</tr>

1175

<tr>

1176

<td class="enum_member_name"><p><a name="ATSPI-STATE-ANIMATED:CAPS"></a>ATSPI_STATE_ANIMATED</p></td>

1177

1178

<p>Indicates this object's visual representation is

1179

dynamic, not static. This state may be applied to an object during an

1180

animated 'effect' and be removed from the object once its visual

1181

representation becomes static. Some applications, notably content viewers,

1182

may not be able to detect all kinds of animated content. Therefore the

1183

absence of this state should not be taken as

1184

definitive evidence that the object's visual representation is

1185

static; this state is advisory.</p>

1186

</td>

1187

1188

</tr>

1189

<tr>

1190

<td class="enum_member_name"><p><a name="ATSPI-STATE-INVALID-ENTRY:CAPS"></a>ATSPI_STATE_INVALID_ENTRY</p></td>

1191

1192

<p>This object has indicated an error condition

1193

due to failure of input validation. For instance, a form control may

1194

acquire this state in response to invalid or malformed user input.</p>

1195

</td>

1196

1197

</tr>

1198

<tr>

1199

<td class="enum_member_name"><p><a name="ATSPI-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a>ATSPI_STATE_SUPPORTS_AUTOCOMPLETION</p></td>

1200

1201

<p>This state indicates that the object

1202

in question implements some form of typeahead or

1203

pre-selection behavior whereby entering the first character of one or more

1204

sub-elements causes those elements to scroll into view or become

1205

selected. Subsequent character input may narrow the selection further as

1206

long as one or more sub-elements match the string. This state is normally

1207

only useful and encountered on objects that implement <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.

1208

In some cases the typeahead behavior may result in full or partial

1209

completion of the data in the input field, in which case

1210

these input events may trigger text-changed events from the source.</p>

1211

</td>

1212

1213

</tr>

1214

<tr>

1215

<td class="enum_member_name"><p><a name="ATSPI-STATE-SELECTABLE-TEXT:CAPS"></a>ATSPI_STATE_SELECTABLE_TEXT</p></td>

1216

1217

<p>This state indicates that the object in

1218

question supports text selection. It should only be exposed on objects

1219

which implement the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interface, in order to distinguish this state

1220

from <em class="parameter"><code>ATSPI_STATE_SELECTABLE</code></em>

1221

, which infers that the object in question is a

1222

selectable child of an object which implements <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>. While

1223

similar, text selection and subelement selection are distinct operations.</p>

1224

</td>

1225

1226

</tr>

1227

<tr>

1228

<td class="enum_member_name"><p><a name="ATSPI-STATE-IS-DEFAULT:CAPS"></a>ATSPI_STATE_IS_DEFAULT</p></td>

1229

1230

<p>This state indicates that the object in question is

1231

the 'default' interaction object in a dialog, i.e. the one that gets

1232

activated if the user presses "Enter" when the dialog is initially

1233

posted.</p>

1234

</td>

1235

1236

</tr>

1237

<tr>

1238

<td class="enum_member_name"><p><a name="ATSPI-STATE-VISITED:CAPS"></a>ATSPI_STATE_VISITED</p></td>

1239

1240

<p>This state indicates that the object (typically a

1241

hyperlink) has already been activated or invoked, with the result that

1242

some backing data has been downloaded or rendered.</p>

1243

</td>

1244

1245

</tr>

1246

<tr>

1247

<td class="enum_member_name"><p><a name="ATSPI-STATE-CHECKABLE:CAPS"></a>ATSPI_STATE_CHECKABLE</p></td>

1248

1249

<p>Indicates this object has the potential to

1250

be checked, such as a checkbox or toggle-able table cell. <em class="parameter"><code>Since</code></em>

1251

1252

2.12</p>

1253

</td>

1254

1255

</tr>

1256

<tr>

1257

<td class="enum_member_name"><p><a name="ATSPI-STATE-HAS-POPUP:CAPS"></a>ATSPI_STATE_HAS_POPUP</p></td>

1258

1259

<p>Indicates that the object has a popup

1260

context menu or sub-level menu which may or may not be

1261

showing. This means that activation renders conditional content.

1262

Note that ordinary tooltips are not considered popups in this

1263

context. <em class="parameter"><code>Since</code></em>

1264

: 2.12</p>

1265

</td>

1266

1267

</tr>

1268

<tr>

1269

<td class="enum_member_name"><p><a name="ATSPI-STATE-READ-ONLY:CAPS"></a>ATSPI_STATE_READ_ONLY</p></td>

1270

1271

<p>Indicates that an object which is ENABLED and

1272

SENSITIVE has a value which can be read, but not modified, by the

1273

user. <em class="parameter"><code>Since</code></em>

1274

: 2.16</p>

1275

</td>

1276

1277

</tr>

1278

<tr>

1279

<td class="enum_member_name"><p><a name="ATSPI-STATE-LAST-DEFINED:CAPS"></a>ATSPI_STATE_LAST_DEFINED</p></td>

1280

1281

<p>This value of the enumeration should not be used

1282

as a parameter, it indicates the number of items in the <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a>

1283

enumeration.</p>

1284

</td>

1285

1286

</tr>

1287

</tbody>

1288

</table></div>

1289

</div>

1290

</div>

1291

<hr>

1292

1293

<a name="AtspiKeyEventType"></a><h3>enum AtspiKeyEventType</h3>

1294

<p>Deprecated. Should not be used.</p>

1295

1296

<a name="id-1.2.25.7.13.4"></a><h4>Members</h4>

1297

1298

1299

1300

1301

1302

</colgroup>

1303

<tbody>

1304

<tr>

1305

<td class="enum_member_name"><p><a name="ATSPI-KEY-PRESSED:CAPS"></a>ATSPI_KEY_PRESSED</p></td>

1306

1307

1308

</tr>

1309

<tr>

1310

<td class="enum_member_name"><p><a name="ATSPI-KEY-RELEASED:CAPS"></a>ATSPI_KEY_RELEASED</p></td>

1311

1312

1313

</tr>

1314

</tbody>

1315

</table></div>

1316

</div>

1317

</div>

1318

<hr>

1319

1320

<a name="AtspiEventType"></a><h3>enum AtspiEventType</h3>

1321

<p>Enumeration used to specify the event types of interest to an

1322

<a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a>, or

1323

to identify the type of an event for which notification has been sent.</p>

1324

1325

<a name="id-1.2.25.7.14.4"></a><h4>Members</h4>

1326

1327

1328

1329

1330

1331

</colgroup>

1332

<tbody>

1333

<tr>

1334

<td class="enum_member_name"><p><a name="ATSPI-KEY-PRESSED-EVENT:CAPS"></a>ATSPI_KEY_PRESSED_EVENT</p></td>

1335

1336

<p>Indicates that a key on a keyboard device was

1337

pressed.</p>

1338

</td>

1339

1340

</tr>

1341

<tr>

1342

<td class="enum_member_name"><p><a name="ATSPI-KEY-RELEASED-EVENT:CAPS"></a>ATSPI_KEY_RELEASED_EVENT</p></td>

1343

1344

<p>Indicates that a key on a keyboard device was

1345

released.</p>

1346

</td>

1347

1348

</tr>

1349

<tr>

1350

<td class="enum_member_name"><p><a name="ATSPI-BUTTON-PRESSED-EVENT:CAPS"></a>ATSPI_BUTTON_PRESSED_EVENT</p></td>

1351

1352

<p>Indicates that a button on a non-keyboard

1353

human interface device (HID) was pressed.</p>

1354

</td>

1355

1356

</tr>

1357

<tr>

1358

<td class="enum_member_name"><p><a name="ATSPI-BUTTON-RELEASED-EVENT:CAPS"></a>ATSPI_BUTTON_RELEASED_EVENT</p></td>

1359

1360

<p>Indicates that a button on a non-keyboard

1361

human interface device (HID) was released.</p>

1362

</td>

1363

1364

</tr>

1365

</tbody>

1366

</table></div>

1367

</div>

1368

</div>

1369

<hr>

1370

1371

<a name="AtspiKeySynthType"></a><h3>enum AtspiKeySynthType</h3>

1372

<p>Enumeration used when synthesizing keyboard input via

1373

<a class="link" href="libatspi-atspi-registry.html#atspi-generate-keyboard-event" title="atspi_generate_keyboard_event ()"><span class="type">atspi_generate_keyboard_event</span></a>.</p>

1374

1375

<a name="id-1.2.25.7.15.4"></a><h4>Members</h4>

1376

1377

1378

1379

1380

1381

</colgroup>

1382

<tbody>

1383

<tr>

1384

<td class="enum_member_name"><p><a name="ATSPI-KEY-PRESS:CAPS"></a>ATSPI_KEY_PRESS</p></td>

1385

1386

<p>Emulates the pressing of a hardware keyboard key.</p>

1387

</td>

1388

1389

</tr>

1390

<tr>

1391

<td class="enum_member_name"><p><a name="ATSPI-KEY-RELEASE:CAPS"></a>ATSPI_KEY_RELEASE</p></td>

1392

1393

<p>Emulates the release of a hardware keyboard key.</p>

1394

</td>

1395

1396

</tr>

1397

<tr>

1398

<td class="enum_member_name"><p><a name="ATSPI-KEY-PRESSRELEASE:CAPS"></a>ATSPI_KEY_PRESSRELEASE</p></td>

1399

1400

<p>Emulates the pressing and immediate releasing

1401

of a hardware keyboard key.</p>

1402

</td>

1403

1404

</tr>

1405

<tr>

1406

<td class="enum_member_name"><p><a name="ATSPI-KEY-SYM:CAPS"></a>ATSPI_KEY_SYM</p></td>

1407

1408

<p>A symbolic key event is generated, without specifying a

1409

hardware key. Note: if the keysym is not present in the current keyboard

1410

map, the <span class="type">AtspiDeviceEventController</span> instance has a limited ability to

1411

generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent

1412

calls using out-of-keymap keysyms will vary from system to system, and on

1413

the number of different out-of-keymap keysyms being generated in quick

1414

succession.

1415

In practice this is rarely significant, since the keysyms of interest to

1416

AT clients and keyboard emulators are usually part of the current keymap,

1417

i.e., present on the system keyboard for the current locale (even if a

1418

physical hardware keyboard is not connected).</p>

1419

</td>

1420

1421

</tr>

1422

<tr>

1423

<td class="enum_member_name"><p><a name="ATSPI-KEY-STRING:CAPS"></a>ATSPI_KEY_STRING</p></td>

1424

1425

<p>A string is converted to its equivalent keyboard events

1426

and emitted. If the string consists of complex characters or composed

1427

characters which are not in the current keymap, string emission is

1428

subject to the out-of-keymap limitations described for

1429

<em class="parameter"><code>ATSPI_KEY_SYM</code></em>

1430

. In practice this limitation primarily effects

1431

Chinese and Japanese locales.</p>

1432

</td>

1433

1434

</tr>

1435

</tbody>

1436

</table></div>

1437

</div>

1438

</div>

1439

<hr>

1440

1441

<a name="AtspiModifierType"></a><h3>enum AtspiModifierType</h3>

1442

1443

<a name="id-1.2.25.7.16.3"></a><h4>Members</h4>

1444

1445

1446

1447

1448

1449

</colgroup>

1450

<tbody>

1451

<tr>

1452

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-SHIFT:CAPS"></a>ATSPI_MODIFIER_SHIFT</p></td>

1453

1454

<p>The left or right 'Shift' key.</p>

1455

</td>

1456

1457

</tr>

1458

<tr>

1459

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-SHIFTLOCK:CAPS"></a>ATSPI_MODIFIER_SHIFTLOCK</p></td>

1460

1461

<p>The ShiftLock or CapsLock key.</p>

1462

</td>

1463

1464

</tr>

1465

<tr>

1466

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-CONTROL:CAPS"></a>ATSPI_MODIFIER_CONTROL</p></td>

1467

1468

<p>'Control'/'Ctrl'.</p>

1469

</td>

1470

1471

</tr>

1472

<tr>

1473

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-ALT:CAPS"></a>ATSPI_MODIFIER_ALT</p></td>

1474

1475

<p>The Alt key (as opposed to AltGr).</p>

1476

</td>

1477

1478

</tr>

1479

<tr>

1480

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-META:CAPS"></a>ATSPI_MODIFIER_META</p></td>

1481

1482

<p>Depending on the platform, this may map to 'Window',

1483

'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will

1484

map to one of META, META2, META3. On X Windows platforms these META

1485

values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an

1486

event having <em class="parameter"><code>ATSPI_MODIFIER_META2</code></em>

1487

means that the 'Mod2Mask' bit

1488

is set in the corresponding XEvent.</p>

1489

</td>

1490

1491

</tr>

1492

<tr>

1493

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-META2:CAPS"></a>ATSPI_MODIFIER_META2</p></td>

1494

1495

<p>See <em class="parameter"><code>ATSPI_MODIFIER_META</code></em>

1496

.</p>

1497

</td>

1498

1499

</tr>

1500

<tr>

1501

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-META3:CAPS"></a>ATSPI_MODIFIER_META3</p></td>

1502

1503

<p>See <em class="parameter"><code>ATSPI_MODIFIER_META</code></em>

1504

.</p>

1505

</td>

1506

1507

</tr>

1508

<tr>

1509

<td class="enum_member_name"><p><a name="ATSPI-MODIFIER-NUMLOCK:CAPS"></a>ATSPI_MODIFIER_NUMLOCK</p></td>

1510

1511

<p>A symbolic meta key name that is mapped by AT-SPI

1512

to the appropriate META value, for the convenience of the client.</p>

1513

</td>

1514

1515

</tr>

1516

</tbody>

1517

</table></div>

1518

</div>

1519

</div>

1520

<hr>

1521

1522

<a name="AtspiRelationType"></a><h3>enum AtspiRelationType</h3>

1523

<p><a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> specifies a relationship between objects

1524

(possibly one-to-many

1525

or many-to-one) outside of the normal parent/child hierarchical

1526

relationship. It allows better semantic identification of how objects

1527

are associated with one another. For instance the

1528

<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>

1529

1530

relationship may be used to identify labelling information that should

1531

accompany the accessible name property when presenting an object's content or

1532

identity to the end user. Similarly,

1533

<em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em>

1534

can be used

1535

to further specify the context in which a valuator is useful, and/or the

1536

other UI components which are directly effected by user interactions with

1537

the valuator. Common examples include association of scrollbars with the

1538

viewport or panel which they control.</p>

1539

<p>Enumeration used to specify

1540

the type of relation encapsulated in an <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object.</p>

1541

1542

<a name="id-1.2.25.7.17.5"></a><h4>Members</h4>

1543

1544

1545

1546

1547

1548

</colgroup>

1549

<tbody>

1550

<tr>

1551

<td class="enum_member_name"><p><a name="ATSPI-RELATION-NULL:CAPS"></a>ATSPI_RELATION_NULL</p></td>

1552

1553

<p>Not a meaningful relationship; clients should not

1554

normally encounter this <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> value.</p>

1555

</td>

1556

1557

</tr>

1558

<tr>

1559

<td class="enum_member_name"><p><a name="ATSPI-RELATION-LABEL-FOR:CAPS"></a>ATSPI_RELATION_LABEL_FOR</p></td>

1560

1561

<p>Object is a label for one or more other objects.</p>

1562

</td>

1563

1564

</tr>

1565

<tr>

1566

<td class="enum_member_name"><p><a name="ATSPI-RELATION-LABELLED-BY:CAPS"></a>ATSPI_RELATION_LABELLED_BY</p></td>

1567

1568

<p>Object is labelled by one or more other

1569

objects.</p>

1570

</td>

1571

1572

</tr>

1573

<tr>

1574

<td class="enum_member_name"><p><a name="ATSPI-RELATION-CONTROLLER-FOR:CAPS"></a>ATSPI_RELATION_CONTROLLER_FOR</p></td>

1575

1576

<p>Object is an interactive object which

1577

modifies the state, onscreen location, or other attributes of one or more

1578

target objects.</p>

1579

</td>

1580

1581

</tr>

1582

<tr>

1583

<td class="enum_member_name"><p><a name="ATSPI-RELATION-CONTROLLED-BY:CAPS"></a>ATSPI_RELATION_CONTROLLED_BY</p></td>

1584

1585

<p>Object state, position, etc. is

1586

modified/controlled by user interaction with one or more other objects.

1587

For instance a viewport or scroll pane may be <em class="parameter"><code>ATSPI_RELATION_CONTROLLED_BY</code></em>

1588

1589

scrollbars.</p>

1590

</td>

1591

1592

</tr>

1593

<tr>

1594

<td class="enum_member_name"><p><a name="ATSPI-RELATION-MEMBER-OF:CAPS"></a>ATSPI_RELATION_MEMBER_OF</p></td>

1595

1596

<p>Object has a grouping relationship (e.g. 'same

1597

group as') to one or more other objects.</p>

1598

</td>

1599

1600

</tr>

1601

<tr>

1602

<td class="enum_member_name"><p><a name="ATSPI-RELATION-TOOLTIP-FOR:CAPS"></a>ATSPI_RELATION_TOOLTIP_FOR</p></td>

1603

1604

<p>Object is a tooltip associated with another

1605

object.</p>

1606

</td>

1607

1608

</tr>

1609

<tr>

1610

<td class="enum_member_name"><p><a name="ATSPI-RELATION-NODE-CHILD-OF:CAPS"></a>ATSPI_RELATION_NODE_CHILD_OF</p></td>

1611

1612

<p>Object is a child of the target.</p>

1613

</td>

1614

1615

</tr>

1616

<tr>

1617

<td class="enum_member_name"><p><a name="ATSPI-RELATION-NODE-PARENT-OF:CAPS"></a>ATSPI_RELATION_NODE_PARENT_OF</p></td>

1618

1619

<p>Object is a parent of the target.</p>

1620

</td>

1621

1622

</tr>

1623

<tr>

1624

<td class="enum_member_name"><p><a name="ATSPI-RELATION-EXTENDED:CAPS"></a>ATSPI_RELATION_EXTENDED</p></td>

1625

1626

<p>Used to indicate that a relationship exists, but

1627

its type is not specified in the enumeration.</p>

1628

</td>

1629

1630

</tr>

1631

<tr>

1632

<td class="enum_member_name"><p><a name="ATSPI-RELATION-FLOWS-TO:CAPS"></a>ATSPI_RELATION_FLOWS_TO</p></td>

1633

1634

<p>Object renders content which flows logically to

1635

another object. For instance, text in a paragraph may flow to another

1636

object which is not the 'next sibling' in the accessibility hierarchy.</p>

1637

</td>

1638

1639

</tr>

1640

<tr>

1641

<td class="enum_member_name"><p><a name="ATSPI-RELATION-FLOWS-FROM:CAPS"></a>ATSPI_RELATION_FLOWS_FROM</p></td>

1642

1643

<p>Reciprocal of <em class="parameter"><code>ATSPI_RELATION_FLOWS_TO</code></em>

1644

.</p>

1645

</td>

1646

1647

</tr>

1648

<tr>

1649

<td class="enum_member_name"><p><a name="ATSPI-RELATION-SUBWINDOW-OF:CAPS"></a>ATSPI_RELATION_SUBWINDOW_OF</p></td>

1650

1651

<p>Object is visually and semantically considered

1652

a subwindow of another object, even though it is not the object's child.

1653

Useful when dealing with embedded applications and other cases where the

1654

widget hierarchy does not map cleanly to the onscreen presentation.</p>

1655

</td>

1656

1657

</tr>

1658

<tr>

1659

<td class="enum_member_name"><p><a name="ATSPI-RELATION-EMBEDS:CAPS"></a>ATSPI_RELATION_EMBEDS</p></td>

1660

1661

<p>Similar to <em class="parameter"><code>ATSPI_RELATION_SUBWINDOW_OF</code></em>

1662

, but

1663

specifically used for cross-process embedding.</p>

1664

</td>

1665

1666

</tr>

1667

<tr>

1668

<td class="enum_member_name"><p><a name="ATSPI-RELATION-EMBEDDED-BY:CAPS"></a>ATSPI_RELATION_EMBEDDED_BY</p></td>

1669

1670

<p>Reciprocal of <em class="parameter"><code>ATSPI_RELATION_EMBEDS</code></em>

1671

. Used to

1672

denote content rendered by embedded renderers that live in a separate process

1673

space from the embedding context.</p>

1674

</td>

1675

1676

</tr>

1677

<tr>

1678

<td class="enum_member_name"><p><a name="ATSPI-RELATION-POPUP-FOR:CAPS"></a>ATSPI_RELATION_POPUP_FOR</p></td>

1679

1680

<p>Denotes that the object is a transient window or

1681

frame associated with another onscreen object. Similar to <em class="parameter"><code>ATSPI_TOOLTIP_FOR</code></em>

1682

1683

but more general. Useful for windows which are technically toplevels

1684

but which, for one or more reasons, do not explicitly cause their

1685

associated window to lose 'window focus'. Creation of an <em class="parameter"><code>ATSPI_ROLE_WINDOW</code></em>

1686

1687

object with the <em class="parameter"><code>ATSPI_RELATION_POPUP_FOR</code></em>

1688

relation usually requires

1689

some presentation action on the part

1690

of assistive technology clients, even though the previous toplevel

1691

<em class="parameter"><code>ATSPI_ROLE_FRAME</code></em>

1692

object may still be the active window.</p>

1693

</td>

1694

1695

</tr>

1696

<tr>

1697

<td class="enum_member_name"><p><a name="ATSPI-RELATION-PARENT-WINDOW-OF:CAPS"></a>ATSPI_RELATION_PARENT_WINDOW_OF</p></td>

1698

1699

<p>This is the reciprocal relation to

1700

<em class="parameter"><code>ATSPI_RELATION_POPUP_FOR</code></em>

1701

.</p>

1702

</td>

1703

1704

</tr>

1705

<tr>

1706

<td class="enum_member_name"><p><a name="ATSPI-RELATION-DESCRIPTION-FOR:CAPS"></a>ATSPI_RELATION_DESCRIPTION_FOR</p></td>

1707

1708

<p>Indicates that an object provides

1709

descriptive information about another object; more verbose than

1710

<em class="parameter"><code>ATSPI_RELATION_LABEL_FOR</code></em>

1711

.</p>

1712

</td>

1713

1714

</tr>

1715

<tr>

1716

<td class="enum_member_name"><p><a name="ATSPI-RELATION-DESCRIBED-BY:CAPS"></a>ATSPI_RELATION_DESCRIBED_BY</p></td>

1717

1718

<p>Indicates that another object provides

1719

descriptive information about this object; more verbose than

1720

<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>

1721

.</p>

1722

</td>

1723

1724

</tr>

1725

<tr>

1726

<td class="enum_member_name"><p><a name="ATSPI-RELATION-LAST-DEFINED:CAPS"></a>ATSPI_RELATION_LAST_DEFINED</p></td>

1727

1728

<p>Do not use as a parameter value, used to

1729

determine the size of the enumeration. </p>

1730

</td>

1731

1732

</tr>

1733

</tbody>

1734

</table></div>

1735

</div>

1736

</div>

1737

<hr>

1738

1739

<a name="AtspiRole"></a><h3>enum AtspiRole</h3>

1740

<p>Enumeration used by interface <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> to specify the role

1741

of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>

1742

1743

<a name="id-1.2.25.7.18.4"></a><h4>Members</h4>

1744

1745

1746

1747

1748

1749

</colgroup>

1750

<tbody>

1751

<tr>

1752

<td class="enum_member_name"><p><a name="ATSPI-ROLE-INVALID:CAPS"></a>ATSPI_ROLE_INVALID</p></td>

1753

1754

<p>A role indicating an error condition, such as

1755

uninitialized Role data.</p>

1756

</td>

1757

1758

</tr>

1759

<tr>

1760

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ACCELERATOR-LABEL:CAPS"></a>ATSPI_ROLE_ACCELERATOR_LABEL</p></td>

1761

1762

<p>Object is a label indicating the keyboard

1763

accelerators for the parent.</p>

1764

</td>

1765

1766

</tr>

1767

<tr>

1768

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ALERT:CAPS"></a>ATSPI_ROLE_ALERT</p></td>

1769

1770

<p>Object is used to alert the user about something.</p>

1771

</td>

1772

1773

</tr>

1774

<tr>

1775

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ANIMATION:CAPS"></a>ATSPI_ROLE_ANIMATION</p></td>

1776

1777

<p>Object contains a dynamic or moving image of some

1778

kind.</p>

1779

</td>

1780

1781

</tr>

1782

<tr>

1783

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ARROW:CAPS"></a>ATSPI_ROLE_ARROW</p></td>

1784

1785

<p>Object is a 2d directional indicator.</p>

1786

</td>

1787

1788

</tr>

1789

<tr>

1790

<td class="enum_member_name"><p><a name="ATSPI-ROLE-CALENDAR:CAPS"></a>ATSPI_ROLE_CALENDAR</p></td>

1791

1792

<p>Object contains one or more dates, usually arranged

1793

into a 2d list.</p>

1794

</td>

1795

1796

</tr>

1797

<tr>

1798

<td class="enum_member_name"><p><a name="ATSPI-ROLE-CANVAS:CAPS"></a>ATSPI_ROLE_CANVAS</p></td>

1799

1800

<p>Object that can be drawn into and is used to trap

1801

events.</p>

1802

</td>

1803

1804

</tr>

1805

<tr>

1806

<td class="enum_member_name"><p><a name="ATSPI-ROLE-CHECK-BOX:CAPS"></a>ATSPI_ROLE_CHECK_BOX</p></td>

1807

1808

<p>A choice that can be checked or unchecked and

1809

provides a separate indicator for the current state.</p>

1810

</td>

1811

1812

</tr>

1813

<tr>

1814

<td class="enum_member_name"><p><a name="ATSPI-ROLE-CHECK-MENU-ITEM:CAPS"></a>ATSPI_ROLE_CHECK_MENU_ITEM</p></td>

1815

1816

<p>A menu item that behaves like a check box. See

1817

<em class="parameter"><code>ATSPI_ROLE_CHECK_BOX</code></em>

1818

.</p>

1819

</td>

1820

1821

</tr>

1822

<tr>

1823

<td class="enum_member_name"><p><a name="ATSPI-ROLE-COLOR-CHOOSER:CAPS"></a>ATSPI_ROLE_COLOR_CHOOSER</p></td>

1824

1825

<p>A specialized dialog that lets the user choose a

1826

color.</p>

1827

</td>

1828

1829

</tr>

1830

<tr>

1831

<td class="enum_member_name"><p><a name="ATSPI-ROLE-COLUMN-HEADER:CAPS"></a>ATSPI_ROLE_COLUMN_HEADER</p></td>

1832

1833

<p>The header for a column of data.</p>

1834

</td>

1835

1836

</tr>

1837

<tr>

1838

<td class="enum_member_name"><p><a name="ATSPI-ROLE-COMBO-BOX:CAPS"></a>ATSPI_ROLE_COMBO_BOX</p></td>

1839

1840

<p>A list of choices the user can select from.</p>

1841

</td>

1842

1843

</tr>

1844

<tr>

1845

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DATE-EDITOR:CAPS"></a>ATSPI_ROLE_DATE_EDITOR</p></td>

1846

1847

<p>An object which allows entry of a date.</p>

1848

</td>

1849

1850

</tr>

1851

<tr>

1852

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DESKTOP-ICON:CAPS"></a>ATSPI_ROLE_DESKTOP_ICON</p></td>

1853

1854

<p>An inconifed internal frame within a DESKTOP_PANE.</p>

1855

</td>

1856

1857

</tr>

1858

<tr>

1859

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DESKTOP-FRAME:CAPS"></a>ATSPI_ROLE_DESKTOP_FRAME</p></td>

1860

1861

<p>A pane that supports internal frames and

1862

iconified versions of those internal frames.</p>

1863

</td>

1864

1865

</tr>

1866

<tr>

1867

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DIAL:CAPS"></a>ATSPI_ROLE_DIAL</p></td>

1868

1869

<p>An object that allows a value to be changed via rotating a

1870

visual element, or which displays a value via such a rotating element.</p>

1871

</td>

1872

1873

</tr>

1874

<tr>

1875

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DIALOG:CAPS"></a>ATSPI_ROLE_DIALOG</p></td>

1876

1877

<p>A top level window with title bar and a border.</p>

1878

</td>

1879

1880

</tr>

1881

<tr>

1882

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DIRECTORY-PANE:CAPS"></a>ATSPI_ROLE_DIRECTORY_PANE</p></td>

1883

1884

<p>A pane that allows the user to navigate through

1885

and select the contents of a directory.</p>

1886

</td>

1887

1888

</tr>

1889

<tr>

1890

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DRAWING-AREA:CAPS"></a>ATSPI_ROLE_DRAWING_AREA</p></td>

1891

1892

<p>A specialized dialog that displays the files in

1893

the directory and lets the user select a file, browse a different

1894

directory, or specify a filename.</p>

1895

</td>

1896

1897

</tr>

1898

<tr>

1899

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FILE-CHOOSER:CAPS"></a>ATSPI_ROLE_FILE_CHOOSER</p></td>

1900

1901

<p>An object used for drawing custom user interface

1902

elements.</p>

1903

</td>

1904

1905

</tr>

1906

<tr>

1907

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FILLER:CAPS"></a>ATSPI_ROLE_FILLER</p></td>

1908

1909

<p>A object that fills up space in a user interface.</p>

1910

</td>

1911

1912

</tr>

1913

<tr>

1914

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FOCUS-TRAVERSABLE:CAPS"></a>ATSPI_ROLE_FOCUS_TRAVERSABLE</p></td>

1915

1916

<p>Don't use, reserved for future use.</p>

1917

</td>

1918

1919

</tr>

1920

<tr>

1921

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FONT-CHOOSER:CAPS"></a>ATSPI_ROLE_FONT_CHOOSER</p></td>

1922

1923

<p>Allows selection of a display font.</p>

1924

</td>

1925

1926

</tr>

1927

<tr>

1928

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FRAME:CAPS"></a>ATSPI_ROLE_FRAME</p></td>

1929

1930

<p>A top level window with a title bar, border, menubar,

1931

etc.</p>

1932

</td>

1933

1934

</tr>

1935

<tr>

1936

<td class="enum_member_name"><p><a name="ATSPI-ROLE-GLASS-PANE:CAPS"></a>ATSPI_ROLE_GLASS_PANE</p></td>

1937

1938

<p>A pane that is guaranteed to be painted on top of

1939

all panes beneath it.</p>

1940

</td>

1941

1942

</tr>

1943

<tr>

1944

<td class="enum_member_name"><p><a name="ATSPI-ROLE-HTML-CONTAINER:CAPS"></a>ATSPI_ROLE_HTML_CONTAINER</p></td>

1945

1946

<p>A document container for HTML, whose children

1947

represent the document content.</p>

1948

</td>

1949

1950

</tr>

1951

<tr>

1952

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ICON:CAPS"></a>ATSPI_ROLE_ICON</p></td>

1953

1954

<p>A small fixed size picture, typically used to decorate

1955

components.</p>

1956

</td>

1957

1958

</tr>

1959

<tr>

1960

<td class="enum_member_name"><p><a name="ATSPI-ROLE-IMAGE:CAPS"></a>ATSPI_ROLE_IMAGE</p></td>

1961

1962

<p>An image, typically static.</p>

1963

</td>

1964

1965

</tr>

1966

<tr>

1967

<td class="enum_member_name"><p><a name="ATSPI-ROLE-INTERNAL-FRAME:CAPS"></a>ATSPI_ROLE_INTERNAL_FRAME</p></td>

1968

1969

<p>A frame-like object that is clipped by a desktop

1970

pane.</p>

1971

</td>

1972

1973

</tr>

1974

<tr>

1975

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LABEL:CAPS"></a>ATSPI_ROLE_LABEL</p></td>

1976

1977

<p>An object used to present an icon or short string in an

1978

interface.</p>

1979

</td>

1980

1981

</tr>

1982

<tr>

1983

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LAYERED-PANE:CAPS"></a>ATSPI_ROLE_LAYERED_PANE</p></td>

1984

1985

<p>A specialized pane that allows its children to be

1986

drawn in layers, providing a form of stacking order.</p>

1987

</td>

1988

1989

</tr>

1990

<tr>

1991

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LIST:CAPS"></a>ATSPI_ROLE_LIST</p></td>

1992

1993

<p>An object that presents a list of objects to the user and

1994

allows the user to select one or more of them.</p>

1995

</td>

1996

1997

</tr>

1998

<tr>

1999

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LIST-ITEM:CAPS"></a>ATSPI_ROLE_LIST_ITEM</p></td>

2000

2001

<p>An object that represents an element of a list.</p>

2002

</td>

2003

2004

</tr>

2005

<tr>

2006

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MENU:CAPS"></a>ATSPI_ROLE_MENU</p></td>

2007

2008

<p>An object usually found inside a menu bar that contains a

2009

list of actions the user can choose from.</p>

2010

</td>

2011

2012

</tr>

2013

<tr>

2014

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MENU-BAR:CAPS"></a>ATSPI_ROLE_MENU_BAR</p></td>

2015

2016

<p>An object usually drawn at the top of the primary

2017

dialog box of an application that contains a list of menus the user can

2018

choose from.</p>

2019

</td>

2020

2021

</tr>

2022

<tr>

2023

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MENU-ITEM:CAPS"></a>ATSPI_ROLE_MENU_ITEM</p></td>

2024

2025

<p>An object usually contained in a menu that presents

2026

an action the user can choose.</p>

2027

</td>

2028

2029

</tr>

2030

<tr>

2031

<td class="enum_member_name"><p><a name="ATSPI-ROLE-OPTION-PANE:CAPS"></a>ATSPI_ROLE_OPTION_PANE</p></td>

2032

2033

<p>A specialized pane whose primary use is inside a

2034

dialog.</p>

2035

</td>

2036

2037

</tr>

2038

<tr>

2039

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PAGE-TAB:CAPS"></a>ATSPI_ROLE_PAGE_TAB</p></td>

2040

2041

<p>An object that is a child of a page tab list.</p>

2042

</td>

2043

2044

</tr>

2045

<tr>

2046

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PAGE-TAB-LIST:CAPS"></a>ATSPI_ROLE_PAGE_TAB_LIST</p></td>

2047

2048

<p>An object that presents a series of panels (or

2049

page tabs), one at a time,through some mechanism provided by the

2050

object.</p>

2051

</td>

2052

2053

</tr>

2054

<tr>

2055

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PANEL:CAPS"></a>ATSPI_ROLE_PANEL</p></td>

2056

2057

<p>A generic container that is often used to group objects.</p>

2058

</td>

2059

2060

</tr>

2061

<tr>

2062

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PASSWORD-TEXT:CAPS"></a>ATSPI_ROLE_PASSWORD_TEXT</p></td>

2063

2064

<p>A text object uses for passwords, or other places

2065

where the text content is not shown visibly to the user.</p>

2066

</td>

2067

2068

</tr>

2069

<tr>

2070

<td class="enum_member_name"><p><a name="ATSPI-ROLE-POPUP-MENU:CAPS"></a>ATSPI_ROLE_POPUP_MENU</p></td>

2071

2072

<p>A temporary window that is usually used to offer the

2073

user a list of choices, and then hides when the user selects one of those

2074

choices.</p>

2075

</td>

2076

2077

</tr>

2078

<tr>

2079

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PROGRESS-BAR:CAPS"></a>ATSPI_ROLE_PROGRESS_BAR</p></td>

2080

2081

<p>An object used to indicate how much of a task has

2082

been completed.</p>

2083

</td>

2084

2085

</tr>

2086

<tr>

2087

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PUSH-BUTTON:CAPS"></a>ATSPI_ROLE_PUSH_BUTTON</p></td>

2088

2089

<p>An object the user can manipulate to tell the

2090

application to do something.</p>

2091

</td>

2092

2093

</tr>

2094

<tr>

2095

<td class="enum_member_name"><p><a name="ATSPI-ROLE-RADIO-BUTTON:CAPS"></a>ATSPI_ROLE_RADIO_BUTTON</p></td>

2096

2097

<p>A specialized check box that will cause other

2098

radio buttons in the same group to become unchecked when this one is

2099

checked.</p>

2100

</td>

2101

2102

</tr>

2103

<tr>

2104

<td class="enum_member_name"><p><a name="ATSPI-ROLE-RADIO-MENU-ITEM:CAPS"></a>ATSPI_ROLE_RADIO_MENU_ITEM</p></td>

2105

2106

<p>Object is both a menu item and a "radio button"

2107

. See <em class="parameter"><code>ATSPI_ROLE_RADIO_BUTTON</code></em>

2108

.</p>

2109

</td>

2110

2111

</tr>

2112

<tr>

2113

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ROOT-PANE:CAPS"></a>ATSPI_ROLE_ROOT_PANE</p></td>

2114

2115

<p>A specialized pane that has a glass pane and a

2116

layered pane as its children.</p>

2117

</td>

2118

2119

</tr>

2120

<tr>

2121

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ROW-HEADER:CAPS"></a>ATSPI_ROLE_ROW_HEADER</p></td>

2122

2123

<p>The header for a row of data.</p>

2124

</td>

2125

2126

</tr>

2127

<tr>

2128

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SCROLL-BAR:CAPS"></a>ATSPI_ROLE_SCROLL_BAR</p></td>

2129

2130

<p>An object usually used to allow a user to

2131

incrementally view a large amount of data by moving the bounds of a

2132

viewport along a one-dimensional axis.</p>

2133

</td>

2134

2135

</tr>

2136

<tr>

2137

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SCROLL-PANE:CAPS"></a>ATSPI_ROLE_SCROLL_PANE</p></td>

2138

2139

<p>An object that allows a user to incrementally view

2140

a large amount of information. <em class="parameter"><code>ATSPI_ROLE_SCROLL_PANE</code></em>

2141

objects are usually

2142

accompanied by <em class="parameter"><code>ATSPI_ROLE_SCROLL_BAR</code></em>

2143

controllers, on which the

2144

<em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em>

2145

and <em class="parameter"><code>ATSPI_RELATION_CONTROLLED_BY</code></em>

2146

2147

reciprocal relations are set. See <span class="type">atspi_get_relation_set</span>.</p>

2148

</td>

2149

2150

</tr>

2151

<tr>

2152

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SEPARATOR:CAPS"></a>ATSPI_ROLE_SEPARATOR</p></td>

2153

2154

<p>An object usually contained in a menu to provide a

2155

visible and logical separation of the contents in a menu.</p>

2156

</td>

2157

2158

</tr>

2159

<tr>

2160

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SLIDER:CAPS"></a>ATSPI_ROLE_SLIDER</p></td>

2161

2162

<p>An object that allows the user to select from a bounded

2163

range.</p>

2164

</td>

2165

2166

</tr>

2167

<tr>

2168

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SPIN-BUTTON:CAPS"></a>ATSPI_ROLE_SPIN_BUTTON</p></td>

2169

2170

<p>An object which allows one of a set of choices to

2171

be selected, and which displays the current choice. Unlike

2172

<em class="parameter"><code>ATSPI_ROLE_SCROLL_BAR</code></em>

2173

, <em class="parameter"><code>ATSPI_ROLE_SLIDER</code></em>

2174

objects need not control

2175

'viewport'-like objects.</p>

2176

</td>

2177

2178

</tr>

2179

<tr>

2180

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SPLIT-PANE:CAPS"></a>ATSPI_ROLE_SPLIT_PANE</p></td>

2181

2182

<p>A specialized panel that presents two other panels

2183

at the same time.</p>

2184

</td>

2185

2186

</tr>

2187

<tr>

2188

<td class="enum_member_name"><p><a name="ATSPI-ROLE-STATUS-BAR:CAPS"></a>ATSPI_ROLE_STATUS_BAR</p></td>

2189

2190

<p>Object displays non-quantitative status information

2191

(c.f. <em class="parameter"><code>ATSPI_ROLE_PROGRESS_BAR</code></em>

2192

)</p>

2193

</td>

2194

2195

</tr>

2196

<tr>

2197

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TABLE:CAPS"></a>ATSPI_ROLE_TABLE</p></td>

2198

2199

<p>An object used to repesent information in terms of rows

2200

and columns.</p>

2201

</td>

2202

2203

</tr>

2204

<tr>

2205

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TABLE-CELL:CAPS"></a>ATSPI_ROLE_TABLE_CELL</p></td>

2206

2207

<p>A 'cell' or discrete child within a Table. Note:

2208

Table cells need not have <em class="parameter"><code>ATSPI_ROLE_TABLE_CELL</code></em>

2209

, other

2210

<span class="type">AtspiRoleType</span> values are valid as well.</p>

2211

</td>

2212

2213

</tr>

2214

<tr>

2215

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TABLE-COLUMN-HEADER:CAPS"></a>ATSPI_ROLE_TABLE_COLUMN_HEADER</p></td>

2216

2217

<p>An object which labels a particular column

2218

in an <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>.</p>

2219

</td>

2220

2221

</tr>

2222

<tr>

2223

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TABLE-ROW-HEADER:CAPS"></a>ATSPI_ROLE_TABLE_ROW_HEADER</p></td>

2224

2225

<p>An object which labels a particular row in a

2226

<a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>. <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> rows and columns may also be labelled via the

2227

<em class="parameter"><code>ATSPI_RELATION_LABEL_FOR</code></em>

2228

/<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>

2229

relationships.

2230

See <span class="type">atspi_get_relation_set</span>.</p>

2231

</td>

2232

2233

</tr>

2234

<tr>

2235

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TEAROFF-MENU-ITEM:CAPS"></a>ATSPI_ROLE_TEAROFF_MENU_ITEM</p></td>

2236

2237

<p>Object allows menu to be removed from menubar

2238

and shown in its own window.</p>

2239

</td>

2240

2241

</tr>

2242

<tr>

2243

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TERMINAL:CAPS"></a>ATSPI_ROLE_TERMINAL</p></td>

2244

2245

<p>An object that emulates a terminal.</p>

2246

</td>

2247

2248

</tr>

2249

<tr>

2250

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TEXT:CAPS"></a>ATSPI_ROLE_TEXT</p></td>

2251

2252

<p>An interactive widget that supports multiple lines of text

2253

and optionally accepts user input, but whose purpose is not to solicit user

2254

input. Thus <em class="parameter"><code>ATSPI_ROLE_TEXT</code></em>

2255

is appropriate for the text view in a plain text

2256

editor but inappropriate for an input field in a dialog box or web form. For

2257

widgets whose purpose is to solicit input from the user, see <em class="parameter"><code>ATSPI_ROLE_ENTRY</code></em>

2258

2259

and <em class="parameter"><code>ATSPI_ROLE_PASSWORD_TEXT</code></em>

2260

. For generic objects which display a brief amount

2261

of textual information, see <em class="parameter"><code>ATSPI_ROLE_STATIC</code></em>

2262

.</p>

2263

</td>

2264

2265

</tr>

2266

<tr>

2267

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TOGGLE-BUTTON:CAPS"></a>ATSPI_ROLE_TOGGLE_BUTTON</p></td>

2268

2269

<p>A specialized push button that can be checked or

2270

unchecked, but does not procide a separate indicator for the current

2271

state.</p>

2272

</td>

2273

2274

</tr>

2275

<tr>

2276

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TOOL-BAR:CAPS"></a>ATSPI_ROLE_TOOL_BAR</p></td>

2277

2278

<p>A bar or palette usually composed of push buttons or

2279

toggle buttons.</p>

2280

</td>

2281

2282

</tr>

2283

<tr>

2284

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TOOL-TIP:CAPS"></a>ATSPI_ROLE_TOOL_TIP</p></td>

2285

2286

<p>An object that provides information about another

2287

object.</p>

2288

</td>

2289

2290

</tr>

2291

<tr>

2292

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TREE:CAPS"></a>ATSPI_ROLE_TREE</p></td>

2293

2294

<p>An object used to repsent hierarchical information to the

2295

user.</p>

2296

</td>

2297

2298

</tr>

2299

<tr>

2300

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TREE-TABLE:CAPS"></a>ATSPI_ROLE_TREE_TABLE</p></td>

2301

2302

<p>An object that presents both tabular and

2303

hierarchical info to the user.</p>

2304

</td>

2305

2306

</tr>

2307

<tr>

2308

<td class="enum_member_name"><p><a name="ATSPI-ROLE-UNKNOWN:CAPS"></a>ATSPI_ROLE_UNKNOWN</p></td>

2309

2310

<p>The object contains some <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> information,

2311

but its role is not known.</p>

2312

</td>

2313

2314

</tr>

2315

<tr>

2316

<td class="enum_member_name"><p><a name="ATSPI-ROLE-VIEWPORT:CAPS"></a>ATSPI_ROLE_VIEWPORT</p></td>

2317

2318

<p>An object usually used in a scroll pane, or to

2319

otherwise clip a larger object or content renderer to a specific

2320

onscreen viewport.</p>

2321

</td>

2322

2323

</tr>

2324

<tr>

2325

<td class="enum_member_name"><p><a name="ATSPI-ROLE-WINDOW:CAPS"></a>ATSPI_ROLE_WINDOW</p></td>

2326

2327

<p>A top level window with no title or border.</p>

2328

</td>

2329

2330

</tr>

2331

<tr>

2332

<td class="enum_member_name"><p><a name="ATSPI-ROLE-EXTENDED:CAPS"></a>ATSPI_ROLE_EXTENDED</p></td>

2333

2334

<p>means that the role for this item is known, but not

2335

included in the core enumeration.</p>

2336

</td>

2337

2338

</tr>

2339

<tr>

2340

<td class="enum_member_name"><p><a name="ATSPI-ROLE-HEADER:CAPS"></a>ATSPI_ROLE_HEADER</p></td>

2341

2342

<p>An object that serves as a document header.</p>

2343

</td>

2344

2345

</tr>

2346

<tr>

2347

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FOOTER:CAPS"></a>ATSPI_ROLE_FOOTER</p></td>

2348

2349

<p>An object that serves as a document footer.</p>

2350

</td>

2351

2352

</tr>

2353

<tr>

2354

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PARAGRAPH:CAPS"></a>ATSPI_ROLE_PARAGRAPH</p></td>

2355

2356

<p>An object which is contains a single paragraph of

2357

text content. See also <em class="parameter"><code>ATSPI_ROLE_TEXT</code></em>

2358

.</p>

2359

</td>

2360

2361

</tr>

2362

<tr>

2363

<td class="enum_member_name"><p><a name="ATSPI-ROLE-RULER:CAPS"></a>ATSPI_ROLE_RULER</p></td>

2364

2365

<p>An object which describes margins and tab stops, etc.

2366

for text objects which it controls (should have

2367

<em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em>

2368

relation to such).</p>

2369

</td>

2370

2371

</tr>

2372

<tr>

2373

<td class="enum_member_name"><p><a name="ATSPI-ROLE-APPLICATION:CAPS"></a>ATSPI_ROLE_APPLICATION</p></td>

2374

2375

<p>An object corresponding to the toplevel accessible

2376

of an application, which may contain <em class="parameter"><code>ATSPI_ROLE_FRAME</code></em>

2377

objects or other

2378

accessible objects. Children of <span class="type">AccessibleDesktop</span> objects are generally

2379

<em class="parameter"><code>ATSPI_ROLE_APPLICATION</code></em>

2380

objects.</p>

2381

</td>

2382

2383

</tr>

2384

<tr>

2385

<td class="enum_member_name"><p><a name="ATSPI-ROLE-AUTOCOMPLETE:CAPS"></a>ATSPI_ROLE_AUTOCOMPLETE</p></td>

2386

2387

<p>The object is a dialog or list containing items

2388

for insertion into an entry widget, for instance a list of words for

2389

completion of a text entry.</p>

2390

</td>

2391

2392

</tr>

2393

<tr>

2394

<td class="enum_member_name"><p><a name="ATSPI-ROLE-EDITBAR:CAPS"></a>ATSPI_ROLE_EDITBAR</p></td>

2395

2396

<p>The object is an editable text object in a toolbar.</p>

2397

</td>

2398

2399

</tr>

2400

<tr>

2401

<td class="enum_member_name"><p><a name="ATSPI-ROLE-EMBEDDED:CAPS"></a>ATSPI_ROLE_EMBEDDED</p></td>

2402

2403

<p>The object is an embedded component container. This

2404

role is a "grouping" hint that the contained objects share a context

2405

which is different from the container in which this accessible is

2406

embedded. In particular, it is used for some kinds of document embedding,

2407

and for embedding of out-of-process component, "panel applets", etc.</p>

2408

</td>

2409

2410

</tr>

2411

<tr>

2412

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ENTRY:CAPS"></a>ATSPI_ROLE_ENTRY</p></td>

2413

2414

<p>The object is a component whose textual content may be

2415

entered or modified by the user, provided <em class="parameter"><code>ATSPI_STATE_EDITABLE</code></em>

2416

is present.

2417

A readonly <em class="parameter"><code>ATSPI_ROLE_ENTRY</code></em>

2418

object (i.e. where <em class="parameter"><code>ATSPI_STATE_EDITABLE</code></em>

2419

2420

not present) implies a read-only 'text field' in a form, as opposed to a

2421

title, label, or caption.</p>

2422

</td>

2423

2424

</tr>

2425

<tr>

2426

<td class="enum_member_name"><p><a name="ATSPI-ROLE-CHART:CAPS"></a>ATSPI_ROLE_CHART</p></td>

2427

2428

<p>The object is a graphical depiction of quantitative data.

2429

It may contain multiple subelements whose attributes and/or description

2430

may be queried to obtain both the quantitative data and information about

2431

how the data is being presented. The <em class="parameter"><code>ATSPI_LABELLED_BY</code></em>

2432

relation is

2433

particularly important in interpreting objects of this type, as is the

2434

accessible description property. See <em class="parameter"><code>ATSPI_ROLE_CAPTION</code></em>

2435

.</p>

2436

</td>

2437

2438

</tr>

2439

<tr>

2440

<td class="enum_member_name"><p><a name="ATSPI-ROLE-CAPTION:CAPS"></a>ATSPI_ROLE_CAPTION</p></td>

2441

2442

<p>The object contains descriptive information, usually

2443

textual, about another user interface element such as a table, chart, or

2444

image.</p>

2445

</td>

2446

2447

</tr>

2448

<tr>

2449

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DOCUMENT-FRAME:CAPS"></a>ATSPI_ROLE_DOCUMENT_FRAME</p></td>

2450

2451

<p>The object is a visual frame or container which

2452

contains a view of document content. <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> frames may occur within

2453

another <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> instance, in which case the second document may be

2454

said to be embedded in the containing instance. HTML frames are often

2455

ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant,

2456

should implement the <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> interface.</p>

2457

</td>

2458

2459

</tr>

2460

<tr>

2461

<td class="enum_member_name"><p><a name="ATSPI-ROLE-HEADING:CAPS"></a>ATSPI_ROLE_HEADING</p></td>

2462

2463

<p>The object serves as a heading for content which

2464

follows it in a document. The 'heading level' of the heading, if

2465

availabe, may be obtained by querying the object's attributes.</p>

2466

</td>

2467

2468

</tr>

2469

<tr>

2470

<td class="enum_member_name"><p><a name="ATSPI-ROLE-PAGE:CAPS"></a>ATSPI_ROLE_PAGE</p></td>

2471

2472

<p>The object is a containing instance which encapsulates a

2473

page of information. <em class="parameter"><code>ATSPI_ROLE_PAGE</code></em>

2474

is used in documents and content which

2475

support a paginated navigation model.</p>

2476

</td>

2477

2478

</tr>

2479

<tr>

2480

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SECTION:CAPS"></a>ATSPI_ROLE_SECTION</p></td>

2481

2482

<p>The object is a containing instance of document content

2483

which constitutes a particular 'logical' section of the document. The

2484

type of content within a section, and the nature of the section division

2485

itself, may be obtained by querying the object's attributes. Sections

2486

may be nested.</p>

2487

</td>

2488

2489

</tr>

2490

<tr>

2491

<td class="enum_member_name"><p><a name="ATSPI-ROLE-REDUNDANT-OBJECT:CAPS"></a>ATSPI_ROLE_REDUNDANT_OBJECT</p></td>

2492

2493

<p>The object is redundant with another object in

2494

the hierarchy, and is exposed for purely technical reasons. Objects of

2495

this role should be ignored by clients, if they are encountered at all.</p>

2496

</td>

2497

2498

</tr>

2499

<tr>

2500

<td class="enum_member_name"><p><a name="ATSPI-ROLE-FORM:CAPS"></a>ATSPI_ROLE_FORM</p></td>

2501

2502

<p>The object is a containing instance of document content

2503

which has within it components with which the user can interact in order

2504

to input information; i.e. the object is a container for pushbuttons,

2505

comboboxes, text input fields, and other 'GUI' components. <em class="parameter"><code>ATSPI_ROLE_FORM</code></em>

2506

2507

should not, in general, be used for toplevel GUI containers or dialogs,

2508

but should be reserved for 'GUI' containers which occur within document

2509

content, for instance within Web documents, presentations, or text

2510

documents. Unlike other GUI containers and dialogs which occur inside

2511

application instances, <em class="parameter"><code>ATSPI_ROLE_FORM</code></em>

2512

containers' components are

2513

associated with the current document, rather than the current foreground

2514

application or viewer instance.</p>

2515

</td>

2516

2517

</tr>

2518

<tr>

2519

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LINK:CAPS"></a>ATSPI_ROLE_LINK</p></td>

2520

2521

<p>The object is a hypertext anchor, i.e. a "link" in a

2522

hypertext document. Such objects are distinct from 'inline' content

2523

which may also use the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>/<a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> interfacesto indicate

2524

the range/location within a text object where an inline or embedded object

2525

lies.</p>

2526

</td>

2527

2528

</tr>

2529

<tr>

2530

<td class="enum_member_name"><p><a name="ATSPI-ROLE-INPUT-METHOD-WINDOW:CAPS"></a>ATSPI_ROLE_INPUT_METHOD_WINDOW</p></td>

2531

2532

<p>The object is a window or similar viewport

2533

which is used to allow composition or input of a 'complex character',

2534

in other words it is an "input method window".</p>

2535

</td>

2536

2537

</tr>

2538

<tr>

2539

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TABLE-ROW:CAPS"></a>ATSPI_ROLE_TABLE_ROW</p></td>

2540

2541

<p>A row in a table.</p>

2542

</td>

2543

2544

</tr>

2545

<tr>

2546

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TREE-ITEM:CAPS"></a>ATSPI_ROLE_TREE_ITEM</p></td>

2547

2548

<p>An object that represents an element of a tree.</p>

2549

</td>

2550

2551

</tr>

2552

<tr>

2553

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DOCUMENT-SPREADSHEET:CAPS"></a>ATSPI_ROLE_DOCUMENT_SPREADSHEET</p></td>

2554

2555

<p>A document frame which contains a

2556

spreadsheet.</p>

2557

</td>

2558

2559

</tr>

2560

<tr>

2561

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DOCUMENT-PRESENTATION:CAPS"></a>ATSPI_ROLE_DOCUMENT_PRESENTATION</p></td>

2562

2563

<p>A document frame which contains a

2564

presentation or slide content.</p>

2565

</td>

2566

2567

</tr>

2568

<tr>

2569

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DOCUMENT-TEXT:CAPS"></a>ATSPI_ROLE_DOCUMENT_TEXT</p></td>

2570

2571

<p>A document frame which contains textual content,

2572

such as found in a word processing

2573

application.</p>

2574

</td>

2575

2576

</tr>

2577

<tr>

2578

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DOCUMENT-WEB:CAPS"></a>ATSPI_ROLE_DOCUMENT_WEB</p></td>

2579

2580

<p>A document frame which contains HTML or other

2581

markup suitable for display in a web browser.</p>

2582

</td>

2583

2584

</tr>

2585

<tr>

2586

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DOCUMENT-EMAIL:CAPS"></a>ATSPI_ROLE_DOCUMENT_EMAIL</p></td>

2587

2588

<p>A document frame which contains email content

2589

to be displayed or composed either in plain text or

2590

HTML.</p>

2591

</td>

2592

2593

</tr>

2594

<tr>

2595

<td class="enum_member_name"><p><a name="ATSPI-ROLE-COMMENT:CAPS"></a>ATSPI_ROLE_COMMENT</p></td>

2596

2597

<p>An object found within a document and designed to

2598

present a comment, note, or other annotation. In some cases, this object

2599

might not be visible until activated.</p>

2600

</td>

2601

2602

</tr>

2603

<tr>

2604

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LIST-BOX:CAPS"></a>ATSPI_ROLE_LIST_BOX</p></td>

2605

2606

<p>A non-collapsible list of choices the user can

2607

select from.</p>

2608

</td>

2609

2610

</tr>

2611

<tr>

2612

<td class="enum_member_name"><p><a name="ATSPI-ROLE-GROUPING:CAPS"></a>ATSPI_ROLE_GROUPING</p></td>

2613

2614

<p>A group of related widgets. This group typically has

2615

a label.</p>

2616

</td>

2617

2618

</tr>

2619

<tr>

2620

<td class="enum_member_name"><p><a name="ATSPI-ROLE-IMAGE-MAP:CAPS"></a>ATSPI_ROLE_IMAGE_MAP</p></td>

2621

2622

<p>An image map object. Usually a graphic with multiple

2623

hotspots, where each hotspot can be activated resulting in the loading of

2624

another document or section of a document.</p>

2625

</td>

2626

2627

</tr>

2628

<tr>

2629

<td class="enum_member_name"><p><a name="ATSPI-ROLE-NOTIFICATION:CAPS"></a>ATSPI_ROLE_NOTIFICATION</p></td>

2630

2631

<p>A transitory object designed to present a

2632

message to the user, typically at the desktop level rather than inside a

2633

particular application.</p>

2634

</td>

2635

2636

</tr>

2637

<tr>

2638

<td class="enum_member_name"><p><a name="ATSPI-ROLE-INFO-BAR:CAPS"></a>ATSPI_ROLE_INFO_BAR</p></td>

2639

2640

<p>An object designed to present a message to the user

2641

within an existing window.</p>

2642

</td>

2643

2644

</tr>

2645

<tr>

2646

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LEVEL-BAR:CAPS"></a>ATSPI_ROLE_LEVEL_BAR</p></td>

2647

2648

<p>A bar that serves as a level indicator to, for

2649

instance, show the strength of a password or the state of a battery.

2650

Since: 2.8</p>

2651

</td>

2652

2653

</tr>

2654

<tr>

2655

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TITLE-BAR:CAPS"></a>ATSPI_ROLE_TITLE_BAR</p></td>

2656

2657

<p>A bar that serves as the title of a window or a

2658

dialog. <em class="parameter"><code>Since</code></em>

2659

: 2.12</p>

2660

</td>

2661

2662

</tr>

2663

<tr>

2664

<td class="enum_member_name"><p><a name="ATSPI-ROLE-BLOCK-QUOTE:CAPS"></a>ATSPI_ROLE_BLOCK_QUOTE</p></td>

2665

2666

<p>An object which contains a text section

2667

that is quoted from another source. <em class="parameter"><code>Since</code></em>

2668

: 2.12</p>

2669

</td>

2670

2671

</tr>

2672

<tr>

2673

<td class="enum_member_name"><p><a name="ATSPI-ROLE-AUDIO:CAPS"></a>ATSPI_ROLE_AUDIO</p></td>

2674

2675

<p>An object which represents an audio

2676

element. <em class="parameter"><code>Since</code></em>

2677

: 2.12</p>

2678

</td>

2679

2680

</tr>

2681

<tr>

2682

<td class="enum_member_name"><p><a name="ATSPI-ROLE-VIDEO:CAPS"></a>ATSPI_ROLE_VIDEO</p></td>

2683

2684

<p>An object which represents a video

2685

element. <em class="parameter"><code>Since</code></em>

2686

: 2.12</p>

2687

</td>

2688

2689

</tr>

2690

<tr>

2691

<td class="enum_member_name"><p><a name="ATSPI-ROLE-DEFINITION:CAPS"></a>ATSPI_ROLE_DEFINITION</p></td>

2692

2693

<p>A definition of a term or concept. <em class="parameter"><code>Since</code></em>

2694

: 2.12</p>

2695

</td>

2696

2697

</tr>

2698

<tr>

2699

<td class="enum_member_name"><p><a name="ATSPI-ROLE-ARTICLE:CAPS"></a>ATSPI_ROLE_ARTICLE</p></td>

2700

2701

<p>A section of a page that consists of a

2702

composition that forms an independent part of a document, page, or

2703

site. Examples: A blog entry, a news story, a forum post. <em class="parameter"><code>Since</code></em>

2704

2705

2.12</p>

2706

</td>

2707

2708

</tr>

2709

<tr>

2710

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LANDMARK:CAPS"></a>ATSPI_ROLE_LANDMARK</p></td>

2711

2712

<p>A region of a web page intended as a

2713

navigational landmark. This is designed to allow Assistive

2714

Technologies to provide quick navigation among key regions within a

2715

document. <em class="parameter"><code>Since</code></em>

2716

: 2.12</p>

2717

</td>

2718

2719

</tr>

2720

<tr>

2721

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LOG:CAPS"></a>ATSPI_ROLE_LOG</p></td>

2722

2723

<p>A text widget or container holding log content, such

2724

as chat history and error logs. In this role there is a

2725

relationship between the arrival of new items in the log and the

2726

reading order. The log contains a meaningful sequence and new

2727

information is added only to the end of the log, not at arbitrary

2728

points. <em class="parameter"><code>Since</code></em>

2729

: 2.12</p>

2730

</td>

2731

2732

</tr>

2733

<tr>

2734

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MARQUEE:CAPS"></a>ATSPI_ROLE_MARQUEE</p></td>

2735

2736

<p>A container where non-essential information

2737

changes frequently. Common usages of marquee include stock tickers

2738

and ad banners. The primary difference between a marquee and a log

2739

is that logs usually have a meaningful order or sequence of

2740

important content changes. <em class="parameter"><code>Since</code></em>

2741

: 2.12</p>

2742

</td>

2743

2744

</tr>

2745

<tr>

2746

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MATH:CAPS"></a>ATSPI_ROLE_MATH</p></td>

2747

2748

<p>A text widget or container that holds a mathematical

2749

expression. <em class="parameter"><code>Since</code></em>

2750

: 2.12</p>

2751

</td>

2752

2753

</tr>

2754

<tr>

2755

<td class="enum_member_name"><p><a name="ATSPI-ROLE-RATING:CAPS"></a>ATSPI_ROLE_RATING</p></td>

2756

2757

<p>A widget whose purpose is to display a rating,

2758

such as the number of stars associated with a song in a media

2759

player. Objects of this role should also implement

2760

AtspiValue. <em class="parameter"><code>Since</code></em>

2761

: 2.12</p>

2762

</td>

2763

2764

</tr>

2765

<tr>

2766

<td class="enum_member_name"><p><a name="ATSPI-ROLE-TIMER:CAPS"></a>ATSPI_ROLE_TIMER</p></td>

2767

2768

<p>An object containing a numerical counter which

2769

indicates an amount of elapsed time from a start point, or the time

2770

remaining until an end point. <em class="parameter"><code>Since</code></em>

2771

: 2.12</p>

2772

</td>

2773

2774

</tr>

2775

<tr>

2776

<td class="enum_member_name"><p><a name="ATSPI-ROLE-STATIC:CAPS"></a>ATSPI_ROLE_STATIC</p></td>

2777

2778

<p>A generic non-container object whose purpose is to display

2779

a brief amount of information to the user and whose role is known by the

2780

implementor but lacks semantic value for the user. Examples in which

2781

<em class="parameter"><code>ATSPI_ROLE_STATIC</code></em>

2782

is appropriate include the message displayed in a message

2783

box and an image used as an alternative means to display text.

2784

<em class="parameter"><code>ATSPI_ROLE_STATIC</code></em>

2785

should not be applied to widgets which are traditionally

2786

interactive, objects which display a significant amount of content, or any

2787

object which has an accessible relation pointing to another object. The

2788

displayed information, as a general rule, should be exposed through the

2789

accessible name of the object. For labels which describe another widget, see

2790

<em class="parameter"><code>ATSPI_ROLE_LABEL</code></em>

2791

. For text views, see <em class="parameter"><code>ATSPI_ROLE_TEXT</code></em>

2792

. For generic

2793

containers, see <em class="parameter"><code>ATSPI_ROLE_PANEL</code></em>

2794

. For objects whose role is not known by the

2795

implementor, see <em class="parameter"><code>ATSPI_ROLE_UNKNOWN</code></em>

2796

. <em class="parameter"><code>Since</code></em>

2797

: 2.16.</p>

2798

</td>

2799

2800

</tr>

2801

<tr>

2802

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MATH-FRACTION:CAPS"></a>ATSPI_ROLE_MATH_FRACTION</p></td>

2803

2804

<p>An object that represents a mathematical fraction.</p>

2805

</td>

2806

2807

</tr>

2808

<tr>

2809

<td class="enum_member_name"><p><a name="ATSPI-ROLE-MATH-ROOT:CAPS"></a>ATSPI_ROLE_MATH_ROOT</p></td>

2810

2811

<p>An object that represents a mathematical expression

2812

displayed with a radical. <em class="parameter"><code>Since</code></em>

2813

: 2.16.</p>

2814

</td>

2815

2816

</tr>

2817

<tr>

2818

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SUBSCRIPT:CAPS"></a>ATSPI_ROLE_SUBSCRIPT</p></td>

2819

2820

<p>An object that contains text that is displayed as a

2821

subscript. <em class="parameter"><code>Since</code></em>

2822

: 2.16.</p>

2823

</td>

2824

2825

</tr>

2826

<tr>

2827

<td class="enum_member_name"><p><a name="ATSPI-ROLE-SUPERSCRIPT:CAPS"></a>ATSPI_ROLE_SUPERSCRIPT</p></td>

2828

2829

<p>An object that contains text that is displayed as a

2830

superscript. <em class="parameter"><code>Since</code></em>

2831

: 2.16.</p>

2832

</td>

2833

2834

</tr>

2835

<tr>

2836

<td class="enum_member_name"><p><a name="ATSPI-ROLE-LAST-DEFINED:CAPS"></a>ATSPI_ROLE_LAST_DEFINED</p></td>

2837

2838

<p>Not a valid role, used for finding end of

2839

enumeration.</p>

2840

</td>

2841

2842

</tr>

2843

</tbody>

2844

</table></div>

2845

</div>

2846

</div>

2847

</div>

2848

</div>

2849

2850

<hr>Generated by GTK-Doc V1.24.1</div>

2851

</body>

2852

</html>

b'\\ No newline at end of file'

Older »