/usr/include/fifechan/widgets/tabbedarea.hpp is in libfifechan-dev 0.1.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | /***************************************************************************
* Copyright (c) 2017 by the fifechan team *
* https://github.com/fifengine/fifechan *
* This file is part of fifechan. *
* *
* fifechan is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naessén a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* 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.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* 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
* OWNER 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.
*/
#ifndef FCN_TABBEDAREA_HPP
#define FCN_TABBEDAREA_HPP
#include <map>
#include <string>
#include <vector>
#include "fifechan/actionlistener.hpp"
#include "fifechan/keylistener.hpp"
#include "fifechan/mouselistener.hpp"
#include "fifechan/platform.hpp"
#include "fifechan/widget.hpp"
namespace fcn
{
class Container;
class Tab;
/**
* An implementation of a tabbed area where a user can display a widget by
* selecting a tab.
*
*/
class FCN_CORE_DECLSPEC TabbedArea:
public ActionListener,
public KeyListener,
public MouseListener,
public Widget
{
friend class Tab;
public:
/**
* Constructor.
*/
TabbedArea();
/**
* Destructor.
*/
virtual ~TabbedArea();
/**
* Sets the tabbed area to be opaque or not. If the tabbed area is
* opaque its background will be drawn, if it's not opaque its
* background will not be drawn. By default, a tabbed area is not
* opaque.
*
* The tabbed area's background is normally only visible behind the
* tabs, since the container holding the tab contents is opaque by
* default.
*
* @param opaque True if the tabbed area should be opaque, false
* otherwise.
* @see isOpaque
*/
void setOpaque(bool opaque);
/**
* Checks if the tabbed area is opaque or not.
*
* @return true if the tabbed area is opaque, false otherwise.
* @see setOpaque
*/
bool isOpaque() const;
/**
* Adds a tab to the tabbed area. The newly created tab will be
* automatically deleted by the tabbed area when it is removed.
*
* @param caption The caption of the tab to add.
* @param widget The widget to view when the tab is selected.
* @see removeTab, removeTabWithIndex
*/
virtual void addTab(const std::string& caption, Widget* widget);
/**
* Adds a tab to the tabbed area. The tab will not be deleted by the
* tabbed area when it is removed.
*
* @param tab The tab widget for the tab.
* @param widget The widget to view when the tab is selected.
* @see removeTab, removeTabWithIndex
*/
virtual void addTab(Tab* tab, Widget* widget);
/**
* Removes a tab from the tabbed area.
*
* @param index The index of the tab to remove.
* @see addTab
*/
virtual void removeTabWithIndex(unsigned int index);
/**
* Removes a tab from the tabbed area.
*
* @param index The tab to remove.
* @see addTab
*/
virtual void removeTab(Tab* tab);
/**
* Returns the number of tabs in this tabbed area.
*
*/
int getNumberOfTabs() const;
/**
* Checks if a tab given an index is selected or not.
*
* @param index The index of the tab to check.
* @return True if the tab is selected, false otherwise.
* @see setSelectedTab
*/
virtual bool isTabSelected(unsigned int index) const;
/**
* Checks if a tab is selected or not.
*
* @param index The tab to check.
* @return True if the tab is selected, false otherwise.
* @see setSelectedTab
*/
virtual bool isTabSelected(Tab* tab) const;
/**
* Sets a tab given an index to be selected.
*
* @param index The index of the tab to be selected.
* @see isTabSelected, getSelectedTab
*/
virtual void setSelectedTab(unsigned int index);
/**
* Sets a tab to be selected or not.
*
* @param index The tab to be selected.
* @see isTabSelected, getSelectedTab
*/
virtual void setSelectedTab(Tab* tab);
/**
* Gets the index of the selected tab.
*
* @return The undex of the selected tab.
* If no tab is selected -1 will be returned.
* @see isTabSelected, setSelectedTab
*/
virtual int getSelectedTabIndex() const;
/**
* Gets the selected tab.
*
* @return The selected tab.
* @see isTabSelected, setSelectedTab
*/
Tab* getSelectedTab() const;
// Inherited from Widget
virtual void draw(Graphics *graphics);
void setWidth(int width);
void setHeight(int height);
void setSize(int width, int height);
void setDimension(const Rectangle& dimension);
void setBaseColor(const Color& color);
// Inherited from ActionListener
void action(const ActionEvent& actionEvent);
// Inherited from DeathListener
virtual void death(const Event& event);
// Inherited from KeyListener
virtual void keyPressed(KeyEvent& keyEvent);
// Inherited from MouseListener
virtual void mousePressed(MouseEvent& mouseEvent);
protected:
/**
* Adjusts the size of the tab container and the widget container.
*/
void adjustSize();
/**
* Adjusts the positions of the tabs.
*/
void adjustTabPositions();
/**
* Holds the selected tab.
*/
Tab* mSelectedTab;
/**
* Holds the container for the tabs.
*/
Container* mTabContainer;
/**
* Holds the container for the widgets.
*/
Container* mWidgetContainer;
/**
* Holds a vector of tabs to delete in the destructor.
* A tab that is to be deleted is a tab that has been
* internally created by the tabbed area.
*/
std::vector<Tab*> mTabsToDelete;
/**
* A map between a tab and a widget to display when the
* tab is selected.
*/
std::vector<std::pair<Tab*, Widget*> > mTabs;
/**
* True if the tabbed area is opaque, false otherwise.
*/
bool mOpaque;
};
}
#endif // end FCN_TABBEDAREA_HPP
|