/usr/include/fifechan/text.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 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 | /***************************************************************************
* 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_TEXT_HPP
#define FCN_TEXT_HPP
#include "fifechan/platform.hpp"
#include "fifechan/rectangle.hpp"
#include <string>
#include <vector>
namespace fcn
{
class Font;
/**
* A utility class to ease working with text in widgets such as
* TextBox and TextField. The class wraps common text operations
* such as inserting and deleting text.
*
*/
class FCN_CORE_DECLSPEC Text
{
public:
/**
* Constructor.
*/
Text();
/**
* Constructor.
*
* @param content The content of the text.
*/
Text(const std::string& content);
/**
* Destructor.
*/
virtual ~Text();
/**
* Sets the content of the text. Will completely remove
* any previous text and reset the caret position.
*
* @param content The content of the text.
*/
virtual void setContent(const std::string& text);
/**
* Gets the content of the text.
*
* @return The content of the text.
*/
virtual std::string getContent() const;
/**
* Sets the content of a row.
*
* @param row The row to set the text of.
* @throws Exception when the row does not exist.
*/
virtual void setRow(unsigned int row, const std::string& content);
/**
* Adds a row to the content. Calling this method will
* not change the current caret position.
*
* @param row The row to add.
*/
virtual void addRow(const std::string& row);
/**
* Inserts a row before the specified row position. Calling this method
* will not change the current caret position.
*
* @param row The row to add.
* @param position Inserts new row before this row.
*/
virtual void insertRow(const std::string& row, unsigned int position);
/**
* Erases the given row. Calling this method will not change the current
* caret position.
*
* @param row Row to be erased.
*/
virtual void eraseRow(unsigned int row);
/**
* Gets a reference to a row.
*
* @param row The row to get the content of.
* @return The reference to a row.
* @throws Exception when no such row exists.
*/
virtual std::string& getRow(unsigned int row);
/**
* Inserts a character at the current caret position.
*
* @parameter character The character to insert.
*/
virtual void insert(int character);
/**
* Removes a given number of characters at starting
* at the current caret position.
*
* If the number of characters to remove is negative
* characters will be removed left of the caret position.
* If the number is positive characters will be removed
* right of the caret position. If a line feed is
* removed the row with the line feed will be merged
* with the row above the line feed.
*
* @param numberOfCharacters The number of characters to remove.
*/
virtual void remove(int numberOfCharacters);
/**
* Gets the caret position.
*
* @return The caret position.
*/
virtual int getCaretPosition() const;
/**
* Sets the caret position. The position will be
* clamp to the dimension of the content.
*
* @param position The position of the caret.
*/
virtual void setCaretPosition(int position);
/**
* Sets the caret position given an x and y coordinate in pixels
* relative to the text. The coordinates will be clamp to the content.
*
* @param x The x coordinate of the caret.
* @param y The y coordinate of the caret.
* @param font The font to use when calculating the position.
*/
virtual void setCaretPosition(int x, int y, Font* font);
/**
* Gets the column the caret is currently in.
*
* @return The column the caret is currently in.
*/
virtual int getCaretColumn() const;
/**
* Gets the row the caret is currently in.
*
* @return The row the caret is currently in.
*/
virtual int getCaretRow() const;
/**
* Sets the column the caret should be in. The column
* will be clamp to the current row.
*
* @param column The column the caret should be in.
*/
virtual void setCaretColumn(int column);
/**
* Sets the row the caret should be in. If the row lies o
* outside of the text, the row will be set to zero or the
* maximum row depending on where the row lies outside of the
* text.
*
* Calling this function trigger a recalculation of the caret
* column.
*
* @param row The row the caret should be in.
*/
virtual void setCaretRow(int row);
/**
* Gets the x coordinate of the caret in pixels given a font.
*
* @param font The font to use when calculating the x coordinate.
* @return The x coorinate of the caret in pixels.
*/
virtual int getCaretX(Font* font) const;
/**
* Gets the y coordinate of the caret in pixels given a font.
*
* @param font The font to use when calculating the y coordinate.
* @return The y coorinate of the caret in pixels.
*/
virtual int getCaretY(Font* font) const;
/**
* Gets the dimension in pixels of the text given a font. If there
* is no text present a dimension of a white space will be returned.
*
* @param font The font to use when calculating the dimension.
* @return The dimension in pixels of the text given a font.
*/
virtual Rectangle getDimension(Font* font) const;
/**
* Gets the caret dimension relative to this text.
* The returned dimension is perfect for use with Widget::showPart
* so the caret is always shown.
*
* @param font The font to use when calculating the dimension.
* @return The dimension of the caret.
*/
virtual Rectangle getCaretDimension(Font* font) const;
/**
* Gets the width in pixels of a row. If the row is not
* present in the text zero will be returned.
*
* @param row The row to get the width of.
* @return The width in pixels of a row.
*/
virtual int getWidth(int row, Font* font) const;
/**
* Gets the maximum row the caret can be in.
*
* @return The maximum row the caret can be in.
*/
virtual unsigned int getMaximumCaretRow() const;
/**
* Gets the maximum column of a row the caret can be in.
*
* @param row The row of the caret.
* @return The maximum column of a row the caret can be in.
*/
virtual unsigned int getMaximumCaretRow(unsigned int row) const;
/**
* Gets the number of rows in the text.
*
* @return The number of rows in the text.
*/
virtual unsigned int getNumberOfRows() const;
/**
* Gets the number of characters in the text.
*
* @return The number of characters in the text.
*/
virtual unsigned int getNumberOfCharacters() const;
/**
* Gets the number of characters in a certain row in the text.
* If the row does not exist, zero will be returned.
*
* @param row The row to get the number of characters in.
* @return The number of characters in a certain row, or zero
* if the row does not exist.
*/
virtual unsigned int getNumberOfCharacters(unsigned int row) const;
protected:
/**
* Calculates the caret position from the caret row and caret column.
*/
void calculateCaretPositionFromRowAndColumn();
/**
* Holds the text row by row.
*/
std::vector<std::string> mRows;
/**
* Holds the position of the caret. This variable should
* always be valid.
*/
unsigned int mCaretPosition;
/**
* Holds the row the caret is in. This variable should always
* be valid.
*/
unsigned int mCaretRow;
/**
* Holds the column the caret is in. This variable should always
* be valid.
*/
unsigned int mCaretColumn;
};
}
#endif
|