Maxim Integrated / Mbed OS MAXREFDES155#

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   MaximInterface

Text.hpp@10:71359af61af8, 2017-04-10 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Apr 10 11:55:33 2017 -0500
Revision:
10:71359af61af8
Parent:
8:a0d75dff3c9b
Child:
13:6a6225690c2e
Reduced copying and dynamic allocations during rendering. Added support for partial redrawing of a scene.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:33d4e66780c0 1 /*******************************************************************************
IanBenzMaxim 0:33d4e66780c0 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:33d4e66780c0 3 *
IanBenzMaxim 0:33d4e66780c0 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:33d4e66780c0 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:33d4e66780c0 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:33d4e66780c0 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:33d4e66780c0 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:33d4e66780c0 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:33d4e66780c0 10 *
IanBenzMaxim 0:33d4e66780c0 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:33d4e66780c0 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:33d4e66780c0 13 *
IanBenzMaxim 0:33d4e66780c0 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:33d4e66780c0 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:33d4e66780c0 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:33d4e66780c0 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:33d4e66780c0 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:33d4e66780c0 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:33d4e66780c0 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:33d4e66780c0 21 *
IanBenzMaxim 0:33d4e66780c0 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:33d4e66780c0 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:33d4e66780c0 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:33d4e66780c0 25 *
IanBenzMaxim 0:33d4e66780c0 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:33d4e66780c0 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:33d4e66780c0 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:33d4e66780c0 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:33d4e66780c0 30 * ownership rights.
IanBenzMaxim 0:33d4e66780c0 31 *******************************************************************************/
IanBenzMaxim 0:33d4e66780c0 32
IanBenzMaxim 0:33d4e66780c0 33 #ifndef TEXT_HPP
IanBenzMaxim 0:33d4e66780c0 34 #define TEXT_HPP
IanBenzMaxim 0:33d4e66780c0 35
IanBenzMaxim 0:33d4e66780c0 36 #include <list>
IanBenzMaxim 0:33d4e66780c0 37 #include <string>
IanBenzMaxim 0:33d4e66780c0 38 #include "Graphic.hpp"
IanBenzMaxim 0:33d4e66780c0 39
IanBenzMaxim 0:33d4e66780c0 40 /// Text graphical primitive.
IanBenzMaxim 0:33d4e66780c0 41 class Text : public Graphic
IanBenzMaxim 0:33d4e66780c0 42 {
IanBenzMaxim 0:33d4e66780c0 43 public:
IanBenzMaxim 8:a0d75dff3c9b 44 Text();
IanBenzMaxim 0:33d4e66780c0 45
IanBenzMaxim 0:33d4e66780c0 46 /// @{
IanBenzMaxim 0:33d4e66780c0 47 /// Text string to display.
IanBenzMaxim 0:33d4e66780c0 48 /// @details Only printable ASCII characters and the line feed ('\n') will be displayed.
IanBenzMaxim 0:33d4e66780c0 49 const std::string & text() const { return m_text; }
IanBenzMaxim 0:33d4e66780c0 50 void setText(const std::string & text);
IanBenzMaxim 0:33d4e66780c0 51 /// @}
IanBenzMaxim 0:33d4e66780c0 52
IanBenzMaxim 0:33d4e66780c0 53 /// @{
IanBenzMaxim 0:33d4e66780c0 54 /// Lines will wrapped when they are too long to be displayed with the current width.
IanBenzMaxim 0:33d4e66780c0 55 bool wordWrap() const { return m_wordWrap; }
IanBenzMaxim 0:33d4e66780c0 56 void setWordWrap(bool wordWrap);
IanBenzMaxim 0:33d4e66780c0 57 /// @}
IanBenzMaxim 0:33d4e66780c0 58
IanBenzMaxim 0:33d4e66780c0 59 /// @{
IanBenzMaxim 0:33d4e66780c0 60 /// Spacing in pixels between characters.
IanBenzMaxim 8:a0d75dff3c9b 61 int charSpacing() const { return m_charSpacing; }
IanBenzMaxim 8:a0d75dff3c9b 62 void setCharSpacing(int charSpacing);
IanBenzMaxim 0:33d4e66780c0 63 /// @}
IanBenzMaxim 0:33d4e66780c0 64
IanBenzMaxim 0:33d4e66780c0 65 /// @{
IanBenzMaxim 0:33d4e66780c0 66 /// Spacing in pixels between lines.
IanBenzMaxim 8:a0d75dff3c9b 67 int lineSpacing() const { return m_lineSpacing; }
IanBenzMaxim 8:a0d75dff3c9b 68 void setLineSpacing(int lineSpacing);
IanBenzMaxim 0:33d4e66780c0 69 /// @}
IanBenzMaxim 0:33d4e66780c0 70
IanBenzMaxim 0:33d4e66780c0 71 /// @{
IanBenzMaxim 0:33d4e66780c0 72 /// @note Preferred width and height are calculated after word wrapping.
IanBenzMaxim 8:a0d75dff3c9b 73 int preferredWidth() const;
IanBenzMaxim 8:a0d75dff3c9b 74 int preferredHeight() const;
IanBenzMaxim 0:33d4e66780c0 75 /// @}
IanBenzMaxim 0:33d4e66780c0 76
IanBenzMaxim 0:33d4e66780c0 77 protected:
IanBenzMaxim 8:a0d75dff3c9b 78 virtual void resized();
IanBenzMaxim 10:71359af61af8 79 virtual void doRender(Bitmap & bitmap, int xOffset, int yOffset) const;
IanBenzMaxim 0:33d4e66780c0 80
IanBenzMaxim 0:33d4e66780c0 81 private:
IanBenzMaxim 8:a0d75dff3c9b 82 void calculateLayout() const;
IanBenzMaxim 8:a0d75dff3c9b 83
IanBenzMaxim 0:33d4e66780c0 84 std::string m_text;
IanBenzMaxim 0:33d4e66780c0 85 bool m_wordWrap;
IanBenzMaxim 8:a0d75dff3c9b 86 int m_charSpacing;
IanBenzMaxim 8:a0d75dff3c9b 87 int m_lineSpacing;
IanBenzMaxim 8:a0d75dff3c9b 88
IanBenzMaxim 8:a0d75dff3c9b 89 mutable std::list<std::string> m_textLines;
IanBenzMaxim 8:a0d75dff3c9b 90 mutable int m_preferredWidth;
IanBenzMaxim 8:a0d75dff3c9b 91 mutable int m_preferredHeight;
IanBenzMaxim 0:33d4e66780c0 92 };
IanBenzMaxim 0:33d4e66780c0 93
IanBenzMaxim 0:33d4e66780c0 94 #endif