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

kdevplatform/vcs

  • KDevelop
  • IPatchSource
Public Types | Signals | Public Member Functions | List of all members
KDevelop::IPatchSource Class Referenceabstract

#include <ipatchsource.h>

Inheritance diagram for KDevelop::IPatchSource:
Inheritance graph
[legend]

Public Types

using Ptr = QPointer< IPatchSource >
 

Signals

void patchChanged ()
 

Public Member Functions

virtual QMap< QUrl, KDevelop::VcsStatusInfo::State > additionalSelectableFiles () const
 
virtual QUrl baseDir () const =0
 
virtual bool canCancel () const
 
virtual void cancelReview ()
 
virtual bool canSelectFiles () const
 
virtual QWidget * customWidget () const
 
virtual uint depth () const
 
virtual QUrl file () const =0
 
virtual bool finishReview (const QList< QUrl > &selection)
 
virtual QString finishReviewCustomText () const
 
virtual QIcon icon () const
 
virtual bool isAlreadyApplied () const =0
 
virtual QString name () const =0
 
virtual void update ()=0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Any entity may delete an IPatchSource based object at will, so it must always be referenced through a QPointer (Just use IPatchSource::Ptr).

Definition at line 32 of file ipatchsource.h.

Member Typedef Documentation

◆ Ptr

using KDevelop::IPatchSource::Ptr = QPointer<IPatchSource>

Definition at line 36 of file ipatchsource.h.

Member Function Documentation

◆ additionalSelectableFiles()

QMap< QUrl, KDevelop::VcsStatusInfo::State > IPatchSource::additionalSelectableFiles ( ) const
virtual

May return an additional list of selectable files together with short description strings for this patch The default implementation returns an empty list.

Reimplemented in VCSDiffPatchSource.

Definition at line 52 of file ipatchsource.cpp.

◆ baseDir()

virtual QUrl KDevelop::IPatchSource::baseDir ( ) const
pure virtual

Should return the base-dir of the patch.

Implemented in VCSDiffPatchSource.

◆ canCancel()

bool IPatchSource::canCancel ( ) const
virtual

Should return whether the user may cancel this review (cancelReview will be called when he does) The default implementation returns false.

Reimplemented in VCSCommitDiffPatchSource.

Definition at line 47 of file ipatchsource.cpp.

◆ cancelReview()

void IPatchSource::cancelReview ( )
virtual

Called when the user has rejected this patch.

Reimplemented in VCSCommitDiffPatchSource.

Definition at line 36 of file ipatchsource.cpp.

◆ canSelectFiles()

bool IPatchSource::canSelectFiles ( ) const
virtual

Should return whether the user should be able to select files of the patch The files available for selection will be all files affected by the patch, and the files return by additionalSelectableFiles() The default implementation returns false.

Reimplemented in VCSCommitDiffPatchSource.

Definition at line 57 of file ipatchsource.cpp.

◆ customWidget()

QWidget * IPatchSource::customWidget ( ) const
virtual

Can return a custom widget that should be shown to the user with this patch The ownership of the widget is shared between the caller and the patch-source (both may delete it at will) The default implementation returns zero.

Reimplemented in VCSCommitDiffPatchSource.

Definition at line 67 of file ipatchsource.cpp.

◆ depth()

uint IPatchSource::depth ( ) const
virtual

Depth - number of directories to left-strip from paths in the patch - see "patch -p" Defaults to 0.

Reimplemented in VCSDiffPatchSource.

Definition at line 72 of file ipatchsource.cpp.

◆ file()

virtual QUrl KDevelop::IPatchSource::file ( ) const
pure virtual

Name of the patch file.

Implemented in VCSDiffPatchSource.

◆ finishReview()

bool IPatchSource::finishReview ( const QList< QUrl > &  selection)
virtual

Called when the user has reviewed and accepted this patch If canSelectFiles() returned true, selection will contain the list of selected files If this returns false, the review is not finished.

Reimplemented in VCSCommitDiffPatchSource.

Definition at line 41 of file ipatchsource.cpp.

◆ finishReviewCustomText()

QString IPatchSource::finishReviewCustomText ( ) const
virtual

May return a custom text for the "Finish Review" action.

The default implementation returns QString(), which means that the default is used

Reimplemented in VCSCommitDiffPatchSource.

Definition at line 62 of file ipatchsource.cpp.

◆ icon()

QIcon IPatchSource::icon ( ) const
virtual

Icon that will be shown with the patch.

Definition at line 26 of file ipatchsource.cpp.

◆ isAlreadyApplied()

virtual bool KDevelop::IPatchSource::isAlreadyApplied ( ) const
pure virtual

Should tell if the patch is already applied on the local version.

Implemented in VCSDiffPatchSource.

◆ name()

virtual QString KDevelop::IPatchSource::name ( ) const
pure virtual

Name of the patch, that will be shown in a combo box.

Should describe the patch in a useful way, for example "Difference to base in kdevplatform/language"

Implemented in VCSDiffPatchSource.

◆ patchChanged

void KDevelop::IPatchSource::patchChanged ( )
signal

Should be emitted whenever the patch has changed.

◆ update()

virtual void KDevelop::IPatchSource::update ( )
pure virtual

Explicit updating of the patch: If it is a dynamic patch, it should re-compare the files or whatever needs to be done If the patch has changed, patchChanged needs to be emitted.

Implemented in VCSDiffPatchSource.


The documentation for this class was generated from the following files:
  • ipatchsource.h
  • ipatchsource.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Mar 8 2021 23:30:50 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/vcs

Skip menu "kdevplatform/vcs"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdevelop API Reference

Skip menu "kdevelop API Reference"
  • kdevplatform
  •   debugger
  •   documentation
  •   interfaces
  •   language
  •     assistant
  •     backgroundparser
  •     checks
  •     classmodel
  •     codecompletion
  •     codegen
  •     duchain
  •     editor
  •     highlighting
  •     interfaces
  •     util
  •   outputview
  •   project
  •   serialization
  •   shell
  •   sublime
  •   tests
  •   util
  •   vcs

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