Crystal Space: iutil/eventnames.h Source File (Crystal Space Public API Reference)

| ## Public API Reference

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

- File List
- File Members

# iutil/eventnames.h

Go to the documentation of this file.

    00001 /*
    00002   Copyright (C) 2005 by Adam D. Bradley <artdodge@cs.bu.edu>
    00003
    00004   This library is free software; you can redistribute it and/or
    00005   modify it under the terms of the GNU Library General Public
    00006   License as published by the Free Software Foundation; either
    00007   version 2 of the License, or (at your option) any later version.
    00008
    00009   This library is distributed in the hope that it will be useful,
    00010   but WITHOUT ANY WARRANTY; without even the implied warranty of
    00011   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00012   Library General Public License for more details.
    00013
    00014   You should have received a copy of the GNU Library General Public
    00015   License along with this library; if not, write to the Free
    00016   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    00017 */
    00018
    00019 #ifndef __CS_IUTIL_EVENTNAMES_H__
    00020 #define __CS_IUTIL_EVENTNAMES_H__
    00021
    00022 #include "iutil/strset.h"
    00023 class csString;
    00024
    00032 #include "csutil/scf_interface.h"
    00033
    00038 typedef csStringID csEventID;
    00039
    00040 #define CS_EVENT_INVALID csInvalidStringID
    00041 #define CS_EVENTLIST_END csInvalidStringID
    00042
    00043
    00060 struct iEventNameRegistry : public virtual iBase
    00061 {
    00062   SCF_INTERFACE(iEventNameRegistry, 1,1,0);
    00063
    00068   virtual CS_CONST_METHOD csEventID GetID (const char* name) = 0;
    00069
    00073   virtual CS_CONST_METHOD const char* GetString (const csEventID id) = 0;
    00078   virtual CS_CONST_METHOD csEventID GetParentID (const csEventID id) = 0;
    00085   virtual CS_CONST_METHOD bool IsImmediateChildOf (const csEventID child,
    00086                                                    const csEventID parent) = 0;
    00094   virtual CS_CONST_METHOD bool IsKindOf (const csEventID child,
    00095     const csEventID parent) = 0;
    00096
    00097 };
    00098
    00101 #endif // __CS_IUTIL_EVENTNAMES_H__