FTXUI/component_8hpp_source.html

// 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.

#ifndef FTXUI_COMPONENT_HPP

#define FTXUI_COMPONENT_HPP


#include <functional>  // for function

#include <memory>      // for make_shared, shared_ptr

#include <utility>     // for forward


#include <ftxui/util/warn_windows_macro.hpp>

#include "ftxui/component/component_base.hpp"  // for Component, Components

#include "ftxui/component/component_options.hpp"  // for ButtonOption, CheckboxOption, MenuOption

#include "ftxui/dom/elements.hpp"  // for Element

#include "ftxui/util/export.hpp"

#include "ftxui/util/ref.hpp"  // for ConstRef, Ref, ConstStringRef, ConstStringListRef, StringRef


namespace ftxui {

struct ButtonOption;

struct CheckboxOption;

struct Event;

struct InputOption;

struct MenuOption;

struct RadioboxOption;

struct MenuEntryOption;


template <class T, class... Args>


std::shared_ptr<T> Make(Args&&... args) {

  return std::make_shared<T>(std::forward<Args>(args)...);

}


// Pipe operator to decorate components.

using ComponentDecorator = std::function<Component(Component)>;

using ElementDecorator = std::function<Element(Element)>;

FTXUI_EXPORT(COMPONENT)

Component operator|(Component component, ComponentDecorator decorator);

FTXUI_EXPORT(COMPONENT)

Component operator|(Component component, ElementDecorator decorator);

FTXUI_EXPORT(COMPONENT)

Component& operator|=(Component& component, ComponentDecorator decorator);

FTXUI_EXPORT(COMPONENT)

Component& operator|=(Component& component, ElementDecorator decorator);


namespace Container {

FTXUI_EXPORT(COMPONENT) Component Vertical(Components children);

FTXUI_EXPORT(COMPONENT) Component Vertical(Components children, int* selector);

FTXUI_EXPORT(COMPONENT) Component Horizontal(Components children);

FTXUI_EXPORT(COMPONENT)

Component Horizontal(Components children, int* selector);

FTXUI_EXPORT(COMPONENT) Component Tab(Components children, int* selector);

FTXUI_EXPORT(COMPONENT) Component Stacked(Components children);

}  // namespace Container


FTXUI_EXPORT(COMPONENT) Component Button(ButtonOption options);

FTXUI_EXPORT(COMPONENT)

Component Button(ConstStringRef label,

                 std::function<void()> on_click,

                 ButtonOption options = ButtonOption::Simple());


FTXUI_EXPORT(COMPONENT) Component Checkbox(CheckboxOption options);

FTXUI_EXPORT(COMPONENT)

Component Checkbox(ConstStringRef label,

                   bool* checked,

                   CheckboxOption options = CheckboxOption::Simple());


FTXUI_EXPORT(COMPONENT) Component Input(InputOption options = {});

FTXUI_EXPORT(COMPONENT)

Component Input(StringRef content, InputOption options = {});

FTXUI_EXPORT(COMPONENT)

Component Input(StringRef content,

                StringRef placeholder,

                InputOption options = {});


FTXUI_EXPORT(COMPONENT) Component Menu(MenuOption options);

FTXUI_EXPORT(COMPONENT)

Component Menu(ConstStringListRef entries,

               int* selected_,

               MenuOption options = MenuOption::Vertical());

FTXUI_EXPORT(COMPONENT) Component MenuEntry(MenuEntryOption options);

FTXUI_EXPORT(COMPONENT)

Component MenuEntry(ConstStringRef label, MenuEntryOption options = {});


FTXUI_EXPORT(COMPONENT) Component Radiobox(RadioboxOption options);

FTXUI_EXPORT(COMPONENT)

Component Radiobox(ConstStringListRef entries,

                   int* selected_,

                   RadioboxOption options = {});


FTXUI_EXPORT(COMPONENT)

Component Dropdown(ConstStringListRef entries, int* selected);

FTXUI_EXPORT(COMPONENT) Component Dropdown(DropdownOption options);


FTXUI_EXPORT(COMPONENT)

Component Toggle(ConstStringListRef entries, int* selected);


// General slider constructor:

template <typename T>

Component Slider(SliderOption<T> options);


extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<int8_t>);

extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<int16_t>);

extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<int32_t>);

extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<int64_t>);


extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<uint8_t>);

extern template FTXUI_EXPORT(COMPONENT) Component

    Slider(SliderOption<uint16_t>);

extern template FTXUI_EXPORT(COMPONENT) Component

    Slider(SliderOption<uint32_t>);

