← Back to branch summary

~ubuntu-branches/ubuntu/precise/kbibtex/precise

« back to all changes in this revision

Viewing changes to src/libkbibtexio/file.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/file.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_FILE_H
 
22
#define KBIBTEX_IO_FILE_H
 
23
 
 
24
#include <QList>
 
25
#include <QStringList>
 
26
 
 
27
#include <KUrl>
 
28
 
 
29
#include <element.h>
 
30
 
 
31
#include "kbibtexio_export.h"
 
32
 
 
33
class Element;
 
34
 
 
35
/**
 
36
 * This class represents a bibliographic file such as a BibTeX
 
37
 * (or any other format after proper conversion). The files content
 
38
 * can be accessed using the inherited QList interface (for example
 
39
 * list iterators).
 
40
 * @see Element
 
41
 * @author Thomas Fischer <fischer@unix-ag.uni-kl.de>
 
42
 */
 
43
class KBIBTEXIO_EXPORT File : public QList<Element*>
 
44
{
 
45
public:
 
46
    /// used for property map
 
47
    const static QString Url, Encoding;
 
48
 
 
49
    File();
 
50
    virtual ~File();
 
51
 
 
52
    /**
 
53
     * Check if a given key,for example a key for a macro or an id for an entry
 
54
     * is contained in the file object.
 
55
     * @see #allKeys() const
 
56
     * @return @c the object addressed by the key @c NULL if no such file has been found
 
57
     */
 
58
    const Element *containsKey(const QString &key) const;
 
59
 
 
60
    /**
 
61
     * Retrieves a list of all keys for example from macros or entries.
 
62
     * @see #const containsKey(const QString &) const
 
63
     * @return list of keys
 
64
     */
 
65
    QStringList allKeys() const;
 
66
 
 
67
    void setProperty(const QString &key, const QVariant &value);
 
68
    QVariant property(const QString &key) const;
 
69
    QVariant property(const QString &key, const QVariant &defaultValue) const;
 
70
    bool hasProperty(const QString &key) const;
 
71
 
 
72
private:
 
73
    class FilePrivate;
 
74
    FilePrivate *d;
 
75
};
 
76
 
 
77
#endif // KBIBTEX_IO_FILE_H