← Back to branch summary

~ubuntu-branches/ubuntu/vivid/psi/vivid

« back to all changes in this revision

Viewing changes to src/sxe/sxeedit.h

  • Committer: Bazaar Package Importer
  • Author(s): Jan Niehusmann
  • Date: 2008-08-28 18:46:52 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080828184652-iiik12dl91nq7cdi
Tags: 0.12-2
http://bugs.debian.org/494352
Uploading to unstable (Closes: Bug#494352)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/sxe/sxeedit.h
 
1
/*
 
2
 * sxeedit.h - The base class for SXE edits
 
3
 * Copyright (C) 2007  Joonas Govenius
 
4
 *
 
5
 * This program is free software; you can redistribute it and/or
 
6
 * modify it under the terms of the GNU General Public License
 
7
 * as published by the Free Software Foundation; either version 2
 
8
 * of the License, or (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 library; if not, write to the Free Software
 
17
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
18
 *
 
19
 */
 
20
 
 
21
#ifndef SXDEEDIT_H
 
22
#define SXDEEDIT_H
 
23
 
 
24
#include <QString>
 
25
#include <QDomNode>
 
26
 
 
27
/*! \brief A class used for storing SXE edits in the undo stacks and in the queue of outgoing edits.*/
 
28
class SxeEdit {
 
29
    public:
 
30
        /*! \brief Describes which kind of edit the object represents.*/
 
31
        enum EditType {New, Record, Remove};
 
32
 
 
33
        /*! \brief Constructor
 
34
         *  Constructs an SxeEdit for a node with \a rid.
 
35
         */
 
36
        SxeEdit(const QString rid, bool remote);
 
37
 
 
38
        virtual ~SxeEdit();
 
39
 
 
40
        /*! \brief Indicates whether the edit is from a remote client.*/
 
41
        bool remote() const;
 
42
        /*! \brief The rid of the edit.*/
 
43
        QString rid() const;
 
44
        /*! \brief The type of edit.*/
 
45
        virtual EditType type() const = 0;
 
46
        /*! \brief The XML (the SXE) representing the edit.*/
 
47
        virtual QDomElement xml(QDomDocument &doc) const = 0;
 
48
        /*! \brief Returns true if \a e renders the SxeEdit ineffective
 
49
         *  (e.g. a SxeRemoveEdit will make a SxeNewEdit ineffective).
 
50
         */
 
51
        bool overrides(const SxeEdit &e) const;
 
52
 
 
53
    protected:
 
54
        /*! \brief The node id of the target.*/
 
55
        QString rid_;
 
56
        /*! \brief Indicates whether the edit is from a remote client.*/
 
57
        bool remote_;
 
58
};
 
59
 
 
60
#endif