KDevelop API Documentation

KDevPartController Class Reference

#include <kdevpartcontroller.h>

Inheritance diagram for KDevPartController:

Inheritance graph
[legend]
Collaboration diagram for KDevPartController:

Collaboration graph
[legend]
List of all members.

Signals

void savedFile (const KURL &)
 Emitted when a document has been saved.
void loadedFile (const KURL &)
 Emitted when a document has been loaded.
void closedFile (const KURL &)
 Emitted when a document has been closed.
void fileDirty (const KURL &)
 Emitted when a file has been modified outside of KDevelop.
void partURLChanged (KParts::ReadOnlyPart *)
 this is typically emitted when an editorpart does "save as" which will change the part's URL
void documentChangedState (const KURL &, DocumentState)
 this is emitted when the document changes, either internally or on disc

Public Member Functions

 KDevPartController (QWidget *parent)
virtual void setEncoding (const QString &encoding)=0
 Call before a call to editDocument to set the encoding of the document to be opened.
virtual void editDocument (const KURL &url, int lineNum=-1, int col=-1)=0
 Open a new or existing document.
virtual void showDocument (const KURL &url, bool newWin=false)=0
 Show a HTML document in the documentation viewer.
virtual void showPart (KParts::Part *part, const QString &name, const QString &shortDescription)=0
 Embed a part into the main area of the mainwindow.
virtual KParts::ReadOnlyPartpartForURL (const KURL &url)=0
 Find the embedded part corresponding to a given URL.
virtual KParts::PartpartForWidget (const QWidget *widget)=0
 Find the embedded part corresponding to a given main widget.
virtual KURL::List openURLs ()=0
 Returns a list of open documents.
virtual void saveAllFiles ()=0
 Save all open files.
virtual void saveFiles (const KURL::List &list)=0
 Save a list of files.
virtual void revertAllFiles ()=0
 Reload all open files.
virtual void revertFiles (const KURL::List &list)=0
 Reload a list of files.
virtual bool closeAllFiles ()=0
 Close all open files.
virtual bool closeFiles (const KURL::List &list)=0
 Close a list of files.
virtual bool closePart (KParts::Part *part)=0
 Close this part (close the window/tab for this part).
virtual void activatePart (KParts::Part *part)=0
 Activate this part.
virtual DocumentState documentState (KURL const &url)=0
 Check the state of a document.

Constructor & Destructor Documentation

KDevPartController::KDevPartController QWidget parent  ) 
 

Definition at line 25 of file kdevpartcontroller.cpp.


Member Function Documentation

virtual void KDevPartController::activatePart KParts::Part part  )  [pure virtual]
 

Activate this part.

Parameters:
part the part to activate

Implemented in PartController.

Referenced by FileListWidget::itemClicked().

virtual bool KDevPartController::closeAllFiles  )  [pure virtual]
 

Close all open files.

Implemented in PartController.

void KDevPartController::closedFile const KURL  )  [signal]
 

Emitted when a document has been closed.

Referenced by PartController::closePart().

virtual bool KDevPartController::closeFiles const KURL::List list  )  [pure virtual]
 

Close a list of files.

Parameters:
list a list of URLs for the files to close

Implemented in PartController.

Referenced by FileListWidget::closeSelectedFiles(), and CloserPart::openDialog().

virtual bool KDevPartController::closePart KParts::Part part  )  [pure virtual]
 

Close this part (close the window/tab for this part).

Parameters:
part the part to close
Returns:

Implemented in PartController.

void KDevPartController::documentChangedState const KURL ,
DocumentState 
[signal]
 

this is emitted when the document changes, either internally or on disc

Referenced by PartController::doEmitState(), PartController::reloadFile(), PartController::saveFile(), and PartController::slotDocumentDirty().

virtual DocumentState KDevPartController::documentState KURL const &  url  )  [pure virtual]
 

Check the state of a document.

Parameters:
url the URL to check
Returns:
the DocumentState enum corresponding to the document state

Implemented in PartController.

Referenced by DiffPart::contextMenu(), and FileListWidget::refreshFileList().

