Grcov report - atspi-accessible.c

1

/*

2

 * AT-SPI - Assistive Technology Service Provider Interface

3

 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)

4

5

 * Copyright 2001, 2002 Sun Microsystems Inc.,

6

 * Copyright 2001, 2002 Ximian, Inc.

7

 * Copyright 2010, 2011 Novell, Inc.

8

9

 * This library is free software; you can redistribute it and/or

10

 * modify it under the terms of the GNU Lesser General Public

11

 * License as published by the Free Software Foundation; either

12

 * version 2.1 of the License, or (at your option) any later version.

13

14

 * This library is distributed in the hope that it will be useful,

15

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

16

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

17

 * Lesser General Public License for more details.

18

19

 * You should have received a copy of the GNU Lesser General Public

20

 * License along with this library; if not, write to the

21

 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,

22

 * Boston, MA 02110-1301, USA.

23

*/

24

25

#include "atspi-accessible-private.h"

26

#include "atspi-private.h"

27

#include <string.h>

28

29

/**

30

 * AtspiAccessible:

31

32

 * The base interface which is implemented by all accessible objects.

33

34

 * All objects support interfaces for querying their contained 'children'

35

 * and position in the accessible-object hierarchy, whether or not they

36

 * actually have children.

37

*/

38

39

enum

40

41

  REGION_CHANGED,

42

  MODE_CHANGED,

43

  LAST_SIGNAL

44

};

45

46

static gboolean enable_caching = FALSE;

47

static guint quark_locale;

48

49

static guint atspi_accessible_signals[LAST_SIGNAL] = {

50

0,

51

};

52

53

static gboolean

54

screen_reader_signal_watcher (GSignalInvocationHint *signal_hint,

55

                              guint n_param_values,

56

                              const GValue *param_values,

57

                              gpointer data)

58

59

  GObject *object;

60

  AtspiAccessible *accessible;

61

  GSignalQuery signal_query;

62

  const char *name;

63

  DBusMessage *signal;

64

  DBusMessageIter iter, iter_struct, iter_variant, iter_array;

65

  dbus_int32_t detail1 = 0, detail2 = 0;

66

  const char *detail = "";

67

  gchar *dbus_name;

68

69

  object = g_value_get_object (param_values + 0);

70

  g_return_val_if_fail (ATSPI_IS_ACCESSIBLE (object), FALSE);

71

72

  g_signal_query (signal_hint->signal_id, &signal_query);

73

  name = signal_query.signal_name;

74

  if (signal_hint->detail)

75

    detail = g_quark_to_string (signal_hint->detail);

76

  if (n_param_values > 1)

77

    detail1 = g_value_get_int (param_values + 1);

78

  if (n_param_values > 2 && G_VALUE_HOLDS_INT (param_values + 2))

79

    detail2 = g_value_get_int (param_values + 2);

80

  accessible = ATSPI_ACCESSIBLE (object);

81

  g_return_val_if_fail (accessible->parent.app != NULL, FALSE);

82

83

  dbus_name = _atspi_strdup_and_adjust_for_dbus (name);

84

  signal = dbus_message_new_signal (ATSPI_DBUS_PATH_SCREEN_READER,

85

                                    ATSPI_DBUS_INTERFACE_EVENT_SCREEN_READER,

86

                                    dbus_name);

87

  g_free (dbus_name);

88

  dbus_message_iter_init_append (signal, &iter);

89

  dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &detail);

90

  dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &detail1);

91

  dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &detail2);

92

  dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "(so)",

93

                                    &iter_variant);

94

  dbus_message_iter_open_container (&iter_variant, DBUS_TYPE_STRUCT, NULL,

95

                                    &iter_struct);

96

  dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &accessible->parent.app->bus_name);

97

  dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &accessible->parent.path);

98

  dbus_message_iter_close_container (&iter_variant, &iter_struct);

99

  dbus_message_iter_close_container (&iter, &iter_variant);

100

  dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY, "{sv}",

101

                                    &iter_array);

102

  dbus_message_iter_close_container (&iter, &iter_array);

103

  dbus_connection_send (_atspi_bus (), signal, NULL);

104

  dbus_message_unref (signal);

105

  return TRUE;

106

107

108

static void

109

2

atspi_action_interface_init (AtspiAction *action)

110

111

2

112

113

static void

114

2

atspi_collection_interface_init (AtspiCollection *component)

115

116

2

117

118

static void

119

2

atspi_component_interface_init (AtspiComponent *component)

120

121

2

122

123

static void

124

2

atspi_document_interface_init (AtspiDocument *document)

125

126

2

127

128

static void

129

2

atspi_editable_text_interface_init (AtspiEditableText *editable_text)

130

131

2

132

133

static void

134

2

atspi_hypertext_interface_init (AtspiHypertext *hypertext)

135

136

2

137

138

static void

139

2

atspi_image_interface_init (AtspiImage *image)

140

141

2

142

143

static void

144

2

atspi_selection_interface_init (AtspiSelection *selection)

145

146

2

147

148

static void

149

2

atspi_table_interface_init (AtspiTable *table)

150

151

2

152

153

static void

154

2

atspi_table_cell_interface_init (AtspiTableCell *cell)

155

156

2

157

158

static void

159

2

atspi_text_interface_init (AtspiText *text)

160

161

2

162

163

static void

164

2

atspi_value_interface_init (AtspiValue *value)

165

166

2

167

168

2

G_DEFINE_TYPE_WITH_CODE (AtspiAccessible, atspi_accessible, ATSPI_TYPE_OBJECT, G_ADD_PRIVATE (AtspiAccessible) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_ACTION, atspi_action_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COLLECTION, atspi_collection_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COMPONENT, atspi_component_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_DOCUMENT, atspi_document_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_EDITABLE_TEXT, atspi_editable_text_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_HYPERTEXT, atspi_hypertext_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_IMAGE, atspi_image_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_SELECTION, atspi_selection_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE, atspi_table_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE_CELL, atspi_table_cell_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TEXT, atspi_text_interface_init) G_IMPLEMENT_INTERFACE (ATSPI_TYPE_VALUE, atspi_value_interface_init))

169

170

#ifdef DEBUG_REF_COUNTS

171

static gint accessible_count = 0;

172

#endif

173

174

static void

175

1682

atspi_accessible_unref (GObject *accessible)

176

177

1682

  if (accessible != NULL)

178

1682

    g_object_unref (accessible);

179

1682

180

181

static void

182

1685

atspi_accessible_init (AtspiAccessible *accessible)

183

184

#ifdef DEBUG_REF_COUNTS

185

  accessible_count++;

186

  g_hash_table_insert (_atspi_get_live_refs (), accessible, NULL);

187

  g_print ("at-spi: init: %d objects\n", accessible_count);

188

#endif

189

190

1685

  accessible->priv = atspi_accessible_get_instance_private (accessible);

191

192

1685

  accessible->children = g_ptr_array_new_with_free_func ((GDestroyNotify) atspi_accessible_unref);

193

1685

194

195

static void

196

3366

