FTXUI/include/ftxui/component/component.hpp

104 lines
4.0 KiB
C++
Raw Normal View History

2021-05-10 02:32:27 +08:00
#ifndef FTXUI_COMPONENT_HPP
#define FTXUI_COMPONENT_HPP
2021-05-10 02:32:27 +08:00
#include <functional> // for function
#include <memory> // for make_shared, shared_ptr
2021-05-10 02:32:27 +08:00
#include <string> // for wstring
#include <utility> // for forward
2021-05-10 02:32:27 +08:00
#include <vector> // for vector
2021-05-02 02:40:35 +08:00
#include "ftxui/component/component_base.hpp" // for Component, Components
2022-03-14 01:51:46 +08:00
#include "ftxui/component/component_options.hpp" // for ButtonOption, CheckboxOption (ptr only), InputOption (ptr only), MenuEntryOption (ptr only), MenuOption, RadioboxOption (ptr only)
#include "ftxui/dom/elements.hpp" // for Element
#include "ftxui/util/ref.hpp" // for Ref, ConstStringRef, ConstStringListRef, StringRef
namespace ftxui {
2021-07-10 19:20:43 +08:00
struct ButtonOption;
struct CheckboxOption;
struct Event;
2021-07-10 19:20:43 +08:00
struct InputOption;
struct MenuOption;
struct RadioboxOption;
2021-09-17 02:45:26 +08:00
struct MenuEntryOption;
2021-05-10 02:32:27 +08:00
template <class T, class... Args>
std::shared_ptr<T> Make(Args&&... args) {
return std::make_shared<T>(std::forward<Args>(args)...);
2021-05-10 02:32:27 +08:00
}
// Pipe operator to decorate components.
using ComponentDecorator = std::function<Component(Component)>;
using ElementDecorator = std::function<Element(Element)>;
Component operator|(Component component, ComponentDecorator decorator);
Component operator|(Component component, ElementDecorator decorator);
Component& operator|=(Component& component, ComponentDecorator decorator);
Component& operator|=(Component& component, ElementDecorator decorator);
2022-01-02 22:48:56 +08:00
namespace Container {
Component Vertical(Components children);
Component Vertical(Components children, int* selector);
Component Horizontal(Components children);
Component Horizontal(Components children, int* selector);
Component Tab(Components children, int* selector);
} // namespace Container
Component Button(ConstStringRef label,
std::function<void()> on_click,
2022-03-14 01:51:46 +08:00
Ref<ButtonOption> = ButtonOption::Simple());
2021-07-08 04:37:50 +08:00
Component Checkbox(ConstStringRef label,
bool* checked,
2022-03-14 01:51:46 +08:00
Ref<CheckboxOption> option = CheckboxOption::Simple());
2021-07-08 06:01:42 +08:00
Component Input(StringRef content,
ConstStringRef placeholder,
2021-07-10 18:29:39 +08:00
Ref<InputOption> option = {});
Component Menu(ConstStringListRef entries,
int* selected_,
2022-03-14 01:51:46 +08:00
Ref<MenuOption> = MenuOption::Vertical());
Component MenuEntry(ConstStringRef label, Ref<MenuEntryOption> = {});
Component Dropdown(ConstStringListRef entries, int* selected);
Component Radiobox(ConstStringListRef entries,
2021-07-10 16:50:25 +08:00
int* selected_,
2021-07-10 18:29:39 +08:00
Ref<RadioboxOption> option = {});
2022-03-14 01:51:46 +08:00
Component Toggle(ConstStringListRef entries, int* selected);
2021-06-03 03:11:23 +08:00
template <class T> // T = {int, float, long}
Component Slider(ConstStringRef label, T* value, T min, T max, T increment);
2021-07-10 20:23:46 +08:00
Component ResizableSplitLeft(Component main, Component back, int* main_size);
Component ResizableSplitRight(Component main, Component back, int* main_size);
Component ResizableSplitTop(Component main, Component back, int* main_size);
Component ResizableSplitBottom(Component main, Component back, int* main_size);
2021-05-23 18:53:20 +08:00
Component Renderer(Component child, std::function<Element()>);
Component Renderer(std::function<Element()>);
2021-08-07 02:32:33 +08:00
Component Renderer(std::function<Element(bool /* focused */)>);
ComponentDecorator Renderer(ElementDecorator);
2021-05-23 18:53:20 +08:00
Component CatchEvent(Component child, std::function<bool(Event)>);
ComponentDecorator CatchEvent(std::function<bool(Event)> on_event);
2022-01-02 22:48:56 +08:00
Component Maybe(Component, const bool* show);
Component Maybe(Component, std::function<bool()>);
ComponentDecorator Maybe(const bool* show);
ComponentDecorator Maybe(std::function<bool()>);
2022-01-02 22:48:56 +08:00
Component Collapsible(ConstStringRef label,
Component child,
Ref<bool> show = false);
2021-05-15 04:00:49 +08:00
} // namespace ftxui
// Include component using the old deprecated wstring.
#include "ftxui/component/deprecated.hpp"
2021-05-10 02:32:27 +08:00
#endif /* end of include guard: FTXUI_COMPONENT_HPP */
2021-05-10 02:32:27 +08:00
// Copyright 2021 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.