← Back to branch summary

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

« back to all changes in this revision

Viewing changes to src/libkbibtexio/macro.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/macro.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
 
 
21
#ifndef KBIBTEX_IO_MACRO_H
 
22
#define KBIBTEX_IO_MACRO_H
 
23
 
 
24
#include <element.h>
 
25
#include <value.h>
 
26
 
 
27
class QString;
 
28
 
 
29
/**
 
30
 * This class represents a macro in a BibTeX file. Macros in BibTeX
 
31
 * are similar to variables, allowing to use the same value such as
 
32
 * journal titles in several entries.
 
33
 * @author Thomas Fischer <fischer@unix-ag.uni-kl.de>
 
34
 */
 
35
class KBIBTEXIO_EXPORT Macro : public Element
 
36
{
 
37
    Q_PROPERTY(QString key READ key WRITE setKey)
 
38
    Q_PROPERTY(Value value READ value WRITE setValue)
 
39
 
 
40
public:
 
41
    /**
 
42
     * Create a new macro with a given key-value pair.
 
43
     * @param key macro's key
 
44
     * @param value macro's value
 
45
     */
 
46
    Macro(const QString& key = QString::null, const Value& value = Value());
 
47
 
 
48
    /**
 
49
     * Copy constructor cloning another macro object.
 
50
     * @param other macro object to clone
 
51
     */
 
52
    Macro(const Macro &other);
 
53
 
 
54
    virtual ~Macro();
 
55
 
 
56
    /**
 
57
     * Assignment operator, working similar to a copy constructor,
 
58
     * but overwrites the current object's values.
 
59
     */
 
60
    Macro& operator= (const Macro& other);
 
61
 
 
62
    /**
 
63
     * Set the key of this macro.
 
64
     * @param key new key of this macro
 
65
     */
 
66
    void setKey(const QString &key);
 
67
 
 
68
    /**
 
69
     * Retrieve the key of this macro.
 
70
     * @return key of this comment
 
71
     */
 
72
    QString key() const;
 
73
 
 
74
    /**
 
75
     * Retrieve the key of this macro. Returns a reference which may not be modified.
 
76
     * @return key of this comment
 
77
     */
 
78
    const Value& value() const;
 
79
 
 
80
    /**
 
81
     * Retrieve the key of this macro. Returns a reference which may be modified.
 
82
     * @return key of this comment
 
83
     */
 
84
    Value& value();
 
85
 
 
86
    /**
 
87
     * Set the value of this macro.
 
88
     * @param value new value of this macro
 
89
     */
 
90
    void setValue(const Value& value);
 
91
 
 
92
private:
 
93
    class MacroPrivate;
 
94
    MacroPrivate * const d;
 
95
};
 
96
 
 
97
 
 
98
#endif