Public API Reference

ivideo/fontserv.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 by Norman Kraemer

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

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IVIDEO_FONTSERV_H__
#define __CS_IVIDEO_FONTSERV_H__

#include "csutil/csunicode.h"
#include "csutil/scf_interface.h"
#include "csutil/ref.h"


#define CSFONT_LARGE            "*large"
#define CSFONT_ITALIC           "*italic"
#define CSFONT_COURIER          "*courier"
#define CSFONT_SMALL            "*small"

#define CS_FONT_DEFAULT_GLYPH   0xffff

struct iFont;
struct iDataBuffer;


struct iFontDeleteNotify : public virtual iBase
{
  SCF_INTERFACE(iFontDeleteNotify, 2,0,0);
  virtual void BeforeDelete (iFont* font) = 0;
};

struct csBitmapMetrics
{
  int width;
  int height;
  int left;
  int top;
};

struct csGlyphMetrics
{
  int advance;
};

struct iFont : public virtual iBase
{
  SCF_INTERFACE (iFont, 6, 0, 0);

  virtual void AddDeleteCallback (iFontDeleteNotify* func) = 0;

  virtual bool RemoveDeleteCallback (iFontDeleteNotify* func) = 0;
  
  virtual float GetSize () = 0;

  virtual void GetMaxSize (int &oW, int &oH) = 0;

  virtual bool GetGlyphMetrics (utf32_char c, csGlyphMetrics& metrics) = 0;

  virtual csPtr<iDataBuffer> GetGlyphBitmap (utf32_char c,
    csBitmapMetrics& metrics) = 0;

  virtual csPtr<iDataBuffer> GetGlyphAlphaBitmap (utf32_char c,
    csBitmapMetrics& metrics) = 0;

  virtual void GetDimensions (const char *text, int &oW, int &oH) = 0;

  virtual void GetDimensions (const char *text, int &oW, int &oH,
        int &desc) = 0;

  virtual int GetLength (const char *text, int maxwidth) = 0;
  
  virtual int GetDescent () = 0; 

  virtual int GetAscent () = 0; 
  
  virtual bool HasGlyph (utf32_char c) = 0; 

  virtual int GetTextHeight () = 0;

  virtual int GetUnderlinePosition () = 0;

  virtual int GetUnderlineThickness () = 0;
};

struct iFontServer : public virtual iBase
{
  SCF_INTERFACE (iFontServer, 4, 0, 0);

  virtual csPtr<iFont> LoadFont (const char* filename, 
    float size = 10.0f) = 0;

  virtual void SetWarnOnError (bool enable) = 0;
  virtual bool GetWarnOnError () = 0;
};

#endif // __CS_IVIDEO_FONTSERV_H__

---