virtual void KDevPartController::editDocument const KURL url,
int  lineNum = -1,
int  col = -1
[pure virtual]
 

Open a new or existing document.

Parameters:
url the URL of the document to open
lineNum the line number to place the cursor at, if applicable
col the column number to place the cursor at, if applicable

Implemented in PartController.

Referenced by QuickOpenClassDialog::accept(), FCConfigWidget::accept(), AddMethodDialog::accept(), AddAttributeDialog::accept(), AddFileDialog::accept(), QtDesignerIntegration::addFunctionToClass(), FileCreatePart::createNewFile(), FCConfigWidget::edit_template_content_button_clicked(), FCConfigWidget::edit_type_content_button_clicked(), ReplaceWidget::editDocument(), ValgrindWidget::executed(), FileSelectorPart::fileSelected(), CppSupportPart::gotoDeclarationLine(), QuickOpenFunctionDialog::gotoFile(), CTagsPart::gotoFinalTag(), CppSupportPart::gotoLine(), SourceNavPart::gotoPos(), BookmarksWidget::itemClicked(), CTags2Widget::itemExecuted(), AppWizardDialog::openAfterGeneration(), OpenWithPart::openAsEncoding(), FileCreatePart::openCreatedFile(), TypeAliasDomBrowserItem::openDeclaration(), ClassDomBrowserItem::openDeclaration(), VariableDomBrowserItem::openDeclaration(), FunctionDomBrowserItem::openDeclaration(), QtDesignerIntegration::openFunction(), FunctionDomBrowserItem::openImplementation(), MakeWidget::searchItem(), Navigator::selectFunctionNav(), ClassBrowserPart::selectMethod(), GenericProjectWidget::showFileDetails(), TrollProjectWidget::slotDetailsContextMenu(), AutoDetailsView::slotDetailsContextMenu(), TrollProjectWidget::slotDetailsExecuted(), AutoDetailsView::slotDetailsExecuted(), PHPSupportPart::slotErrorMessageSelected(), QuickOpenFileDialog::slotExecuted(), GrepViewWidget::slotExecuted(), ClassTreeBase::slotGotoDeclaration(), ClassTreeBase::slotGotoImplementation(), CppSupportPart::slotGotoIncludeFile(), JAVADebugger::JavaDebuggerPart::slotGotoSource(), GDBDebugger::DebuggerPart::slotGotoSource(), FileTreeWidget::slotItemExecuted(), FileGroupsWidget::slotItemExecuted(), ClassTreeBase::slotItemExecuted(), ClassBrowserWidget::slotItemExecuted(), ClassTreeBase::slotItemPressed(), CppSupportPart::slotMakeMember(), CTagsDialog::slotResultClicked(), QuickOpenFileDialog::slotReturnPressed(), AppOutputWidget::slotRowSelected(), ProblemReporter::slotSelected(), and CppSupportPart::slotSwitchHeader().

void KDevPartController::fileDirty const KURL  )  [signal]
 

Emitted when a file has been modified outside of KDevelop.

void KDevPartController::loadedFile const KURL  )  [signal]
 

Emitted when a document has been loaded.

Referenced by PartController::integratePart().

virtual KURL::List KDevPartController::openURLs  )  [pure virtual]
 

Returns a list of open documents.

Returns:
the list of URLs

Implemented in PartController.

virtual KParts::ReadOnlyPart* KDevPartController::partForURL const KURL url  )  [pure virtual]
 

Find the embedded part corresponding to a given URL.

Parameters:
url the URL of the document
Returns:
the corresponding part, 0 if not found.

Implemented in PartController.

Referenced by MakeWidget::createCursor(), FileListWidget::itemClicked(), FileListWidget::partRemoved(), and MakeWidget::slotDocumentOpened().

virtual KParts::Part* KDevPartController::partForWidget const QWidget widget  )  [pure virtual]
 

Find the embedded part corresponding to a given main widget.

Parameters:
widget the parts main widget
Returns:
the corresponding part, 0 if not found

Implemented in PartController.

void KDevPartController::partURLChanged KParts::ReadOnlyPart  )  [signal]
 