extern template FTXUI_EXPORT(COMPONENT) Component

    Slider(SliderOption<uint64_t>);


extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<float>);

extern template FTXUI_EXPORT(COMPONENT) Component Slider(SliderOption<double>);


// Shorthand without the `SliderOption` constructor:

FTXUI_EXPORT(COMPONENT)

Component Slider(ConstStringRef label,

                 Ref<int> value,

                 ConstRef<int> min = 0,

                 ConstRef<int> max = 100,

                 ConstRef<int> increment = 5);

FTXUI_EXPORT(COMPONENT)

Component Slider(ConstStringRef label,

                 Ref<float> value,

                 ConstRef<float> min = 0.f,

                 ConstRef<float> max = 100.f,

                 ConstRef<float> increment = 5.f);

FTXUI_EXPORT(COMPONENT)

Component Slider(ConstStringRef label,

                 Ref<long> value,

                 ConstRef<long> min = 0L,

                 ConstRef<long> max = 100L,

                 ConstRef<long> increment = 5L);


FTXUI_EXPORT(COMPONENT)

Component ResizableSplit(ResizableSplitOption options);

FTXUI_EXPORT(COMPONENT)

Component ResizableSplitLeft(Component main, Component back, int* main_size);

FTXUI_EXPORT(COMPONENT)

Component ResizableSplitRight(Component main, Component back, int* main_size);

FTXUI_EXPORT(COMPONENT)

Component ResizableSplitTop(Component main, Component back, int* main_size);

FTXUI_EXPORT(COMPONENT)

Component ResizableSplitBottom(Component main, Component back, int* main_size);


FTXUI_EXPORT(COMPONENT)

Component Renderer(Component child, std::function<Element()>);

FTXUI_EXPORT(COMPONENT) Component Renderer(std::function<Element()>);

FTXUI_EXPORT(COMPONENT)

Component Renderer(std::function<Element(bool /* focused */)>);

FTXUI_EXPORT(COMPONENT) ComponentDecorator Renderer(ElementDecorator);


FTXUI_EXPORT(COMPONENT)

Component CatchEvent(Component child, std::function<bool(Event)>);

FTXUI_EXPORT(COMPONENT)

ComponentDecorator CatchEvent(std::function<bool(Event)> on_event);


FTXUI_EXPORT(COMPONENT) Component Maybe(Component, const bool* show);

FTXUI_EXPORT(COMPONENT) Component Maybe(Component, std::function<bool()>);

FTXUI_EXPORT(COMPONENT) ComponentDecorator Maybe(const bool* show);

FTXUI_EXPORT(COMPONENT) ComponentDecorator Maybe(std::function<bool()>);


FTXUI_EXPORT(COMPONENT)

Component Modal(Component main, Component modal, const bool* show_modal);

FTXUI_EXPORT(COMPONENT)

ComponentDecorator Modal(Component modal, const bool* show_modal);


FTXUI_EXPORT(COMPONENT)

Component Collapsible(ConstStringRef label,

                      Component child,

                      Ref<bool> show = false);


FTXUI_EXPORT(COMPONENT)

Component Hoverable(Component component, bool* hover);

FTXUI_EXPORT(COMPONENT)

Component Hoverable(Component component,

                    std::function<void()> on_enter,

                    std::function<void()> on_leave);

FTXUI_EXPORT(COMPONENT)

Component Hoverable(Component component,  //

                    std::function<void(bool)> on_change);

FTXUI_EXPORT(COMPONENT) ComponentDecorator Hoverable(bool* hover);

FTXUI_EXPORT(COMPONENT)

ComponentDecorator Hoverable(std::function<void()> on_enter,

                             std::function<void()> on_leave);

FTXUI_EXPORT(COMPONENT)

ComponentDecorator Hoverable(std::function<void(bool)> on_change);


FTXUI_EXPORT(COMPONENT) Component Window(WindowOptions option);


}  // namespace ftxui


#endif /* end of include guard: FTXUI_COMPONENT_HPP */

ftxui::Ref
An adapter. Own or reference an mutable object.
Definition ref.hpp:56

component_base.hpp

component_options.hpp

elements.hpp

main
int main()
Definition examples/component/button.cpp:33

export.hpp

FTXUI_EXPORT
#define FTXUI_EXPORT(component)
Definition export.hpp:24

ftxui::Button
Component Button(ConstStringRef label, std::function< void()> on_click, ButtonOption options=ButtonOption::Simple())
Draw a button. Execute a function when clicked.
Definition src/ftxui/component/button.cpp:202

