| 1 | /* |
| 2 | Printable.h - Interface class that allows printing of complex types |
| 3 | Copyright (c) 2011 Adrian McEwen. All right reserved. |
| 4 | |
| 5 | This library is free software; you can redistribute it and/or |
| 6 | modify it under the terms of the GNU Lesser General Public |
| 7 | License as published by the Free Software Foundation; either |
| 8 | version 2.1 of the License, or (at your option) any later version. |
| 9 | |
| 10 | This library is distributed in the hope that it will be useful, |
| 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 13 | Lesser General Public License for more details. |
| 14 | |
| 15 | You should have received a copy of the GNU Lesser General Public |
| 16 | License along with this library; if not, write to the Free Software |
| 17 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 18 | */ |
| 19 |
|
| 20 | #ifndef Printable_h |
| 21 | #define Printable_h |
| 22 |
|
| 23 | #include <stdlib.h> |
| 24 |
|
| 25 | class Print; |
| 26 |
|
| 27 | /** The Printable class provides a way for new classes to allow themselves to be printed. |
| 28 | By deriving from Printable and implementing the printTo method, it will then be possible |
| 29 | for users to print out instances of this class by passing them into the usual |
| 30 | Print::print and Print::println methods. |
| 31 | */ |
| 32 |
|
| 33 | class Printable |
| 34 | { |
| 35 | public: |
| 36 | virtual size_t printTo(Print& p) const = 0; |
| 37 | }; |
| 38 |
|
| 39 | #endif |
| 40 |
|
| 41 |
|