KDevelop API Documentation

KDevLanguageSupport Class Reference

#include <kdevlanguagesupport.h>

Inheritance diagram for KDevLanguageSupport:

KDevPlugin QObject KXMLGUIClient AdaSupportPart BashSupportPart CppSupportPart FortranSupportPart HaskellSupportPart JavaSupportPart PascalSupportPart PerlSupportPart PHPSupportPart PythonSupportPart RubySupportPart SQLSupportPart List of all members.

Public Types

enum  Features {
  Classes = 1, Structs = 2, Functions = 4, Variables = 8,
  Namespaces = 16, Signals = 32, Slots = 64, Declarations = 128,
  NewClass = 512, AddMethod = 1024, AddAttribute = 2048, Scripts = 4096,
  NewScript = 8192
}

Signals

void updatedSourceInfo ()
 Emitted when the content of the classtore has been modified.

void aboutToRemoveSourceInfo (const QString &fileName)
 Emitted before remove the file from the classstore.

void removedSourceInfo (const QString &fileName)
 Emitted when a file has been removed from the classstore.

void addedSourceInfo (const QString &fileName)
 Emitted when a file has been added Emitted when a file has been removed from the classstorefrom the classstore.


Public Member Functions

 KDevLanguageSupport (const QString &pluginName, const QString &icon, QObject *parent, const char *name)
 ~KDevLanguageSupport ()
virtual Features features ()
 Returns the feature set of the language.

virtual KMimeType::List mimeTypes ()
 Returns a typical mimetype list for the support language should be configurable in the languagesupport dialog.

virtual QString formatTag (const Tag &tag)
 Formats a Tag as used by the class store to the human-readable convention.

virtual QString formatModelItem (const CodeModelItem *item, bool shortDescription=false)
 Formats a CodeModelItem as used by the CodeModel to the human-readable convention.

virtual QString formatClassName (const QString &name)
 Formats a canonicalized class path as used by the class store to the human-readable convention.

virtual QString unformatClassName (const QString &name)
 The opposite of formatClassName().

virtual void addClass ()
 Opens a "New class" dialog and adds the configured class to the sources.

virtual void addMethod (ClassDom klass)
 Opens an "Add method" dialog and adds the configured method to the sources.

virtual void implementVirtualMethods (ClassDom klass)
 Opens an "Implement Virtual Methods" dialog and adds the configured methods to the sources.

virtual void addAttribute (ClassDom klass)
 Opens an "Add attribute" dialog and adds the configured method to the sources.

virtual QStringList subclassWidget (const QString &formName)
 Opens an "Subclass Widget" dialog for given Qt .ui file (formName) and propmts to implement it's slots.

virtual QStringList updateWidget (const QString &formName, const QString &fileName)
 Opens and "Update Widget" dialog for given Qt .ui file (formName) and prompts to add missing slot implementations in the subclass located in fileName.


Member Enumeration Documentation

enum KDevLanguageSupport::Features
 

Enumeration values:
Classes 
Structs 
Functions 
Variables 
Namespaces 
Signals 
Slots 
Declarations 
NewClass 
AddMethod 
AddAttribute 
Scripts 
NewScript 

Definition at line 46 of file kdevlanguagesupport.h.

Referenced by features().


Constructor & Destructor Documentation

KDevLanguageSupport::KDevLanguageSupport const QString pluginName,
const QString icon,
QObject parent,
const char *  name
 

Definition at line 29 of file kdevlanguagesupport.cpp.

References KDevLanguageSupport().

Referenced by KDevLanguageSupport().

KDevLanguageSupport::~KDevLanguageSupport  ) 
 

Definition at line 34 of file kdevlanguagesupport.cpp.


Member Function Documentation

void KDevLanguageSupport::aboutToRemoveSourceInfo const QString fileName  )  [signal]
 

Emitted before remove the file from the classstore.

void KDevLanguageSupport::addAttribute ClassDom  klass  )  [virtual]
 

Opens an "Add attribute" dialog and adds the configured method to the sources.

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 75 of file kdevlanguagesupport.cpp.

References addAttribute().

Referenced by addAttribute(), ClassViewPart::selectedAddAttribute(), ClassViewWidget::slotAddAttribute(), and ClassTreeBase::slotAddAttribute().

void KDevLanguageSupport::addClass  )  [virtual]
 

Opens a "New class" dialog and adds the configured class to the sources.

Todo:
Use KDevNode stuff for this

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 63 of file kdevlanguagesupport.cpp.

Referenced by ClassViewPart::selectedAddClass(), and ClassViewWidget::slotNewClass().

void KDevLanguageSupport::addedSourceInfo const QString fileName  )  [signal]
 

Emitted when a file has been added Emitted when a file has been removed from the classstorefrom the classstore.

void KDevLanguageSupport::addMethod ClassDom  klass  )  [virtual]
 

Opens an "Add method" dialog and adds the configured method to the sources.

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 67 of file kdevlanguagesupport.cpp.

References addMethod(), and ClassDom.

Referenced by addMethod(), ClassViewPart::selectedAddMethod(), ClassViewWidget::slotAddMethod(), and ClassTreeBase::slotAddMethod().

KDevLanguageSupport::Features KDevLanguageSupport::features  )  [virtual]
 

Returns the feature set of the language.

This is e.g. used by the class view to decide which organizer items to display and which not.

Reimplemented in AdaSupportPart, BashSupportPart, CppSupportPart, FortranSupportPart, HaskellSupportPart, JavaSupportPart, PascalSupportPart, PerlSupportPart, PHPSupportPart, PythonSupportPart, RubySupportPart, and SQLSupportPart.

