AOO410/main/svx/inc/svx/sdr/event/eventhandler.hxx

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef _SDR_EVENT_EVENTHANDLER_HXX
#define _SDR_EVENT_EVENTHANDLER_HXX

#include <sal/types.h>

#include <vector>
#include <vcl/timer.hxx>

//////////////////////////////////////////////////////////////////////////////
// predeclarations

namespace sdr
{
	namespace event
	{
		class BaseEvent;
		class EventHandler;

		// typedefs for a list of BaseEvents
		typedef ::std::vector< BaseEvent* > BaseEventVector;
	} // end of namespace event
} // end of namespace sdr

//////////////////////////////////////////////////////////////////////////////

namespace sdr
{
	namespace event
	{
		class BaseEvent
		{
			// the EventHandler this event is registered at
			EventHandler&									mrEventHandler;

		public:
			// basic constructor.
			BaseEvent(EventHandler& rEventHandler);

			// destructor
			virtual ~BaseEvent();

			// the called method if the event is triggered
			virtual void ExecuteEvent() = 0;
		};
	} // end of namespace event
} // end of namespace sdr

//////////////////////////////////////////////////////////////////////////////

namespace sdr
{
	namespace event
	{
		class EventHandler
		{
			BaseEventVector									maVector;

			// to allow BaseEvents to use the add/remove functionality
			friend class BaseEvent;

			// methods to add/remove events. These are private since
			// they are used from BaseEvent only.
			void AddEvent(BaseEvent& rBaseEvent);
			void RemoveEvent(BaseEvent& rBaseEvent);

			// access to a event, 0L when no more events
			BaseEvent* GetEvent();

		public:
			// basic constructor.
			EventHandler();

			// destructor
			virtual ~EventHandler();

			// Trigger and consume the events
			virtual void ExecuteEvents();

			// for control
			sal_Bool IsEmpty() const;
		};
	} // end of namespace event
} // end of namespace sdr

//////////////////////////////////////////////////////////////////////////////

namespace sdr
{
	namespace event
	{
		class TimerEventHandler : public EventHandler, public Timer
		{
		public:
			// basic constructor.
			TimerEventHandler(sal_uInt32 nTimeout = 1L);

			// destructor
			virtual ~TimerEventHandler();

			// The timer when it is triggered; from class Timer
			virtual void Timeout();

			// reset the timer
			void Restart();
		};
	} // end of namespace event
} // end of namespace sdr

//////////////////////////////////////////////////////////////////////////////

#endif //_SDR_EVENT_EVENTHANDLER_HXX

// eof