FTXUI  5.0.0
C++ functional terminal UI.
Loading...
Searching...
No Matches
scroll_indicator.cpp
Go to the documentation of this file.
1// Copyright 2021 Arthur Sonzogni. All rights reserved.
2// Use of this source code is governed by the MIT license that can be found in
3// the LICENSE file.
4#include <algorithm> // for max
5#include <memory> // for make_shared, __shared_ptr_access
6#include <string> // for string
7#include <utility> // for move
8
9#include "ftxui/dom/elements.hpp" // for Element, vscroll_indicator, hscroll_indicator
10#include "ftxui/dom/node.hpp" // for Node, Elements
11#include "ftxui/dom/node_decorator.hpp" // for NodeDecorator
12#include "ftxui/dom/requirement.hpp" // for Requirement
13#include "ftxui/screen/box.hpp" // for Box
14#include "ftxui/screen/screen.hpp" // for Screen, Pixel
15
16namespace ftxui {
17
18/// @brief Display a vertical scrollbar to the right.
19/// colors.
20/// @ingroup dom
22 class Impl : public NodeDecorator {
24
25 void ComputeRequirement() override {
27 requirement_ = children_[0]->requirement();
28 requirement_.min_x++;
29 }
30
31 void SetBox(Box box) override {
32 box_ = box;
33 box.x_max--;
34 children_[0]->SetBox(box);
35 }
36
37 void Render(Screen& screen) final {
39
40 const Box& stencil = screen.stencil;
41
42 const int size_inner = box_.y_max - box_.y_min;
43 if (size_inner <= 0) {
44 return;
45 }
46 const int size_outter = stencil.y_max - stencil.y_min + 1;
47 if (size_outter >= size_inner) {
48 return;
49 }
50
52 size = std::max(size, 1);
53
54 const int start_y =
55 2 * stencil.y_min + //
56 2 * (stencil.y_min - box_.y_min) * size_outter / size_inner;
57
58 const int x = stencil.x_max;
59 for (int y = stencil.y_min; y <= stencil.y_max; ++y) {
60 const int y_up = 2 * y + 0;
61 const int y_down = 2 * y + 1;
62 const bool up = (start_y <= y_up) && (y_up <= start_y + size);
63 const bool down = (start_y <= y_down) && (y_down <= start_y + size);
64
65 const char* c = up ? (down ? "┃" : "╹") : (down ? "╻" : " "); // NOLINT
66 screen.PixelAt(x, y).character = c;
67 }
68 }
69 };
70 return std::make_shared<Impl>(std::move(child));
71}
72
73/// @brief Display an horizontal scrollbar to the bottom.
74/// colors.
75/// @ingroup dom
77 class Impl : public NodeDecorator {
79
80 void ComputeRequirement() override {
82 requirement_ = children_[0]->requirement();
83 requirement_.min_y++;
84 }
85
86 void SetBox(Box box) override {
87 box_ = box;
88 box.y_max--;
89 children_[0]->SetBox(box);
90 }
91
92 void Render(Screen& screen) final {
94
95 const Box& stencil = screen.stencil;
96
97 const int size_inner = box_.x_max - box_.x_min;
98 if (size_inner <= 0) {
99 return;
100 }
101 const int size_outter = stencil.x_max - stencil.x_min + 1;
102 if (size_outter >= size_inner) {
103 return;
104 }
105
107 size = std::max(size, 1);
108
109 const int start_x =
110 2 * stencil.x_min + //
111 2 * (stencil.x_min - box_.x_min) * size_outter / size_inner;
112
113 const int y = stencil.y_max;
114 for (int x = stencil.x_min; x <= stencil.x_max; ++x) {
115 const int x_left = 2 * x + 0;
116 const int x_right = 2 * x + 1;
117 const bool left = (start_x <= x_left) && (x_left <= start_x + size);
118 const bool right = (start_x <= x_right) && (x_right <= start_x + size);
119
120 const char* c =
121 left ? (right ? "─" : "╴") : (right ? "╶" : " "); // NOLINT
122 screen.PixelAt(x, y).character = c;
123 }
124 }
125 };
126 return std::make_shared<Impl>(std::move(child));
127}
128
129} // namespace ftxui
NodeDecorator(Element child)
void ComputeRequirement() override
Compute how much space an elements needs.
virtual void Render(Screen &screen)
Display an element on a ftxui::Screen.
Definition node.cpp:47
A rectangular grid of Pixel.
Definition screen.hpp:27
Element vscroll_indicator(Element)
Display a vertical scrollbar to the right. colors.
Decorator size(WidthOrHeight, Constraint, int value)
Apply a constraint on the size of an element.
Definition size.cpp:89
std::shared_ptr< Node > Element
Definition elements.hpp:22
std::shared_ptr< T > Make(Args &&... args)
Definition component.hpp:26
Element hscroll_indicator(Element)
Display an horizontal scrollbar to the bottom. colors.
void Render(Screen &screen, const Element &element)
Display an element on a ftxui::Screen.
Definition node.cpp:72
int x_max
Definition box.hpp:11
int y_min
Definition box.hpp:12
int y_max
Definition box.hpp:13
int x_min
Definition box.hpp:10