atspi_accessible_dispose (GObject *object)

197

198

3366

  AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);

199

  AtspiEvent e;

200

  AtspiAccessible *parent;

201

  gint i;

202

203

  /* TODO: Only fire if object not already marked defunct */

204

3366

  memset (&e, 0, sizeof (e));

205

3366

  e.type = "object:state-changed:defunct";

206

3366

  e.source = accessible;

207

3366

  e.detail1 = 1;

208

3366

  e.detail2 = 0;

209

3366

  _atspi_send_event (&e);

210

211

3366

  g_clear_object (&accessible->states);

212

213

3366

  parent = accessible->accessible_parent;

214

3366

  if (parent)

215

216

709

      accessible->accessible_parent = NULL;

217

709

      if (parent->children)

218

709

        g_ptr_array_remove (parent->children, accessible);

219

709

      g_object_unref (parent);

220

221

222

3366

  if (accessible->children)

223

2658

    for (i = accessible->children->len - 1; i >= 0; i--)

224

225

973

        AtspiAccessible *child = g_ptr_array_index (accessible->children, i);

226

973

        if (child && child->accessible_parent == accessible)

227

228

824

            child->accessible_parent = NULL;

229

824

            g_object_unref (accessible);

230

231

232

233

3366

  if (accessible->children)

234

235

1685

      g_ptr_array_free (accessible->children, TRUE);

236

1685

      accessible->children = NULL;

237

238

239

3366

  G_OBJECT_CLASS (atspi_accessible_parent_class)->dispose (object);

240

3366

241

242

static void

243

1681

atspi_accessible_finalize (GObject *object)

244

245

1681

  AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);

246

247

1681

  g_free (accessible->description);

248

1681

  g_free (accessible->name);

249

250

1681

  if (accessible->attributes)

251

1

    g_hash_table_unref (accessible->attributes);

252

253

1681

  if (accessible->priv->cache)

254

    g_hash_table_destroy (accessible->priv->cache);

255

256

#ifdef DEBUG_REF_COUNTS

257

  accessible_count--;

258

  g_hash_table_remove (_atspi_get_live_refs (), accessible);

259

  g_print ("at-spi: finalize: %d objects\n", accessible_count);

260

#endif

261

262

1681

  G_OBJECT_CLASS (atspi_accessible_parent_class)->finalize (object);

263

264

  /* TODO: remove emission hook */

265

1681

266

267

static void

268

2

atspi_accessible_class_init (AtspiAccessibleClass *klass)

269

270

2

  GObjectClass *object_class = G_OBJECT_CLASS (klass);

271

272

2

  object_class->dispose = atspi_accessible_dispose;

273

2

  object_class->finalize = atspi_accessible_finalize;

274

275

2

  quark_locale = g_quark_from_string ("accessible-locale");

276

277

/**

278

   * AtspiAccessible::region-changed:

279

   * @atspiaccessible: the object which received the signal

280

   * @arg1: an integer specifying the current offset of the text being read,

281

   *        if the object is textual.

282

   * @arg2: an integer specifying the ending offset of the text being read,

283

   *        if the object is textual.

284

285

   * The signal "region-changed" is emitted by a screen reader to indicate

286

   * that it is now reading or tracking a new object, or, a new piece of

287

   * text within an object. This allows a magnifier to gain the information

288

   * needed to highlight the object that the screen reader is reading.

289

*/

290

2

  atspi_accessible_signals[REGION_CHANGED] =

291

2

      g_signal_new ("region_changed",

292

                    G_TYPE_FROM_CLASS (klass),

293

                    G_SIGNAL_RUN_LAST,

294

                    G_STRUCT_OFFSET (AtspiAccessibleClass, region_changed),

295

                    NULL, NULL,

296

                    atspi_marshal_VOID__INT_INT,

297

                    G_TYPE_NONE,

298

                    2, G_TYPE_INT, G_TYPE_INT);

299

300

/**

301

   * AtspiAccessible::mode-changed:

302

   * @atspiaccessible: the object which received the signal

303

   * @arg1: a boolean specifying whether the mode is being toggled on or off.

304

   * @why: an optional string explaining why the mode changed.

305

306

   * The signal "mode-changed" is emitted by a screen reader to indicate

307

   * that its mode has changed. This signal supports the following details:

308

   * focus-tracking

309

   * flat-review

310

   * mouse-review

311

   * say-all

312

   * caret-tracking

313

*/

314

2

  atspi_accessible_signals[MODE_CHANGED] =

315

2

      g_signal_new ("mode_changed",

316

                    G_TYPE_FROM_CLASS (klass),

317

                    G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,

318

                    G_STRUCT_OFFSET (AtspiAccessibleClass, mode_changed),

319

                    NULL, NULL,

320

                    atspi_marshal_VOID__INT_STRING,

321

                    G_TYPE_NONE,

322

                    2, G_TYPE_INT, G_TYPE_STRING);

323

324

2

  g_signal_add_emission_hook (atspi_accessible_signals[REGION_CHANGED], 0,

325

                              screen_reader_signal_watcher, NULL,

326

                              (GDestroyNotify) NULL);

327

2

  g_signal_add_emission_hook (atspi_accessible_signals[MODE_CHANGED], 0,

328

                              screen_reader_signal_watcher, NULL,

329

                              (GDestroyNotify) NULL);

330

2

331

332

/**

333

 * atspi_accessible_get_name:

334

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

335

336

 * Gets the name of an #AtspiAccessible object.

337

338

 * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object

339

 * or NULL on exception.

340

**/

341

gchar *

342

193

atspi_accessible_get_name (AtspiAccessible *obj, GError **error)

343

344

193

  g_return_val_if_fail (obj != NULL, g_strdup (""));

345

193

  gchar *name = NULL;

346

347

193

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_NAME))

348

349

163

      g_free (obj->name);

350

163

      obj->name = NULL;

351

163

      if (!_atspi_dbus_get_property (obj, atspi_interface_accessible, "Name", error,

352

                                     "s", &name))

353

        return g_strdup ("");

354

163

      _atspi_accessible_add_cache (obj, ATSPI_CACHE_NAME);

355

163

      if (!obj->name)

356

162

        obj->name = name;

357

      else

358

1

        free (name);

359

360

193

  return g_strdup (obj->name);

361

362

363

/**

364

 * atspi_accessible_get_description:

365

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

366

367

 * Gets the description of an #AtspiAccessible object.

368

369

 * Returns: a UTF-8 string describing the #AtspiAccessible object

370

 * or NULL on exception.

371

**/

372

gchar *

373

1

atspi_accessible_get_description (AtspiAccessible *obj, GError **error)

374

375

1

  g_return_val_if_fail (obj != NULL, g_strdup (""));

376

1

  gchar *description = NULL;

377

378

1

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_DESCRIPTION))

379

380

1

      g_free (obj->description);

381

1

      obj->description = NULL;

382

1

      if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,

383

                                     "Description", error, "s",

384

1

                                     &obj->description))

385

        return g_strdup ("");

386

1

      _atspi_accessible_add_cache (obj, ATSPI_CACHE_DESCRIPTION);

