1
/***************************************************************************
2
* Copyright (C) 2004-2010 by Thomas Fischer *
3
* fischer@unix-ag.uni-kl.de *
5
* This program is free software; you can redistribute it and/or modify *
6
* it under the terms of the GNU General Public License as published by *
7
* the Free Software Foundation; either version 2 of the License, or *
8
* (at your option) any later version. *
10
* This program 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 *
13
* GNU General Public License for more details. *
15
* You should have received a copy of the GNU General Public License *
16
* along with this program; if not, write to the *
17
* Free Software Foundation, Inc., *
18
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19
***************************************************************************/
20
#ifndef KBIBTEX_IO_COMMENT_H
21
#define KBIBTEX_IO_COMMENT_H
26
* This class represents a comment in a BibTeX file. In BibTeX files,
27
* everything that cannot be interpreted as a BibTeX comment is see
28
* as a comment. Alternatively, the comment command can be used in BibTeX
30
* @author Thomas Fischer <fischer@unix-ag.uni-kl.de>
32
class KBIBTEXIO_EXPORT Comment : public Element
34
Q_PROPERTY(QString text READ text WRITE setText)
35
Q_PROPERTY(bool useCommand READ useCommand WRITE setUseCommand)
39
* Create a new comment with a given text.
40
* @param text comment's textual content
41
* @param useCommand mark this comment to use BibTeX's comment command
43
Comment(const QString &text = QString::null, bool useCommand = false);
46
* Copy constructor cloning another comment object.
47
* @param other comment object to clone
49
Comment(const Comment& other);
54
* Retrieve the text of this comment.
55
* @return text of this comment
60
* Set the text of this comment.
61
* @param text text of this comment
63
void setText(const QString &text);
66
* Retrieve the flag whether to use BibTeX's comment command or not.
67
* @return mark if this comment has to use BibTeX's comment command
69
bool useCommand() const;
72
* Set the flag whether to use BibTeX's comment command or not.
73
* @param useCommand set if this comment has to use BibTeX's comment command
75
void setUseCommand(bool useCommand);
79
CommentPrivate * const d;
82
#endif // KBIBTEX_IO_COMMENT_H