Line data    Source code

       1             : 
       2             : /* Copyright (c) 2014-2017, Daniel Nachbaur <danielnachbaur@gmail.com>
       3             :  *
       4             :  * This library is free software; you can redistribute it and/or modify it under
       5             :  * the terms of the GNU Lesser General Public License version 2.1 as published
       6             :  * by the Free Software Foundation.
       7             :  *
       8             :  * This library is distributed in the hope that it will be useful, but WITHOUT
       9             :  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
      10             :  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
      11             :  * details.
      12             :  *
      13             :  * You should have received a copy of the GNU Lesser General Public License
      14             :  * along with this library; if not, write to the Free Software Foundation, Inc.,
      15             :  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
      16             :  */
      17             : 
      18             : #ifndef EQ_NOTIFIER_INTERFACE_H
      19             : #define EQ_NOTIFIER_INTERFACE_H
      20             : 
      21             : #include <eq/types.h>
      22             : 
      23             : namespace eq
      24             : {
      25             : /** A base class for notifying errors and events. */
      26           2 : class NotifierInterface
      27             : {
      28             : public:
      29           2 :     virtual ~NotifierInterface() {}
      30             :     /**
      31             :      * Send an error event to the application node.
      32             :      *
      33             :      * @param error the error code.
      34             :      * @version 1.7.2
      35             :      */
      36             :     virtual EventOCommand sendError(const uint32_t error) = 0;
      37             : 
      38             :     /**
      39             :      * Process a received event.
      40             :      *
      41             :      * The task of this method is to update this object as necessary, and send
      42             :      * it to the application using Config::sendEvent() if needed.
      43             :      *
      44             :      * @param type the event type.
      45             :      * @param event the received event.
      46             :      * @return true when the event was handled, false if not.
      47             :      */
      48             :     virtual bool processEvent(EventType type, SizeEvent& event) = 0;
      49             :     virtual bool processEvent(EventType type, PointerEvent& event) = 0;
      50             :     virtual bool processEvent(EventType type, KeyEvent& event) = 0;
      51             :     virtual bool processEvent(AxisEvent& event) = 0;
      52             :     virtual bool processEvent(ButtonEvent& event) = 0;
      53             :     virtual bool processEvent(EventType type) = 0; //!< stateless event
      54             : };
      55             : }
      56             : 
      57             : #endif // EQ_NOTIFIER_INTERFACE_H