CopperWindow.h

Go to the documentation of this file.

#ifndef _COPPER_WINDOW_H
#define _COPPER_WINDOW_H

#include "MercuryObject.h"
#include <map>

struct CopperKeypress
{
    char cLetter;
    enum {
        KEY_DOWN,
        KEY_UP
    } pType;
};

struct CopperMouseEvent
{
    int x;
    int y;
    enum {
        MOUSE_MOVE,
        MOUSE_DOWN,
        MOUSE_UP,
        MOUSE_IN,
        MOUSE_OUT
    } pType;
};

struct CSTMessagePair
{
    MString Message;
    MString Data;
    bool Use() { return Message.length() != 0 || Data.length() != 0; }
    void Broadcast() { if (Use()) MESSAGEMAN->BroadcastMessage( Message, PStack(PSElement(Data) )); }
};


class ScreenCopper;

class CopperWindow : public MercuryObject
{
public:
    virtual ~CopperWindow();
    virtual void Init( CopperWindow * pParent, const MString & sName );
//  virtual void Update( const float dTime );
    virtual void KeyPress( const CopperKeypress & pKeypress );
    virtual bool MouseEvent( const CopperMouseEvent & pMouseEvent );
    virtual bool IsMouseEventOnTarget( const CopperMouseEvent & pMouseEvent );

    virtual bool IsFocusable() = 0;

    MString GetFocus();
    void SetFocus( const MString & sFocus );

    void SetWidth( float fWidth ) { m_fWidth = fWidth; }
    void SetHeight( float fHeight ) { m_fHeight = fHeight; }

    float GetWidth() { return m_fWidth; }
    float GetHeight() { return m_fHeight; }
    CLASS_RTTI( CopperWindow, MercuryObject );
protected:
    CSTMessagePair  m_pBrdOverOn;
    CSTMessagePair  m_pBrdOverOff;
    CSTMessagePair  m_pBrdUpInTarget;
    CSTMessagePair  m_pBrdUpOutTarget;
    CSTMessagePair  m_pBrdDown;

    CopperWindow *  m_pParent;
    MVector < CopperWindow * > m_vWindows;
    int         m_iCurrentFocus;
    float       m_fHeight, m_fWidth;
    int         m_iLastMouseWindow;
};



//NOTE: This type of self-registering system is almost an
//exact rip-off of the one in Rage (for StepMania). The following
//few lines are (c) 2001-2005 Chris Danford, Glenn Maynard
//and fall under the MIT/X11 license listed at the bottom of this 
//document.

typedef CopperWindow* (*NewCopperFunction)(const MString& sClassName);
void RegisterCopperWindow( const MString& sClassName, NewCopperFunction pfn );

#define REGISTER_COPPER_CLASS( className ) \
    static CopperWindow* Create##className( const MString &sName ) \
    { CopperWindow *pRet = new className( /*sName*/ ); return pRet; } \
    struct Register##className { \
        Register##className() { RegisterCopperWindow( #className,Create##className); } \
    }; \
    static Register##className register_##className;

extern std::map< MString, NewCopperFunction >  *ToMakeWindows;

CopperWindow * GetCopperByClass( const MString & sClassName, const MString & sWindowName );

//End of Rage-based registering system.

#endif

/*
 * (c) 2005 Joshua Allen, Charles Lohr
 * All rights reserved.
 *
 * Certain parts of the code (as noted)
 * (c) 2001-2005 Chris Danford, Glenn Maynard
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, and/or sell copies of the Software, and to permit persons to
 * whom the Software is furnished to do so, provided that the above
 * copyright notice(s) and this permission notice appear in all copies of
 * the Software and that both the above copyright notice(s) and this
 * permission notice appear in supporting documentation.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
 * THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
 * INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
 * OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

---

Hosted by