387

1

      if (!obj->description)

388

        obj->description = description;

389

      else

390

1

        free (description);

391

392

1

  return g_strdup (obj->description);

393

394

395

const char *str_parent = "Parent";

396

397

/**

398

 * atspi_accessible_get_parent:

399

 * @obj: a pointer to the #AtspiAccessible object to query.

400

401

 * Gets an #AtspiAccessible object's parent container.

402

403

 * Returns: (nullable) (transfer full): a pointer to the

404

 *          #AtspiAccessible object which contains the given

405

 *          #AtspiAccessible instance, or NULL if the @obj has no

406

 *          parent container.

407

408

**/

409

AtspiAccessible *

410

3

atspi_accessible_get_parent (AtspiAccessible *obj, GError **error)

411

412

3

  g_return_val_if_fail (obj != NULL, NULL);

413

414

3

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_PARENT))

415

416

      DBusMessage *message, *reply;

417

      DBusMessageIter iter, iter_variant;

418

3

      if (!obj->parent.app)

419

        return NULL;

420

3

      message = dbus_message_new_method_call (obj->parent.app->bus_name,

421

3

                                              obj->parent.path,

422

                                              DBUS_INTERFACE_PROPERTIES, "Get");

423

3

      if (!message)

424

        return NULL;

425

3

      dbus_message_append_args (message, DBUS_TYPE_STRING, &atspi_interface_accessible,

426

                                DBUS_TYPE_STRING, &str_parent,

427

                                DBUS_TYPE_INVALID);

428

3

      reply = _atspi_dbus_send_with_reply_and_block (message, error);

429

3

      if (!reply)

430

        return NULL;

431

3

      if (strcmp (dbus_message_get_signature (reply), "v") != 0)

432

433

          dbus_message_unref (reply);

434

          return NULL;

435

436

3

      dbus_message_iter_init (reply, &iter);

437

3

      dbus_message_iter_recurse (&iter, &iter_variant);

438

3

      g_clear_object (&obj->accessible_parent);

439

3

      obj->accessible_parent = _atspi_dbus_consume_accessible (&iter_variant);

440

3

      dbus_message_unref (reply);

441

3

      _atspi_accessible_add_cache (obj, ATSPI_CACHE_PARENT);

442

443

3

  if (!obj->accessible_parent)

444

2

    return NULL;

445

1

  return g_object_ref (obj->accessible_parent);

446

447

448

/**

449

 * atspi_accessible_get_child_count:

450

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

451

452

 * Gets the number of children contained by an #AtspiAccessible object.

453

454

 * Returns: a #long indicating the number of #AtspiAccessible children

455

 *          contained by an #AtspiAccessible object or -1 on exception.

456

457

**/

458

gint

459

161

atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error)

460

461

161

  g_return_val_if_fail (obj != NULL, -1);

462

463

161

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))

464

465

      dbus_int32_t ret;

466

161

      if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,

467

                                     "ChildCount", error, "i", &ret))

468

        return -1;

469

161

      return ret;

470

471

472

  if (!obj->children)

473

    return 0; /* assume it's disposed */

474

475

  return obj->children->len;

476

477

478

/**

479

 * atspi_accessible_get_child_at_index:

480

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

481

 * @child_index: a #long indicating which child is specified.

482

483

 * Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index.

484

485

 * Returns: (transfer full): a pointer to the #AtspiAccessible child object at

486

 * index @child_index or NULL on exception.

487

**/

488

AtspiAccessible *

489

300

atspi_accessible_get_child_at_index (AtspiAccessible *obj,

490

                                     gint child_index,

491

                                     GError **error)

492

493

  AtspiAccessible *child;

494

  DBusMessage *reply;

495

496

300

  g_return_val_if_fail (obj != NULL, NULL);

497

498

300

  if (_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))

499

500

4

      if (!obj->children)

501

        return NULL; /* assume disposed */

502

503

4

      if (child_index < obj->children->len)

504

505

4

          child = g_ptr_array_index (obj->children, child_index);

506

4

          if (child)

507

4

            return g_object_ref (child);

508

509

510

511

296

  reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,

512

                                    "GetChildAtIndex", error, "i", child_index);

513

296

  child = _atspi_dbus_return_accessible_from_message (reply);

514

515

296

  if (!child)

516

1

    return NULL;

517

518

295

  if (_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))

519

520

9

      if (child_index >= obj->children->len)

521

        g_ptr_array_set_size (obj->children, child_index + 1);

522

9

      else if (g_ptr_array_index (obj->children, child_index))

523

9

        g_object_unref (g_ptr_array_index (obj->children, child_index));

524

9

      g_ptr_array_index (obj->children, child_index) = g_object_ref (child);

525

526

295

  return child;

527

528

529

/**

530

 * atspi_accessible_get_index_in_parent:

531

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

532

533

 * Gets the index of an #AtspiAccessible object within its parent's

534

 * #AtspiAccessible children list.

535

536

 * Returns: a #glong indicating the index of the #AtspiAccessible object

537

 *          in its parent,

538

 *          or -1 if @obj has no containing parent or on exception.

539

**/

540

gint

541

1

atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error)

542

543

1

  gint i = 0;

544

1

  dbus_int32_t ret = -1;

545

546

1

  g_return_val_if_fail (obj != NULL, -1);

547

1

  if (_atspi_accessible_test_cache (obj, ATSPI_CACHE_PARENT))

548

549

      if (!obj->accessible_parent)

550

        return -1;

551

552

      if (!_atspi_accessible_test_cache (obj->accessible_parent, ATSPI_CACHE_CHILDREN) || !obj->accessible_parent->children)

553

        goto dbus;

554

555

      for (i = 0; i < obj->accessible_parent->children->len; i++)

556

        if (g_ptr_array_index (obj->accessible_parent->children, i) == obj)

557

          return i;

558

559

560

1

dbus:

561

1

  _atspi_dbus_call (obj, atspi_interface_accessible,

562

                    "GetIndexInParent", NULL, "=>i", &ret);

563

1

  return ret;

564

565

566

typedef struct

567

568

  dbus_uint32_t type;

569

  GArray *targets;

570

} Accessibility_Relation;

571

572

/**

573

 * atspi_accessible_get_relation_set:

574

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

575

576

 * Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's

577

 * relationships with other #AtspiAccessible objects.

578

579

 * Returns: (element-type AtspiRelation*) (transfer full): a #GArray of

580

 *          #AtspiRelation pointers or NULL on exception.

581

**/

582

GArray *

583

2

atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)

584

585

  DBusMessage *reply;

586

  DBusMessageIter iter, iter_array;

587

  GArray *ret;

588

589

2

  g_return_val_if_fail (obj != NULL, NULL);

590

591

2

  reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetRelationSet", error, "");

592

2

  if (!reply)

593

    return NULL;

594

2

  _ATSPI_DBUS_CHECK_SIG (reply, "a(ua(so))", error, NULL);

595

596

2

  ret = g_array_new (TRUE, TRUE, sizeof (AtspiRelation *));