this is typically emitted when an editorpart does "save as" which will change the part's URL

Referenced by PartController::showDocument(), and PartController::slotUploadFinished().

virtual void KDevPartController::revertAllFiles  )  [pure virtual]
 

Reload all open files.

Implemented in PartController.

virtual void KDevPartController::revertFiles const KURL::List list  )  [pure virtual]
 

Reload a list of files.

Parameters:
list the list of URLs to reload

Implemented in PartController.

Referenced by FileListWidget::reloadSelectedFiles().

virtual void KDevPartController::saveAllFiles  )  [pure virtual]
 

Save all open files.

Implemented in PartController.

Referenced by AutoProjectPart::buildTarget(), PHPSupportPart::executeInTerminal(), PHPSupportPart::executeOnWebserver(), AutoProjectPart::executeTarget(), ReplaceWidget::makeReplacements(), PascalProjectPart::slotBuild(), HaskellProjectPart::slotBuild(), AdaProjectPart::slotBuild(), TrollProjectWidget::slotBuildProject(), TrollProjectWidget::slotBuildTarget(), TrollProjectWidget::slotCleanTarget(), PascalProjectPart::slotExecute(), HaskellProjectPart::slotExecute(), CustomProjectPart::slotExecute(), AutoProjectPart::slotExecute(), AdaProjectPart::slotExecute(), FortranSupportPart::slotFtnchek(), TrollProjectWidget::slotRebuildProject(), TrollProjectWidget::slotRebuildTarget(), TrollProjectWidget::startMakeCommand(), CustomProjectPart::startMakeCommand(), and AutoProjectPart::startMakeCommand().

void KDevPartController::savedFile const KURL  )  [signal]
 

Emitted when a document has been saved.

Referenced by PartController::saveFile().

virtual void KDevPartController::saveFiles const KURL::List list  )  [pure virtual]
 

Save a list of files.

Parameters:
list the list of URLs to save

Implemented in PartController.

Referenced by FileListWidget::saveSelectedFiles().

virtual void KDevPartController::setEncoding const QString encoding  )  [pure virtual]
 

Call before a call to editDocument to set the encoding of the document to be opened.

Parameters:
encoding the encoding to open as

Implemented in PartController.

Referenced by OpenWithPart::openAsEncoding().

virtual void KDevPartController::showDocument const KURL url,
bool  newWin = false
[pure virtual]
 

Show a HTML document in the documentation viewer.

Parameters:
url the URL of the document to view
newWin if true, the new window will be created instead of using current

Implemented in PartController.

Referenced by DocIndexDialog::accept(), FindDocumentation::clickOnItem(), DocUtils::docItemPopup(), SearchView::executed(), DocumentationPart::infoPage(), ContentsView::itemExecuted(), BookmarkView::itemExecuted(), DocumentationPart::manPage(), DocBookmarkOwner::openBookmarkURL(), FindDocumentation::procInfoReadFromStdout(), FindDocumentation::procManReadFromStdout(), FindDocumentation::searchInContents(), FindDocumentation::searchInGoogle(), IndexView::searchInIndex(), FindDocumentation::searchInIndex(), DocTreeViewPart::slotContextFulltextSearch(), DocTreeViewPart::slotContextGotoManpage(), PHPHTMLView::slotDuplicate(), DocTreeViewWidget::slotIndexItemExecuted(), DocTreeViewWidget::slotItemExecuted(), ChooseDlg::slotItemExecuted(), DocTreeViewPart::slotManpage(), PHPHTMLView::slotOpenInNewWindow(), PerlSupportPart::slotPerldocFAQ(), PerlSupportPart::slotPerldocFunction(), DoxygenPart::slotPreviewProcessExited(), PythonSupportPart::slotPydoc(), and DocTreeViewPart::slotSearchDocumentation().

virtual void KDevPartController::showPart KParts::Part part,
const QString name,
const QString shortDescription
[pure virtual]
 

Embed a part into the main area of the mainwindow.

Parameters:
part the part to embed
name the name of the part
shortDescription currently not used (?)

Implemented in PartController.

Referenced by KDevPlugin::showPart().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:22:47 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003