Commit afe38c3a authored by Mike Kremer's avatar Mike Kremer

Added some cross references for the documentation (to the tutorials)

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@5493 383ad7c9-94d9-4d36-a494-682f7c89f535
parent dc10b0b1
......@@ -53,6 +53,9 @@
* a key (or key combination). For each registered key you will receive a keyEvent when
* the key was pressed and a keyReleaseEvent when the key was released.
*
* See our tutorial \ref ex3 for an example of how to use mouse and keyboard events
* within a plugin.
*
*/
class KeyInterface {
signals:
......
......@@ -53,6 +53,8 @@ enum Logtype { LOGOUT, LOGINFO , LOGWARN , LOGERR };
* To simplify debugging the core will prepend the plugin name to every log message. You dont
* have to do this yourself!\n
* The log message will either be black or will be colored depending on the Logtype you specified.
*
* Read our tutorials \ref ex2 and \ref ex3 for an example of how to use logging output.
*/
class LoggingInterface {
......
......@@ -58,6 +58,9 @@
* mode.
*
* slotMouseEventIdentify will be used when question mode is active.
*
* See our tutorial \ref ex3 for an example of how to use mouse and keyboard events
* within a plugin.
*/
class MouseInterface {
......
......@@ -36,7 +36,7 @@
#include <QtGui>
/**
* This Interface should be used by plugins which will provide a their own options.
* This Interface should be used by plugins which will provide their own options.
* For your options to show up in OpenFlippers Options window implement the initializeOptionsWidget() slot.
* The widget you return with this slot will be integrated into the options window and when
* the user hits the apply- or ok-button in the options window the slot applyOptions() is called and
......
......@@ -51,7 +51,9 @@
/**
* \brief Allow access to picking functions.
*
* Interface Class which allows access to picking functions
* Interface Class which allows access to picking functions.
*
* Read tutorial \ref ex3 for an example of how to use mouse picking.
*/
class PickingInterface {
signals :
......
......@@ -57,6 +57,9 @@
* ToolboxInterface::initializeToolbox(QWidget*& _widget). You can create extra Signals and slots in your Plugin.
* These can be connected between your toolbox and your plugin. Signals and slots across plugins are currently
* not available but may be possible via an internal message system later.\n
*
* See our tutorials \ref ex2 and \ref ex3 for an example of to add custom toolboxes to
* OpenFlipper.
*/
class ToolboxInterface {
......
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