PFont.h

Go to the documentation of this file.

//* -*- mode:C++; tab-width:4; c-basic-offset:4; indent-tabs-mode:nil -*- */
//    Name:       src/objects/PFont.h
//    Purpose:    Contains generic specs for a font
//    Author:     Shane T. Mueller, Ph.D.
//    Copyright:  (c) 2003-2026 Shane T. Mueller <smueller@obereed.net>
//    License:    GPL 2
//
//
//
//     This file is part of the PEBL project.
//
//    PEBL 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 2 of the License, or
//    (at your option) any later version.
//
//    PEBL 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 PEBL; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#ifndef __PFONT_H__
#define __PFONT_H__
 
 
#include "PWidget.h"
#include "PColor.h"
#include <string>
#include "../utility/rc_ptrs.h"
#include "../base/PEBLObject.h"
 
 
enum PFontStyle
    {
        PFS_Normal    = 0x00,   
        PFS_Bold      = 0x01,
        PFS_Italic    = 0x02,
        PFS_Underline = 0x04
    };
 
 
class PFont: virtual public PEBLObjectBase
{
public:
 
    PFont();                                     
    PFont(const std::string &  filename);
    PFont(const std::string & filename, int style, int size,
          PColor fgcolor, PColor bgcolor, bool aa);
    PFont(const PFont & font);              
    virtual ~PFont();                       
 
    //overloaded generic PObject methods
    virtual bool SetProperty(std::string, Variant v);
    virtual Variant GetProperty(std::string)const;
    virtual ObjectValidationError ValidateProperty(std::string, Variant v)const;
    virtual ObjectValidationError ValidateProperty(std::string)const;
    
    virtual std::string ObjectName() const;
    
    virtual void SetFontFileName(const std::string & name);
    virtual void SetFontStyle(const int style);
    virtual void SetFontSize(const int size); 
    virtual void SetFontColor(PColor color);
    virtual void SetBackgroundColor(PColor color);
    virtual void SetAntiAliased(const bool aa);
 
 
    
    //Get methods for all of the data in font
    virtual std::string GetFontFileName()     const {return mFontFileName;};
    virtual int GetFontStyle()          const {return mFontStyle;};
    virtual int GetFontSize()           const {return mFontSize;};
    virtual PColor GetFontColor()       const;
    virtual PColor GetBackgroundColor() const;
    virtual bool GetAntiAliased()       const {return mAntiAliased;};
 
 
    //These get different styles
    virtual bool IsNormalFont() const;
    virtual bool IsBoldFont()   const;
    virtual bool IsItalicFont() const;
    virtual bool IsUnderlineFont() const;
 
protected:
    virtual  std::ostream & SendToStream(std::ostream& out) const;
 
    // Helper methods to get color pointers from property system (like PDrawObject)
    PColor* GetFontColorPtr() const;
    PColor* GetBackgroundColorPtr() const;
 
    std::string  mFontFileName;            // Filename of font file.
    int  mFontStyle;                 // Bold, underlined, italics, normal, etc.  These use PFontStyle constants or'ed together
    int  mFontSize;                  // Size, in 'points'
 
    // Colors are stored ONLY in property map (like PDrawObject, PCanvas, PWindow)
    // No member variables - eliminates double ownership bug
    bool mAntiAliased;               // Whether the text is anti-aliased, alpha-blended with background (slow but nice)    
};
 
 
#endif