597

2

  dbus_message_iter_init (reply, &iter);

598

2

  dbus_message_iter_recurse (&iter, &iter_array);

599

4

  while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)

600

601

      AtspiRelation *relation;

602

2

      relation = _atspi_relation_new_from_iter (&iter_array);

603

2

      ret = g_array_append_val (ret, relation);

604

2

      dbus_message_iter_next (&iter_array);

605

606

2

  dbus_message_unref (reply);

607

2

  return ret;

608

609

610

/**

611

 * atspi_accessible_get_role:

612

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

613

614

 * Gets the UI role played by an #AtspiAccessible object.

615

 * This role's name can be obtained via atspi_accessible_get_role_name ().

616

617

 * Returns: the #AtspiRole of an #AtspiAccessible object.

618

619

**/

620

AtspiRole

621

324

atspi_accessible_get_role (AtspiAccessible *obj, GError **error)

622

623

324

  g_return_val_if_fail (obj != NULL, ATSPI_ROLE_INVALID);

624

625

324

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_ROLE))

626

627

      dbus_uint32_t role;

628

      /* TODO: Make this a property */

629

9

      if (_atspi_dbus_call (obj, atspi_interface_accessible, "GetRole", error, "=>u", &role))

630

631

9

          obj->role = role;

632

9

          _atspi_accessible_add_cache (obj, ATSPI_CACHE_ROLE);

633

634

635

324

  return obj->role;

636

637

638

/**

639

 * atspi_accessible_get_role_name:

640

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

641

642

 * Gets a UTF-8 string corresponding to the name of the role played by an object.

643

 * This method will return useful values for roles that fall outside the

644

 * enumeration used in atspi_accessible_get_role ().

645

646

 * Returns: a UTF-8 string specifying the type of UI role played by an

647

 * #AtspiAccessible object.

648

649

**/

650

gchar *

651

1

atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error)

652

653

1

  gchar *retval = NULL;

654

  AtspiRole role;

655

656

1

  g_return_val_if_fail (obj != NULL, NULL);

657

658

1

  role = atspi_accessible_get_role (obj, error);

659

1

  if (role >= 0 && role < ATSPI_ROLE_COUNT && role != ATSPI_ROLE_EXTENDED)

660

1

    return atspi_role_get_name (role);

661

662

  _atspi_dbus_call (obj, atspi_interface_accessible, "GetRoleName", error, "=>s", &retval);

663

664

  if (!retval)

665

    retval = g_strdup ("");

666

667

  return retval;

668

669

670

/**

671

 * atspi_accessible_get_localized_role_name:

672

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

673

674

 * Gets a UTF-8 string corresponding to the name of the role played by an

675

 * object, translated to the current locale.

676

 * This method will return useful values for roles that fall outside the

677

 * enumeration used in atspi_accessible_getRole ().

678

679

 * Returns: a localized, UTF-8 string specifying the type of UI role played

680

 * by an #AtspiAccessible object.

681

682

**/

683

gchar *

684

1

atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error)

685

686

1

  char *retval = NULL;

687

  AtspiRole role;

688

689

1

  g_return_val_if_fail (obj != NULL, NULL);

690

691

1

  role = atspi_accessible_get_role (obj, error);

692

1

  if (role >= 0 && role < ATSPI_ROLE_COUNT && role != ATSPI_ROLE_EXTENDED)

693

1

    return atspi_role_get_localized_name (role);

694

695

  _atspi_dbus_call (obj, atspi_interface_accessible, "GetLocalizedRoleName", error, "=>s", &retval);

696

697

  if (!retval)

698

    return g_strdup ("");

699

700

  return retval;

701

702

703

static AtspiStateSet *

704

defunct_set ()

705

706

  AtspiStateSet *set = atspi_state_set_new (NULL);

707

  atspi_state_set_add (set, ATSPI_STATE_DEFUNCT);

708

  return set;

709

710

711

/**

712

 * atspi_accessible_get_state_set:

713

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

714

715

 * Gets the states currently held by an object.

716

717

 * Returns: (transfer full): a pointer to an #AtspiStateSet representing an

718

 * object's current state set.

719

**/

720

AtspiStateSet *

721

15

atspi_accessible_get_state_set (AtspiAccessible *obj)

722

723

  /* TODO: Should take a GError **, but would be an API break */

724

15

  if (!obj->parent.app || !obj->parent.app->bus)

725

    return defunct_set ();

726

727

15

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_STATES))

728

729

      DBusMessage *reply;

730

      DBusMessageIter iter;

731

11

      reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,

732

                                        "GetState", NULL, "");

733

11

      _ATSPI_DBUS_CHECK_SIG (reply, "au", NULL, defunct_set ());

734

11

      dbus_message_iter_init (reply, &iter);

735

11

      _atspi_dbus_set_state (obj, &iter);

736

11

      dbus_message_unref (reply);

737

11

      _atspi_accessible_add_cache (obj, ATSPI_CACHE_STATES);

738

739

740

15

  return g_object_ref (obj->states);

741

742

743

/**

744

 * atspi_accessible_get_attributes:

745

 * @obj: The #AtspiAccessible being queried.

746

747

 * Gets the #AttributeSet representing any assigned

748

 * name-value pair attributes or annotations for this object.

749

 * For typographic, textual, or textually-semantic attributes, see

750

 * atspi_text_get_attributes instead.

751

752

 * Returns: (element-type gchar* gchar*) (transfer full): The name-value-pair

753

 * attributes assigned to this object.

754

*/

755

GHashTable *

756

1

atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error)

757

758

  DBusMessage *message;

759

760

1

  g_return_val_if_fail (obj != NULL, NULL);

761

762

1

  if (obj->priv->cache)

763

764

      GValue *val = g_hash_table_lookup (obj->priv->cache, "Attributes");

765

      if (val)

766

        return g_value_dup_boxed (val);

767

768

769

1

  if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_ATTRIBUTES))

770

771

1

      message = _atspi_dbus_call_partial (obj, atspi_interface_accessible,

772

                                          "GetAttributes", error, "");

773

1

      g_clear_pointer (&(obj->attributes), g_hash_table_unref);

774

775

1

      obj->attributes = _atspi_dbus_return_hash_from_message (message);

776

1

      _atspi_accessible_add_cache (obj, ATSPI_CACHE_ATTRIBUTES);

777

778

779

1

  if (!obj->attributes)

780

    return NULL;

781

1

  return g_hash_table_ref (obj->attributes);

782

783

784

static void

785

add_to_attribute_array (gpointer key, gpointer value, gpointer data)

786

787

  GArray **array = (GArray **) data;

788

  gchar *str = g_strconcat (key, ":", value, NULL);

789

  *array = g_array_append_val (*array, str);

790

791

792

/**

793

 * atspi_accessible_get_attributes_as_array:

794

 * @obj: The #AtspiAccessible being queried.

795

796

 * Gets a #GArray representing any assigned

797

 * name-value pair attributes or annotations for this object.

798

 * For typographic, textual, or textually-semantic attributes, see

799

 * atspi_text_get_attributes_as_array instead.

800

801

 * Returns: (element-type gchar*) (transfer full): The name-value-pair

802

 *          attributes assigned to this object.

803

*/

