/usr/include/fifechan/widgets/textfield.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 | /***************************************************************************
* 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_TEXTFIELD_HPP
#define FCN_TEXTFIELD_HPP
#include "fifechan/keylistener.hpp"
#include "fifechan/mouselistener.hpp"
#include "fifechan/platform.hpp"
#include "fifechan/widget.hpp"
#include <string>
namespace fcn
{
class Text;
class UTF8StringEditor;
/**
* An implementation of a text field where a user can enter a line of text.
*/
class FCN_CORE_DECLSPEC TextField:
public Widget,
public MouseListener,
public KeyListener
{
public:
/**
* Constructor.
*/
TextField();
/**
* Constructor. The text field will be automatically resized
* to fit the text.
*
* @param text The default text of the text field.
*/
TextField(const std::string& text);
/**
* Destructor.
*/
~TextField();
/**
* Sets the text of the text field.
*
* @param text The text of the text field.
* @see getText
*/
virtual void setText(const std::string& text);
/**
* Gets the text of the text field.
*
* @return The text of the text field.
* @see setText
*/
virtual std::string getText() const;
/**
* Adjusts the size of the text field to fit the text.
*/
void adjustSize();
/**
* Adjusts the height of the text field to fit caption.
*/
void adjustHeight();
/**
* Checks if the text field is editable.
*
* @return True it the text field is editable, false otherwise.
* @see setEditable
*/
bool isEditable() const;
/**
* Sets the text field to be editable or not. A text field is editable
* by default.
*
* @param editable True if the text field should be editable, false
* otherwise.
*/
void setEditable(bool editable);
/**
* Sets the caret position. As there is only one line of text
* in a text field the position is the caret's x coordinate.
*
* @param position The caret position.
* @see getCaretPosition
*/
void setCaretPosition(unsigned int position);
/**
* Gets the caret position. As there is only one line of text
* in a text field the position is the caret's x coordinate.
*
* @return The caret position.
* @see setCaretPosition
*/
unsigned int getCaretPosition() const;
// Inherited from Widget
virtual void draw(Graphics* graphics);
// Inherited from MouseListener
virtual void mousePressed(MouseEvent& mouseEvent);
virtual void mouseDragged(MouseEvent& mouseEvent);
// Inherited from KeyListener
virtual void keyPressed(KeyEvent& keyEvent);
protected:
/**
* Draws the caret. Overloaded this method if you want to
* change the style of the caret.
*
* @param graphics the Graphics object to draw with.
* @param x the caret's x-position.
*/
virtual void drawCaret(Graphics* graphics, int x);
/**
* Scrolls the text horizontally so that the caret shows if needed.
* The method is used any time a user types in the text field so the
* caret always will be shown.
*/
void fixScroll();
/**
* True if the text field is editable, false otherwise.
*/
bool mEditable;
/**
* Holds the text of the text field.
*/
Text* mText;
/**
* Holds the amount scrolled in x. If a user types more characters than
* the text field can display, due to the text field being to small, the
* text needs to scroll in order to show the last type character.
*/
int mXScroll;
/**
* String editor for UTF8 support.
*/
UTF8StringEditor* mStringEditor;
};
}
#endif // end FCN_TEXTFIELD_HPP
|