• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kde-baseapps API Reference
  • KDE Home
  • Contact Us
 

libkonq

  • sources
  • kde-4.14
  • kde-baseapps
  • lib
  • konq
kversioncontrolplugin2.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Copyright (C) 2011 by Vishesh Yadav <vishesh3y@gmail.com> *
3  * Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com> *
4  * *
5  * This library is free software; you can redistribute it and/or *
6  * modify it under the terms of the GNU Library General Public *
7  * License version 2 as published by the Free Software Foundation. *
8  * *
9  * This library is distributed in the hope that it will be useful, *
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
12  * Library General Public License for more details. *
13  * *
14  * You should have received a copy of the GNU Library General Public License *
15  * along with this library; see the file COPYING.LIB. If not, write to *
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, *
17  * Boston, MA 02110-1301, USA. *
18  *****************************************************************************/
19 
20 #ifndef KVERSIONCONTROLPLUGIN2_H
21 #define KVERSIONCONTROLPLUGIN2_H
22 
23 #include <libkonq_export.h>
24 #include <kversioncontrolplugin.h>
25 
81 class LIBKONQ_EXPORT KVersionControlPlugin2 : public KVersionControlPlugin
82 {
83  Q_OBJECT
84 
85 public:
86  enum ItemVersion
87  {
89  UnversionedVersion,
94  NormalVersion,
99  UpdateRequiredVersion,
105  LocallyModifiedVersion,
110  AddedVersion,
115  RemovedVersion,
121  ConflictingVersion,
128  LocallyModifiedUnstagedVersion,
134  IgnoredVersion,
141  MissingVersion
142  };
143 
144  KVersionControlPlugin2(QObject* parent = 0);
145  virtual ~KVersionControlPlugin2();
146 
152  virtual QString fileName() const = 0;
153 
160  virtual bool beginRetrieval(const QString& directory) = 0;
161 
168  virtual void endRetrieval() = 0;
169 
176  virtual ItemVersion itemVersion(const KFileItem& item) const = 0;
177 
186  virtual QList<QAction*> actions(const KFileItemList& items) const = 0;
187 
189  virtual VersionState versionState(const KFileItem& item);
190 
192  virtual QList<QAction*> contextMenuActions(const KFileItemList& items);
193 
195  virtual QList<QAction*> contextMenuActions(const QString& directory);
196 
197 signals:
207  void itemVersionsChanged();
208 
213  void infoMessage(const QString& msg);
214 
219  void errorMessage(const QString& msg);
220 
225  void operationCompletedMessage(const QString& msg);
226 };
227 
228 #endif // KVERSIONCONTROLPLUGIN2_H
229 
KVersionControlPlugin
Base class for version control plugins.
Definition: kversioncontrolplugin.h:43
KVersionControlPlugin2::RemovedVersion
The file is under version control but has been marked for getting removed with the next commit...
Definition: kversioncontrolplugin2.h:115
kversioncontrolplugin.h
KVersionControlPlugin2::NormalVersion
The file is under version control and represents the latest version.
Definition: kversioncontrolplugin2.h:94
KVersionControlPlugin2::IgnoredVersion
The file is not under version control and is listed in the ignore list of the version control system...
Definition: kversioncontrolplugin2.h:134
KVersionControlPlugin2::ItemVersion
ItemVersion
Definition: kversioncontrolplugin2.h:86
KVersionControlPlugin2::UnversionedVersion
The file is not under version control.
Definition: kversioncontrolplugin2.h:89
KVersionControlPlugin::endRetrieval
virtual void endRetrieval()=0
Is invoked after the version control information has been received.
KVersionControlPlugin::beginRetrieval
virtual bool beginRetrieval(const QString &directory)=0
Is invoked whenever the version control information will get retrieved for the directory directory...
QObject
KVersionControlPlugin::errorMessage
void errorMessage(const QString &msg)
Is emitted if an error message with the content msg should be shown.
QString
QList< QAction * >
KVersionControlPlugin2::ConflictingVersion
The file is under version control and has been locally modified.
Definition: kversioncontrolplugin2.h:121
libkonq_export.h
KVersionControlPlugin2::LocallyModifiedUnstagedVersion
The file is under version control and has local modifications, which will not be part of the next com...
Definition: kversioncontrolplugin2.h:128
KVersionControlPlugin2
Base class for version control plugins.
Definition: kversioncontrolplugin2.h:81
LIBKONQ_EXPORT
#define LIBKONQ_EXPORT
Definition: libkonq_export.h:36
KVersionControlPlugin2::AddedVersion
The file has not been under version control but has been marked to get added with the next commit...
Definition: kversioncontrolplugin2.h:110
KVersionControlPlugin::fileName
virtual QString fileName() const =0
Returns the name of the file which stores the version controls information.
KVersionControlPlugin::infoMessage
void infoMessage(const QString &msg)
Is emitted if an information message with the content msg should be shown.
KVersionControlPlugin::operationCompletedMessage
void operationCompletedMessage(const QString &msg)
Is emitted if an "operation completed" message with the content msg should be shown.
KVersionControlPlugin::versionState
virtual VersionState versionState(const KFileItem &item)=0
Returns the version state for the file item.
KVersionControlPlugin2::UpdateRequiredVersion
The file is under version control and a newer version exists on the main branch.
Definition: kversioncontrolplugin2.h:99
KVersionControlPlugin2::LocallyModifiedVersion
The file is under version control and has been modified locally.
Definition: kversioncontrolplugin2.h:105
KVersionControlPlugin::contextMenuActions
virtual QList< QAction * > contextMenuActions(const KFileItemList &items)=0
Returns the list of actions that should be shown in the context menu for the files items...
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:07:48 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

libkonq

Skip menu "libkonq"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kde-baseapps API Reference

Skip menu "kde-baseapps API Reference"
  • Libraries
  •   libkonq

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal