propclass/tooltip.h Source File (CEL: Crystal Entity Layer 2.0 Public API Reference)

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001 by Jorrit Tyberghein
00004   
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009   
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014   
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_TOOLTIP__
00021 #define __CEL_PF_TOOLTIP__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 
00026 struct iFont;
00027 
00028 enum celTooltipJustify
00029 {
00030   CEL_TOOLTIP_LEFT,
00031   CEL_TOOLTIP_CENTER,
00032   CEL_TOOLTIP_RIGHT
00033 };
00034 
00038 struct iPcTooltip : public virtual iBase
00039 {
00040   SCF_INTERFACE (iPcTooltip, 0, 0, 1);
00041 
00045   virtual void SetText (const char* text) = 0;
00046 
00050   virtual void Show (int x, int y) = 0;
00051 
00055   virtual void Hide () = 0;
00056 
00060   virtual bool IsVisible () const = 0;
00061 
00065   virtual void SetTextColor (int r, int g, int b) = 0;
00066 
00071   virtual void SetBackgroundColor (int r, int g, int b) = 0;
00072 
00077   virtual void SetFont (iFont* font) = 0;
00078 
00083   virtual void SetJustify (celTooltipJustify justify) = 0;
00084 };
00085 
00086 #endif // __CEL_PF_TOOLTIP__
00087