scrollarea.hpp

00001 /*      _______   __   __   __   ______   __   __   _______   __   __
00002  *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
00003  *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
00004  *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
00005  *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
00006  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
00007  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
00008  *
00009  * Copyright (c) 2004, 2005, 2006 Olof Naessén and Per Larsson
00010  *
00011  *                                                         Js_./
00012  * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
00013  * Olof Naessén a.k.a jansem/yakslem                _asww7!uY`>  )\a//
00014  *                                                 _Qhm`] _f "'c  1!5m
00015  * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
00016  *                                               .)j(] .d_/ '-(  P .   S
00017  * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
00018  * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
00019  * binary forms, with or without                 )4d[#7r, .   '     )d`)[
00020  * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
00021  * that the following conditions are met:       j<<WP+k/);.        _W=j f
00022  * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
00023  *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
00024  *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
00025  *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
00026  * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
00027  *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
00028  *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
00029  *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
00030  *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
00031  *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
00032  * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
00033  *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
00034  *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
00035  *    from this software without specific        (js, \[QQW$QWW#?!V"".
00036  *    prior written permission.                    ]y:.<\..          .
00037  *                                                 -]n w/ '         [.
00038  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
00039  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
00040  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
00041  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
00042  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
00043  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
00044  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
00045  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
00046  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
00047  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
00048  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
00049  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
00050  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00051  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00052  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00053  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
00054  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00055  */
00056 
00057 #ifndef GCN_SCROLLAREA_HPP
00058 #define GCN_SCROLLAREA_HPP
00059 
00060 #include <string>
00061 
00062 #include "guichan/basiccontainer.hpp"
00063 #include "guichan/mouselistener.hpp"
00064 #include "guichan/platform.hpp"
00065 
00066 namespace gcn
00067 {
00077     class GCN_CORE_DECLSPEC ScrollArea:
00078         public BasicContainer,
00079         public MouseListener
00080     {
00081     public:
00082 
00086         ScrollArea();
00087 
00093         ScrollArea(Widget *content);
00094 
00104         ScrollArea(Widget *content, unsigned int hPolicy, unsigned int vPolicy);
00105 
00109         virtual ~ScrollArea();
00110 
00116         virtual void setContent(Widget* widget);
00117 
00123         virtual Widget* getContent();
00124 
00131         virtual void setHorizontalScrollPolicy(unsigned int hPolicy);
00132 
00139         virtual unsigned int getHorizontalScrollPolicy();
00140 
00147         virtual void setVerticalScrollPolicy(unsigned int vPolicy);
00148 
00155         virtual unsigned int getVerticalScrollPolicy();
00156 
00165         virtual void setScrollPolicy(unsigned int hPolicy, unsigned int vPolicy);
00166 
00172         virtual void setVerticalScrollAmount(int vScroll);
00173 
00178         virtual int getVerticalScrollAmount();
00179 
00185         virtual void setHorizontalScrollAmount(int hScroll);
00186 
00192         virtual int getHorizontalScrollAmount();
00193 
00200         virtual void setScrollAmount(int hScroll, int vScroll);
00201 
00207         virtual int getHorizontalMaxScroll();
00208 
00214         virtual int getVerticalMaxScroll();
00215 
00221         virtual void setScrollbarWidth(int width);
00222 
00228         virtual int getScrollbarWidth();
00229 
00234         virtual void setLeftButtonScrollAmount(int amount);
00235 
00240         virtual void setRightButtonScrollAmount(int amount);
00241 
00246         virtual void setUpButtonScrollAmount(int amount);
00247 
00252         virtual void setDownButtonScrollAmount(int amount);
00253 
00260         virtual int getLeftButtonScrollAmount();
00261 
00268         virtual int getRightButtonScrollAmount();
00269 
00276         virtual int getUpButtonScrollAmount();
00277 
00284         virtual int getDownButtonScrollAmount();
00285 
00286 
00287         // Inherited from BasicContainer
00288 
00289         virtual void showWidgetPart(Widget* widget, Rectangle area);
00290 
00291         virtual Rectangle getChildrenArea();
00292 
00293         virtual Widget *getWidgetAt(int x, int y);
00294 
00295 
00296         // Inherited from Widget
00297 
00298         virtual void draw(Graphics *graphics);
00299 
00300         virtual void drawBorder(Graphics* graphics);
00301 
00302         virtual void logic();
00303 
00304         virtual void setWidth(int width);
00305 
00306         virtual void setHeight(int height);
00307 
00308         virtual void setDimension(const Rectangle& dimension);
00309 
00310 
00311         // Inherited from MouseListener
00312 
00313         virtual void mousePress(int x, int y, int button);
00314 
00315         virtual void mouseRelease(int x, int y, int button);
00316 
00317         virtual void mouseMotion(int x, int y);
00318 
00319         virtual void mouseWheelUp(int x, int y);
00320 
00321         virtual void mouseWheelDown(int x, int y);
00322 
00323 
00333         enum
00334         {
00335             SHOW_ALWAYS,
00336             SHOW_NEVER,
00337             SHOW_AUTO
00338         };
00339 
00340     protected:
00347         virtual void drawBackground(Graphics *graphics);
00348 
00354         virtual void drawUpButton(Graphics *graphics);
00355 
00361         virtual void drawDownButton(Graphics *graphics);
00362 
00368         virtual void drawLeftButton(Graphics *graphics);
00369 
00375         virtual void drawRightButton(Graphics *graphics);
00376 
00382         virtual void drawVBar(Graphics* graphics);
00383 
00389         virtual void drawHBar(Graphics* graphics);
00390 
00396         virtual void drawVMarker(Graphics* graphics);
00397 
00403         virtual void drawHMarker(Graphics* graphics);
00404 
00408         virtual void checkPolicies();
00409 
00415         virtual Rectangle getUpButtonDimension();
00416 
00422         virtual Rectangle getDownButtonDimension();
00423 
00429         virtual Rectangle getLeftButtonDimension();
00430 
00436         virtual Rectangle getRightButtonDimension();
00437 
00443         virtual Rectangle getVerticalBarDimension();
00444 
00450         virtual Rectangle getHorizontalBarDimension();
00451 
00457         virtual Rectangle getVerticalMarkerDimension();
00458 
00464         virtual Rectangle getHorizontalMarkerDimension();
00465 
00466         int mVScroll;
00467         int mHScroll;
00468         int mScrollbarWidth;
00469         unsigned int mHPolicy;
00470         unsigned int mVPolicy;
00471         bool mVBarVisible;
00472         bool mHBarVisible;
00473         bool mUpButtonPressed;
00474         bool mDownButtonPressed;
00475         bool mLeftButtonPressed;
00476         bool mRightButtonPressed;
00477         bool mVerticalMarkerPressed;
00478         int mVerticalMarkerMousePosition;
00479         bool mHorizontalMarkerPressed;
00480         int mHorizontalMarkerMousePosition;
00481         int mUpButtonScrollAmount;
00482         int mDownButtonScrollAmount;
00483         int mLeftButtonScrollAmount;
00484         int mRightButtonScrollAmount;
00485     };
00486 }
00487 
00488 #endif // end GCN_SCROLLAREA_HPP

Generated on Sat Jul 29 19:38:48 2006 for Guichan by  doxygen 1.4.7