diff options
| author | Darrell Anderson <humanreadable@yahoo.com> | 2014-03-02 20:05:33 +0100 | 
|---|---|---|
| committer | Slávek Banko <slavek.banko@axis.cz> | 2014-03-02 20:05:33 +0100 | 
| commit | 722ce1efbac31c61b1d4b13f7e075c9f311e3e73 (patch) | |
| tree | db1b6b28566e5fe9accb4a688f7257673cecb080 /lib/interfaces/extensions/tdevdifffrontend.h | |
| parent | afb74575caf7dd8ccb6c235b1c8d788e320c19da (diff) | |
| download | tdevelop-722ce1efbac31c61b1d4b13f7e075c9f311e3e73.tar.gz tdevelop-722ce1efbac31c61b1d4b13f7e075c9f311e3e73.zip | |
Finish renaming tdevelop components
Diffstat (limited to 'lib/interfaces/extensions/tdevdifffrontend.h')
| -rw-r--r-- | lib/interfaces/extensions/tdevdifffrontend.h | 79 | 
1 files changed, 79 insertions, 0 deletions
| diff --git a/lib/interfaces/extensions/tdevdifffrontend.h b/lib/interfaces/extensions/tdevdifffrontend.h new file mode 100644 index 00000000..c0c343cb --- /dev/null +++ b/lib/interfaces/extensions/tdevdifffrontend.h @@ -0,0 +1,79 @@ +/* This file is part of the KDE project +   Copyright (C) 2002 Harald Fernengel <harry@kdevelop.org> +   Copyright (C) 2002 F@lk Brettschneider <falkbr@kdevelop.org> +   Copyright (C) 2003 Roberto Raggi <roberto@kdevelop.org> + +   This library is free software; you can redistribute it and/or +   modify it under the terms of the GNU Library General Public +   License as published by the Free Software Foundation; either +   version 2 of the License, or (at your option) any later version. + +   This library is distributed in the hope that it will be useful, +   but WITHOUT ANY WARRANTY; without even the implied warranty of +   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU +   Library General Public License for more details. + +   You should have received a copy of the GNU Library General Public License +   along with this library; see the file COPYING.LIB.  If not, write to +   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +   Boston, MA 02110-1301, USA. +*/ +#ifndef TDEVDIFFFRONTEND_H +#define TDEVDIFFFRONTEND_H + +#include <kurl.h> +#include <tdevplugin.h> + +/** +@file tdevdifffrontend.h +Diff frontend interface. +*/ + +/** +KDevelop diff frontend interface. +This is the abstract base class for plugins that want to display differencies between +files. + +Instances that implement this interface are available through extension architecture: +@code +TDevDiffFrontend *df = extension<TDevDiffFrontend>("TDevelop/DiffFrontend"); +if (df) { +    // do something +} else { +    // fail +} +@endcode +@sa TDevPlugin::extension method documentation. +*/ +class TDevDiffFrontend : public TDevPlugin +{ + +public: +    /**Constructor. +    @param info Important information about the plugin - plugin internal and generic +    (GUI) name, description, a list of authors, etc. That information is used to show +    plugin information in various places like "about application" dialog, plugin selector +    dialog, etc. Plugin does not take ownership on info object, also its lifetime should +    be equal to the lifetime of the plugin. +    @param parent The parent object for the plugin. Parent object must implement @ref TDevApi +    interface. Otherwise the plugin will not be constructed. +    @param name The internal name which identifies the plugin.*/ +    TDevDiffFrontend( const TDevPluginInfo *info, TQObject *parent=0, const char *name=0 ) +        :TDevPlugin(info, parent, name ? name : "TDevDiffFrontend") {} + +    /**Displays the patch. +    @param diff A string which contains a patch in unified format.*/ +    virtual void showDiff( const TQString& diff ) = 0; + +    /**Displays a patch file. +    @param url An url of the patch file.*/ +    virtual void openURL( const KURL &url ) = 0; + +    /**Displays the difference between the two files. +    @param url1 First file to compare. +    @param url2 Second file to compare.*/ +    virtual void showDiff( const KURL &url1, const KURL &url2 ) = 0; + +}; + +#endif | 
