Commit be7d271e authored by Jan Möbius's avatar Jan Möbius

Fixed Documentation

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@20393 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 9e6df6e2
......@@ -61,6 +61,8 @@
*/
/** \brief Enables implementers to react on deserialization of meta data.
*
* \ref MetaDataInterfacePage "Detailed description"
*
* Using functions such as BaseObject::getCommentByKey() plugins can attach
* meta data to objects. This meta data is currently only serialized when
......@@ -126,6 +128,25 @@ class MetadataInterface {
};
/** \page MetaDataInterfacePage MetaData Interface
\n
\image html metaDataInterface.png
\n
Using functions such as BaseObject::getCommentByKey() plugins can attach
meta data to objects. This meta data is currently only serialized when
taking viewer snapshots. "Plugin-DeserializeScreenshotMetadata" allows
deserializing this metadata from a viewer snapshot. (In the future
serialization and deserialization of meta data may occur in other contexts
as well.)
Whenever meta gets deserialized the slots in this interface will get
triggered. Please refer to the documentation of the individual slots
to find out which specific signal suits your needs.
*/
#if QT_VERSION >= 0x050000
Q_DECLARE_INTERFACE(MetadataInterface,"OpenFlipper.MetadataInterface_qt5/1.0")
#else
......
......@@ -1207,6 +1207,23 @@ private slots:
/** @} */
//===========================================================================
/** @name Metadata support
* @{ */
//===========================================================================
signals:
void genericMetadataDeserialized(QString key, QString value);
void objectMetadataDeserialized(QString object_name, QString value);
#if QT_VERSION >= 0x050000
void objectMetadataDeserializedJson(
QString object_name, QJsonDocument value);
#endif
private slots:
void slotMetadataDeserialized( const QVector<QPair<QString, QString> > &data);
/** @} */
//===========================================================================
/** @name Scripting support
......@@ -1251,21 +1268,6 @@ private slots:
void showReducedMenuBar(bool reduced);
//===========================================================================
/** @name Metadata support
* @{ */
//===========================================================================
signals:
void genericMetadataDeserialized(QString key, QString value);
void objectMetadataDeserialized(QString object_name, QString value);
#if QT_VERSION >= 0x050000
void objectMetadataDeserializedJson(
QString object_name, QJsonDocument value);
#endif
private slots:
void slotMetadataDeserialized(
const QVector<QPair<QString, QString> > &data);
private :
......
......@@ -143,6 +143,10 @@ Provides an interface to read and write file types. All load/save plugins need t
Provides functions to control loading/saving of files and generate new objects. Additionally
this interface informs plugins, when objects get added or removed( \ref loadSaveInterfacePage ).
\subpage MetaDataInterfacePage
\image html metaDataInterface.png
This interface provides functions for serealizing and deserializing MetaData which is stored in screenshots or other files.
\subpage selectionInterfacePage
\image html SelectionInterface.png
This interface provides functions which control OpenFlippers selection system. Selection plugins
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment