merging back XTI branch part 2

[wxWidgets.git] / include / wx / xtihandler.h

/////////////////////////////////////////////////////////////////////////////\r
// Name:        wx/xtihandler.h\r
// Purpose:     XTI handlers\r
// Author:      Stefan Csomor\r
// Modified by: Francesco Montorsi\r
// Created:     27/07/03\r
// RCS-ID:      $Id: xti.h 47299 2007-07-10 15:58:27Z FM $\r
// Copyright:   (c) 1997 Julian Smart\r
//              (c) 2003 Stefan Csomor\r
// Licence:     wxWindows licence\r
/////////////////////////////////////////////////////////////////////////////\r
\r
#ifndef _XTIHANDLER_H_\r
#define _XTIHANDLER_H_\r
\r
#include "wx/defs.h"\r
\r
#if wxUSE_EXTENDED_RTTI\r
\r
#include "wx/string.h"\r
\r
class WXDLLIMPEXP_BASE wxObject;\r
class WXDLLIMPEXP_BASE wxClassInfo;\r
class WXDLLIMPEXP_BASE wxDynamicClassInfo;\r
class WXDLLIMPEXP_BASE wxHashTable;\r
class WXDLLIMPEXP_BASE wxHashTable_Node;\r
class WXDLLIMPEXP_BASE wxObjectRefData;\r
class WXDLLIMPEXP_BASE wxEvent;\r
class WXDLLIMPEXP_BASE wxEvtHandler;\r
\r
typedef void (wxObject::*wxObjectEventFunction)(wxEvent&);\r
\r
// ----------------------------------------------------------------------------\r
// Handler Info\r
//\r
// this describes an event sink\r
// ----------------------------------------------------------------------------\r
\r
class WXDLLIMPEXP_BASE wxHandlerInfo\r
{\r
    friend class WXDLLIMPEXP_BASE wxDynamicClassInfo;\r
\r
public:\r
    wxHandlerInfo(wxHandlerInfo* &iter,\r
                  wxClassInfo* itsClass,\r
                  const wxString& name,\r
                  wxObjectEventFunction address,\r
                  const wxClassInfo* eventClassInfo) :\r
            m_eventFunction(address),\r
            m_name(name),\r
            m_eventClassInfo(eventClassInfo),\r
            m_itsClass(itsClass)\r
       {\r
            Insert(iter);\r
       }\r
\r
    ~wxHandlerInfo()\r
        { Remove(); }\r
\r
    // return the name of this handler\r
    const wxString& GetName() const { return m_name; }\r
\r
    // return the class info of the event\r
    const wxClassInfo *GetEventClassInfo() const { return m_eventClassInfo; }\r
\r
    // get the handler function pointer\r
    wxObjectEventFunction GetEventFunction() const { return m_eventFunction; }\r
\r
    // returns NULL if this is the last handler of this class\r
    wxHandlerInfo*     GetNext() const { return m_next; }\r
\r
    // return the class this property is declared in\r
    const wxClassInfo*   GetDeclaringClass() const { return m_itsClass; }\r
\r
private:\r
\r
    // inserts this handler at the end of the linked chain which begins\r
    // with "iter" handler.\r
    void Insert(wxHandlerInfo* &iter);\r
\r
    // removes this handler from the linked chain of the m_itsClass handlers.\r
    void Remove();\r
\r
    wxObjectEventFunction m_eventFunction;\r
    wxString              m_name;\r
    const wxClassInfo*    m_eventClassInfo;\r
    wxHandlerInfo*        m_next;\r
    wxClassInfo*          m_itsClass;\r
};\r
\r
#define wxHANDLER(name,eventClassType)                                               \\r
    static wxHandlerInfo _handlerInfo##name( first, class_t::GetClassInfoStatic(),   \\r
                    wxT(#name), (wxObjectEventFunction) (wxEventFunction) &name,     \\r
                    CLASSINFO( eventClassType ) );\r
\r
#define wxBEGIN_HANDLERS_TABLE(theClass)          \\r
    wxHandlerInfo *theClass::GetHandlersStatic()  \\r
    {                                             \\r
        typedef theClass class_t;                 \\r
        static wxHandlerInfo* first = NULL;\r
\r
#define wxEND_HANDLERS_TABLE()                    \\r
    return first; }\r
\r
#define wxEMPTY_HANDLERS_TABLE(theClass)          \\r
    wxBEGIN_HANDLERS_TABLE(theClass)              \\r
    wxEND_HANDLERS_TABLE()\r
\r
#endif      // wxUSE_EXTENDED_RTTI\r
#endif      // _XTIHANDLER_H_\r