Commit 08b7a5f0 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@4297 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 0a489361
...@@ -12,12 +12,12 @@ ...@@ -12,12 +12,12 @@
// it under the terms of the GNU Lesser General Public License as published by // it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or // the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version. // (at your option) any later version.
// //
// OpenFlipper is distributed in the hope that it will be useful, // OpenFlipper is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of // but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details. // GNU Lesser General Public License for more details.
// //
// You should have received a copy of the GNU Lesser General Public License // You should have received a copy of the GNU Lesser General Public License
// along with OpenFlipper. If not, see <http://www.gnu.org/licenses/>. // along with OpenFlipper. If not, see <http://www.gnu.org/licenses/>.
// //
...@@ -35,68 +35,68 @@ ...@@ -35,68 +35,68 @@
// //
// C++ Interface: Basic Interface for mouse events // C++ Interface: Basic Interface for mouse events
// //
// Description: // Description:
// //
// //
// Author: Jan Moebius <moebius@informatik.rwth-aachen.de>, (C) 2007 // Author: Jan Moebius <moebius@informatik.rwth-aachen.de>, (C) 2007
#ifndef MOUSEINTERFACE_HH #ifndef MOUSEINTERFACE_HH
#define MOUSEINTERFACE_HH #define MOUSEINTERFACE_HH
#include <QtGui> #include <QtGui>
/** \brief Interface for all plugins which have to react on mouse events /** \brief Interface for all plugins which have to react on mouse events
* *
* When using mouse events in your plugins implement this interface. Remember that * When using mouse events in your plugins implement this interface. Remember that
* all plugins may get these signals. Therefore you hav to check if the current pickingMode * all plugins may get these signals. Therefore you hav to check if the current pickingMode
* is active before doing anything. Only the slotMouseEventIdentify is independent of picking modes. * is active before doing anything. Only the slotMouseEventIdentify is independent of picking modes.
*/ */
class MouseInterface { class MouseInterface {
private slots : private slots :
/** \brief Wheel Event from Main App /** \brief Wheel Event from Main App
* *
* This slot is called if a wheel event occured in the Viewer and is extended by * This slot is called if a wheel event occured in the Viewer and is extended by
* the current Mode set in the Viewer. You can add additional Picking Modes to * the current Mode set in the Viewer. You can add additional Picking Modes to
* the Viewer by calling examiner_widget_->addPickMode("Mode"). * the Viewer by using the picking interface.
* This slot will only get called in pickingMode. * This slot will only get called in pickingMode.
* @param _event Mousevent * @param _event Mousevent
* @param _mode Name of the current Picking Mode. * @param _mode Name of the current Picking Mode.
*/ */
virtual void slotMouseWheelEvent(QWheelEvent * /*_event*/, const std::string & /*_mode*/) {}; virtual void slotMouseWheelEvent(QWheelEvent * /*_event*/, const std::string & /*_mode*/) {};
/** \brief Mouse Event from Main App ( Picking Mode ) /** \brief Mouse Event from Main App ( Picking Mode )
* *
* This slot is called if a mouse event occured in the Viewer * This slot is called if a mouse event occured in the Viewer
* This slot will only get called in pickingMode. * This slot will only get called in pickingMode.
* Right button clicks will not be passed to the plugins as this is reserved for * Right button clicks will not be passed to the plugins as this is reserved for
* the context Menu. * the context Menu.
* *
* @param _event Mousevent * @param _event Mousevent
*/ */
virtual void slotMouseEvent( QMouseEvent* /*_event*/ ) {}; virtual void slotMouseEvent( QMouseEvent* /*_event*/ ) {};
/** \brief Mouse Event from Main App ( Identify Mode ) /** \brief Mouse Event from Main App ( Identify Mode )
* *
* This slot is called if a mouse event occured in the Viewer * This slot is called if a mouse event occured in the Viewer
* This slot will only get called in identifyMode. * This slot will only get called in identifyMode.
* Right button clicks will not be passed to the plugins as this is reserved for * Right button clicks will not be passed to the plugins as this is reserved for
* the context Menu. * the context Menu.
* *
* @param _event Mousevent * @param _event Mousevent
*/ */
virtual void slotMouseEventIdentify() {}; virtual void slotMouseEventIdentify() {};
public : public :
/// Destructor /// Destructor
virtual ~MouseInterface() {}; virtual ~MouseInterface() {};
}; };
Q_DECLARE_INTERFACE(MouseInterface,"OpenFlipper.MouseInterface/1.0") Q_DECLARE_INTERFACE(MouseInterface,"OpenFlipper.MouseInterface/1.0")
#endif // MOUSEINTERFACE_HH #endif // MOUSEINTERFACE_HH
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