After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 697968 - Deprecate atk_text_get_text_{before,after}_offset()
Deprecate atk_text_get_text_{before,after}_offset()
Status: RESOLVED FIXED
Product: atk
Classification: Platform
Component: atk
unspecified
Other Linux
: Normal normal
: ---
Assigned To: ATK maintainer(s)
ATK maintainer(s)
Depends on:
Blocks: 697969
 
 
Reported: 2013-04-13 21:51 UTC by Joanmarie Diggs (IRC: joanie)
Modified: 2013-06-17 18:21 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Deprecate atk_text_get_text_{before/after}_offset (3.20 KB, patch)
2013-06-17 15:47 UTC, Alejandro Piñeiro Iglesias (IRC: infapi00)
committed Details | Review
Deprecate _END boundaries (3.04 KB, patch)
2013-06-17 15:50 UTC, Alejandro Piñeiro Iglesias (IRC: infapi00)
committed Details | Review
Update atk_text_get_text{at/after/before}_offset (6.93 KB, patch)
2013-06-17 15:51 UTC, Alejandro Piñeiro Iglesias (IRC: infapi00)
committed Details | Review

Description Joanmarie Diggs (IRC: joanie) 2013-04-13 21:51:26 UTC
As described in this message [1], atk_text_get_text_{before,after}_offset should be removed. It's redundant to atk_text_get_text_at_offset() and confuses those implementing AtkText support.

Orca is the primary, and possibly only, consumer of these additional redundant methods. Or, rather, it was. As of today, Orca no longer calls the pyatspi2 methods getTextBeforeOffset() and getTextAfterOffset().

Let's deprecate these methods for the 3.10 cycle and remove them in 3.12.

[1] https://mail.gnome.org/archives/gnome-accessibility-devel/2013-April/msg00000.html
Comment 1 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-06-17 15:47:57 UTC
Created attachment 247043 [details] [review]
Deprecate atk_text_get_text_{before/after}_offset
Comment 2 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-06-17 15:50:18 UTC
Created attachment 247044 [details] [review]
Deprecate _END boundaries

This patch deprecates _END boudaries. It does that only on the documentation. Right now there isn't a proper way to deprecate a specific element of a enum without breaking ABI or having problems with the glib-mkenums.

If we make an API break (that promised ATK 3.0) we could remove those elements.
Comment 3 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-06-17 15:51:30 UTC
Created attachment 247045 [details] [review]
Update atk_text_get_text{at/after/before}_offset

Removes documentation from the deprecated {before/after}. Removes any reference to _END on the current one.
Comment 4 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-06-17 15:56:21 UTC
The thread that started Joanmarie [1] concluded that simplify the API was a good idea. Alex Surkov and Trevor made some suggestions (like starting over), but for simplicity and "fist step" sake, we are going to start with this. Joanmarie already tried this path by removing the usage of the deprecated methods at Orca [2].

In the future, the idea would having Boundaries without the _START suffix, as we don't have an opposite. That future Boundary would mimic the START suffix.

I have posted the patches just in case some want to review it.


[1] https://mail.gnome.org/archives/gnome-accessibility-devel/2013-April/msg00000.html
[2] https://twitter.com/Joanmarie/status/333601862760677378
Comment 5 Alejandro Piñeiro Iglesias (IRC: infapi00) 2013-06-17 18:20:32 UTC
After review from Joanmarie and some minor, I have committed the patches. This will be included on next ATK release. Thanks.