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

kdevplatform/language/duchain

  • KDevelop
  • AbstractNavigationContext
Classes | Signals | Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
KDevelop::AbstractNavigationContext Class Referenceabstract

#include <abstractnavigationcontext.h>

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

Classes

struct  TextHandler
 

Signals

void contentsChanged ()
 

Public Member Functions

 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 QString html (bool shorten=false)
 
virtual bool isWidgetMaximized () const
 
int linkCount () const
 
virtual QString name () const =0
 
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

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)
 

Static Protected Attributes

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
 

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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 64 of file abstractnavigationcontext.h.

Constructor & Destructor Documentation

◆ AbstractNavigationContext()

KDevelop::AbstractNavigationContext::AbstractNavigationContext ( const TopDUContextPointer &  topContext = TopDUContextPointer(),
AbstractNavigationContext *  previousContext = nullptr 
)
explicit

Definition at line 76 of file abstractnavigationcontext.cpp.

◆ ~AbstractNavigationContext()

KDevelop::AbstractNavigationContext::~AbstractNavigationContext ( )
override

Definition at line 89 of file abstractnavigationcontext.cpp.

Member Function Documentation

◆ accept() [1/2]

NavigationContextPointer KDevelop::AbstractNavigationContext::accept ( )

Definition at line 456 of file abstractnavigationcontext.cpp.

◆ accept() [2/2]

NavigationContextPointer KDevelop::AbstractNavigationContext::accept ( IndexedDeclaration  decl)

Definition at line 467 of file abstractnavigationcontext.cpp.

◆ acceptLink()

NavigationContextPointer KDevelop::AbstractNavigationContext::acceptLink ( const QString &  link)

Definition at line 477 of file abstractnavigationcontext.cpp.

◆ addHtml()

void KDevelop::AbstractNavigationContext::addHtml ( const QString &  html)
protected

Adds given the text to currentHtml()

Definition at line 569 of file abstractnavigationcontext.cpp.

◆ alreadyComputed()

bool KDevelop::AbstractNavigationContext::alreadyComputed ( ) const

Returns whether this context's string has already been computed, and is up to date.

After clear() was called, this returns false again.

Definition at line 538 of file abstractnavigationcontext.cpp.

◆ back()

NavigationContextPointer KDevelop::AbstractNavigationContext::back ( )

Definition at line 446 of file abstractnavigationcontext.cpp.

◆ clear()

void KDevelop::AbstractNavigationContext::clear ( )
protected

Definition at line 146 of file abstractnavigationcontext.cpp.

◆ contentsChanged

void KDevelop::AbstractNavigationContext::contentsChanged ( )
signal

◆ createLink()

QString KDevelop::AbstractNavigationContext::createLink ( const QString &  name,
const QString &  targetId,
const NavigationAction &  action 
)
protected

Creates a link that executes the given action and returns it.

Definition at line 100 of file abstractnavigationcontext.cpp.

◆ currentAction()

NavigationAction KDevelop::AbstractNavigationContext::currentAction ( ) const

Definition at line 490 of file abstractnavigationcontext.cpp.

◆ currentHtml()

QString KDevelop::AbstractNavigationContext::currentHtml ( ) const
protected

Returns the html text being built in its current state.

Definition at line 587 of file abstractnavigationcontext.cpp.

◆ declarationKind()

QString KDevelop::AbstractNavigationContext::declarationKind ( const DeclarationPointer &  decl)
protectedvirtual

Definition at line 497 of file abstractnavigationcontext.cpp.

◆ down()

bool KDevelop::AbstractNavigationContext::down ( )

Definition at line 294 of file abstractnavigationcontext.cpp.

◆ execute()

NavigationContextPointer KDevelop::AbstractNavigationContext::execute ( const NavigationAction &  action)

Definition at line 175 of file abstractnavigationcontext.cpp.

◆ executeKeyAction()

NavigationContextPointer KDevelop::AbstractNavigationContext::executeKeyAction ( const QString &  key)
protectedvirtual

Override this to execute own key-actions using NavigationAction.

Reimplemented in KDevelop::ProblemNavigationContext, and KDevelop::AbstractDeclarationNavigationContext.

Definition at line 169 of file abstractnavigationcontext.cpp.

◆ executeLink()

void KDevelop::AbstractNavigationContext::executeLink ( const QString &  link)

Definition at line 158 of file abstractnavigationcontext.cpp.

◆ html()

QString KDevelop::AbstractNavigationContext::html ( bool  shorten = false)
virtual

Here the context can return html to be displayed.

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

Reimplemented in KDevelop::AbstractDeclarationNavigationContext, KDevelop::ProblemNavigationContext, KDevelop::AbstractIncludeNavigationContext, and KDevelop::UsesNavigationContext.

Definition at line 530 of file abstractnavigationcontext.cpp.

◆ isWidgetMaximized()

bool KDevelop::AbstractNavigationContext::isWidgetMaximized ( ) const
virtual

Whether the widget returned by widget() should take the maximum possible spsace.

The default implementation returns true.

Reimplemented in KDevelop::ProblemNavigationContext.

Definition at line 545 of file abstractnavigationcontext.cpp.

◆ linkCount()

int KDevelop::AbstractNavigationContext::linkCount ( ) const

Definition at line 430 of file abstractnavigationcontext.cpp.

