Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable cursor movement with braille display routing keys in PowerPoint #17004

Merged
merged 8 commits into from
Aug 15, 2024

Conversation

SaschaCowley
Copy link
Member

@SaschaCowley SaschaCowley commented Aug 14, 2024

Link to issue number:

Closes #9101

Summary of the issue:

The routing keys on a braille display do not work to move the text insertion point in Microsoft PowerPoint.

Description of user facing changes

The routing keys now move the cursor in PowerPoint.

Description of development approach

Looked at TextFrameTextInfo to look at how access to PowerPoint text works. Used the Microsoft Powerpoint Object Model documentation to find the appropriate methods. Implemented a _setCaretOffset implementation on TextFrameTextInfo.

Sources:

Testing strategy:

Manually tested with an old NV Access presentation.

Known issues with pull request:

None.

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • New Features
    • Introduced caret offset management for improved text manipulation in PowerPoint.
    • Added support for braille display routing keys to navigate text cursor in PowerPoint, enhancing accessibility options for users with dexterity impairments.
  • Documentation
    • Updated documentation to include the new braille display functionality and its customization options.

@SaschaCowley SaschaCowley requested a review from a team as a code owner August 14, 2024 07:30
@SaschaCowley SaschaCowley linked an issue Aug 14, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Aug 14, 2024

Walkthrough

The recent updates introduce a new method in the PowerPoint module that allows for more precise control of the text caret position. Additionally, NVDA has been enhanced to support braille display routing keys for moving the text cursor within PowerPoint documents. This significantly improves accessibility for users relying on braille displays, making it easier for them to interact with text in PowerPoint presentations.

Changes

File Path Change Summary
source/appModules/powerpnt.py Added _setCaretOffset method for managing text caret position within PowerPoint text ranges.
user_docs/en/changes.md Introduced braille display routing key functionality for cursor movement in PowerPoint, enhancing accessibility.

Assessment against linked issues

Objective Addressed Explanation
Cursor routing from a braille display not working in PowerPoint (##9101)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@LeonarddeR
Copy link
Collaborator

@SaschaCowley This is lovely. Could you also implement _setSelectionOffsets while at it?

@SaschaCowley SaschaCowley marked this pull request as draft August 14, 2024 22:14
@SaschaCowley SaschaCowley marked this pull request as ready for review August 14, 2024 22:57
Copy link
Member

@seanbudd seanbudd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me generally, nice work on this

source/appModules/powerpnt.py Outdated Show resolved Hide resolved
source/appModules/powerpnt.py Outdated Show resolved Hide resolved
source/appModules/powerpnt.py Outdated Show resolved Hide resolved
user_docs/en/changes.md Outdated Show resolved Hide resolved
@SaschaCowley SaschaCowley merged commit fa442e5 into master Aug 15, 2024
4 checks passed
@SaschaCowley SaschaCowley deleted the i9101 branch August 15, 2024 04:47
@github-actions github-actions bot added this to the 2024.4 milestone Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cursor routing from a braille display not working in PowerPoint
3 participants