/usr/include/guichan/widgets/scrollarea.hpp is in libguichan-dev 0.8.2-18.
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 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 | /* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* 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 GCN_SCROLLAREA_HPP
#define GCN_SCROLLAREA_HPP
#include <string>
#include "guichan/basiccontainer.hpp"
#include "guichan/mouselistener.hpp"
#include "guichan/platform.hpp"
namespace gcn
{
/**
* Implementation if a scrollable area used to view widgets larger than the scroll area.
* A scroll area can be customized to always show scroll bars or to show them only when
* necessary.
*/
class GCN_CORE_DECLSPEC ScrollArea:
public BasicContainer,
public MouseListener
{
public:
/**
* Scrollpolicies for the horizontal and vertical scrollbar.
* The policies are:
*
* SHOW_ALWAYS - Always show the scrollbars no matter what.
* SHOW_NEVER - Never show the scrollbars no matter waht.
* SHOW_AUTO - Show the scrollbars only when needed. That is if the
* content grows larger then the ScrollArea.
*/
enum ScrollPolicy
{
SHOW_ALWAYS = 0,
SHOW_NEVER,
SHOW_AUTO
};
/**
* Constructor.
*/
ScrollArea();
/**
* Constructor.
*
* @param content The content of the scroll area.
*/
ScrollArea(Widget *content);
/**
* Constructor.
*
* @param content The content of the scroll area.
* @param hPolicy The policy for the horizontal scrollbar. See enum with
* policies.
* @param vPolicy The policy for the vertical scrollbar. See enum with
* policies.
*/
ScrollArea(Widget *content,
ScrollPolicy hPolicy,
ScrollPolicy vPolicy);
/**
* Destructor.
*/
virtual ~ScrollArea();
/**
* Sets the content.
*
* @param widget The content of the scroll area.
*/
void setContent(Widget* widget);
/**
* Gets the content.
*
* @return The content of the scroll area.
*/
Widget* getContent();
/**
* Sets the horizontal scrollbar policy. See enum with policies.
*
* @param hPolicy The policy for the horizontal scrollbar.
* @see getHorizontalScrollPolicy
*/
void setHorizontalScrollPolicy(ScrollPolicy hPolicy);
/**
* Gets the horizontal scrollbar policy. See enum with policies.
*
* @return The policy for the horizontal scrollbar policy.
* @see setHorizontalScrollPolicy, setScrollPolicy
*/
ScrollPolicy getHorizontalScrollPolicy() const;
/**
* Sets the vertical scrollbar policy. See enum with policies.
*
* @param vPolicy The policy for the vertical scrollbar.
* @see getVerticalScrollPolicy
*/
void setVerticalScrollPolicy(ScrollPolicy vPolicy);
/**
* Gets the vertical scrollbar policy. See enum with policies.
*
* @return The policy for the vertical scrollbar.
* @see setVerticalScrollPolicy, setScrollPolicy
*/
ScrollPolicy getVerticalScrollPolicy() const;
/**
* Sets the horizontal and vertical scrollbar policy.
*
* @param hPolicy The policy for the horizontal scrollbar.
* @param vPolicy The policy for the vertical scrollbar.
* @see getVerticalScrollPolicy, getHorizontalScrollPolicy
*/
void setScrollPolicy(ScrollPolicy hPolicy, ScrollPolicy vPolicy);
/**
* Sets the amount to scroll vertically.
*
* @param vScroll The amount to scroll.
* @see getVerticalScrollAmount
*/
void setVerticalScrollAmount(int vScroll);
/**
* Gets the amount that is scrolled vertically.
*
* @return The scroll amount on vertical scroll.
* @see setVerticalScrollAmount, setScrollAmount
*/
int getVerticalScrollAmount() const;
/**
* Sets the amount to scroll horizontally.
*
* @param hScroll The amount to scroll.
* @see getHorizontalScrollAmount
*/
void setHorizontalScrollAmount(int hScroll);
/**
* Gets the amount that is scrolled horizontally.
*
* @return The scroll amount on horizontal scroll.
* @see setHorizontalScrollAmount, setScrollAmount
*/
int getHorizontalScrollAmount() const;
/**
* Sets the amount to scroll horizontally and vertically.
*
* @param hScroll The amount to scroll on horizontal scroll.
* @param vScroll The amount to scroll on vertical scroll.
* @see getHorizontalScrollAmount, getVerticalScrollAmount
*/
void setScrollAmount(int hScroll, int vScroll);
/**
* Gets the maximum amount of horizontal scroll.
*
* @return The horizontal max scroll.
*/
int getHorizontalMaxScroll();
/**
* Gets the maximum amount of vertical scroll.
*
* @return The vertical max scroll.
*/
int getVerticalMaxScroll();
/**
* Sets the width of the scroll bars.
*
* @param width The width of the scroll bars.
* @see getScrollbarWidth
*/
void setScrollbarWidth(int width);
/**
* Gets the width of the scroll bars.
*
* @return the width of the ScrollBar.
* @see setScrollbarWidth
*/
int getScrollbarWidth() const;
/**
* Sets the amount to scroll in pixels when the left scroll button is
* pushed.
*
* @param amount The amount to scroll in pixels.
* @see getLeftButtonScrollAmount
*/
void setLeftButtonScrollAmount(int amount);
/**
* Sets the amount to scroll in pixels when the right scroll button is
* pushed.
*
* @param amount The amount to scroll in pixels.
* @see getRightButtonScrollAmount
*/
void setRightButtonScrollAmount(int amount);
/**
* Sets the amount to scroll in pixels when the up scroll button is
* pushed.
*
* @param amount The amount to scroll in pixels.
* @see getUpButtonScrollAmount
*/
void setUpButtonScrollAmount(int amount);
/**
* Sets the amount to scroll in pixels when the down scroll button is
* pushed.
*
* @param amount The amount to scroll in pixels.
* @see getDownButtonScrollAmount
*/
void setDownButtonScrollAmount(int amount);
/**
* Gets the amount to scroll in pixels when the left scroll button is
* pushed.
*
* @return The amount to scroll in pixels.
* @see setLeftButtonScrollAmount
*/
int getLeftButtonScrollAmount() const;
/**
* Gets the amount to scroll in pixels when the right scroll button is
* pushed.
*
* @return The amount to scroll in pixels.
* @see setRightButtonScrollAmount
*/
int getRightButtonScrollAmount() const;
/**
* Gets the amount to scroll in pixels when the up scroll button is
* pushed.
*
* @return The amount to scroll in pixels.
* @see setUpButtonScrollAmount
*/
int getUpButtonScrollAmount() const;
/**
* Gets the amount to scroll in pixels when the down scroll button is
* pushed.
*
* @return The amount to scroll in pixels.
* @see setDownButtonScrollAmount
*/
int getDownButtonScrollAmount() const;
/**
* Sets the scroll area to be opaque, that is sets the scoll area
* to display its background.
*
* @param opaque True if the scoll area should be opaque, false otherwise.
*/
void setOpaque(bool opaque);
/**
* Checks if the scroll area is opaque, that is if the scroll area
* displays its background.
*
* @return True if the scroll area is opaque, false otherwise.
*/
bool isOpaque() const;
// Inherited from BasicContainer
virtual void showWidgetPart(Widget* widget, Rectangle area);
virtual Rectangle getChildrenArea();
virtual Widget *getWidgetAt(int x, int y);
// Inherited from Widget
virtual void draw(Graphics *graphics);
virtual void logic();
void setWidth(int width);
void setHeight(int height);
void setDimension(const Rectangle& dimension);
// Inherited from MouseListener
virtual void mousePressed(MouseEvent& mouseEvent);
virtual void mouseReleased(MouseEvent& mouseEvent);
virtual void mouseDragged(MouseEvent& mouseEvent);
virtual void mouseWheelMovedUp(MouseEvent& mouseEvent);
virtual void mouseWheelMovedDown(MouseEvent& mouseEvent);
protected:
/**
* Draws the background of the scroll area, that is
* the area behind the content.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawBackground(Graphics *graphics);
/**
* Draws the up button.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawUpButton(Graphics *graphics);
/**
* Draws the down button.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawDownButton(Graphics *graphics);
/**
* Draws the left button.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawLeftButton(Graphics *graphics);
/**
* Draws the right button.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawRightButton(Graphics *graphics);
/**
* Draws the vertical scroll bar.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawVBar(Graphics* graphics);
/**
* Draws the horizontal scroll bar.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawHBar(Graphics* graphics);
/**
* Draws the vertical marker.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawVMarker(Graphics* graphics);
/**
* Draws the horizontal marker.
*
* @param graphics a Graphics object to draw with.
*/
virtual void drawHMarker(Graphics* graphics);
/**
* Checks the policies for the scroll bars.
*/
virtual void checkPolicies();
/**
* Gets the up button dimension.
*
* @return the dimension of the up button.
*/
Rectangle getUpButtonDimension();
/**
* Gets the down button dimension.
*
* @return the dimension of the down button.
*/
Rectangle getDownButtonDimension();
/**
* Gets the left button dimension.
*
* @return the dimension of the left button.
*/
Rectangle getLeftButtonDimension();
/**
* Gets the right button dimension.
*
* @return the dimension of the right button.
*/
Rectangle getRightButtonDimension();
/**
* Gets the vertical scrollbar dimension.
*
* @return the dimension of the vertical scrollbar.
*/
Rectangle getVerticalBarDimension();
/**
* Gets the horizontal scrollbar dimension.
*
* @return the dimension of the horizontal scrollbar.
*/
Rectangle getHorizontalBarDimension();
/**
* Gets the vertical marker dimension.
*
* @return the dimension of the vertical marker.
*/
Rectangle getVerticalMarkerDimension();
/**
* Gets the horizontal marker dimension.
*
* @return the dimension of the horizontal marker.
*/
Rectangle getHorizontalMarkerDimension();
/**
* Holds the vertical scroll amount.
*/
int mVScroll;
/**
* Holds the horizontal scroll amount.
*/
int mHScroll;
/**
* Holds the width of the scroll bars.
*/
int mScrollbarWidth;
/**
* Holds the horizontal scroll bar policy.
*/
ScrollPolicy mHPolicy;
/**
* Holds the vertical scroll bar policy.
*/
ScrollPolicy mVPolicy;
/**
* True if the vertical scroll bar is visible, false otherwise.
*/
bool mVBarVisible;
/**
* True if the horizontal scroll bar is visible, false otherwise.
*/
bool mHBarVisible;
/**
* True if the up button is pressed, false otherwise.
*/
bool mUpButtonPressed;
/**
* True if the down button is pressed, false otherwise.
*/
bool mDownButtonPressed;
/**
* True if the left button is pressed, false otherwise.
*/
bool mLeftButtonPressed;
/**
* True if the right button is pressed, false otherwise.
*/
bool mRightButtonPressed;
/**
* Holds the up button scroll amount.
*/
int mUpButtonScrollAmount;
/**
* Holds the down button scroll amount.
*/
int mDownButtonScrollAmount;
/**
* Holds the left button scroll amount.
*/
int mLeftButtonScrollAmount;
/**
* Holds the right button scroll amount.
*/
int mRightButtonScrollAmount;
/**
* True if the vertical marked is dragged.
*/
bool mIsVerticalMarkerDragged;
/**
* True if the horizontal marked is dragged.
*/
bool mIsHorizontalMarkerDragged;
/**
* Holds the horizontal markers drag offset.
*/
int mHorizontalMarkerDragOffset;
/**
* Holds the vertical markers drag offset.
*/
int mVerticalMarkerDragOffset;
/**
* True if the scroll area should be opaque (that is
* display its background), false otherwise.
*/
bool mOpaque;
};
}
#endif // end GCN_SCROLLAREA_HPP
|