CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

eventq.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 2001 by Eric Sunshine <sunshine@sunshineco.com>
00003     Copyright (C) 2000 by Andrew Zabolotny <bit@eltech.ru>
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00018 */
00019 
00020 #ifndef __CS_IUTIL_EVENTQ_H__
00021 #define __CS_IUTIL_EVENTQ_H__
00022 
00029 #include "csutil/scf.h"
00030 struct iEvent;
00031 struct iEventCord;
00032 struct iEventOutlet;
00033 struct iEventPlug;
00034 struct iEventHandler;
00035 
00036 SCF_VERSION(iEventQueue, 0, 0, 1);
00037 
00056 struct iEventQueue : public iBase
00057 {
00065   virtual void Process () = 0;
00066 
00073   virtual void Dispatch (iEvent&) = 0;
00074 
00093   virtual void RegisterListener (iEventHandler*, unsigned int trigger) = 0;
00094 
00099   virtual void RemoveListener (iEventHandler*) = 0;
00100 
00105   virtual void ChangeListenerTrigger (iEventHandler*, unsigned int trigger) = 0;
00106 
00116   virtual csPtr<iEventOutlet> CreateEventOutlet (iEventPlug*) = 0;
00117 
00129   virtual iEventOutlet* GetEventOutlet () = 0;
00130 
00139   virtual iEventCord* GetEventCord (int Category, int Subcategory) = 0;
00140 
00145   virtual csPtr<iEvent> CreateEvent(uint8 type) = 0;
00146 
00156   virtual void Post (iEvent*) = 0;
00157 
00164   virtual csPtr<iEvent> Get () = 0;
00165 
00167   virtual void Clear () = 0;
00168 
00170   virtual bool IsEmpty () = 0;
00171 
00182   virtual void RemoveAllListeners () = 0;
00183 
00184 };
00185 
00188 #endif // __CS_IUTIL_EVENTQ_H__

Generated for Crystal Space by doxygen 1.4.4