#include <ApiDocManager.h>

Inheritance diagram for ApiDocManager:

Signals
void	objectApiAboutToBeAdded (ObjectDocumentation *, int)

void	objectApiAboutToBeRemoved (int, int)

void	objectApiAdded ()

void	objectApiRemoved ()

Public Member Functions
	ApiDocManager (QObject *parent=0)

QString	apiOverviewDocument () const

void	loadLocalData ()

bool	loadObjectApi (const KUrl &path)

ObjectDocumentation *	objectApi (int index) const

QString	objectApiDocument (const QString &identifier)

QList< ObjectDocumentation * >	objectApiList () 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 QObject receiver, const char method)

bool	disconnect (const char signal, 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

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)

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

Properties inherited from QObject
	objectName

Detailed Description

Load and provide api documentation objects.

Definition at line 37 of file ApiDocManager.h.

Constructor & Destructor Documentation

ApiDocManager::ApiDocManager ( QObject * parent = 0 )

explicit

Definition at line 40 of file ApiDocManager.cpp.

Member Function Documentation

QString ApiDocManager::apiOverviewDocument ( ) const

Generates HTML document with the an overview over all available API objects.

Returns: HTML content

Definition at line 265 of file ApiDocManager.cpp.

void ApiDocManager::loadLocalData ( )

This method loads all api documentation files.

Definition at line 45 of file ApiDocManager.cpp.

bool ApiDocManager::loadObjectApi ( const KUrl & path )

Load documenation object specification from locally stored XML file.

Parameters

path	is the local XML file containing the object API specification

Returns: true if loaded successfully, otherwise false

Definition at line 155 of file ApiDocManager.cpp.

ObjectDocumentation * ApiDocManager::objectApi ( int index ) const

Definition at line 58 of file ApiDocManager.cpp.

void ApiDocManager::objectApiAboutToBeAdded	(	ObjectDocumentation *	,
		int
	)

signal

void ApiDocManager::objectApiAboutToBeRemoved	(	int	,
		int
	)

signal

void ApiDocManager::objectApiAdded ( )

signal

QString ApiDocManager::objectApiDocument ( const QString & identifier )

Generates HTML document with the API documentation for the specified object.

The generated object is cached such that only the first call to this method is expensive, later calls only return the cached page;

Parameters

identifier is the identifier of an ObjectDocumentation object

Returns: HTML content

Definition at line 64 of file ApiDocManager.cpp.

QList< ObjectDocumentation * > ApiDocManager::objectApiList ( ) const

Returns: list of all loaded language specifications

Definition at line 53 of file ApiDocManager.cpp.

void ApiDocManager::objectApiRemoved ( )

signal

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

rocs/App

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

rocs/App

kdeedu API Reference

Search