File indexing completed on 2024-04-28 05:42:07

0001 /***************************************************************************
0002  *   Copyright (C) 2005-2009 by Rajko Albrecht                             *
0003  *   ral@alwins-world.de                                                   *
0004  *                                                                         *
0005  * This program is free software; you can redistribute it and/or           *
0006  * modify it under the terms of the GNU Lesser General Public              *
0007  * License as published by the Free Software Foundation; either            *
0008  * version 2.1 of the License, or (at your option) any later version.      *
0009  *                                                                         *
0010  * This program is distributed in the hope that it will be useful,         *
0011  * but WITHOUT ANY WARRANTY; without even the implied warranty of          *
0012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU       *
0013  * Lesser General Public License for more details.                         *
0014  *                                                                         *
0015  * You should have received a copy of the GNU Lesser General Public        *
0016  * License along with this program (in the file LGPL.txt); if not,         *
0017  * write to the Free Software Foundation, Inc., 51 Franklin St,            *
0018  * Fifth Floor, Boston, MA  02110-1301  USA                                *
0019  *                                                                         *
0020  * This software consists of voluntary contributions made by many          *
0021  * individuals.  For exact contribution history, see the revision          *
0022  * history and logs, available at https://commits.kde.org/kdesvn.          *
0023  ***************************************************************************/
0024 /*!
0025  * \file client_annotate_parameter.h
0026  * \brief defining classes working as named parameters for different subversion commit
0027  *
0028  * Subversion has various functions which has growing / changing parameter lists from version to version.
0029  * since subversion 1.4 this changes are more and more unhandy for a c++ wrapper due every time changes to
0030  * virtual class. This special data containers may reduce changes of signatures to the client interface.
0031  */
0032 
0033 #ifndef CLIENT_ANNOTATE_PARAMETER_H
0034 #define CLIENT_ANNOTATE_PARAMETER_H
0035 
0036 #include <QScopedPointer>
0037 #include <svnqt/path.h>
0038 #include <svnqt/revision.h>
0039 #include <svnqt/svnqt_defines.h>
0040 #include <svnqt/svnqttypes.h>
0041 
0042 namespace svn
0043 {
0044 class DiffOptions;
0045 struct AnnotateParameterData;
0046 class SVNQT_EXPORT AnnotateParameter
0047 {
0048 private:
0049     QScopedPointer<AnnotateParameterData> _data;
0050 
0051 public:
0052     AnnotateParameter();
0053     ~AnnotateParameter();
0054 
0055     //! file to annotate.
0056     AnnotateParameter &path(const Path &path);
0057     //! file to annotate.
0058     const Path &path() const;
0059 
0060     AnnotateParameter &revisionRange(const RevisionRange &range);
0061     const RevisionRange &revisionRange() const;
0062     AnnotateParameter &pegRevision(const Revision &peg);
0063     const Revision &pegRevision() const;
0064     AnnotateParameter &diffOptions(const DiffOptions &options);
0065     const DiffOptions &diffOptions() const;
0066     AnnotateParameter &ignoreMimeTypes(bool ignore);
0067     bool ignoreMimeTypes() const;
0068     AnnotateParameter &includeMerged(bool inc);
0069     bool includeMerged() const;
0070 };
0071 }
0072 
0073 #endif