804

GArray *

805

1

atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error)

806

807

  DBusMessage *message;

808

809

1

  g_return_val_if_fail (obj != NULL, NULL);

810

811

1

  if (obj->priv->cache)

812

813

      GValue *val = g_hash_table_lookup (obj->priv->cache, "Attributes");

814

      if (val)

815

816

          GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));

817

          GHashTable *attributes = g_value_get_boxed (val);

818

          g_hash_table_foreach (attributes, add_to_attribute_array, &array);

819

          return array;

820

821

822

823

1

  message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");

824

1

  return _atspi_dbus_return_attribute_array_from_message (message);

825

826

827

/**

828

 * atspi_accessible_get_application:

829

 * @obj: The #AtspiAccessible being queried.

830

831

 * Gets the containing #AtspiApplication for an object.

832

833

 * Returns: (transfer full): the containing #AtspiApplication instance for

834

 *          this object.

835

*/

836

AtspiAccessible *

837

1

atspi_accessible_get_application (AtspiAccessible *obj, GError **error)

838

839

  AtspiAccessible *parent;

840

841

1

  g_object_ref (obj);

842

  for (;;)

843

844

1

      parent = atspi_accessible_get_parent (obj, NULL);

845

2

      if (!parent && obj->parent.app &&

846

1

          atspi_accessible_get_role (obj, NULL) != ATSPI_ROLE_APPLICATION)

847

848

1

          AtspiAccessible *root = g_object_ref (obj->parent.app->root);

849

1

          if (root)

850

851

1

              g_object_unref (obj);

852

1

              if (atspi_accessible_get_role (root, NULL) == ATSPI_ROLE_DESKTOP_FRAME)

853

854

                  g_object_unref (root);

855

                  return NULL;

856

857

1

              return root;

858

859

860

      if (!parent || parent == obj ||

861

          atspi_accessible_get_role (parent, NULL) == ATSPI_ROLE_DESKTOP_FRAME)

862

863

          if (parent)

864

            g_object_unref (parent);

865

          return obj;

866

867

      g_object_unref (obj);

868

      obj = parent;

869

870

871

872

/* Application-specific methods */

873

874

/**

875

 * atspi_accessible_get_toolkit_name:

876

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

877

878

 * Gets the toolkit name for an #AtspiAccessible object.

879

 * Only works on application root objects.

880

881

 * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception.

882

**/

883

gchar *

884

1

atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)

885

886

1

  g_return_val_if_fail (obj != NULL, NULL);

887

888

1

  if (!obj->parent.app)

889

    return NULL;

890

891

1

  if (!obj->parent.app->toolkit_name)

892

1

    _atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitName",

893

1

                              error, "s", &obj->parent.app->toolkit_name);

894

895

1

  return g_strdup (obj->parent.app->toolkit_name);

896

897

898

/**

899

 * atspi_accessible_get_toolkit_version:

900

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

901

902

 * Gets the toolkit version for an #AtspiAccessible object.

903

 * Only works on application root objects.

904

905

 * Returns: a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception.

906

**/

907

gchar *

908

1

atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)

909

910

1

  g_return_val_if_fail (obj != NULL, NULL);

911

912

1

  if (!obj->parent.app)

913

    return NULL;

914

915

1

  if (!obj->parent.app->toolkit_version)

916

1

    _atspi_dbus_get_property (obj, atspi_interface_application, "Version",

917

1

                              error, "s", &obj->parent.app->toolkit_version);

918

919

1

  return g_strdup (obj->parent.app->toolkit_version);

920

921

922

/**

923

 * atspi_accessible_get_atspi_version:

924

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

925

926

 * Gets the AT-SPI IPC specification version supported by the application

927

 * pointed to by the #AtspiAccessible object.

928

 * Only works on application root objects.

929

930

 * Returns: a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception.

931

**/

932

gchar *

933

1

atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error)

934

935

1

  g_return_val_if_fail (obj != NULL, NULL);

936

937

1

  if (!obj->parent.app)

938

    return NULL;

939

940

1

  if (!obj->parent.app->atspi_version)

941

1

    _atspi_dbus_get_property (obj, atspi_interface_application, "AtspiVersion",

942

1

                              error, "s", &obj->parent.app->atspi_version);

943

944

1

  return g_strdup (obj->parent.app->atspi_version);

945

946

947

/**

948

 * atspi_accessible_get_id:

949

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

950

951

 * Gets the application id for a #AtspiAccessible object.

952

 * Only works on application root objects.

953

954

 * Returns: a positive #gint indicating the id for the #AtspiAccessible object

955

 * or -1 on exception.

956

**/

957

gint

958

1

atspi_accessible_get_id (AtspiAccessible *obj, GError **error)

959

960

1

  gint ret = -1;

961

962

1

  g_return_val_if_fail (obj != NULL, -1);

963

964

1

  if (!_atspi_dbus_get_property (obj, atspi_interface_application, "Id", error, "i", &ret))

965

    return -1;

966

1

  return ret;

967

968

969

/* Interface query methods */

970

971

static gboolean

972

141

_atspi_accessible_is_a (AtspiAccessible *accessible,

973

                        const char *interface_name)

974

975

  int n;

976

977

141

  if (accessible == NULL)

978

979

      return FALSE;

980

981

982

141

  if (!_atspi_accessible_test_cache (accessible, ATSPI_CACHE_INTERFACES))

983

984

      DBusMessage *reply;

985

      DBusMessageIter iter;

986

121

      reply = _atspi_dbus_call_partial (accessible, atspi_interface_accessible,

987

                                        "GetInterfaces", NULL, "");

988

121

      _ATSPI_DBUS_CHECK_SIG (reply, "as", NULL, FALSE);

989

121

      dbus_message_iter_init (reply, &iter);

990

121

      _atspi_dbus_set_interfaces (accessible, &iter);

991

121

      dbus_message_unref (reply);

992

993

994

141

  n = _atspi_get_iface_num (interface_name);

995

141

  if (n == -1)

996

    return FALSE;

997

141

  return (gboolean) ((accessible->interfaces & (1 << n)) ? TRUE : FALSE);

998

999

1000

/**

1001

 * atspi_accessible_is_action:

1002

 * @obj: a pointer to the #AtspiAccessible instance to query.

1003

1004

 * Query whether the specified #AtspiAccessible implements the

1005

 * #AtspiAction interface.

1006

1007

 * Returns: #TRUE if @obj implements the #AtspiAction interface,

1008

 *          #FALSE otherwise.

1009

**/

1010

gboolean

1011

1

atspi_accessible_is_action (AtspiAccessible *obj)

1012

1013

1

  return _atspi_accessible_is_a (obj,

1014

                                 atspi_interface_action);

1015

1016

1017

