File indexing completed on 2024-05-19 04:21:16

0001 // vim: set tabstop=4 shiftwidth=4 expandtab:
0002 /*
0003 Gwenview: an image viewer
0004 Copyright 2008 Aurélien Gâteau <agateau@kde.org>
0005 
0006 This program is free software; you can redistribute it and/or
0007 modify it under the terms of the GNU General Public License
0008 as published by the Free Software Foundation; either version 2
0009 of the License, or (at your option) any later version.
0010 
0011 This program is distributed in the hope that it will be useful,
0012 but WITHOUT ANY WARRANTY; without even the implied warranty of
0013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0014 GNU General Public License for more details.
0015 
0016 You should have received a copy of the GNU General Public License
0017 along with this program; if not, write to the Free Software
0018 Foundation, Inc., 51 Franklin Street, Fifth Floor, Cambridge, MA 02110-1301, USA.
0019 
0020 */
0021 #ifndef ABSTRACTDOCUMENTEDITOR_H
0022 #define ABSTRACTDOCUMENTEDITOR_H
0023 
0024 #include <lib/gwenviewlib_export.h>
0025 
0026 // Qt
0027 
0028 // KF
0029 
0030 // Local
0031 #include <lib/orientation.h>
0032 
0033 class QImage;
0034 
0035 namespace Gwenview
0036 {
0037 /**
0038  * An interface which can be returned by some implementations of
0039  * AbstractDocumentImpl if they support edition.
0040  */
0041 class GWENVIEWLIB_EXPORT AbstractDocumentEditor
0042 {
0043 public:
0044     virtual ~AbstractDocumentEditor() = default;
0045 
0046     /**
0047      * Replaces the current image with image.
0048      * Calling this while the document is loaded won't do anything.
0049      *
0050      * This method should only be called from a subclass of
0051      * AbstractImageOperation and applied through Document::undoStack().
0052      */
0053     virtual void setImage(const QImage &) = 0;
0054 
0055     /**
0056      * Apply a transformation to the document image.
0057      *
0058      * Transformations are handled by the Document class because it can be
0059      * done in a lossless way by some Document implementations.
0060      *
0061      * This method should only be called from a subclass of
0062      * AbstractImageOperation and applied through Document::undoStack().
0063      */
0064     virtual void applyTransformation(Orientation) = 0;
0065 };
0066 
0067 } // namespace
0068 
0069 #endif /* ABSTRACTDOCUMENTEDITOR_H */