<root> / Text.hpp (00fe1708402e2b703575e35aefac79dceceab2bd) (2,531B) (mode 100644) [raw]
// libcursed -- C++ classes for dealing with curses
// Copyright (C) 2019 xaizek <xaizek@posteo.net>
//
// This file is part of libcursed.
//
// libcursed is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// libcursed is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with libcursed.  If not, see <https://www.gnu.org/licenses/>.

#ifndef LIBCURSED__TEXT_HPP__
#define LIBCURSED__TEXT_HPP__

#include <string>
#include <vector>

#include "guts/WindowWidget.hpp"
#include "ColorTree.hpp"

namespace cursed {

// A scrollable widget for displaying static text.
class Text : public guts::WindowWidget
{
public:
    // Constructs an empty text widget.  Can throw `std::runtime_error`.
    explicit Text();

    Text(const Text &rhs) = delete;
    Text(Text &&rhs) = delete;
    Text & operator=(const Text &rhs) = delete;
    Text & operator=(Text &&rhs) = delete;

public:
    // Retrieves height.
    int getHeight() const;

    // Assigns list of lines.
    void setLines(std::vector<ColorTree> newLines);

    // Scrolls all the way up.
    void scrollToTop();
    // Scrolls all the way down.
    void scrollToBottom();

    // Scrolls text one line down.
    void scrollDown();
    // Scrolls text one line up.
    void scrollUp();

private:
    // Updates state of this widget to be published on the screen.
    virtual void draw() override;

    // Retrieves vertical size policy.
    // Positive number or zero means exactly that much.
    // Negative number means at least that much in magnitude.
    virtual int desiredHeight() override;
    // Retrieves horizontal size policy.
    // Positive number or zero means exactly that much.
    // Negative number means at least that much in magnitude.
    virtual int desiredWidth() override;

    // Notifies widget of new position and size.
    virtual void placed(guts::Pos newPos, guts::Size newSize) override;

private:
    std::vector<ColorTree> lines; // Text itself.
    int top;                      // First element to display.
    int height;                   // Screen height.
};

}

#endif // LIBCURSED__TEXT_HPP__
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/libcursed

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/libcursed

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master