Mercurial > fife-parpg
diff engine/core/gui/widgets/utf8textbox.h @ 228:756b895e1dab
Merged unicode-support back into trunk.
Now all GUI/visible strings should be unicode.
Internal strings unchanged.
Remember to use a font that actually has the desired codepoints.
Current default unicode policiy is 'ignore'.
author | phoku@33b003aa-7bff-0310-803a-e67f0ece8222 |
---|---|
date | Sat, 21 Mar 2009 10:38:11 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/engine/core/gui/widgets/utf8textbox.h Sat Mar 21 10:38:11 2009 +0000 @@ -0,0 +1,120 @@ +/*************************************************************************** + * Copyright (C) 2009 by the FIFE team * + * http://www.fifengine.de * + * This file is part of FIFE. * + * * + * FIFE 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 * + ***************************************************************************/ + +#ifndef RAVERON_UTF8TEXTBOX_HPP +#define RAVERON_UTF8TEXTBOX_HPP + +// Standard C++ library includes + +// 3rd party library includes +#include <guichan/widgets/textbox.hpp> + +// FIFE includes +// These includes are split up in two parts, separated by one empty line +// First block: files included from the FIFE root src directory +// Second block: files included from the same folder +#include "util/utf8/utf8stringeditor.h" + +namespace gcn { + + /** + * UTF-8 aware version of the TextBox class. + * + * Using UTF8StringEditor, it is able to correctly edit UTF-8 multiline texts. + * + * You will also need an UTF-8 aware font to be able to correctly + * display such text (so gcn::ImageFont can not be used). + * + * TextBox::setCaretColumn(), TextBox::setCaretRow(), + * TextBox::setCaretRowColumn(), TextBox::getCaretColumn() + * and TextBox::getCaretRow() addresses byte offsets of the text. + * Use character versions of those methods with UTF8 suffix, they + * will correctly access real character positions in UTF-8 texts. + * + * @author Przemyslaw Grzywacz + */ + class UTF8TextBox: public TextBox { + public: + /** + * Constructor. + * @param text Initial text. + */ + UTF8TextBox(const std::string& text = ""); + + /** + * Destructor. + */ + virtual ~UTF8TextBox(); + + /** + * Key pressed handler. + * + * Overides gcn::TextField to handle UTF-8 character codes. + * + * @param keyEvent Keyboard event. + */ + virtual void keyPressed(KeyEvent& keyEvent); + + /** + * Sets caret column (UTF-8 aware). + * @param column Caret column. + */ + void setCaretColumnUTF8(int column); + + /** + * Sets caret row (UTF-8 aware). + * @param row Caret row + */ + void setCaretRowUTF8(int row); + + /** + * Sets caret row and column (UTF-8 aware). + * @param row Caret row. + * @param column Caret column. + */ + void setCaretRowColumnUTF8(int row, int column); + + /** + * Gets caret column (UTF-8 aware). + * @return Caret column. + */ + int getCaretColumnUTF8(); + + /** + * Gets caret column (UTF-8 aware). + * @return Caret row. + */ + int getCaretRowUTF8(); + + protected: + + /** + * UTF-8 string editor suppor. + * + * It allows the UTF8TextBox to easly traverse UTF-8 strings + * as well as inserting and deleting characters. + */ + UTF8StringEditor* mStringEditor; + }; + +}; + +#endif // !RAVERON_UTF8TEXTBOX_HPP