/* * The ManaPlus Client * Copyright (C) 2008-2009 The Mana World Development Team * Copyright (C) 2009-2010 The Mana Developers * Copyright (C) 2011-2012 The ManaPlus Developers * * 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 TABBEDAREA_H #define TABBEDAREA_H #include "gui/widgets/widget2.h" #include <guichan/actionlistener.hpp> #include <guichan/widget.hpp> #include <guichan/widgetlistener.hpp> #include <guichan/widgets/container.hpp> #include "gui/widgets/button.h" #include "utils/stringvector.h" class Tab; /** * A tabbed area, the same as the guichan tabbed area in 0.8, but extended */ class TabbedArea final : public Widget2, public gcn::ActionListener, public gcn::BasicContainer, public gcn::KeyListener, public gcn::MouseListener, public gcn::WidgetListener { public: /** * Constructor. */ TabbedArea(); A_DELETE_COPY(TabbedArea) ~TabbedArea(); /** * Draw the tabbed area. */ void draw(gcn::Graphics *graphics) override; /** * Return how many tabs have been created. * * @todo Remove this method when upgrading to Guichan 0.9.0 */ int getNumberOfTabs() const; /** * Return tab with specified name as caption. */ Tab *getTab(const std::string &name) const; Tab *getTabByIndex(const int index) const; gcn::Widget *getWidgetByIndex(const int index) const; /** * Returns the widget with the tab that has specified caption */ gcn::Widget *getWidget(const std::string &name) const; /** * Returns the widget for the current tab */ gcn::Widget *getCurrentWidget(); /** * Add a tab. Overridden since it needs to size the widget. * * @param tab The tab widget for the tab. * @param widget The widget to view when the tab is selected. */ void addTab(Tab *tab, gcn::Widget *widget); void addTab(const std::string &caption, gcn::Widget *const widget); bool isTabSelected(unsigned int index) const; bool isTabSelected(Tab* tab); /** * Overload the remove tab function as it's broken in guichan 0.8. */ void removeTab(Tab *tab); void removeAll(); /** * Overload the logic function since it's broken in guichan 0.8. */ void logic() override; int getContainerHeight() const { return mWidgetContainer->getHeight(); } void setSelectedTab(Tab *tab); void setSelectedTab(unsigned int index); int getSelectedTabIndex() const; Tab* getSelectedTab() { return mSelectedTab; } void setOpaque(bool opaque) { mOpaque = opaque; } bool isOpaque() const { return mOpaque; } void adjustSize(); void setSelectedTabByPos(int tab); void setSelectedTabByName(const std::string &name); void widgetResized(const gcn::Event &event) override; /* void moveLeft(Tab *tab); void moveRight(Tab *tab); */ void adjustTabPositions(); void action(const gcn::ActionEvent& actionEvent) override; // Inherited from MouseListener void mousePressed(gcn::MouseEvent &mouseEvent) override; void enableScrollButtons(const bool enable); void setRightMargin(int n) { mRightMargin = n; } int getRightMargin() const { return mRightMargin; } void setFollowDownScroll(bool n) { mFollowDownScroll = n; } bool getFollowDownScroll() const { return mFollowDownScroll; } void fixSize() { adjustSize(); } void keyPressed(gcn::KeyEvent& keyEvent) override; void setBlockSwitching(bool b) { mBlockSwitching = b; } void setWidth(int width); void setHeight(int height); void setSize(int width, int height); void setDimension(const gcn::Rectangle &dimension); void death(const gcn::Event &event); private: typedef std::vector <std::pair<Tab*, gcn::Widget*> > TabContainer; /** The tab arrows */ Button *mArrowButton[2]; /** Check whether the arrow should be clickable */ void updateArrowEnableState(); /** * Update the overall width of all tab. Used to know whether the arrows * have to be drawn or not. */ void updateTabsWidth(); Tab* mSelectedTab; gcn::Container* mTabContainer; gcn::Container* mWidgetContainer; std::vector<Tab*> mTabsToDelete; std::vector<std::pair<Tab*, gcn::Widget*> > mTabs; bool mOpaque; /** * The overall width of all tab. */ int mTabsWidth; /** * Update the overall width of visible tab. Used to know whether * the arrows have to be enable or not. */ void updateVisibleTabsWidth(); /** * The overall width of visible tab. */ int mVisibleTabsWidth; /** * The tab scroll index. When scrolling with the arrows, the tabs * must be displayed according to the current index. * So the first tab displayed may not be the first in the list. * @note the index must start at 0. */ unsigned mTabScrollIndex; bool mEnableScrollButtons; int mRightMargin; bool mFollowDownScroll; bool mBlockSwitching; }; #endif