ftxui::ResizableSplitTop
Component ResizableSplitTop(Component main, Component back, int *main_size)
An vertical split in between two components, configurable using the mouse.
Definition src/ftxui/component/resizable_split.cpp:267

ftxui::Container::Horizontal
Component Horizontal(Components children, int *selector)
A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow...
Definition container.cpp:382

ftxui::Toggle
Component Toggle(ConstStringListRef entries, int *selected)
An horizontal list of elements. The user can navigate through them.
Definition src/ftxui/component/menu.cpp:547

ftxui::Renderer
Component Renderer(Component child, std::function< Element()>)
Return a new Component, similar to |child|, but using |render| as the Component::Render() event.
Definition src/ftxui/component/renderer.cpp:61

ftxui::Checkbox
Component Checkbox(ConstStringRef label, bool *checked, CheckboxOption options=CheckboxOption::Simple())
Draw checkable element.
Definition src/ftxui/component/checkbox.cpp:137

ftxui::Container::Vertical
Component Vertical(Components children)
A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or...
Definition container.cpp:317

ftxui::ResizableSplitRight
Component ResizableSplitRight(Component main, Component back, int *main_size)
An horizontal split in between two components, configurable using the mouse.
Definition src/ftxui/component/resizable_split.cpp:233

ftxui::Input
Component Input(StringRef content, InputOption options={})
An input box for editing text.
Definition src/ftxui/component/input.cpp:618

ftxui::Dropdown
Component Dropdown(ConstStringListRef entries, int *selected)
A dropdown menu.
Definition src/ftxui/component/dropdown.cpp:22

ftxui::Container::Stacked
Component Stacked(Components children)
A list of components to be stacked on top of each other. Events are propagated to the first component...
Definition container.cpp:432

ftxui::Radiobox
Component Radiobox(ConstStringListRef entries, int *selected_, RadioboxOption options={})
A list of element, where only one can be selected.
Definition src/ftxui/component/radiobox.cpp:237

ftxui::ResizableSplitBottom
Component ResizableSplitBottom(Component main, Component back, int *main_size)
An vertical split in between two components, configurable using the mouse.
Definition src/ftxui/component/resizable_split.cpp:301

ftxui::Menu
Component Menu(ConstStringListRef entries, int *selected_, MenuOption options=MenuOption::Vertical())
A list of text. The focused element is selected.
Definition src/ftxui/component/menu.cpp:536

ftxui::ResizableSplitLeft
Component ResizableSplitLeft(Component main, Component back, int *main_size)
An horizontal split in between two components, configurable using the mouse.
Definition src/ftxui/component/resizable_split.cpp:199

ftxui::Container::Tab
Component Tab(Components children, int *selector)
A list of components, where only one is drawn and interacted with at a time. The |selector| gives the...
Definition container.cpp:405

ftxui::MenuEntry
Component MenuEntry(ConstStringRef label, MenuEntryOption options={})
A specific menu entry. They can be put into a Container::Vertical to form a menu.
Definition src/ftxui/component/menu.cpp:577

Container
The FTXUI ftxui::Container:: namespace.

ftxui::Container::selector
int * selector
Definition component.hpp:46

ftxui
The FTXUI ftxui:: namespace.
Definition animation.hpp:11

ftxui::Make
std::shared_ptr< T > Make(Args &&... args)
Definition component.hpp:28

ftxui::Element
std::shared_ptr< Node > Element
Definition elements.hpp:24

ftxui::ElementDecorator
std::function< Element(Element)> ElementDecorator
Definition component.hpp:34

ftxui::Components
std::vector< Component > Components
Definition component_base.hpp:26

ftxui::ResizableSplit
Component ResizableSplit(ResizableSplitOption options)
A split in between two components.
Definition src/ftxui/component/resizable_split.cpp:170

ftxui::operator|
Component operator|(Component component, ComponentDecorator decorator)
Definition component/util.cpp:12

ftxui::Slider
Component Slider(SliderOption< T > options)
A slider in any direction.
Definition src/ftxui/component/slider.cpp:314

ftxui::value
int value
Definition elements.hpp:178

ftxui::operator|=
Component & operator|=(Component &component, ComponentDecorator decorator)
Definition component/util.cpp:22

ftxui::show
const bool * show
Definition component.hpp:159

ftxui::ComponentDecorator
std::function< Component(Component)> ComponentDecorator
Definition component.hpp:33

ftxui::Component
std::shared_ptr< ComponentBase > Component
Definition app.hpp:23

ref.hpp

warn_windows_macro.hpp