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

custcursor.h

00001 /*
00002     Copyright (C)2003 by Neil Mosafi
00003 
00004     This library is free software; you can redistribute it and/or
00005     modify it under the terms of the GNU Lesser 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_IVIDEO_CUSTCURSOR_H__
00020 #define __CS_IVIDEO_CUSTCURSOR_H__
00021 
00022 #include "csutil/scf.h"
00023 
00024 #include "csgfx/rgbpixel.h"
00025 #include "csgeom/vector2.h"
00026 
00027 struct iConfigFile;
00028 struct iGraphics3D;
00029 struct iImage;
00030 
00031 
00033 #define CSCURSOR_Default "default"
00034 
00035 #define CSCURSOR_MouseDown "MouseDown"
00036 
00037 SCF_VERSION (iCursor, 0, 1, 0);
00038 
00048 struct iCursor : public iBase
00049 {
00050   
00056   virtual bool Setup (iGraphics3D *, bool ForceEmulation = false) = 0;
00057 
00059   virtual bool ParseConfigFile (iConfigFile*) = 0;
00060 
00067   virtual void SetCursor (const char *name, iImage *image, 
00068     csRGBcolor* keycolor = 0, csVector2 hotspot = csVector2 (0,0),
00069     uint8 transparency = 0, csRGBcolor fg = csRGBcolor (255,255,255),
00070     csRGBcolor bg = csRGBcolor (0,0,0)) = 0;
00071       
00073   virtual void SetHotSpot (const char *name, csVector2 hotspot) = 0;
00074 
00081   virtual void SetTransparency(const char *name, uint8 transparancy) = 0;
00082   
00084   virtual void SetKeyColor (const char *name, csRGBcolor) = 0;
00085 
00090   virtual void SetColor (const char *name, csRGBcolor fg, csRGBcolor bg) = 0;
00091 
00098   virtual csRef<iImage> GetCursorImage (const char *name) const = 0;
00099 
00104   virtual csVector2 GetHotSpot (const char *name) const = 0;
00105 
00111   virtual uint8 GetTransparency (const char *name) const = 0;
00112   
00118   virtual const csRGBcolor* GetKeyColor (const char *name) const = 0;
00119 
00125   virtual csRGBcolor GetFGColor (const char *name) const = 0;
00126 
00132   virtual csRGBcolor GetBGColor (const char *name) const = 0;
00133 
00135   virtual bool RemoveCursor (const char *name) = 0;
00136 
00138   virtual void RemoveAllCursors () = 0;
00139 
00147   virtual bool SwitchCursor (const char *name) = 0;
00148 };
00149 
00150 #endif //__CS_IVIDEO_CUSTCURSOR_H__

Generated for Crystal Space by doxygen 1.4.4