Add documentation for ResizableSplit

This commit is contained in:
ArthurSonzogni
2021-05-27 15:46:23 +02:00
committed by Arthur Sonzogni
parent bba2abbb60
commit 2504a24ee0
6 changed files with 163 additions and 36 deletions

View File

@@ -1,7 +1,10 @@
/// @example ./examples/util/print_key_press.cpp
/// @example ./examples/dom/color_truecolor_HSV.cpp
/// @example ./examples/dom/dbox.cpp
/// @example ./examples/dom/separator.cpp
/// @example ./examples/dom/style_color.cpp
/// @example ./examples/dom/color_info_palette256.cpp
/// @example ./examples/dom/color_truecolor_RGB.cpp
/// @example ./examples/dom/paragraph.cpp
/// @example ./examples/dom/style_blink.cpp
/// @example ./examples/dom/style_dim.cpp
@@ -12,6 +15,7 @@
/// @example ./examples/dom/html_like.cpp
/// @example ./examples/dom/border.cpp
/// @example ./examples/dom/style_underlined.cpp
/// @example ./examples/dom/color_gallery.cpp
/// @example ./examples/dom/gauge.cpp
/// @example ./examples/dom/style_bold.cpp
/// @example ./examples/dom/spinner.cpp
@@ -25,10 +29,15 @@
/// @example ./examples/component/checkbox_in_frame.cpp
/// @example ./examples/component/menu2.cpp
/// @example ./examples/component/tab_horizontal.cpp
/// @example ./examples/component/slider.cpp
/// @example ./examples/component/slider_rgb.cpp
/// @example ./examples/component/input.cpp
/// @example ./examples/component/homescreen.cpp
/// @example ./examples/component/radiobox.cpp
/// @example ./examples/component/resizable_split.cpp
/// @example ./examples/component/menu.cpp
/// @example ./examples/component/menu_style.cpp
/// @example ./examples/component/radiobox_in_frame.cpp
/// @example ./examples/component/button.cpp
/// @example ./examples/component/toggle.cpp
/// @example ./examples/component/modal_dialog.cpp

View File

@@ -31,10 +31,11 @@
@example ./examples/component/menu2.cpp
@example ./examples/component/tab_horizontal.cpp
@example ./examples/component/slider.cpp
@example ./examples/component/slider_rgb.cpp
@example ./examples/component/input.cpp
@example ./examples/component/homescreen.cpp
@example ./examples/component/radiobox.cpp
@example ./examples/component/slider_rgb.cpp
@example ./examples/component/resizable_split.cpp
@example ./examples/component/menu.cpp
@example ./examples/component/menu_style.cpp
@example ./examples/component/radiobox_in_frame.cpp

View File

@@ -459,6 +459,12 @@ Produced by: ftxui::Renderer() from \ref "ftxui/component/component.hpp". This
component decorate another one by using a different function to render an
interface.
## CatchEvent
Produced by: ftxui::CatchEvent() from \ref "ftxui/component/component.hpp". This
component decorate another one and catch the events before the underlying
component.
## Container::Horizontal
Produced by: ftxui::Container::Horizontal() from
@@ -476,3 +482,21 @@ and handles keyboard/mouse navigation.
Produced by: ftxui::Container::Tab() from
"ftxui/component/component.hpp". It take a list of component and display only
one of them. This is useful for implementing a tab bar.
## ResizableSplit::{Left, Right, Top, Bottom}
Produced by:
- ftxui::ResizableSplitLeft()
- ftxui::ResizableSplitRight()
- ftxui::ResizableSplitTop()
- ftxui::ResizableSplitBottom()
from "ftxui/component/component.hpp"
It defines an horizontal or vertical separation in between two chilren
component. The position of the split is variable and controlable using the
mouse.
@htmlonly
<script id="asciicast-tprMH2EdkUoMb7D2YxgMGgpzx" src="https://asciinema.org/a/tprMH2EdkUoMb7D2YxgMGgpzx.js" async></script>
@endhtmlonly