source: wkhtmltox/trunk/fuentes/src/shared/outputter.cc @ 51

Last change on this file since 51 was 51, checked in by mabarracus, 4 years ago

wip

File size: 2.7 KB
Line 
1// -*- mode: c++; tab-width: 4; indent-tabs-mode: t; eval: (progn (c-set-style "stroustrup") (c-set-offset 'innamespace 0)); -*-
2// vi:set ts=4 sts=4 sw=4 noet :
3//
4// Copyright 2010, 2011 wkhtmltopdf authors
5//
6// This file is part of wkhtmltopdf.
7//
8// wkhtmltopdf is free software: you can redistribute it and/or modify
9// it under the terms of the GNU Lesser General Public License as published by
10// the Free Software Foundation, either version 3 of the License, or
11// (at your option) any later version.
12//
13// wkhtmltopdf is distributed in the hope that it will be useful,
14// but WITHOUT ANY WARRANTY; without even the implied warranty of
15// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16// GNU General Public License for more details.
17//
18// You should have received a copy of the GNU Lesser General Public License
19// along with wkhtmltopdf.  If not, see <http://www.gnu.org/licenses/>.
20
21#include "outputter.hh"
22
23/*!
24  \class Outputter
25  \brief Interface for classes used to output documentation
26*/
27
28/*!
29  \fn Outputter::beginSection(const QString & name)
30  Add a new section to the output
31  \param name The name of the section
32*/
33
34/*!
35  \fn Outputter::endSection()
36  End the current section
37*/
38
39/*!
40  \fn Outputter::beginParagraph()
41  Begin a text paragraph
42*/
43
44/*!
45  \fn Outputter::text(const QString & t)
46  Add some text to the current paragraph
47  \param t The text to add
48*/
49
50/*!
51  \fn Outputter::bold(const QString & t) =  0;
52  Add some bold text to the current paragraph
53  \param t The text to add
54*/
55
56/*!
57  \fn Outputter::italic(const QString & t)
58  Add some italic text tho the current paragraph
59  \param t The text to add
60*/
61
62/*!
63  \fn Outputter::link(const QString & l)
64  Add a hyperlink to somewhere
65  \param l The url to link to
66*/
67
68/*!
69  \fn Outputter::endParagraph()
70  End the current paragraph
71*/
72
73/*!
74  \fn Outputter::verbatim(const QString & t)
75  Add a pice of code or verbatime text
76  \param t The text to add
77*/
78
79/*!
80  \fn Outputter::beginList(bool ordered=false)
81  Begin a ordered or unordered listing
82  \param ordered Should the list be ordered
83*/
84
85/*!
86  \fn Outputter::endList()
87  End the current listing
88*/
89
90/*!
91  \fn Outputter::listItem(QString & t)
92  Add an item to the current listing
93  \param t The text to add
94*/
95
96/*!
97  \fn Outputter::beginSwitch()
98  Begin a section with command line switches
99*/
100
101
102/*!
103  \fn Outputter::cswitch(const ArgHandler * h, bool doc)
104  Output a switch description
105  \param h The switch to add
106  \param doc Are we outputting to documentation
107*/
108
109/*!
110  \fn Outputter::endSwitch()
111  End a switch section
112*/
113
114
115/*!
116  Output a paragraph of simple text
117*/
118void Outputter::paragraph(const QString & t) {
119        beginParagraph();
120        text(t);
121        endParagraph();
122}
Note: See TracBrowser for help on using the repository browser.