/**

1018

 * atspi_accessible_is_application:

1019

 * @obj: a pointer to the #AtspiAccessible instance to query.

1020

1021

 * Query whether the specified #AtspiAccessible implements the

1022

 * #AtspiApplication interface.

1023

1024

 * Returns: #TRUE if @obj implements the #AtspiApplication interface,

1025

 *          #FALSE otherwise.

1026

**/

1027

gboolean

1028

atspi_accessible_is_application (AtspiAccessible *obj)

1029

1030

  return _atspi_accessible_is_a (obj,

1031

                                 atspi_interface_application);

1032

1033

1034

/**

1035

 * atspi_accessible_is_collection:

1036

 * @obj: a pointer to the #AtspiAccessible instance to query.

1037

1038

 * Query whether the specified #AtspiAccessible implements the

1039

 * #AtspiCollection interface.

1040

1041

 * Returns: #TRUE if @obj implements the #AtspiCollection interface,

1042

 *          #FALSE otherwise.

1043

**/

1044

gboolean

1045

1

atspi_accessible_is_collection (AtspiAccessible *obj)

1046

1047

1

  return _atspi_accessible_is_a (obj,

1048

                                 atspi_interface_collection);

1049

1050

1051

/**

1052

 * atspi_accessible_is_component:

1053

 * @obj: a pointer to the #AtspiAccessible instance to query.

1054

1055

 * Query whether the specified #AtspiAccessible implements #AtspiComponent.

1056

1057

 * Returns: #TRUE if @obj implements the #AtspiComponent interface,

1058

 *          #FALSE otherwise.

1059

**/

1060

gboolean

1061

1

atspi_accessible_is_component (AtspiAccessible *obj)

1062

1063

1

  return _atspi_accessible_is_a (obj,

1064

                                 atspi_interface_component);

1065

1066

1067

/**

1068

 * atspi_accessible_is_document:

1069

 * @obj: a pointer to the #AtspiAccessible instance to query.

1070

1071

 * Query whether the specified #AtspiAccessible implements the

1072

 * #AtspiDocument interface.

1073

1074

 * Returns: #TRUE if @obj implements the #AtspiDocument interface,

1075

 *          #FALSE otherwise.

1076

**/

1077

gboolean

1078

1

atspi_accessible_is_document (AtspiAccessible *obj)

1079

1080

1

  return _atspi_accessible_is_a (obj,

1081

                                 atspi_interface_document);

1082

1083

1084

/**

1085

 * atspi_accessible_is_editable_text:

1086

 * @obj: a pointer to the #AtspiAccessible instance to query.

1087

1088

 * Query whether the specified #AtspiAccessible implements the

1089

 * #AtspiEditableText interface.

1090

1091

 * Returns: #TRUE if @obj implements the #AtspiEditableText interface,

1092

 *          #FALSE otherwise.

1093

**/

1094

gboolean

1095

1

atspi_accessible_is_editable_text (AtspiAccessible *obj)

1096

1097

1

  return _atspi_accessible_is_a (obj,

1098

                                 atspi_interface_editable_text);

1099

1100

1101

/**

1102

 * atspi_accessible_is_hypertext:

1103

 * @obj: a pointer to the #AtspiAccessible instance to query.

1104

1105

 * Query whether the specified #AtspiAccessible implements the

1106

 * #AtspiHypertext interface.

1107

1108

 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,

1109

 *          #FALSE otherwise.

1110

**/

1111

gboolean

1112

1

atspi_accessible_is_hypertext (AtspiAccessible *obj)

1113

1114

1

  return _atspi_accessible_is_a (obj,

1115

                                 atspi_interface_hypertext);

1116

1117

1118

/**

1119

 * atspi_accessible_is_hyperlink:

1120

 * @obj: a pointer to the #AtspiAccessible instance to query.

1121

1122

 * Query whether the specified #AtspiAccessible implements the

1123

 * #AtspiHyperlink interface.

1124

1125

 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,

1126

 *          #FALSE otherwise.

1127

**/

1128

gboolean

1129

1

atspi_accessible_is_hyperlink (AtspiAccessible *obj)

1130

1131

1

  return _atspi_accessible_is_a (obj,

1132

                                 atspi_interface_hyperlink);

1133

1134

1135

/**

1136

 * atspi_accessible_is_image:

1137

 * @obj: a pointer to the #AtspiAccessible instance to query.

1138

1139

 * Query whether the specified #AtspiAccessible implements the

1140

 * #AtspiImage interface.

1141

1142

 * Returns: #TRUE if @obj implements the #AtspiImage interface,

1143

 *          #FALSE otherwise.

1144

**/

1145

gboolean

1146

1

atspi_accessible_is_image (AtspiAccessible *obj)

1147

1148

1

  return _atspi_accessible_is_a (obj,

1149

                                 atspi_interface_image);

1150

1151

1152

/**

1153

 * atspi_accessible_is_selection:

1154

 * @obj: a pointer to the #AtspiAccessible instance to query.

1155

1156

 * Query whether the specified #AtspiAccessible implements the

1157

 * #AtspiSelection interface.

1158

1159

 * Returns: #TRUE if @obj implements the #AtspiSelection interface,

1160

 *          #FALSE otherwise.

1161

**/

1162

gboolean

1163

1

atspi_accessible_is_selection (AtspiAccessible *obj)

1164

1165

1

  return _atspi_accessible_is_a (obj,

1166

                                 atspi_interface_selection);

1167

1168

1169

/**

1170

 * atspi_accessible_is_table:

1171

 * @obj: a pointer to the #AtspiAccessible instance to query.

1172

1173

 * Query whether the specified #AtspiAccessible implements the

1174

 * #AtspiTable interface.

1175

1176

 * Returns: #TRUE if @obj implements the #AtspiTable interface,

1177

 *          #FALSE otherwise.

1178

**/

1179

gboolean

1180

1

atspi_accessible_is_table (AtspiAccessible *obj)

1181

1182

1

  return _atspi_accessible_is_a (obj,

1183

                                 atspi_interface_table);

1184

1185

1186

/**

1187

 * atspi_accessible_is_table_cell:

1188

 * @obj: a pointer to the #AtspiAccessible instance to query.

1189

1190

 * Query whether the specified #AtspiAccessible implements the

1191

 * #AtspiTableCell interface.

1192

1193

 * Returns: #TRUE if @obj implements the #AtspiTable interface,

1194

 *          #FALSE otherwise.

1195

**/

1196

gboolean

1197

1

atspi_accessible_is_table_cell (AtspiAccessible *obj)

1198

1199

1

  return _atspi_accessible_is_a (obj,

1200

                                 atspi_interface_table_cell);

1201

1202

1203

/**

1204

 * atspi_accessible_is_streamable_content:

1205

 * @obj: a pointer to the #AtspiAccessible instance to query.

1206

1207

 * Query whether the specified #AtspiAccessible implements the

1208

 * #AtspiStreamableContent interface.

1209

1210

 * Returns: #TRUE if @obj implements the #AtspiStreamableContent interface,

1211

 *          #FALSE otherwise.

1212

**/

1213

gboolean

1214

atspi_accessible_is_streamable_content (AtspiAccessible *obj)

1215

1216

