1
0
зеркало из https://github.com/glebtv/tui-textarea.git synced 2026-09-08 08:25:51 +03:00

improve textarea.alignment and textarea.set_alignment document and add doc tests for them

Этот коммит содержится в:
rhysd
2022-09-28 21:24:23 +09:00
родитель 0ffaee324f
Коммит d805c3709a

Просмотреть файл

@@ -1272,7 +1272,17 @@ impl<'a> TextArea<'a> {
self.cursor self.cursor
} }
/// Get alignment text /// Set text alignment. When [`Alignment::Center`] or [`Alignment::Right`] is set, line number is automatically
/// disabled because those alignments don't work well with line numbers.
/// ```
/// use tui_textarea::TextArea;
/// use tui::layout::Alignment;
///
/// let mut textarea = TextArea::default();
///
/// textarea.set_alignment(Alignment::Center);
/// assert_eq!(textarea.alignment(), Alignment::Center);
/// ```
pub fn set_alignment(&mut self, alignment: Alignment) { pub fn set_alignment(&mut self, alignment: Alignment) {
if let Alignment::Center | Alignment::Right = alignment { if let Alignment::Center | Alignment::Right = alignment {
self.line_number_style = None; self.line_number_style = None;
@@ -1280,7 +1290,15 @@ impl<'a> TextArea<'a> {
self.alignment = alignment; self.alignment = alignment;
} }
/// Get current alignment text /// Get current text alignment. The default alignment is [`Alignment::Left`].
/// ```
/// use tui_textarea::TextArea;
/// use tui::layout::Alignment;
///
/// let mut textarea = TextArea::default();
///
/// assert_eq!(textarea.alignment(), Alignment::Left);
/// ```
pub fn alignment(&self) -> Alignment { pub fn alignment(&self) -> Alignment {
self.alignment self.alignment
} }