guitable.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2008-2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * This file is part of The ManaPlus Client.
 *
 * This program 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 2 of the License, or
 * any later version.
 *
 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GUI_WIDGETS_GUITABLE_H
#define GUI_WIDGETS_GUITABLE_H
 
#include "localconsts.h"
 
#include "enums/simpletypes/opaque.h"
 
#include "listeners/keylistener.h"
#include "listeners/mouselistener.h"
#include "listeners/tablemodellistener.h"
 
#include "gui/widgets/widget.h"
 
class GuiTableActionListener;
class TableModel;
 
class GuiTable final : public Widget,
 public MouseListener,
 public KeyListener,
 public TableModelListener
{
 // so that the action listener can call distributeActionEvent
 friend class GuiTableActionListener;
 
 public:
 GuiTable(const Widget2 *const widget,
 TableModel *const initial_model,
 const Opaque opacity);
 
 A_DELETE_COPY(GuiTable)
 
 ~GuiTable() override final;
 
 void setModel(TableModel *const m);
 
 const TableModel *getModel() const A_WARN_UNUSED RETURNS_NONNULL;
 
 void setSelected(const int row, const int column);
 
 int getSelectedRow() const A_WARN_UNUSED;
 
 int getSelectedColumn() const A_WARN_UNUSED;
 
 void setSelectedRow(const int selected);
 
 void setSelectedColumn(const int selected);
 
 bool isWrappingEnabled() const noexcept2 A_WARN_UNUSED
 { return mWrappingEnabled; }
 
 void setWrappingEnabled(bool wrappingEnabled)
 { mWrappingEnabled = wrappingEnabled; }
 
 Rect getChildrenArea() override final A_WARN_UNUSED;
 
 void setLinewiseSelection(bool linewise)
 { mLinewiseMode = linewise; }
 
 // Inherited from Widget
 void draw(Graphics *const graphics) override final A_NONNULL(2);
 
 void safeDraw(Graphics *const graphics) override final A_NONNULL(2);
 
 Widget *getWidgetAt(int x, int y) override final A_WARN_UNUSED;
 
 void moveToTop(Widget *const widget) override final;
 
 void moveToBottom(Widget *const widget) override final;
 
 void setFocusHandler(FocusHandler *const focusHandler) override final;
 
 // Inherited from KeyListener
 void keyPressed(KeyEvent& event) override final;
 
 void setOpaque(Opaque opaque)
 { mOpaque = opaque; }
 
 bool isOpaque() const noexcept2 A_WARN_UNUSED
 { return mOpaque == Opaque_true; }
 
 // Inherited from MouseListener
 void mousePressed(MouseEvent& event) override final;
 
 void mouseWheelMovedUp(MouseEvent& event) override final;
 
 void mouseWheelMovedDown(MouseEvent& event) override final;
 
 void mouseDragged(MouseEvent& event) override final;
 
 // Constraints inherited from TableModelListener
 void modelUpdated(const bool completed) override final;
 
 void requestFocus() override;
 
 void setSelectableGui(bool b)
 { mSelectableGui = b; }
 
 protected:
 void uninstallActionListeners();
 
 void installActionListeners();
 
 int getRowHeight() const A_WARN_UNUSED;
 
 int getColumnWidth(const int i) const A_WARN_UNUSED;
 
 private:
 int getRowForY(const int y) const A_WARN_UNUSED; // -1 on error
 
 int getColumnForX(const int x) const A_WARN_UNUSED; // -1 on error
 
 void recomputeDimensions();
 
 static float mAlpha;
 
 TableModel *mModel A_NONNULLPOINTER;
 
 Widget *mTopWidget;
 
 STD_VECTOR<GuiTableActionListener *> mActionListeners2;
 
 Color mHighlightColor;
 
 int mSelectedRow;
 int mSelectedColumn;
 
 bool mLinewiseMode;
 bool mWrappingEnabled;
 Opaque mOpaque;
 bool mSelectableGui;
};
 
#endif // GUI_WIDGETS_GUITABLE_H