#if 0

1217

  return _atspi_accessible_is_a (obj,

1218

			      atspi_interface_streamable_content);

1219

#else

1220

  g_warning ("Streamable content not implemented");

1221

  return FALSE;

1222

#endif

1223

1224

1225

/**

1226

 * atspi_accessible_is_text:

1227

 * @obj: a pointer to the #AtspiAccessible instance to query.

1228

1229

 * Query whether the specified #AtspiAccessible implements the

1230

 * #AtspiText interface.

1231

1232

 * Returns: #TRUE if @obj implements the #AtspiText interface,

1233

 *          #FALSE otherwise.

1234

**/

1235

gboolean

1236

1

atspi_accessible_is_text (AtspiAccessible *obj)

1237

1238

1

  return _atspi_accessible_is_a (obj,

1239

                                 atspi_interface_text);

1240

1241

1242

/**

1243

 * atspi_accessible_is_value:

1244

 * @obj: a pointer to the #AtspiAccessible instance to query.

1245

1246

 * Query whether the specified #AtspiAccessible implements the

1247

 * #AtspiValue interface.

1248

1249

 * Returns: #TRUE if @obj implements the #AtspiValue interface,

1250

 *          #FALSE otherwise.

1251

**/

1252

gboolean

1253

1

atspi_accessible_is_value (AtspiAccessible *obj)

1254

1255

1

  return _atspi_accessible_is_a (obj,

1256

                                 atspi_interface_value);

1257

1258

1259

/**

1260

 * atspi_accessible_get_action:

1261

 * @obj: a pointer to the #AtspiAccessible instance to query.

1262

1263

 * Gets the #AtspiAction interface for an #AtspiAccessible.

1264

1265

 * Returns: (transfer full): a pointer to an #AtspiAction interface

1266

 *          instance, or NULL if @obj does not implement #AtspiAction.

1267

1268

 * Deprecated: 2.10: Use atspi_accessible_get_action_iface instead.

1269

**/

1270

AtspiAction *

1271

atspi_accessible_get_action (AtspiAccessible *accessible)

1272

1273

  return (_atspi_accessible_is_a (accessible, atspi_interface_action) ? g_object_ref (ATSPI_ACTION (accessible)) : NULL);

1274

1275

1276

/**

1277

 * atspi_accessible_get_action_iface:

1278

 * @obj: a pointer to the #AtspiAccessible instance to query.

1279

1280

 * Gets the #AtspiAction interface for an #AtspiAccessible.

1281

1282

 * Returns: (transfer full): a pointer to an #AtspiAction interface

1283

 *          instance, or NULL if @obj does not implement #AtspiAction.

1284

**/

1285

AtspiAction *

1286

8

atspi_accessible_get_action_iface (AtspiAccessible *accessible)

1287

1288

8

  return (_atspi_accessible_is_a (accessible, atspi_interface_action) ? g_object_ref (ATSPI_ACTION (accessible)) : NULL);

1289

1290

1291

/**

1292

 * atspi_accessible_get_collection:

1293

 * @obj: a pointer to the #AtspiAccessible instance to query.

1294

1295

 * Gets the #AtspiCollection interface for an #AtspiAccessible.

1296

1297

 * Returns: (transfer full): a pointer to an #AtspiCollection interface

1298

 *          instance, or NULL if @obj does not implement #AtspiCollection.

1299

1300

 * Deprecated: 2.10: Use atspi_accessible_get_collection_iface instead.

1301

**/

1302

AtspiCollection *

1303

atspi_accessible_get_collection (AtspiAccessible *accessible)

1304

1305

  return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ? g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);

1306

1307

1308

/**

1309

 * atspi_accessible_get_collection_iface:

1310

 * @obj: a pointer to the #AtspiAccessible instance to query.

1311

1312

 * Gets the #AtspiCollection interface for an #AtspiAccessible.

1313

1314

 * Returns: (transfer full): a pointer to an #AtspiCollection interface

1315

 *          instance, or NULL if @obj does not implement #AtspiCollection.

1316

**/

1317

AtspiCollection *

1318

5

atspi_accessible_get_collection_iface (AtspiAccessible *accessible)

1319

1320

5

  return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ? g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);

1321

1322

1323

/**

1324

 * atspi_accessible_get_component:

1325

 * @obj: a pointer to the #AtspiAccessible instance to query.

1326

1327

 * Gets the #AtspiComponent interface for an #AtspiAccessible.

1328

1329

 * Returns: (transfer full): a pointer to an #AtspiComponent interface

1330

 *          instance, or NULL if @obj does not implement #AtspiComponent.

1331

1332

 * Deprecated: 2.10: Use atspi_accessible_get_component_iface instead.

1333

**/

1334

AtspiComponent *

1335

atspi_accessible_get_component (AtspiAccessible *obj)

1336

1337

  return (_atspi_accessible_is_a (obj, atspi_interface_component) ? g_object_ref (ATSPI_COMPONENT (obj)) : NULL);

1338

1339

1340

/**

1341

 * atspi_accessible_get_component_iface:

1342

 * @obj: a pointer to the #AtspiAccessible instance to query.

1343

1344

 * Gets the #AtspiComponent interface for an #AtspiAccessible.

1345

1346

 * Returns: (transfer full): a pointer to an #AtspiComponent interface

1347

 *          instance, or NULL if @obj does not implement #AtspiComponent.

1348

**/

1349

AtspiComponent *

1350

10

atspi_accessible_get_component_iface (AtspiAccessible *obj)

1351

1352

10

  return (_atspi_accessible_is_a (obj, atspi_interface_component) ? g_object_ref (ATSPI_COMPONENT (obj)) : NULL);

1353

1354

1355

/**

1356

 * atspi_accessible_get_document:

1357

 * @obj: a pointer to the #AtspiAccessible instance to query.

1358

1359

 * Gets the #AtspiDocument interface for an #AtspiAccessible.

1360

1361

 * Returns: (transfer full): a pointer to an #AtspiDocument interface

1362

 *          instance, or NULL if @obj does not implement #AtspiDocument.

1363

1364

 * Deprecated: 2.10: Use atspi_accessible_get_document_iface instead.

1365

**/

1366

AtspiDocument *

1367

atspi_accessible_get_document (AtspiAccessible *accessible)

1368

1369

  return (_atspi_accessible_is_a (accessible, atspi_interface_document) ? g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);

1370

1371

1372

/**

1373

 * atspi_accessible_get_document_iface:

1374

 * @obj: a pointer to the #AtspiAccessible instance to query.

1375

1376

 * Gets the #AtspiDocument interface for an #AtspiAccessible.

1377

1378

 * Returns: (transfer full): a pointer to an #AtspiDocument interface

1379

 *          instance, or NULL if @obj does not implement #AtspiDocument.

1380

**/

1381

AtspiDocument *

1382

5

atspi_accessible_get_document_iface (AtspiAccessible *accessible)

1383

1384

5

  return (_atspi_accessible_is_a (accessible, atspi_interface_document) ? g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);

1385

1386

1387

