PowerToys/doc/devdocs/modules/quickaccent.md

Quick Accent

Public overview - Microsoft Learn

Quick Links

All Issues
Bugs
Pull Requests

Overview

Quick Accent (formerly known as Power Accent) is a PowerToys module that allows users to quickly insert accented characters by holding a key and pressing an activation key (like the Space key or arrow keys). For example, holding 'a' might display options like 'à', 'á', 'â', etc. This tool enhances productivity by streamlining the input of special characters without the need to memorize keyboard shortcuts.

Architecture

The Quick Accent module consists of four main components:

poweraccent/
├── PowerAccent.Core/               # Core component containing Language Sets
├── PowerAccent.UI/                 # The character selector UI
├── PowerAccentKeyboardService/     # Keyboard Hook
└── PowerAccentModuleInterface/     # DLL interface

Module Interface (PowerAccentModuleInterface)

The Module Interface, implemented in PowerAccentModuleInterface/dllmain.cpp, is responsible for:

• Handling communication between PowerToys Runner and the PowerAccent process
• Managing module lifecycle (enable/disable/settings)
• Launching and terminating the PowerToys.PowerAccent.exe process

Core Logic (PowerAccent.Core)

The Core component contains:

• Main accent character logic
• Keyboard input detection
• Character mappings for different languages
• Management of language sets and special characters (currency, math symbols, etc.)
• Usage statistics for frequently used characters

UI Layer (PowerAccent.UI)

The UI component is responsible for:

• Displaying the toolbar with accent options
• Handling user selection of accented characters
• Managing the visual positioning of the toolbar

Keyboard Service (PowerAccentKeyboardService)

This component:

• Implements keyboard hooks to detect key presses
• Manages the trigger mechanism for displaying the accent toolbar
• Handles keyboard input processing

Implementation Details

Activation Mechanism

The Quick Accent is activated when:

1. A user presses and holds a character key (e.g., 'a')
2. User presses the trigger key
3. After a brief delay (around 300ms per setting), the accent toolbar appears
4. The user can select an accented variant using the trigger key
5. Upon releasing the keys, the selected accented character is inserted

Character Sets

The module includes multiple language-specific character sets and special character sets:

• Various language sets for different alphabets and writing systems
• Special character sets (currency symbols, mathematical notations, etc.)
• These sets are defined in the core component and can be extended

Known Behaviors

• The module has a specific timing mechanism for activation that users have become accustomed to. Initially, this was considered a bug (where the toolbar would still appear even after quickly tapping and releasing keys), but it has been maintained as expected behavior since users rely on it.
• Multiple rapid key presses can trigger multiple background tasks.

Future Considerations

• Potential refinements to the activation timing mechanism
• Additional language and special character sets
• Improved UI positioning in different application contexts

Debugging

To debug the Quick Accent module via runner approach, follow these steps:

0. Get familiar with the overall Debugging Process for PowerToys.
1. Build the entire PowerToys solution in Visual Studio
2. Navigate to the PowerAccent folder in Solution Explorer
3. Open the file you want to debug and set breakpoints at the relevant locations
4. Find the runner project in the root of the solution
5. Right-click on the runner project and select "Set as Startup Project"
6. Start debugging by pressing F5 or clicking the "Start" button
7. When the PowerToys Runner launches, enable the Quick Accent module in the UI
8. Use the Visual Studio Debug menu or press Ctrl+Alt+P to open "Reattach to Process"
9. Find and select "PowerToys.PowerAccent.exe" in the process list
10. Trigger the action in Quick Accent that should hit your breakpoint
11. Verify that the debugger breaks at your breakpoint and you can inspect variables and step through code

This process allows you to debug the Quick Accent module while it's running as part of the full PowerToys application.

Alternative Debugging Approach

To directly debug the Quick Accent UI component:

0. Get familiar with the overall Debugging Process for PowerToys.
1. Build the entire PowerToys solution in Visual Studio
2. Navigate to the PowerAccent folder in Solution Explorer
3. Open the file you want to debug and set breakpoints at the relevant locations
4. Right-click on the PowerAccent.UI project and select "Set as Startup Project"
5. Start debugging by pressing F5 or clicking the "Start" button
6. Verify that the debugger breaks at your breakpoint and you can inspect variables and step through code

Known issue: You may encounter approximately 78 errors during the start of debugging.
Solution: If you encounter errors, right-click on the PowerAccent folder in Solution Explorer and select "Rebuild". After rebuilding, start debugging again.