backend/core/interfaces.dox

0001 /**
0002  * \class PartMaker
0003  * \brief Factory for AbstractPart objects.
0004  */
0005
0006 /**
0007  * \fn PartMaker::makePart()
0008  * \brief The factory method.
0009  */
0010
0011 /**
0012  * \fn PartMaker::makeAction(QObject *parent)
0013  * \brief The action to be used for making new parts.
0014  *
0015  * The caller takes care of connecting the action. If the parent argument is zero, it
0016  * also recieves ownership of the action.
0017  * Implementations should only set things like name and icon.
0018  */
0019
0020 /**
0021  * \class FilterMaker
0022  * \brief Factory for filters.
0023  *
0024  * A FilterMaker introduces one or more filters to the kernel.
0025  */
0026
0027 /**
0028  * \class FileFormat
0029  * \brief Factory for import/export filters.
0030  */
0031
0032 /**
0033  * \class ActionManagerOwner
0034  * \brief A module (typically a PartMaker) that has an ActionManager.
0035  */
0036
0037 /**
0038  * \fn ActionManagerOwner::actionManager()
0039  * \brief Return the action manager of the module
0040  */
0041
0042 /**
0043  * \fn ActionManagerOwner::initActionManager()
0044  * \brief Method that contains initialization that has to be done after loading the plugin
0045  */
0046
0047 /**
0048  * \class ConfigPageMaker
0049  * \brief A module with application-wide settings.
0050  */
0051
0052 /**
0053  * \class XmlElementAspectMaker
0054  * \brief Factory that creates an aspect out of an XML element.
0055  */
0056
0057 /**
0058  * \fn XmlElementAspectMaker::canCreate(const QString & element_name)
0059  * \brief Determine whether the loader can handle the given element.
0060  */
0061
0062 /**
0063  * \fn XmlElementAspectMaker::createAspectFromXml(XmlStreamReader * reader)
0064  * \brief The factory method.
0065  */
0066
0067 /**
0068  * \class NeedsStaticInit
0069  * \brief A Module that needs to be initialized at application startup.
0070  */
0071
0072 /**
0073  * \class VersionedPlugin
0074  * \brief Interface for plugins to identify which version and which application they are for.
0075  */
0076
0077 /**
0078  * \fn VersionedPlugin::pluginTargetAppVersion()
0079  * \brief Return the version number of the application the plugin was compiled for.
0080  */
0081
0082 /**
0083  * \fn VersionedPlugin::pluginTargetAppName()
0084  * \brief Return the application name of the application the plugin was compiled for.
0085 */
0086