Aloe Keyboard Crate

Aloe Keyboard is a Rust library that provides a comprehensive abstraction for handling keyboard events and text input management across various platform-specific GUI systems. It is designed to facilitate the creation of robust text editor components by uniformly integrating with on-screen keyboards, OS input mechanisms, and clipboard operations.

Features

• Virtual Keyboard Types: A flexible enumerator detailing possible on-screen keyboard layouts, such as numeric, URL, and text keyboards.
• Text Input Target Interface: A trait that standardizes text input management via a unified interface across different text editor components.
• Key Press Representation: Implements nuanced key press handling including complex modifier combinations like CTRL+C and SHIFT+ALT+H.
• Modifier Keys Management: Efficient handling and querying of mouse and keyboard modifier states.
• System Clipboard Access: Manage clipboard interactions seamlessly for text data.

Technical Overview

Virtual Keyboard Type

The VirtualKeyboardType enum provides distinct configurations for keyboard layouts suited for specific text input contexts, making it adaptable for different application requirements.

TextInputTarget Trait

A pivotal trait that components implementing text editing functionality must follow to seamlessly integrate with the library's input system. It includes operations like is_text_input_active, managing highlight regions, and determining appropriate keyboard types.

Modular Design

The KeyPress and ModifierKeys structs offer extensions for key event handling, supporting advanced operations such as detecting key states in real-time and dynamically constructing key press descriptions.

Usage Example

Implementing a text editor component with Aloe requires minimal setup. Ensure your component integrates the TextInputTarget trait, leveraging Aloe's key event utilities to manage editing commands and input events efficiently.

Installation

Add the following to your Cargo.toml:

[dependencies]
aloe-keyboard = "0.1.0"

License

This project is licensed under the terms of the GPL-3.0 license.

Contribution

Development is hosted on GitHub. We welcome contributions through pull requests. For major changes, please open a discussion in the issues section.

This README.md file was generated by an AI model and may not be 100% accurate, however, it should be pretty good.

This crate is a translation of the JUCE module.

JUCE is a c++ software framework for developing high performance audio applications.

Usage falls under the GPLv3 as well as the JUCE commercial license.

See github.com/juce-framework/JUCE and the JUCE license page for details.

This crate is in the process of being translated from c++ to rust. For progress updates, please see the workspacer rust project. designed specifically for rust projects.