/**
 * $Id$
 * $Revision$
 * $Author$
 * $Date$
 *
 * This file is part of The iWear Framework.
 * In particular this file is part of the Framework Output
 *
 * The iWear Framework is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation as in version 2 of the License.

 * 
 * The iWear Framework 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 General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * The iWear Framework; if not, write to the Free Software Foundation, Inc., 59
 * Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __MENUEVENT_H
#define __MENUEVENT_H

#include <iwear/debugstream.h>
#include <iwear/utility.h>
#include <iwear_uiservices/menufunctor.h>
#include <iwear/eventbase.h>
#include <iwear/atomiccounter.h>
#include <iwear/refcountevent.h>

namespace iwear{
namespace uiservices{

/**
 * Class for wrapping MenuFunctors
 */
class MenuEvent : public iwear::RefCountEvent<MenuFunctor> {

 public:
    
    /**
     * Constructor
     */
    MenuEvent(MenuFunctor&           menu_functor, 
	      uint32_t               element_id, 
	      MENU_EVENT             menu_event,
	      MENU_EVENT_INFORMATION menu_event_information,
	      AtomicCounter<uint32_t>& counter);

    /**
     * Destructor
     */
    virtual ~MenuEvent(void);
   
    /**
     * Dispatch
     */
    virtual void dispatch_this(void);
    
 private: 

    /**
     * Reference to the functor;
     */
    MenuFunctor& menu_functor;

    /**
     * Id of the changed menu element
     */
    uint32_t element_id;
    
    /**
     * Status of the menu
     */
    MENU_EVENT menu_event;

    /**
     * Additional information
     */
    MENU_EVENT_INFORMATION menu_event_information;

};

} // namespace uiservices
} // namespace iwear

#endif // __MENUEVENT_H