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_commit_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_COMMIT_PARAMETER_H
0034 #define CLIENT_COMMIT_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 #include <svnqt/targets.h>
0042 
0043 namespace svn
0044 {
0045 struct CommitParameterData;
0046 class SVNQT_EXPORT CommitParameter
0047 {
0048 private:
0049     QScopedPointer<CommitParameterData> _data;
0050 
0051 public:
0052     CommitParameter();
0053     ~CommitParameter();
0054 
0055     //! files to commit.
0056     CommitParameter &targets(const Targets &targets);
0057     //! files to commit.
0058     const Targets &targets() const;
0059     //! log message. if QString() svnqt ask for a message
0060     CommitParameter &message(const QString &message);
0061     //! log message. if QString() svnqt ask for a message
0062     const QString &message() const;
0063     //! default empty
0064     CommitParameter &changeList(const StringArray &_changeList);
0065     //! default empty
0066     const StringArray &changeList() const;
0067     //! default empty
0068     CommitParameter &revisionProperties(const PropertiesMap &_revProps);
0069     //! default empty
0070     const PropertiesMap &revisionProperties() const;
0071     //! default DepthInfinity
0072     CommitParameter &depth(Depth depth);
0073     //! default DepthInfinity
0074     Depth depth() const;
0075     //! if false unlock items in path (default)
0076     CommitParameter &keepLocks(bool _keep);
0077     //! if false unlock items in path (default)
0078     bool keepLocks() const;
0079     //! default false
0080     CommitParameter &keepChangeList(bool _keep);
0081     //! default false
0082     bool keepChangeList() const;
0083     //! default false
0084     CommitParameter &commitAsOperations(bool _keep);
0085     //! default false
0086     bool commitAsOperations() const;
0087 };
0088 }
0089 
0090 #endif