/home/master/UCL/VisualizationLibrary/src/vlGraphics/UIEventListener.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2011, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef EventListener_INCLUDE_ONCE
#define EventListener_INCLUDE_ONCE

#include <vlGraphics/link_config.hpp>
#include <vlCore/String.hpp>

namespace vl
{
  class OpenGLContext;
  //-----------------------------------------------------------------------------
  // UIEventListener
  //-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT UIEventListener: public Object
  {
    VL_INSTRUMENT_ABSTRACT_CLASS(vl::UIEventListener, Object)

    friend class OpenGLContext;

  public:
    UIEventListener(): mOpenGLContext(NULL), mEnabled(true) 
    {
      VL_DEBUG_SET_OBJECT_NAME()
    }

    virtual void initEvent() = 0;

    virtual void destroyEvent() = 0;

    virtual void updateEvent() = 0;
    
    virtual void enableEvent(bool enabled) = 0;

    virtual void addedListenerEvent(OpenGLContext*) = 0;

    virtual void removedListenerEvent(OpenGLContext*) = 0;

    virtual void mouseMoveEvent(int x, int y) = 0;

    virtual void mouseUpEvent(EMouseButton button, int x, int y) = 0;

    virtual void mouseDownEvent(EMouseButton button, int x, int y) = 0;

    virtual void mouseWheelEvent(int n) = 0;

    virtual void keyPressEvent(unsigned short unicode_ch, EKey key) = 0;

    virtual void keyReleaseEvent(unsigned short unicode_ch, EKey key) = 0;

    virtual void resizeEvent(int x, int y) = 0;

    virtual void fileDroppedEvent(const std::vector<String>& files) = 0;

    virtual void visibilityEvent(bool visible) = 0;

    virtual void setEnabled(bool enabled) { if (mEnabled != enabled) { mEnabled = enabled; enableEvent(enabled); } }

    bool isEnabled() const { return mEnabled; }

    OpenGLContext* openglContext();

    const OpenGLContext* openglContext() const;

  private:
    OpenGLContext* mOpenGLContext;
    bool mEnabled;
  };
}

#endif