Definition at line 38 of file kdevlanguagesupport.cpp.

References Features.

Referenced by ClassTreeItem::createPopup(), ClassViewPart::langHasFeature(), ClassTreeScopeItem::setOpen(), ClassViewWidget::slotAddAttribute(), ClassViewWidget::slotAddMethod(), and ClassViewWidget::slotNewClass().

QString KDevLanguageSupport::formatClassName const QString name  )  [virtual]
 

Formats a canonicalized class path as used by the class store to the human-readable convention.

For example, the C++ support part formats the string "KParts.Part" into "KParts::Part".

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 53 of file kdevlanguagesupport.cpp.

References formatClassName().

Referenced by formatClassName(), HierarchyDialog::refresh(), and HierarchyDialog::slotClassComboChoice().

QString KDevLanguageSupport::formatModelItem const CodeModelItem item,
bool  shortDescription = false
[virtual]
 

Formats a CodeModelItem as used by the CodeModel to the human-readable convention.

Reimplemented in CppSupportPart, JavaSupportPart, and PascalSupportPart.

Definition at line 89 of file kdevlanguagesupport.cpp.

References formatModelItem(), and CodeModelItem::name().

Referenced by ClassViewPart::addFile(), CppNewClassDialog::addToConstructorsList(), CppNewClassDialog::addToMethodsList(), CppNewClassDialog::addToUpgradeList(), formatModelItem(), CppNewClassDialog::isConstructor(), CppNewClassDialog::isDestructor(), ViewCombosOp::processClass(), ViewCombosOp::processNamespace(), ViewCombosOp::refreshClasses(), ViewCombosOp::refreshFunctions(), ViewCombosOp::refreshNamespaces(), VariableDomBrowserItem::setup(), FunctionDomBrowserItem::setup(), TypeAliasDomBrowserItem::setup(), ClassDomBrowserItem::setup(), NamespaceDomBrowserItem::setup(), ClassViewPart::updateClassesForAdd(), and ClassViewPart::updateFunctionsForAdd().

QString KDevLanguageSupport::formatTag const Tag tag  )  [virtual]
 

Formats a Tag as used by the class store to the human-readable convention.

Reimplemented in CppSupportPart, JavaSupportPart, and PascalSupportPart.

Definition at line 48 of file kdevlanguagesupport.cpp.

References formatTag().

Referenced by formatTag(), and ClassBrowserPart::refreshMethods().

void KDevLanguageSupport::implementVirtualMethods ClassDom  klass  )  [virtual]
 

Opens an "Implement Virtual Methods" dialog and adds the configured methods to the sources.

Definition at line 71 of file kdevlanguagesupport.cpp.

References implementVirtualMethods().

Referenced by implementVirtualMethods().

KMimeType::List KDevLanguageSupport::mimeTypes  )  [virtual]
 

Returns a typical mimetype list for the support language should be configurable in the languagesupport dialog.

Reimplemented in AdaSupportPart, BashSupportPart, CppSupportPart, HaskellSupportPart, JavaSupportPart, PascalSupportPart, PerlSupportPart, PHPSupportPart, PythonSupportPart, RubySupportPart, and SQLSupportPart.

Definition at line 43 of file kdevlanguagesupport.cpp.

References List, and KMimeType::List.

Referenced by ScriptProjectPart::openProject(), PascalProjectPart::openProject(), and AdaProjectPart::openProject().

void KDevLanguageSupport::removedSourceInfo const QString fileName  )  [signal]
 

Emitted when a file has been removed from the classstore.

QStringList KDevLanguageSupport::subclassWidget const QString formName  )  [virtual]
 

Opens an "Subclass Widget" dialog for given Qt .ui file (formName) and propmts to implement it's slots.

Returns a list of newly created files.

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 79 of file kdevlanguagesupport.cpp.

References subclassWidget().

Referenced by TrollProjectWidget::slotDetailsContextMenu(), AutoDetailsView::slotDetailsContextMenu(), and subclassWidget().

QString KDevLanguageSupport::unformatClassName const QString name  )  [virtual]
 

The opposite of formatClassName().

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 58 of file kdevlanguagesupport.cpp.

References unformatClassName().

Referenced by unformatClassName().

void KDevLanguageSupport::updatedSourceInfo  )  [signal]
 

Emitted when the content of the classtore has been modified.

Referenced by SQLSupportPart::addedFilesToProject(), BashSupportPart::addedFilesToProject(), PythonSupportPart::initialParse(), PHPSupportPart::initialParse(), PerlSupportPart::initialParse(), PascalSupportPart::initialParse(), JavaSupportPart::initialParse(), FortranSupportPart::initialParse(), CppSupportPart::initialParse(), AdaSupportPart::initialParse(), BashSupportPart::parse(), JavaSupportPart::parseProject(), CppSupportPart::parseProject(), SQLSupportPart::removedFilesFromProject(), PerlSupportPart::removedFilesFromProject(), PerlSupportPart::savedFile(), PascalSupportPart::savedFile(), AdaSupportPart::savedFile(), and SQLSupportPart::updateCatalog().

QStringList KDevLanguageSupport::updateWidget const QString formName,
const QString fileName
[virtual]
 

Opens and "Update Widget" dialog for given Qt .ui file (formName) and prompts to add missing slot implementations in the subclass located in fileName.

Returns a list of newly created files.

Reimplemented in CppSupportPart, and JavaSupportPart.

Definition at line 84 of file kdevlanguagesupport.cpp.

References updateWidget().

Referenced by TrollProjectWidget::slotDetailsContextMenu(), AutoDetailsView::slotDetailsContextMenu(), and updateWidget().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Oct 19 08:02:01 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003