◆ makeLink() [1/2]

void KDevelop::AbstractNavigationContext::makeLink ( const QString &  name,
const DeclarationPointer &  declaration,
NavigationAction::Type  actionType 
)
protectedvirtual

Creates and registers a link to the given declaration, labeled by the given name.

Definition at line 93 of file abstractnavigationcontext.cpp.

◆ makeLink() [2/2]

void KDevelop::AbstractNavigationContext::makeLink ( const QString &  name,
const QString &  targetId,
const NavigationAction &  action 
)
protected

Creates a link that executes the given action and adds it to the current context.

Definition at line 141 of file abstractnavigationcontext.cpp.

◆ modifyHtml()

TextHandler KDevelop::AbstractNavigationContext::modifyHtml ( )
inlineprotected

Returns a convenience object that allows writing "modifyHtml() += "Hallo";".

Definition at line 139 of file abstractnavigationcontext.h.

◆ name()

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

Implemented in KDevelop::AbstractIncludeNavigationContext, KDevelop::ProblemNavigationContext, KDevelop::AbstractDeclarationNavigationContext, and KDevelop::UsesNavigationContext.

◆ nextLink()

bool KDevelop::AbstractNavigationContext::nextLink ( )

Definition at line 384 of file abstractnavigationcontext.cpp.

◆ previousContext()

AbstractNavigationContext * KDevelop::AbstractNavigationContext::previousContext ( ) const
protected

Definition at line 253 of file abstractnavigationcontext.cpp.

◆ previousLink()

bool KDevelop::AbstractNavigationContext::previousLink ( )

Definition at line 407 of file abstractnavigationcontext.cpp.

◆ registerChild() [1/2]

NavigationContextPointer KDevelop::AbstractNavigationContext::registerChild ( AbstractNavigationContext *  context)
protected

Definition at line 267 of file abstractnavigationcontext.cpp.

◆ registerChild() [2/2]

NavigationContextPointer KDevelop::AbstractNavigationContext::registerChild ( const DeclarationPointer &  declaration)
protected

Definition at line 275 of file abstractnavigationcontext.cpp.

◆ resetNavigation()

void KDevelop::AbstractNavigationContext::resetNavigation ( )

Definition at line 437 of file abstractnavigationcontext.cpp.

◆ setPreviousContext()

void KDevelop::AbstractNavigationContext::setPreviousContext ( AbstractNavigationContext *  previousContext)
protectedvirtual

Definition at line 260 of file abstractnavigationcontext.cpp.

◆ setTopContext()

void KDevelop::AbstractNavigationContext::setTopContext ( const TopDUContextPointer &  context)

Definition at line 62 of file abstractnavigationcontext.cpp.

◆ topContext()

TopDUContextPointer KDevelop::AbstractNavigationContext::topContext ( ) const

Definition at line 69 of file abstractnavigationcontext.cpp.

◆ up()

bool KDevelop::AbstractNavigationContext::up ( )

Definition at line 342 of file abstractnavigationcontext.cpp.

◆ widget()

QWidget * KDevelop::AbstractNavigationContext::widget ( ) const
virtual

Here the context can return a widget to be displayed.

The widget stays owned by this navigation-context. The widget may have a signal "navigateDeclaration(KDevelop::IndexedDeclaration)". If that signal is emitted, the new declaration is navigated in the navigation-wdiget.

Reimplemented in KDevelop::ProblemNavigationContext, and KDevelop::UsesNavigationContext.

Definition at line 550 of file abstractnavigationcontext.cpp.

Member Data Documentation

◆ codeHighlight

const Colorizer KDevelop::AbstractNavigationContext::codeHighlight
staticprotected

Definition at line 165 of file abstractnavigationcontext.h.

◆ commentHighlight

const Colorizer KDevelop::AbstractNavigationContext::commentHighlight
staticprotected

Definition at line 169 of file abstractnavigationcontext.h.

◆ errorHighlight

const Colorizer KDevelop::AbstractNavigationContext::errorHighlight
staticprotected

Definition at line 163 of file abstractnavigationcontext.h.

◆ importantHighlight

const Colorizer KDevelop::AbstractNavigationContext::importantHighlight
staticprotected

Definition at line 168 of file abstractnavigationcontext.h.

◆ labelHighlight

const Colorizer KDevelop::AbstractNavigationContext::labelHighlight
staticprotected

Definition at line 164 of file abstractnavigationcontext.h.

◆ nameHighlight

const Colorizer KDevelop::AbstractNavigationContext::nameHighlight
staticprotected

Definition at line 170 of file abstractnavigationcontext.h.

◆ navigationHighlight

const Colorizer KDevelop::AbstractNavigationContext::navigationHighlight
staticprotected

Definition at line 167 of file abstractnavigationcontext.h.

◆ propertyHighlight

const Colorizer KDevelop::AbstractNavigationContext::propertyHighlight
staticprotected

Definition at line 166 of file abstractnavigationcontext.h.

◆ typeHighlight

const Colorizer KDevelop::AbstractNavigationContext::typeHighlight
staticprotected

Definition at line 162 of file abstractnavigationcontext.h.


The documentation for this class was generated from the following files:
  • abstractnavigationcontext.h
  • abstractnavigationcontext.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Mar 3 2021 00:37:28 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