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

Updated documentation

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@11001 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 3a230d93
......@@ -101,9 +101,11 @@ signals:
* This Action will be visible when you rightclick in the viewer widget on an item
* of the given context menu type. You can add a whole menu here by adding the action:
* menu->menuAction() of your own menu.
*
* @param _menu Pointer to the new Action
* @param _type Type context menu type
*/
virtual void addContextMenuItem(QAction* /*_action*/ , ContextMenuType /*_type*/) {};
virtual void addContextMenuItem(QAction* _action , ContextMenuType _type) {};
/** \brief Add an entry for a context Menu
*
......@@ -117,29 +119,29 @@ signals:
* @param _objectType Type of the picked object
* @param _type Type of the context Menu ( See ContextMenuType )
*/
virtual void addContextMenuItem(QAction* /*_action*/ ,DataType /*_objectType*/ , ContextMenuType /*_type*/ ) {};
virtual void addContextMenuItem(QAction* _action ,DataType _objectType , ContextMenuType _type ) {};
private slots:
/** When the main application requests a context menu, this slot is called before showing the window.
* If an object is picked the id will be given in this call so you can change the contents of your menu
* depending on the given object.
*
* @param _objectId id of the object
*/
virtual void slotUpdateContextMenu( int /*_objectId*/ ) {};
virtual void slotUpdateContextMenu( int _objectId ) {};
/** When the main application requests a context menu, this slot is called before showing the window.
* This slot will be called indicating that a scenegraph node not belonging to an object
* has been picked.
* The id of the node is given as a parameter
*
* @param _node id of the picked node
*/
virtual void slotUpdateContextMenuNode( int /*_nodeId*/ ) {};
virtual void slotUpdateContextMenuNode( int _nodeId ) {};
/** When the main application requests a context menu, this slot is called before showing the window.
* This slot will be called indicating thatthe background has been picked.
* The id of the node is given as a parameter
* @param _node id of the picked node
* This slot will be called indicating that the background has been picked.
*
*/
virtual void slotUpdateContextMenuBackground( ) {};
......
......@@ -112,23 +112,29 @@ enum Logtype { LOGOUT , /*!< Standard log messages. Will be printed in black i
class LoggingInterface {
signals :
/** Send a log message to the mainwindow of the widget \n
/** Send a log message to the mainwindow of the widget
*
* @param _type Message type (LOGINFO,LOGOUT,LOGWARN,LOGERR)
* @param _message Message to be displayed
*/
virtual void log(Logtype /*_type*/, QString /*_message*/) = 0;
virtual void log(Logtype _type, QString _message) = 0;
/** Send a log message to the mainwindow of the widget \n
* defaults to LOGOUT message type
*
* @param _message Message to be displayed
*/
virtual void log(QString /*_message*/) = 0;
virtual void log(QString _message) = 0;
private slots:
/** Through this slot you can receive all logging information emitted by OpenFlipper
* or one of its plugins */
virtual void logOutput( Logtype /*_type*/ , QString /*_message*/ ) {};
* or one of its plugins
*
* @param _type Message type
* @param _message Message
*/
virtual void logOutput( Logtype _type , QString _message ) {};
public:
......
......@@ -90,7 +90,7 @@ signals:
* @param _menu The returned toplevel menu
* @param _create Should a new menu be created if id doesn't exist
*/
virtual void getMenubarMenu (QString /*_name*/, QMenu *& /*_menu*/, bool /*_create*/) {};
virtual void getMenubarMenu (QString _name, QMenu *& _menu, bool _create) {};
/** \brief Adds an action to the menubar
*
......@@ -108,7 +108,7 @@ signals:
* @param _action Pointer to the new action
* @param _name Name of the menu
*/
virtual void addMenubarAction(QAction* /*_action*/, QString /*_name*/ ) {};
virtual void addMenubarAction(QAction* _action, QString _name ) {};
};
......
......@@ -54,9 +54,6 @@
*/
/**
* \brief Plugins can add its own toolbox to the main widget's toolbox area by using this interface.
*
......@@ -86,14 +83,21 @@ class ToolboxInterface {
/** \brief Add a toolbox widget to the gui with the given name
*
* This signal adds a toolbox widget to the toolbar on the right.
*
* @param _name Visible name of the toolbox
* @param _widget Pointer to the toolbox widget
*/
virtual void addToolbox( QString /* _name */ , QWidget* /*_widget*/ ) {};
virtual void addToolbox( QString _name , QWidget* _widget ) {};
/** \brief Add a toolbox widget to the gui with the given name and an icon
*
* This signal adds a toolbox widget to the toolbar on the right. And sets an icon for it
*
* @param _name Visible name of the toolbox
* @param _widget Pointer to the toolbox widget
* @param _icon Icon for the toolbox
*/
virtual void addToolbox( QString /* _name */ , QWidget* /*_widget*/, QIcon* /*_icon*/) {};
virtual void addToolbox( QString _name , QWidget* _widget, QIcon* _icon) {};
};
......
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