Improve the documentation.

This commit is contained in:
ArthurSonzogni
2021-05-14 20:56:37 +02:00
parent 58287c147a
commit 9fdf235836
5 changed files with 217 additions and 158 deletions

View File

@@ -32,11 +32,11 @@ Component Renderer(std::function<Element()>);
template <class T> // T = {int, float}
Component Slider(std::wstring label, T* value, T min, T max, T increment);
// namespace Component {
// Component Vertical(Components children);
// Component Horizontal(Components children);
// Component Tab(int* selector, Components children);
//} // namespace Component
namespace Container {
Component Vertical(Components children);
Component Horizontal(Components children);
Component Tab(int* selector, Components children);
} // namespace Container
}; // namespace ftxui

View File

@@ -9,7 +9,7 @@
namespace ftxui {
/// @brief A component where focus and events are automatically handled for you.
class Container : public ComponentBase {
class ContainerBase : public ComponentBase {
public:
static Component Vertical();
static Component Vertical(Components children);
@@ -20,7 +20,7 @@ class Container : public ComponentBase {
static Component Tab(int* selector);
static Component Tab(int* selector, Components children);
~Container() override = default;
~ContainerBase() override = default;
// Component override.
bool OnEvent(Event event) override;
@@ -30,13 +30,13 @@ class Container : public ComponentBase {
protected:
// Handlers
using EventHandler = bool (Container::*)(Event);
using EventHandler = bool (ContainerBase::*)(Event);
bool VerticalEvent(Event event);
bool HorizontalEvent(Event event);
bool TabEvent(Event) { return false; }
EventHandler event_handler_;
using RenderHandler = Element (Container::*)();
using RenderHandler = Element (ContainerBase::*)();
Element VerticalRender();
Element HorizontalRender();
Element TabRender();