/**

1388

 * atspi_accessible_get_editable_text:

1389

 * @obj: a pointer to the #AtspiAccessible instance to query.

1390

1391

 * Gets the #AtspiEditableText interface for an #AtspiAccessible.

1392

1393

 * Returns: (transfer full): a pointer to an #AtspiEditableText interface

1394

 *          instance, or NULL if @obj does not implement #AtspiEditableText.

1395

1396

 * Deprecated: 2.10: Use atspi_accessible_get_editable_text_iface instead.

1397

**/

1398

AtspiEditableText *

1399

atspi_accessible_get_editable_text (AtspiAccessible *accessible)

1400

1401

  return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ? g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);

1402

1403

1404

/**

1405

 * atspi_accessible_get_editable_text_iface:

1406

 * @obj: a pointer to the #AtspiAccessible instance to query.

1407

1408

 * Gets the #AtspiEditableText interface for an #AtspiAccessible.

1409

1410

 * Returns: (transfer full): a pointer to an #AtspiEditableText interface

1411

 *          instance, or NULL if @obj does not implement #AtspiEditableText.

1412

**/

1413

AtspiEditableText *

1414

7

atspi_accessible_get_editable_text_iface (AtspiAccessible *accessible)

1415

1416

7

  return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ? g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);

1417

1418

1419

/**

1420

 * atspi_accessible_get_hyperlink:

1421

 * @obj: a pointer to the #AtspiAccessible object on which to operate.

1422

1423

 * Gets the #AtspiHyperlink interface for an #AtspiAccessible.

1424

1425

 * Returns: (transfer full): the #AtspiHyperlink object associated with

1426

 *          the given #AtspiAccessible, or NULL if not supported.

1427

**/

1428

AtspiHyperlink *

1429

atspi_accessible_get_hyperlink (AtspiAccessible *accessible)

1430

1431

  return (_atspi_accessible_is_a (accessible, atspi_interface_hyperlink) ? _atspi_hyperlink_new (accessible->parent.app, accessible->parent.path) : NULL);

1432

1433

1434

/**

1435

 * atspi_accessible_get_hypertext:

1436

 * @obj: a pointer to the #AtspiAccessible instance to query.

1437

1438

 * Gets the #AtspiHypertext interface for an #AtspiAccessible.

1439

1440

 * Returns: (transfer full): a pointer to an #AtspiHypertext interface

1441

 *          instance, or NULL if @obj does not implement #AtspiHypertext.

1442

1443

 * Deprecated: 2.10: Use atspi_accessible_get_hypertext_iface instead.

1444

**/

1445

AtspiHypertext *

1446

atspi_accessible_get_hypertext (AtspiAccessible *accessible)

1447

1448

  return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ? g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);

1449

1450

1451

/**

1452

 * atspi_accessible_get_hypertext_iface:

1453

 * @obj: a pointer to the #AtspiAccessible instance to query.

1454

1455

 * Gets the #AtspiHypertext interface for an #AtspiAccessible.

1456

1457

 * Returns: (transfer full): a pointer to an #AtspiHypertext interface

1458

 *          instance, or NULL if @obj does not implement #AtspiHypertext.

1459

**/

1460

AtspiHypertext *

1461

11

atspi_accessible_get_hypertext_iface (AtspiAccessible *accessible)

1462

1463

11

  return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ? g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);

1464

1465

1466

/**

1467

 * atspi_accessible_get_image:

1468

 * @obj: a pointer to the #AtspiAccessible instance to query.

1469

1470

 * Gets the #AtspiImage interface for an #AtspiAccessible.

1471

1472

 * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or

1473

 *          NULL if @obj does not implement #AtspiImage.

1474

1475

 * Deprecated: 2.10: Use atspi_accessible_get_image_iface instead.

1476

**/

1477

AtspiImage *

1478

atspi_accessible_get_image (AtspiAccessible *accessible)

1479

1480

  return (_atspi_accessible_is_a (accessible, atspi_interface_image) ? g_object_ref (ATSPI_IMAGE (accessible)) : NULL);

1481

1482

1483

/**

1484

 * atspi_accessible_get_image_iface:

1485

 * @obj: a pointer to the #AtspiAccessible instance to query.

1486

1487

 * Gets the #AtspiImage interface for an #AtspiAccessible.

1488

1489

 * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or

1490

 *          NULL if @obj does not implement #AtspiImage.

1491

**/

1492

AtspiImage *

1493

7

atspi_accessible_get_image_iface (AtspiAccessible *accessible)

1494

1495

7

  return (_atspi_accessible_is_a (accessible, atspi_interface_image) ? g_object_ref (ATSPI_IMAGE (accessible)) : NULL);

1496

1497

1498

/**

1499

 * atspi_accessible_get_selection:

1500

 * @obj: a pointer to the #AtspiAccessible instance to query.

1501

1502

 * Gets the #AtspiSelection interface for an #AtspiAccessible.

1503

1504

 * Returns: (transfer full): a pointer to an #AtspiSelection interface

1505

 *          instance, or NULL if @obj does not implement #AtspiSelection.

1506

1507

 * Deprecated: 2.10: Use atspi_accessible_get_selection_iface instead.

1508

**/

1509

AtspiSelection *

1510

atspi_accessible_get_selection (AtspiAccessible *accessible)

1511

1512

  return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ? g_object_ref (ATSPI_SELECTION (accessible)) : NULL);

1513

1514

1515

/**

1516

 * atspi_accessible_get_selection_iface:

1517

 * @obj: a pointer to the #AtspiAccessible instance to query.

1518

1519

 * Gets the #AtspiSelection interface for an #AtspiAccessible.

1520

1521

 * Returns: (transfer full): a pointer to an #AtspiSelection interface

1522

 *          instance, or NULL if @obj does not implement #AtspiSelection.

1523

**/

1524

AtspiSelection *

1525

10

atspi_accessible_get_selection_iface (AtspiAccessible *accessible)

1526

1527

10

  return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ? g_object_ref (ATSPI_SELECTION (accessible)) : NULL);

1528

1529

1530

#if 0

1531

/**

1532

 * atspi_accessible_get_streamable_content:

1533

 * @obj: a pointer to the #AtspiAccessible instance to query.

1534

1535

 * Gets the #AtspiStreamableContent interface for an #AtspiAccessible.

1536

1537

 * Returns: (transfer full): a pointer to an #AtspiStreamableContent interface

1538

 *          instance, or NULL if @obj does not implement #AtspiStreamableContent.

1539

**/

1540

AtspiStreamableContent *

1541

atspi_accessible_get_streamable_content (AtspiAccessible *accessible)

1542

1543

  return (_atspi_accessible_is_a (accessible, atspi_interface_streamable_content) ?

1544

          accessible : NULL);

1545

1546

#endif

1547

1548

/**

1549

 * atspi_accessible_get_table:

1550

 * @obj: a pointer to the #AtspiAccessible instance to query.

1551

1552

 * Gets the #AtspiTable interface for an #AtspiAccessible.

1553

1554

 * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or

1555

 *          NULL if @obj does not implement #AtspiTable.

1556