ladybird/Userland/Libraries/LibGUI/TableView.h

/*
 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <LibGUI/AbstractTableView.h>

namespace GUI {

class TableView : public AbstractTableView {
    C_OBJECT(TableView)
public:
    virtual ~TableView() override;

    enum class GridStyle {
        None,
        Horizontal,
        Vertical,
        Both,
    };

    enum class CursorStyle {
        None,
        Item,
        Row,
    };

    GridStyle grid_style() const { return m_grid_style; }
    void set_grid_style(GridStyle);

    void set_highlight_key_column(bool b) { m_highlight_key_column = b; }
    bool is_key_column_highlighted() const { return m_highlight_key_column; }

    virtual void move_cursor(CursorMovement, SelectionUpdate) override;

protected:
    TableView();

    virtual void keydown_event(KeyEvent&) override;
    virtual void paint_event(PaintEvent&) override;

private:
    GridStyle m_grid_style { GridStyle::None };

    bool m_highlight_key_column { true };
};

}