FTXUI/include/ftxui/dom/elements.hpp

122 lines
3.8 KiB
C++
Raw Normal View History

#ifndef FTXUI_DOM_ELEMENTS_HPP
#define FTXUI_DOM_ELEMENTS_HPP
2018-09-18 14:48:40 +08:00
2019-01-03 07:35:59 +08:00
#include <functional>
#include <memory>
2019-01-03 07:35:59 +08:00
#include "ftxui/dom/node.hpp"
#include "ftxui/screen/box.hpp"
#include "ftxui/screen/color.hpp"
#include "ftxui/screen/screen.hpp"
#include "ftxui/screen/terminal.hpp"
2018-09-18 14:48:40 +08:00
namespace ftxui {
class Node;
using Element = std::shared_ptr<Node>;
2019-01-13 01:24:46 +08:00
using Elements = std::vector<Element>;
2019-01-03 07:35:59 +08:00
using Decorator = std::function<Element(Element)>;
2020-02-12 04:44:55 +08:00
using GraphFunction = std::function<std::vector<int>(int, int)>;
2018-09-20 03:52:25 +08:00
2020-06-07 21:54:45 +08:00
// Pipe elements into decorator togethers.
// For instance the next lines are equivalents:
2020-05-25 07:34:13 +08:00
// -> text("ftxui") | bold | underlined
// -> underlined(bold(text("FTXUI")))
2020-06-07 21:54:45 +08:00
Element operator|(Element, Decorator);
Elements operator|(Elements, Decorator);
Decorator operator|(Decorator, Decorator);
2019-01-20 05:06:05 +08:00
// --- Widget ---
Element text(std::string text);
Element vtext(std::string text);
Element separator(void);
2019-01-27 09:33:06 +08:00
Element separator(Pixel);
2018-09-22 15:49:43 +08:00
Element gauge(float ratio);
2019-01-20 05:06:05 +08:00
Element border(Element);
2019-01-27 09:33:06 +08:00
Decorator borderWith(Pixel);
2019-01-13 01:24:46 +08:00
Element window(Element title, Element content);
2019-01-07 05:28:15 +08:00
Element spinner(int charset_index, size_t image_index);
Elements paragraph(std::string text); // Use inside hflow(). Split by space.
2019-01-27 09:33:06 +08:00
Element graph(GraphFunction);
// -- Decorator ---
Element bold(Element);
Element dim(Element);
Element inverted(Element);
Element underlined(Element);
2018-10-21 20:18:11 +08:00
Element blink(Element);
2019-01-03 07:35:59 +08:00
Decorator color(Color);
Decorator bgcolor(Color);
2019-01-07 05:28:15 +08:00
Element color(Color, Element);
Element bgcolor(Color, Element);
2018-09-20 03:52:25 +08:00
// --- Layout is
2019-01-20 05:06:05 +08:00
// Horizontal, Vertical or stacked set of elements.
Element hbox(Elements);
2019-01-23 06:42:57 +08:00
Element vbox(Elements);
2019-01-20 05:06:05 +08:00
Element dbox(Elements);
2019-01-23 06:42:57 +08:00
Element hflow(Elements);
2019-01-20 05:06:05 +08:00
// -- Flexibility ---
// Define how to share the remaining space when not all of it is used inside a
// container.
2020-05-25 07:34:13 +08:00
Element flex(Element); // Expand/Minimize if possible/needed.
Element flex_grow(Element); // Expand element if possible.
Element flex_shrink(Element); // Minimize element if needed.
2020-07-17 06:27:39 +08:00
2020-08-16 08:24:50 +08:00
Element xflex(Element); // Expand/Minimize if possible/needed on X axis.
Element xflex_grow(Element); // Expand element if possible on X axis.
Element xflex_shrink(Element); // Minimize element if needed on X axis.
2020-07-17 06:27:39 +08:00
2020-08-16 08:24:50 +08:00
Element yflex(Element); // Expand/Minimize if possible/needed on Y axis.
Element yflex_grow(Element); // Expand element if possible on Y axis.
Element yflex_shrink(Element); // Minimize element if needed on Y axis.
2020-07-17 06:27:39 +08:00
2020-05-25 07:34:13 +08:00
Element notflex(Element); // Reset the flex attribute.
Element filler(); // A blank expandable element.
// -- Size override;
enum Direction { WIDTH, HEIGHT };
enum Constraint { LESS_THAN, EQUAL, GREATER_THAN };
Decorator size(Direction, Constraint, int value);
2019-01-20 05:06:05 +08:00
2021-05-02 02:40:35 +08:00
// --
Decorator reflect(Box& box);
2019-01-20 05:06:05 +08:00
// --- Frame ---
// A frame is a scrollable area. The internal area is potentially larger than
// the external one. The internal area is scrolled in order to make visible the
// focused element.
Element frame(Element);
2020-06-07 21:54:45 +08:00
Element xframe(Element);
Element yframe(Element);
2019-01-20 05:06:05 +08:00
Element focus(Element);
Element select(Element);
// --- Util --------------------------------------------------------------------
2018-09-22 15:49:43 +08:00
Element hcenter(Element);
Element vcenter(Element);
Element center(Element);
Element align_right(Element);
2018-10-21 20:18:11 +08:00
Element nothing(Element element);
// Before drawing the |element| clear the pixel below. This is useful in
// combinaison with dbox.
Element clear_under(Element element);
namespace Dimension {
Dimensions Fit(Element&);
} // namespace Dimension
2020-02-12 04:44:55 +08:00
} // namespace ftxui
2018-09-18 14:48:40 +08:00
2021-07-10 20:23:46 +08:00
// Make container able to take any number of children as input.
#include "ftxui/dom/take_any_args.hpp"
// Include old definitions using wstring.
#include "ftxui/dom/deprecated.hpp"
#endif /* end of include guard: FTXUI_DOM_ELEMENTS_HPP */
// Copyright 2020 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.