Logo Search packages:      
Sourcecode: qt4-x11 version File versions

QHelpEngineCore Class Reference

Inheritance diagram for QHelpEngineCore:

QObject QHelpEngine

List of all members.

Detailed Description

The QHelpEngineCore class provides the core functionality of the help system.

4.4 QtHelp Before the help engine can be used, it must be initialized by calling setupData(). At the beginning of the setup process the signal setupStarted() is emitted. From this point on until the signal setupFinished() is emitted, is the help data in an undefined meaning unusable state.
The core help engine can be used to perform different tasks. By calling linksForIdentifier() the engine returns urls specifying the file locations inside the help system. The actual file data can then be retrived by calling fileData(). In contrast to all other functions in this class, linksForIdentifier() depends on the currently set custom filter. Depending on the filter, the function may return different hits.

Every help engine can contain any number of custom filters. A custom filter is defined by a name and set of filter attributes and can be added to the help engine by calling addCustomFilter(). Analogous, it is removed by calling removeCustomFilter(). customFilters() returns all defined filters.

The help engine also offers the possiblity to set and read values in a persistant way comparable to ini files or Windows registry entries. For more information see setValue() or value().

This class does not offer any GUI components or functionality for indices or contents. If you need one of those use QHelpEngine instead.

Definition at line 62 of file qhelpenginecore.h.

Public Slots

void deleteLater ()


void currentFilterChanged (const QString &newFilter)
void destroyed (QObject *=0)
void setupFinished ()
void setupStarted ()
void warning (const QString &msg)

Public Member Functions

bool addCustomFilter (const QString &filterName, const QStringList &attributes)
bool blockSignals (bool b)
const QObjectListchildren () const
QString collectionFile () const
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool copyCollectionFile (const QString &fileName)
QString currentFilter () const
QStringList customFilters () const
QVariant customValue (const QString &key, const QVariant &defaultValue=QVariant()) const
bool disconnect (const QObject *receiver, const char *member=0)
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
QString documentationFileName (const QString &namespaceName)
void dumpObjectInfo ()
void dumpObjectTree ()
QList< QByteArraydynamicPropertyNames () const
QString error () const
virtual bool event (QEvent *)
virtual bool eventFilter (QObject *, QEvent *)
QByteArray fileData (const QUrl &url) const
QList< QUrlfiles (const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter=QString())
QStringList filterAttributes (const QString &filterName) const
QStringList filterAttributes () const
QList< QStringListfilterAttributeSets (const QString &namespaceName) const
template<typename T>
findChild (const QString &aName=QString()) const
template<typename T>
QList< T > findChildren (const QRegExp &re) const
template<typename T>
QList< T > findChildren (const QString &aName=QString()) const
QUrl findFile (const QUrl &url) const
bool inherits (const char *classname) const
void installEventFilter (QObject *)
bool isWidgetType () const
void killTimer (int id)
QMap< QString, QUrllinksForIdentifier (const QString &id) const
void moveToThread (QThread *thread)
QString objectName () const
QObjectparent () const
QVariant property (const char *name) const
 QHelpEngineCore (const QString &collectionFile, QObject *parent=0)
bool registerDocumentation (const QString &documentationFileName)
QStringList registeredDocumentations () const
bool removeCustomFilter (const QString &filterName)
bool removeCustomValue (const QString &key)
void removeEventFilter (QObject *)
void setCollectionFile (const QString &fileName)
void setCurrentFilter (const QString &filterName)
bool setCustomValue (const QString &key, const QVariant &value)
void setObjectName (const QString &name)
void setParent (QObject *)
bool setProperty (const char *name, const QVariant &value)
bool setupData ()
void setUserData (uint id, QObjectUserData *data)
bool signalsBlocked () const
int startTimer (int interval)
QThreadthread () const
bool unregisterDocumentation (const QString &namespaceName)
QObjectUserData * userData (uint id) const
virtual ~QHelpEngineCore ()

Static Public Member Functions

static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
static QVariant metaData (const QString &documentationFileName, const QString &name)
static QString namespaceName (const QString &documentationFileName)
static uint registerUserData ()

Protected Member Functions

virtual void childEvent (QChildEvent *)
virtual void connectNotify (const char *signal)
virtual void customEvent (QEvent *)
virtual void disconnectNotify (const char *signal)
 QHelpEngineCore (QHelpEngineCorePrivate *helpEngineCorePrivate, QObject *parent)
int receivers (const char *signal) const
QObjectsender () const
virtual void timerEvent (QTimerEvent *)

Protected Attributes

QObjectData * d_ptr

Static Protected Attributes

static const QMetaObject staticQtMetaObject


QString objectName
 the name of this object

Private Attributes

QHelpEngineCorePrivate * d


class QApplication
class QApplicationPrivate
class QCoreApplication
class QCoreApplicationPrivate
class QHelpEngineCorePrivate
struct QMetaObject
class QThreadData
class QWidget

Related Functions

(Note that these are not member functions.)

qFindChild (const QObject *obj, const QString &name=QString(), T dummy=0)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QString &name=QString(), T dummy=0)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
T * qobject_cast (QObject *object)
void * qt_find_obj_child (QObject *parent, const char *type, const QString &name)

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

Generated by  Doxygen 1.6.0   Back to index