controller.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the papyrus library.                             *
 *                                                                         *
 *   papyrus is free software; you can redistribute it and/or modify       *
 *   it under the terms of the GNU Lesser General Public License           *
 *   version 3.0 as published by the Free Software Foundation.             *
 *                                                                         *
 *   papyrus is distributed in the hope that it will be useful,            *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU Lesser General Public License version 3.0 for more details.       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with the papyrus library. If not, see                   *
 *   <http://www.gnu.org/licenses/>.                                       *
 ***************************************************************************/
#ifndef PAPYRUSCONTROLLER_H
#define PAPYRUSCONTROLLER_H

#include <stdint.h>

#include <sigc++/sigc++.h>

#include <papyrus/object.h>
#include <papyrus/pointer.h>
#include <papyrus/event.h>
#include <papyrus/utility.h>

namespace Papyrus
{

  class Controller: public Object
  {
    protected:
      
      Controller(const Glib::ustring& id=Glib::ustring());

    public:

      typedef PapyrusPointer<Controller> pointer;
      typedef PapyrusWeakPointer<Controller> weak_pointer;

      static pointer create( const Glib::ustring& id=Glib::ustring() );

      virtual ~Controller();

      virtual bool is_disabled();

      virtual bool disable ( bool value=true );

      virtual bool enable ( bool value=true );

      sigc::signal<void,bool> signal_disabled();

      bool handle_event( const Event::Event& event );
      
      virtual bool handle ( const Event::Event& event );
      virtual bool handle ( const Event::Button& event );
      virtual bool handle ( const Event::ButtonPress& event );
      virtual bool handle ( const Event::ButtonDoublePress& event );
      virtual bool handle ( const Event::ButtonTriplePress& event );
      virtual bool handle ( const Event::ButtonRelease& event );
      virtual bool handle ( const Event::Key& event );
      virtual bool handle ( const Event::KeyPress& event );
      virtual bool handle ( const Event::KeyRelease& event );
      virtual bool handle ( const Event::Motion& event );
      virtual bool handle ( const Event::Scroll& event );

    protected:
      bool m_disabled;

      weak_pointer m_self;

      sigc::signal<void,bool> m_signal_disabled;

      virtual bool on_button_press ( const Event::ButtonPress& event );
      virtual bool on_button_double_press ( const Event::ButtonDoublePress& event );
      virtual bool on_button_triple_press ( const Event::ButtonTriplePress& event );
      virtual bool on_button_release ( const Event::ButtonRelease& event );
      virtual bool on_key_press ( const Event::KeyPress& event );
      virtual bool on_key_release ( const Event::KeyRelease& event );
      virtual bool on_motion ( const Event::Motion& event );
      virtual bool on_scroll ( const Event::Scroll& event );

  };

}

#endif