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

kdevplatform/language/duchain

  • KDevelop
  • AbstractIncludeNavigationContext
Public Member Functions | Protected Member Functions | List of all members
KDevelop::AbstractIncludeNavigationContext Class Reference

#include <abstractincludenavigationcontext.h>

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

Public Member Functions

 AbstractIncludeNavigationContext (const IncludeItem &item, const TopDUContextPointer &topContext, const ParsingEnvironmentType &type)
 
QString html (bool shorten) override
 
QString name () const override
 
- Public Member Functions inherited from KDevelop::AbstractNavigationContext
 AbstractNavigationContext (const TopDUContextPointer &topContext=TopDUContextPointer(), AbstractNavigationContext *previousContext=nullptr)
 
 ~AbstractNavigationContext () override
 
NavigationContextPointer accept ()
 
NavigationContextPointer accept (IndexedDeclaration decl)
 
NavigationContextPointer acceptLink (const QString &link)
 
bool alreadyComputed () const
 
NavigationContextPointer back ()
 
NavigationAction currentAction () const
 
bool down ()
 
NavigationContextPointer execute (const NavigationAction &action)
 
void executeLink (const QString &link)
 
virtual bool isWidgetMaximized () const
 
int linkCount () const
 
bool nextLink ()
 
bool previousLink ()
 
void resetNavigation ()
 
void setTopContext (const TopDUContextPointer &context)
 
TopDUContextPointer topContext () const
 
bool up ()
 
virtual QWidget * widget () const
 
- 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
 
- Public Member Functions inherited from QSharedData
 QSharedData ()
 
 QSharedData (const QSharedData &other)
 

Protected Member Functions

virtual bool filterDeclaration (Declaration *decl)
 
virtual void getFileInfo (KDevelop::TopDUContext *duchain)
 
- Protected Member Functions inherited from KDevelop::AbstractNavigationContext
void addHtml (const QString &html)
 
void clear ()
 
QString createLink (const QString &name, const QString &targetId, const NavigationAction &action)
 
QString currentHtml () const
 
virtual QString declarationKind (const DeclarationPointer &decl)
 
virtual NavigationContextPointer executeKeyAction (const QString &key)
 
virtual void makeLink (const QString &name, const DeclarationPointer &declaration, NavigationAction::Type actionType)
 
void makeLink (const QString &name, const QString &targetId, const NavigationAction &action)
 
TextHandler modifyHtml ()
 
AbstractNavigationContext * previousContext () const
 
NavigationContextPointer registerChild (AbstractNavigationContext *context)
 
NavigationContextPointer registerChild (const DeclarationPointer &)
 
virtual void setPreviousContext (AbstractNavigationContext *previousContext)
 
- 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)
 

Additional Inherited Members

- Signals inherited from KDevelop::AbstractNavigationContext
void contentsChanged ()
 
- 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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Static Protected Attributes inherited from KDevelop::AbstractNavigationContext
static const Colorizer codeHighlight
 
static const Colorizer commentHighlight
 
static const Colorizer errorHighlight
 
static const Colorizer importantHighlight
 
static const Colorizer labelHighlight
 
static const Colorizer nameHighlight
 
static const Colorizer navigationHighlight
 
static const Colorizer propertyHighlight
 
static const Colorizer typeHighlight
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Abstract navigation context for file includes.

Example usage:

namespace LANG {
class IncludeNavigationContext : public AbstractIncludeNavigationContext
{
public:
IncludeNavigationContext(const IncludeItem& item, TopDuContextPointer topContext)
: AbstractIncludeNavigationContext(item, topContext, KDevelop::LANGParsingEnvironment) {}
protected:
virtual void getFileInfo(KDevelop::TopDUContext* duchain)
{
// write language dependent stuff via modifyHtml()
}
};
}

Definition at line 48 of file abstractincludenavigationcontext.h.

Constructor & Destructor Documentation

◆ AbstractIncludeNavigationContext()

KDevelop::AbstractIncludeNavigationContext::AbstractIncludeNavigationContext ( const IncludeItem &  item,
const TopDUContextPointer &  topContext,
const ParsingEnvironmentType &  type 
)

Definition at line 29 of file abstractincludenavigationcontext.cpp.

Member Function Documentation

◆ filterDeclaration()

bool KDevelop::AbstractIncludeNavigationContext::filterDeclaration ( Declaration *  decl)
protectedvirtual

Should return true if this declaration should be shown, and false if not The duchain is locked when this is called.

Definition at line 128 of file abstractincludenavigationcontext.cpp.

◆ getFileInfo()

void KDevelop::AbstractIncludeNavigationContext::getFileInfo ( KDevelop::TopDUContext *  duchain)
protectedvirtual

Overwrite this to add language dependent information for a given file.

By default only "included by" and "includes" NOTE: You should always append a newline (
) if you write anything.

Definition at line 112 of file abstractincludenavigationcontext.cpp.

◆ html()

QString KDevelop::AbstractIncludeNavigationContext::html ( bool  shorten)
overridevirtual

Here the context can return html to be displayed.

NOTE: The DUChain must be locked while this is called.

Reimplemented from KDevelop::AbstractNavigationContext.

Definition at line 80 of file abstractincludenavigationcontext.cpp.

◆ name()

QString KDevelop::AbstractIncludeNavigationContext::name ( ) const
overridevirtual

Implements KDevelop::AbstractNavigationContext.

Definition at line 123 of file abstractincludenavigationcontext.cpp.


The documentation for this class was generated from the following files:
  • abstractincludenavigationcontext.h
  • abstractincludenavigationcontext.cpp
KDevelop::AbstractIncludeNavigationContext::AbstractIncludeNavigationContext
AbstractIncludeNavigationContext(const IncludeItem &item, const TopDUContextPointer &topContext, const ParsingEnvironmentType &type)
Definition: abstractincludenavigationcontext.cpp:29
KDevelop::TopDUContext
The top context in a definition-use chain for one source file.
Definition: topducontext.h:113
KDevelop::AbstractNavigationContext::topContext
TopDUContextPointer topContext() const
Definition: abstractnavigationcontext.cpp:69
KDevelop
Definition: abstractfunctiondeclaration.cpp:27
KDevelop::AbstractIncludeNavigationContext::getFileInfo
virtual void getFileInfo(KDevelop::TopDUContext *duchain)
Overwrite this to add language dependent information for a given file.
Definition: abstractincludenavigationcontext.cpp:112
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Mar 4 2021 23:31:18 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/language/duchain

Skip menu "kdevplatform/language/duchain"
  • 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