Commit 166cd2db authored by Jan Möbius's avatar Jan Möbius
Browse files

Updated documentation

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14705 383ad7c9-94d9-4d36-a494-682f7c89f535
parent f7279f0b
...@@ -153,6 +153,10 @@ public slots: ...@@ -153,6 +153,10 @@ public slots:
* check if you support the given file type depending on the provided * check if you support the given file type depending on the provided
* filters and dataTypes ( see supportedType and getLoadFilters )\n * filters and dataTypes ( see supportedType and getLoadFilters )\n
* *
* If loading fails, you have to return -1. If you created an empty
* object and then your load procedure fails, you should remove the newly
* generated object.\n
*
* if you just opened a file and did not create any object, return 0 here, * if you just opened a file and did not create any object, return 0 here,
* telling the core that it was successfully loaded but no new object * telling the core that it was successfully loaded but no new object
* has been created! * has been created!
...@@ -169,6 +173,10 @@ public slots: ...@@ -169,6 +173,10 @@ public slots:
* telling the core that it was successfully loaded but no new object * telling the core that it was successfully loaded but no new object
* has been created! * has been created!
* *
* If loading fails, you have to return -1. If you created an empty
* object and then your load procedure fails, you should remove the newly
* generated object.\n
*
* If the Plugin is able to open the file in different DataTypes * If the Plugin is able to open the file in different DataTypes
* one of these DataTypes can be forced with this function. * one of these DataTypes can be forced with this function.
* *
......
...@@ -77,7 +77,7 @@ class LoadSaveInterface { ...@@ -77,7 +77,7 @@ class LoadSaveInterface {
* *
* @param _filename Filename of the File to load * @param _filename Filename of the File to load
* @param _type Type to be loaded * @param _type Type to be loaded
* @param _id Here the id of the loaded object is returned. id its -1 something went wrong * @param _id Here the id of the loaded object is returned. id is -1 something went wrong
*/ */
virtual void load(QString _filename, DataType _type, int& _id) {}; virtual void load(QString _filename, DataType _type, int& _id) {};
...@@ -85,7 +85,7 @@ class LoadSaveInterface { ...@@ -85,7 +85,7 @@ class LoadSaveInterface {
/** Add an empty object of the given type /** Add an empty object of the given type
* *
* @param _type Type to be created * @param _type Type to be created
* @param _id Here the id of the loaded object is returned. id its -1 something went wrong * @param _id Here the id of the loaded object is returned. id is -1 something went wrong
*/ */
virtual void addEmptyObject( DataType _type, int& _id) {}; virtual void addEmptyObject( DataType _type, int& _id) {};
......
Supports Markdown
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