KDevelop::AbstractNavigationContext Class Reference

#include <abstractnavigationcontext.h>

Inheritance diagram for KDevelop::AbstractNavigationContext:

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 52 of file abstractnavigationcontext.h.

Constructor & Destructor Documentation

AbstractNavigationContext()

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

explicit

Definition at line 64 of file abstractnavigationcontext.cpp.

~AbstractNavigationContext()

KDevelop::AbstractNavigationContext::~AbstractNavigationContext ( )

override

Definition at line 77 of file abstractnavigationcontext.cpp.

Member Function Documentation

accept() [1/2]

NavigationContextPointer KDevelop::AbstractNavigationContext::accept

(

)

Definition at line 444 of file abstractnavigationcontext.cpp.

accept() [2/2]

NavigationContextPointer KDevelop::AbstractNavigationContext::accept

(

IndexedDeclaration

decl

)

Definition at line 455 of file abstractnavigationcontext.cpp.

acceptLink()

NavigationContextPointer KDevelop::AbstractNavigationContext::acceptLink

(

const QString &

link

)

Definition at line 465 of file abstractnavigationcontext.cpp.

addHtml()

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

protected

Adds given the text to currentHtml()

Definition at line 557 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 526 of file abstractnavigationcontext.cpp.

back()

NavigationContextPointer KDevelop::AbstractNavigationContext::back

(

)

Definition at line 434 of file abstractnavigationcontext.cpp.

clear()

void KDevelop::AbstractNavigationContext::clear ( )

protected

Definition at line 134 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 88 of file abstractnavigationcontext.cpp.

currentAction()

NavigationAction KDevelop::AbstractNavigationContext::currentAction

(

)

const

Definition at line 478 of file abstractnavigationcontext.cpp.

currentHtml()

QString KDevelop::AbstractNavigationContext::currentHtml ( ) const

protected

Returns the html text being built in its current state.

Definition at line 575 of file abstractnavigationcontext.cpp.

declarationKind()

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

protectedvirtual

Definition at line 485 of file abstractnavigationcontext.cpp.

down()

bool KDevelop::AbstractNavigationContext::down

(

)

Definition at line 282 of file abstractnavigationcontext.cpp.

execute()

NavigationContextPointer KDevelop::AbstractNavigationContext::execute

(

const NavigationAction &

action

)

Definition at line 163 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 157 of file abstractnavigationcontext.cpp.

executeLink()

void KDevelop::AbstractNavigationContext::executeLink

(

const QString &

link

)

Definition at line 146 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 518 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 533 of file abstractnavigationcontext.cpp.

linkCount()

int KDevelop::AbstractNavigationContext::linkCount

(

)

const

Definition at line 418 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 81 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 129 of file abstractnavigationcontext.cpp.

modifyHtml()

TextHandler KDevelop::AbstractNavigationContext::modifyHtml ( )

inlineprotected

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

Definition at line 127 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 372 of file abstractnavigationcontext.cpp.

previousContext()

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

protected

Definition at line 241 of file abstractnavigationcontext.cpp.

previousLink()

bool KDevelop::AbstractNavigationContext::previousLink

(

)

Definition at line 395 of file abstractnavigationcontext.cpp.

registerChild() [1/2]

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

protected

Definition at line 255 of file abstractnavigationcontext.cpp.

registerChild() [2/2]

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

protected

Definition at line 263 of file abstractnavigationcontext.cpp.

resetNavigation()

void KDevelop::AbstractNavigationContext::resetNavigation

(

)

Definition at line 425 of file abstractnavigationcontext.cpp.

setPreviousContext()

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

protectedvirtual

Definition at line 248 of file abstractnavigationcontext.cpp.

setTopContext()

void KDevelop::AbstractNavigationContext::setTopContext

(

const TopDUContextPointer &

context

)

Definition at line 50 of file abstractnavigationcontext.cpp.

topContext()

TopDUContextPointer KDevelop::AbstractNavigationContext::topContext

(

)

const

Definition at line 57 of file abstractnavigationcontext.cpp.

up()

bool KDevelop::AbstractNavigationContext::up

(

)

Definition at line 330 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 538 of file abstractnavigationcontext.cpp.

Member Data Documentation

codeHighlight

const Colorizer KDevelop::AbstractNavigationContext::codeHighlight

staticprotected

Definition at line 153 of file abstractnavigationcontext.h.

commentHighlight

const Colorizer KDevelop::AbstractNavigationContext::commentHighlight

staticprotected

Definition at line 157 of file abstractnavigationcontext.h.

errorHighlight

const Colorizer KDevelop::AbstractNavigationContext::errorHighlight

staticprotected

Definition at line 151 of file abstractnavigationcontext.h.

importantHighlight

const Colorizer KDevelop::AbstractNavigationContext::importantHighlight

staticprotected

Definition at line 156 of file abstractnavigationcontext.h.

labelHighlight

const Colorizer KDevelop::AbstractNavigationContext::labelHighlight

staticprotected

Definition at line 152 of file abstractnavigationcontext.h.

nameHighlight

const Colorizer KDevelop::AbstractNavigationContext::nameHighlight

staticprotected

Definition at line 158 of file abstractnavigationcontext.h.

navigationHighlight

const Colorizer KDevelop::AbstractNavigationContext::navigationHighlight

staticprotected

Definition at line 155 of file abstractnavigationcontext.h.

propertyHighlight

const Colorizer KDevelop::AbstractNavigationContext::propertyHighlight

staticprotected

Definition at line 154 of file abstractnavigationcontext.h.

typeHighlight

const Colorizer KDevelop::AbstractNavigationContext::typeHighlight

staticprotected

Definition at line 150 of file abstractnavigationcontext.h.

---

The documentation for this class was generated from the following files:

• abstractnavigationcontext.h
• abstractnavigationcontext.cpp