blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

SetCursorStyle documentation improvements (#744)

Browse Source
This commit is contained in:
Cl00e9ment 2023-01-12 21:08:39 +01:00 committed by GitHub
parent 814df1c4a0
commit fadec7a19c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/cursor.rs
View File

@ -328,12 +328,11 @@ impl Command for Show {
}
/// A command that enables blinking of the terminal cursor.
///
/// See `SetCursorStyle` which is more advanced and better supported.
///
///
/// # Notes
///
/// - Windows versions lower than Windows 10 do not support this functionality.
/// - Some Unix terminals (ex: GNOME and Konsole) as well as Windows versions lower than Windows 10 do not support this functionality.
/// Use `SetCursorStyle` for better cross-compatibility.
/// - Commands must be executed/queued for execution otherwise they do nothing.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct EnableBlinking;
@ -349,11 +348,10 @@ impl Command for EnableBlinking {
/// A command that disables blinking of the terminal cursor.
///
/// See `SetCursorStyle` which is more advanced and better supported.
///
/// # Notes
///
/// - Windows versions lower than Windows 10 do not support this functionality.
/// - Some Unix terminals (ex: GNOME and Konsole) as well as Windows versions lower than Windows 10 do not support this functionality.
/// Use `SetCursorStyle` for better cross-compatibility.
/// - Commands must be executed/queued for execution otherwise they do nothing.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DisableBlinking;
@ -393,13 +391,13 @@ pub enum SetCursorStyle {
impl Command for SetCursorStyle {
fn write_ansi(&self, f: &mut impl fmt::Write) -> fmt::Result {
match self {
SetCursorStyle::DefaultUserShape => f.write_str("\x1b[?12h\x1b[0 q"),
SetCursorStyle::BlinkingBlock => f.write_str("\x1b[?12h\x1b[1 q"),
SetCursorStyle::SteadyBlock => f.write_str("\x1b[?12l\x1b[2 q"),
SetCursorStyle::BlinkingUnderScore => f.write_str("\x1b[?12h\x1b[3 q"),
SetCursorStyle::SteadyUnderScore => f.write_str("\x1b[?12l\x1b[4 q"),
SetCursorStyle::BlinkingBar => f.write_str("\x1b[?12h\x1b[5 q"),
SetCursorStyle::SteadyBar => f.write_str("\x1b[?12l\x1b[6 q"),
SetCursorStyle::DefaultUserShape => f.write_str("\x1b[0 q"),
SetCursorStyle::BlinkingBlock => f.write_str("\x1b[1 q"),
SetCursorStyle::SteadyBlock => f.write_str("\x1b[2 q"),
SetCursorStyle::BlinkingUnderScore => f.write_str("\x1b[3 q"),
SetCursorStyle::SteadyUnderScore => f.write_str("\x1b[4 q"),
SetCursorStyle::BlinkingBar => f.write_str("\x1b[5 q"),
SetCursorStyle::SteadyBar => f.write_str("\x1b[6 q"),
}
}

5
src/lib.rs
View File

@ -41,15 +41,14 @@
//! - Module [`cursor`](cursor/index.html)
//! - Visibility - [`Show`](cursor/struct.Show.html), [`Hide`](cursor/struct.Hide.html)
//! - Appearance - [`EnableBlinking`](cursor/struct.EnableBlinking.html),
//! [`DisableBlinking`](cursor/struct.DisableBlinking.html)
//! [`DisableBlinking`](cursor/struct.DisableBlinking.html),
//! [`SetCursorStyle`](cursor/enum.SetCursorStyle.html)
//! - Position -
//! [`SavePosition`](cursor/struct.SavePosition.html), [`RestorePosition`](cursor/struct.RestorePosition.html),
//! [`MoveUp`](cursor/struct.MoveUp.html), [`MoveDown`](cursor/struct.MoveDown.html),
//! [`MoveLeft`](cursor/struct.MoveLeft.html), [`MoveRight`](cursor/struct.MoveRight.html),
//! [`MoveTo`](cursor/struct.MoveTo.html), [`MoveToColumn`](cursor/struct.MoveToColumn.html),[`MoveToRow`](cursor/struct.MoveToRow.html),
//! [`MoveToNextLine`](cursor/struct.MoveToNextLine.html), [`MoveToPreviousLine`](cursor/struct.MoveToPreviousLine.html)
//! - Shape -
//! [`SetCursorShape`](cursor/struct.SetCursorShape.html)
//! - Module [`event`](event/index.html)
//! - Keyboard events -
//! [`PushKeyboardEnhancementFlags`](event/struct.PushKeyboardEnhancementFlags.html),