FTXUI 6.1.9 C++ functional terminal UI.

Loading...
Searching...
No Matches
table.hpp
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#ifndef FTXUI_DOM_TABLE
5#define FTXUI_DOM_TABLE
6
7#include <string> // for string
8#include <vector> // for vector
9
10#include "ftxui/dom/elements.hpp" // for Element, BorderStyle, LIGHT, Decorator
11
12 namespace ftxui {
13
14 class Table;
15 class TableSelection;
16
17/// @brief Table is a utility to draw tables.
18///
19/// **example**
20/// ```cpp
21/// auto table = Table({
22/// {"X", "Y"},
23/// {"-1", "1"},
24/// {"+0", "0"},
25/// {"+1", "1"},
26/// });
27///
28/// table.SelectAll().Border(LIGHT);
29/// table.SelectRow(1).Border(DOUBLE);
30/// table.SelectRow(1).SeparatorInternal(LIGHT);
31///
32/// std::move(table).Render();
33/// ```
34///
35/// @ingroup dom
36 class Table {
37 public:
38 Table();
39 explicit Table(std::vector<std::vector<std::string>>);
40 explicit Table(std::vector<std::vector<Element>>);
41 Table(std::initializer_list<std::vector<std::string>> init);
42 TableSelection SelectAll();
43 TableSelection SelectCell(int column, int row);
44 TableSelection SelectRow(int row_index);
45 TableSelection SelectRows(int row_min, int row_max);
46 TableSelection SelectColumn(int column_index);
47 TableSelection SelectColumns(int column_min, int column_max);
48 TableSelection SelectRectangle(int column_min,
49 int column_max,
50 int row_min,
51 int row_max);
52 Element Render();
53
54 private:
55 void Initialize(std::vector<std::vector<Element>>);
56 friend TableSelection;
57 std::vector<std::vector<Element>> elements_;
58 int input_dim_x_ = 0;
59 int input_dim_y_ = 0;
60 int dim_x_ = 0;
61 int dim_y_ = 0;
62};
63
64 class TableSelection {
65 public:
66 void Decorate(Decorator);
67 void DecorateAlternateRow(Decorator, int modulo = 2, int shift = 0);
68 void DecorateAlternateColumn(Decorator, int modulo = 2, int shift = 0);
69
70 void DecorateCells(Decorator);
71 void DecorateCellsAlternateColumn(Decorator, int modulo = 2, int shift = 0);
72 void DecorateCellsAlternateRow(Decorator, int modulo = 2, int shift = 0);
73
74 void Border(BorderStyle border = LIGHT);
75 void BorderLeft(BorderStyle border = LIGHT);
76 void BorderRight(BorderStyle border = LIGHT);
77 void BorderTop(BorderStyle border = LIGHT);
78 void BorderBottom(BorderStyle border = LIGHT);
79
80 void Separator(BorderStyle border = LIGHT);
81 void SeparatorVertical(BorderStyle border = LIGHT);
82 void SeparatorHorizontal(BorderStyle border = LIGHT);
83
84 private:
85 friend Table;
86 Table* table_;
87 int x_min_;
88 int x_max_;
89 int y_min_;
90 int y_max_;
91};
92
93} // namespace ftxui
94
95#endif /* end of include guard: FTXUI_DOM_TABLE */
ftxui::TableSelection
Definition table.hpp:64
ftxui::TableSelection::DecorateAlternateColumn
void DecorateAlternateColumn(Decorator, int modulo=2, int shift=0)
Apply the decorator to the selection. This decorate only the lines modulo modulo with a shift of shif...
Definition src/ftxui/dom/table.cpp:272
ftxui::TableSelection::SeparatorVertical
void SeparatorVertical(BorderStyle border=LIGHT)
Draw some vertical separator lines in the selection.
Definition src/ftxui/dom/table.cpp:377
ftxui::TableSelection::DecorateCells
void DecorateCells(Decorator)
Apply the decorator to the selection.
Definition src/ftxui/dom/table.cpp:255
ftxui::TableSelection::BorderLeft
void BorderLeft(BorderStyle border=LIGHT)
Draw some separator lines to the left side of the selection.
Definition src/ftxui/dom/table.cpp:403
ftxui::TableSelection::DecorateCellsAlternateColumn
void DecorateCellsAlternateColumn(Decorator, int modulo=2, int shift=0)
Apply the decorator to the selection. This decorate only the corners modulo modulo with a shift of sh...
Definition src/ftxui/dom/table.cpp:310
ftxui::TableSelection::Decorate
void Decorate(Decorator)
Apply the decorator to the selection. This decorate both the cells, the lines and the corners.
Definition src/ftxui/dom/table.cpp:242
ftxui::TableSelection::DecorateAlternateRow
void DecorateAlternateRow(Decorator, int modulo=2, int shift=0)
Apply the decorator to the selection. This decorate only the lines modulo modulo with a shift of shif...
Definition src/ftxui/dom/table.cpp:291
ftxui::TableSelection::BorderTop
void BorderTop(BorderStyle border=LIGHT)
Draw some separator lines to the top side of the selection.
Definition src/ftxui/dom/table.cpp:421
ftxui::TableSelection::Separator
void Separator(BorderStyle border=LIGHT)
Draw some separator lines in the selection.
Definition src/ftxui/dom/table.cpp:362
ftxui::TableSelection::BorderBottom
void BorderBottom(BorderStyle border=LIGHT)
Draw some separator lines to the bottom side of the selection.
Definition src/ftxui/dom/table.cpp:430
ftxui::TableSelection::DecorateCellsAlternateRow
void DecorateCellsAlternateRow(Decorator, int modulo=2, int shift=0)
Apply the decorator to the selection. This decorate only the corners modulo modulo with a shift of sh...
Definition src/ftxui/dom/table.cpp:329
ftxui::TableSelection::BorderRight
void BorderRight(BorderStyle border=LIGHT)
Draw some separator lines to the right side of the selection.
Definition src/ftxui/dom/table.cpp:412
ftxui::TableSelection::Border
void Border(BorderStyle border=LIGHT)
Apply a border around the selection.
Definition src/ftxui/dom/table.cpp:344
ftxui::TableSelection::SeparatorHorizontal
void SeparatorHorizontal(BorderStyle border=LIGHT)
Draw some horizontal separator lines in the selection.
Definition src/ftxui/dom/table.cpp:390
elements.hpp
ftxui::Table::Render
Element Render()
Render the table.
Definition src/ftxui/dom/table.cpp:212
ftxui::Table::Table
Table()
Create an empty table.
Definition src/ftxui/dom/table.cpp:47
ftxui::Table::SelectCell
TableSelection SelectCell(int column, int row)
Select a cell of the table.
Definition src/ftxui/dom/table.cpp:169
ftxui::Table::SelectColumn
TableSelection SelectColumn(int column_index)
Select a column of the table.
Definition src/ftxui/dom/table.cpp:153
ftxui::Table::SelectRow
TableSelection SelectRow(int row_index)
Select a row of the table.
Definition src/ftxui/dom/table.cpp:138
ftxui::Table::SelectColumns
TableSelection SelectColumns(int column_min, int column_max)
Select a range of columns of the table.
Definition src/ftxui/dom/table.cpp:161
ftxui::Table::SelectRows
TableSelection SelectRows(int row_min, int row_max)
Select a range of rows of the table.
Definition src/ftxui/dom/table.cpp:146
ftxui::Table::SelectAll
TableSelection SelectAll()
Select all the table.
Definition src/ftxui/dom/table.cpp:200
ftxui::Table::SelectRectangle
TableSelection SelectRectangle(int column_min, int column_max, int row_min, int row_max)
Select a rectangle of the table.
Definition src/ftxui/dom/table.cpp:179
ftxui::Table
Table is a utility to draw tables.
Definition table.hpp:36
ftxui::BorderStyle
BorderStyle
BorderStyle is an enumeration that represents the different styles of borders that can be applied to ...
Definition elements.hpp:35
ftxui::LIGHT
@ LIGHT
Definition elements.hpp:36
ftxui
The FTXUI ftxui:: namespace.
Definition animation.hpp:10
ftxui::Decorator
std::function< Element(Element)> Decorator
Definition elements.hpp:24
ftxui::Element
std::shared_ptr< Node > Element
Definition elements.hpp:22