← Back to branch summary

~ubuntu-branches/ubuntu/raring/kbibtex/raring

« back to all changes in this revision

Viewing changes to src/libkbibtexio/comment.h

  • Committer: Package Import Robot
  • Author(s): Michael Hanke
  • Date: 2011-07-18 09:29:48 UTC
  • mfrom: (1.1.6) (2.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20110718092948-ksxjmg7kdfamolmg
Tags: 0.3-1
http://bugs.debian.org/634255
* First upstream release for KDE4 (Closes: #634255). A number of search
  engines are still missing, in comparison to the 0.2 series.
* Bumped Standards-Version to 3.9.2, no changes necessary.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/libkbibtexio/comment.h
 
1
/***************************************************************************
 
2
*   Copyright (C) 2004-2010 by Thomas Fischer                             *
 
3
*   fischer@unix-ag.uni-kl.de                                             *
 
4
*                                                                         *
 
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.                                   *
 
9
*                                                                         *
 
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.                          *
 
14
*                                                                         *
 
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
 
22
 
 
23
#include <element.h>
 
24
 
 
25
/**
 
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
 
29
 * files.
 
30
 * @author Thomas Fischer <fischer@unix-ag.uni-kl.de>
 
31
 */
 
32
class KBIBTEXIO_EXPORT Comment : public Element
 
33
{
 
34
    Q_PROPERTY(QString text READ text WRITE setText)
 
35
    Q_PROPERTY(bool useCommand READ useCommand WRITE setUseCommand)
 
36
 
 
37
public:
 
38
    /**
 
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
 
42
     */
 
43
    Comment(const QString &text = QString::null, bool useCommand = false);
 
44
 
 
45
    /**
 
46
     * Copy constructor cloning another comment object.
 
47
     * @param other comment object to clone
 
48
     */
 
49
    Comment(const Comment& other);
 
50
 
 
51
    virtual ~Comment();
 
52
 
 
53
    /**
 
54
     * Retrieve the text of this comment.
 
55
     * @return text of this comment
 
56
     */
 
57
    QString text() const;
 
58
 
 
59
    /**
 
60
     * Set the text of this comment.
 
61
     * @param text text of this comment
 
62
     */
 
63
    void setText(const QString &text);
 
64
 
 
65
    /**
 
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
 
68
     */
 
69
    bool useCommand() const;
 
70
 
 
71
    /**
 
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
 
74
     */
 
75
    void setUseCommand(bool useCommand);
 
76
 
 
77
private:
 
78
    class CommentPrivate;
 
79
    CommentPrivate * const d;
 
80
};
 
81
 
 
82
#endif // KBIBTEX_IO_COMMENT_H