Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

textbox.hpp

00001 /*      _______   __   __   __   ______   __   __   _______   __   __                 
00002  *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\                
00003  *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /                 
00004  *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /                  
00005  *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /                   
00006  * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /                    
00007  * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/                      
00008  *
00009  * Copyright (c) 2004, 2005 darkbits                        Js_./
00010  * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
00011  * Olof Naessén a.k.a jansem/yakslem                _asww7!uY`>  )\a//
00012  *                                                 _Qhm`] _f "'c  1!5m
00013  * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
00014  *                                               .)j(] .d_/ '-(  P .   S
00015  * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
00016  * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
00017  * binary forms, with or without                 )4d[#7r, .   '     )d`)[
00018  * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
00019  * that the following conditions are met:       j<<WP+k/);.        _W=j f
00020  * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
00021  *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
00022  *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
00023  *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
00024  * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
00025  *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
00026  *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
00027  *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
00028  *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
00029  *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
00030  * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
00031  *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
00032  *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
00033  *    from this software without specific        (js, \[QQW$QWW#?!V"".
00034  *    prior written permission.                    ]y:.<\..          .
00035  *                                                 -]n w/ '         [.
00036  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
00037  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
00038  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
00039  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
00040  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
00041  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
00042  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
00043  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
00044  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
00045  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
00046  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
00047  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00049  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00050  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00051  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
00052  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00053  */
00054 
00055 #ifndef GCN_TEXTBOX_HPP
00056 #define GCN_TEXTBOX_HPP
00057 
00058 #include <ctime>
00059 #include <string>
00060 #include <vector>
00061 
00062 #include "guichan/platform.hpp"
00063 #include "guichan/widget.hpp"
00064 
00065 namespace gcn
00066 {
00073     class GCN_CORE_DECLSPEC TextBox:
00074         public Widget,
00075         public MouseListener,
00076         public KeyListener
00077     {
00078     public:
00082         TextBox();
00083 
00089         TextBox(const std::string& text);
00090 
00096         virtual void setText(const std::string& text);
00097 
00102         virtual std::string getText() const;
00103 
00109         virtual const std::string& getTextRow(int row) const;
00110 
00117         virtual void setTextRow(int row, const std::string& text);
00118 
00124         virtual unsigned int getNumberOfRows() const;   
00125 
00131         virtual unsigned int getCaretPosition() const;
00132 
00138         virtual void setCaretPosition(unsigned int position);
00139 
00145         virtual unsigned int getCaretRow() const;
00146 
00152         virtual void setCaretRow(int row);
00153                 
00159         virtual unsigned int getCaretColumn() const;
00160 
00166         virtual void setCaretColumn(int column);
00167         
00174         virtual void setCaretRowColumn(int row, int column);
00175 
00179         virtual void scrollToCaret();
00180 
00186         virtual bool isEditable() const;
00187         
00193         virtual void setEditable(bool editable);
00194 
00200         virtual void addRow(const std::string row);
00201 
00207         virtual bool isOpaque();
00208 
00214         virtual void setOpaque(bool opaque);
00215 
00216         
00217         // Inherited from Widget
00218         
00219         virtual void draw(Graphics* graphics);
00220         
00221         virtual void drawBorder(Graphics* graphics);
00222         
00223         virtual void fontChanged();
00224         
00225 
00226         // Inherited from KeyListener
00227 
00228         virtual void keyPress(const Key& key);
00229 
00230         
00231         // Inherited from MouseListener
00232         
00233         virtual void mousePress(int x, int y, int button);
00234 
00235         
00236     protected:
00244         virtual void drawCaret(Graphics* graphics, int x, int y);
00245         
00249         virtual void adjustSize();
00250     
00251         std::vector<std::string> mTextRows;
00252         int mCaretColumn;
00253         int mCaretRow;
00254         bool mEditable;
00255         bool mOpaque;
00256     };  
00257 }
00258 
00259 #endif // end GCN_TEXTBOX_HPP

Generated on Tue May 17 21:23:26 2005 for Guichan by  doxygen 1.4.1