/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
#ifndef _pyGUISkin_h_
#define _pyGUISkin_h_

//////////////////////////////////////////////////////////////////////
//
// pyGUISkin   - a wrapper class to provide interface to a GUI skin
//
//////////////////////////////////////////////////////////////////////

#include "pyKey.h"
#include <python.h>
#include "pyGlueHelpers.h"

class pyColor;

class pyGUISkin
{
private:
	plKey					fGCkey;
	
protected:
	pyGUISkin(pyKey& gckey);
	pyGUISkin(plKey objkey);
	pyGUISkin();

public:
	// required functions for PyObject interoperability
	PYTHON_CLASS_NEW_FRIEND(ptGUISkin);
	PYTHON_CLASS_NEW_DEFINITION;
	static PyObject *New(pyKey& gckey);
	static PyObject *New(plKey objkey);
	PYTHON_CLASS_CHECK_DEFINITION; // returns true if the PyObject is a pyGUISkin object
	PYTHON_CLASS_CONVERT_FROM_DEFINITION(pyGUISkin); // converts a PyObject to a pyGUISkin (throws error if not correct type)

	static void AddPlasmaClasses(PyObject *m);

	static hsBool IsGUISkin(pyKey& gckey);

	void setKey(plKey key) {fGCkey = key;} // used by python glue, do NOT call

	// override the equals to operator
	hsBool operator==(const pyGUISkin &gdobj) const;
	hsBool operator!=(const pyGUISkin &gdobj) const { return !(gdobj == *this);	}

	// getter and setters
	virtual plKey getObjKey();
	virtual PyObject* getObjPyKey(); // returns pyKey

};

#endif // _pyGUISkin_h_