FTXUI  0.8.1
C++ functional terminal UI.
hbox.cpp
Go to the documentation of this file.
1 #include <algorithm> // for max
2 #include <memory> // for __shared_ptr_access, shared_ptr, make_shared
3 #include <utility> // for move
4 #include <vector> // for vector
5 
6 #include "ftxui/dom/box_helper.hpp" // for Box
7 #include "ftxui/dom/elements.hpp" // for Element, Elements, hbox
8 #include "ftxui/dom/node.hpp" // for Node
9 #include "ftxui/dom/requirement.hpp" // for Requirement
10 #include "ftxui/screen/box.hpp" // for Box
11 
12 namespace ftxui {
13 
14 class HBox : public Node {
15  public:
16  HBox(Elements children) : Node(std::move(children)) {}
17 
18  void ComputeRequirement() override {
19  requirement_.min_x = 0;
20  requirement_.min_y = 0;
25  for (auto& child : children_) {
26  child->ComputeRequirement();
27  if (requirement_.selection < child->requirement().selection) {
28  requirement_.selection = child->requirement().selection;
29  requirement_.selected_box = child->requirement().selected_box;
32  }
33  requirement_.min_x += child->requirement().min_x;
35  std::max(requirement_.min_y, child->requirement().min_y);
36  }
37  }
38 
39  void SetBox(Box box) override {
40  Node::SetBox(box);
41 
42  std::vector<box_helper::Element> elements(children_.size());
43  for (size_t i = 0; i < children_.size(); ++i) {
44  auto& element = elements[i];
45  const auto& requirement = children_[i]->requirement();
46  element.min_size = requirement.min_x;
47  element.flex_grow = requirement.flex_grow_x;
48  element.flex_shrink = requirement.flex_shrink_x;
49  }
50  int target_size = box.x_max - box.x_min + 1;
51  box_helper::Compute(&elements, target_size);
52 
53  int x = box.x_min;
54  for (size_t i = 0; i < children_.size(); ++i) {
55  box.x_min = x;
56  box.x_max = x + elements[i].size - 1;
57  children_[i]->SetBox(box);
58  x = box.x_max + 1;
59  }
60  }
61 };
62 
63 /// @brief A container displaying elements horizontally one by one.
64 /// @param children The elements in the container
65 /// @return The container.
66 ///
67 /// #### Example
68 ///
69 /// ```cpp
70 /// hbox({
71 /// text("Left"),
72 /// text("Right"),
73 /// });
74 /// ```
75 Element hbox(Elements children) {
76  return std::make_shared<HBox>(std::move(children));
77 }
78 
79 } // namespace ftxui
80 
81 // Copyright 2020 Arthur Sonzogni. All rights reserved.
82 // Use of this source code is governed by the MIT license that can be found in
83 // the LICENSE file.
ftxui::Requirement::selected_box
Box selected_box
Definition: requirement.hpp:26
ftxui::Node::SetBox
virtual void SetBox(Box box)
Assign a position and a dimension to an element for drawing.
Definition: node.cpp:21
ftxui::Requirement::min_x
int min_x
Definition: requirement.hpp:10
ftxui::Box::x_min
int x_min
Definition: box.hpp:7
ftxui
Definition: captured_mouse.hpp:6
node.hpp
ftxui::Node::requirement
Requirement requirement()
Definition: node.hpp:29
box.hpp
box_helper.hpp
requirement.hpp
ftxui::hbox
Element hbox(Elements)
A container displaying elements horizontally one by one.
Definition: hbox.cpp:75
ftxui::Box::x_max
int x_max
Definition: box.hpp:8
ftxui::Elements
std::vector< Element > Elements
Definition: elements.hpp:16
elements.hpp
ftxui::Node::Node
Node()
Definition: node.cpp:8
ftxui::Requirement::flex_grow_y
int flex_grow_y
Definition: requirement.hpp:15
ftxui::Element
std::shared_ptr< Node > Element
Definition: elements.hpp:15
ftxui::Requirement::selection
Selection selection
Definition: requirement.hpp:25
ftxui::Requirement::min_y
int min_y
Definition: requirement.hpp:11
ftxui::Node::requirement_
Requirement requirement_
Definition: node.hpp:40
ftxui::Requirement::flex_shrink_y
int flex_shrink_y
Definition: requirement.hpp:17
ftxui::Requirement::flex_grow_x
int flex_grow_x
Definition: requirement.hpp:14
ftxui::box_helper::Compute
void Compute(std::vector< Element > *elements, int target_size)
Definition: box_helper.cpp:60
ftxui::Requirement::flex_shrink_x
int flex_shrink_x
Definition: requirement.hpp:16