• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

kompare

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KompareInterface Class Referenceabstract

#include <kompareinterface.h>

Inheritance diagram for KompareInterface:
Inheritance graph
[legend]

Public Member Functions

 KompareInterface ()
 
virtual ~KompareInterface ()
 
virtual void compare (const KUrl &sourceFile, const KUrl &destinationFile)=0
 
virtual void compare3Files (const KUrl &originalFile, const KUrl &changedFile1, const KUrl &changedFile2)=0
 
virtual void compareDirs (const KUrl &sourceDir, const KUrl &destinationDir)=0
 
virtual void compareFiles (const KUrl &sourceFile, const KUrl &destinationFile)=0
 
virtual void compareFileString (const KUrl &sourceFile, const QString &destination)=0
 
virtual void compareStringFile (const QString &source, const KUrl &destinationFile)=0
 
virtual bool openDiff (const KUrl &diffUrl)=0
 
virtual bool openDiff (const QString &diffOutput)=0
 
virtual bool openDiff3 (const KUrl &diff3Url)=0
 
virtual bool openDiff3 (const QString &diff3Output)=0
 
virtual void openDirAndDiff (const KUrl &dir, const KUrl &diffFile)=0
 
virtual void openFileAndDiff (const KUrl &file, const KUrl &diffFile)=0
 
virtual bool queryClose ()=0
 
virtual int readProperties (KConfig *config)=0
 
virtual int saveProperties (KConfig *config)=0
 
virtual void setEncoding (const QString &encoding)
 

Protected Member Functions

 KompareInterface (const KompareInterface &)
 
KompareInterface & operator= (const KompareInterface &)
 

Protected Attributes

KompareInterfacePrivate * kip
 
QString m_encoding
 

Detailed Description

Definition at line 32 of file kompareinterface.h.

Constructor & Destructor Documentation

KompareInterface::KompareInterface ( )

Definition at line 51 of file kompareinterface.cpp.

KompareInterface::~KompareInterface ( )
virtual

Definition at line 56 of file kompareinterface.cpp.

KompareInterface::KompareInterface ( const KompareInterface &  ki)
protected

Definition at line 61 of file kompareinterface.cpp.

Member Function Documentation

virtual void KompareInterface::compare ( const KUrl &  sourceFile,
const KUrl &  destinationFile 
)
pure virtual

Compare, with diff, source with destination, can also be used if you do not know what source and destination are.

The part will try to figure out what they are (directory, file, diff output file) and call the appropriate method(s)

Implemented in KomparePart.

virtual void KompareInterface::compare3Files ( const KUrl &  originalFile,
const KUrl &  changedFile1,
const KUrl &  changedFile2 
)
pure virtual

Compare, with diff3, originalFile with changedFile1 and changedFile2.

Implemented in KomparePart.

virtual void KompareInterface::compareDirs ( const KUrl &  sourceDir,
const KUrl &  destinationDir 
)
pure virtual

Compare, with diff, source with destination directories.

Implemented in KomparePart.

virtual void KompareInterface::compareFiles ( const KUrl &  sourceFile,
const KUrl &  destinationFile 
)
pure virtual

Compare, with diff, source with destination files.

Implemented in KomparePart.

virtual void KompareInterface::compareFileString ( const KUrl &  sourceFile,
const QString &  destination 
)
pure virtual

Compare a Source file to a custom Destination string.

Implemented in KomparePart.

virtual void KompareInterface::compareStringFile ( const QString &  source,
const KUrl &  destinationFile 
)
pure virtual

Compare a custom Source string to a Destination file.

Implemented in KomparePart.

virtual bool KompareInterface::openDiff ( const KUrl &  diffUrl)
pure virtual

Open and parse the diff file at url.

Implemented in KomparePart.

virtual bool KompareInterface::openDiff ( const QString &  diffOutput)
pure virtual

Open and parse the supplied diff output.

Implemented in KomparePart.

virtual bool KompareInterface::openDiff3 ( const KUrl &  diff3Url)
pure virtual

Open and parse the diff3 file at url.

Implemented in KomparePart.

virtual bool KompareInterface::openDiff3 ( const QString &  diff3Output)
pure virtual

Open and parse the supplied diff3 output.

Implemented in KomparePart.

virtual void KompareInterface::openDirAndDiff ( const KUrl &  dir,
const KUrl &  diffFile 
)
pure virtual

This will show the directory and the directory with the diff applied.

Implemented in KomparePart.

virtual void KompareInterface::openFileAndDiff ( const KUrl &  file,
const KUrl &  diffFile 
)
pure virtual

This will show the file and the file with the diff applied.

Implemented in KomparePart.

KompareInterface & KompareInterface::operator= ( const KompareInterface &  ki)
protected

Definition at line 66 of file kompareinterface.cpp.

virtual bool KompareInterface::queryClose ( )
pure virtual

Warning this should be in class ReadWritePart in KDE 4.0, not here ! Around that time the method will disappear here.

Implemented in KomparePart.

virtual int KompareInterface::readProperties ( KConfig *  config)
pure virtual

Warning this should be in class Part in KDE 4.0, not here ! Around that time the methods will disappear here.

Implemented in KomparePart.

virtual int KompareInterface::saveProperties ( KConfig *  config)
pure virtual

Implemented in KomparePart.

void KompareInterface::setEncoding ( const QString &  encoding)
virtual

This will set the encoding to use for all files that are read or for the diffoutput.

Reimplemented in KomparePart.

Definition at line 72 of file kompareinterface.cpp.

Member Data Documentation

KompareInterfacePrivate* KompareInterface::kip
protected

Definition at line 127 of file kompareinterface.h.

QString KompareInterface::m_encoding
protected

Definition at line 128 of file kompareinterface.h.


The documentation for this class was generated from the following files:
  • kompareinterface.h
  • kompareinterface.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:40:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kompare

Skip menu "kompare"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • umbrello
  •   umbrello

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