CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ivideo/custcursor.h

00001 /*
00002     This library is free software; you can redistribute it and/or
00003     modify it under the terms of the GNU Lesser General Public
00004     License as published by the Free Software Foundation; either
00005     version 2 of the License, or (at your option) any later version.
00006 
00007     This library is distributed in the hope that it will be useful,
00008     but WITHOUT ANY WARRANTY; without even the implied warranty of
00009     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00010     Library General Public License for more details.
00011 
00012     You should have received a copy of the GNU Library General Public
00013     License along with this library; if not, write to the Free
00014     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00015 */
00016 
00017 #ifndef __CS_IVIDEO_CUSTCURSOR_H__
00018 #define __CS_IVIDEO_CUSTCURSOR_H__
00019 
00020 #include "csutil/scf.h"
00021 #include "csgeom/cspoint.h"
00022 #include "igraphic/image.h"
00023 
00025 #define CSCURSOR_Default "default"
00026 
00027 #define CSCURSOR_MouseDown "MouseDown"
00028 
00029 SCF_VERSION (iCursor, 0, 0, 1);
00030 
00038 struct iCursor : public iBase
00039 {
00040   
00046   virtual bool Setup (iGraphics3D *, bool forceEmulation = false) = 0;
00047 
00049   virtual bool ParseConfigFile (const char *iFile) = 0;
00050 
00055   virtual void SetCursor (const char *name, iImage *image, csRGBcolor keycolor, 
00056                           csPoint hotspot = csPoint (0,0), uint8 alpha = 0, 
00057                           csRGBcolor fg = csRGBcolor (255,255,255),
00058                           csRGBcolor bg = csRGBcolor (0,0,0)) = 0;
00059       
00061   virtual void SetHotspot (const char *name, csPoint hotspot) = 0;
00062 
00067   virtual void SetAlpha (const char *name, uint8 alpha) = 0;
00068   
00070   virtual void SetKeyColor (const char *name, csRGBcolor col) = 0;
00071 
00076   virtual void SetColor (const char *name, csRGBcolor fg, csRGBcolor bg) = 0;
00077 
00084   virtual const csRef<iImage> GetCursorImage (const char *name) const = 0;
00085 
00090   virtual csPoint GetHotspot (const char *name) const = 0;
00091 
00096   virtual uint8 GetAlpha (const char *name) const = 0;
00097   
00102   virtual csRGBcolor GetKeyColor (const char *name) const = 0;
00103 
00109   virtual csRGBcolor GetFGColor (const char *name) const = 0;
00110 
00116   virtual csRGBcolor GetBGColor (const char *name) const = 0;
00117 
00119   virtual bool RemoveCursor (const char *name) = 0;
00120 
00122   virtual void RemoveAllCursors () = 0;
00123 
00131   virtual bool SwitchCursor (const char *name) = 0;
00132 };
00133 
00134 #endif //__CS_IVIDEO_CUSTCURSOR_H__

Generated for Crystal Space by doxygen 1.2.18