vcl/unx/inc/salfont.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: salfont.h,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SV_SALFONT_H
  32 #define _SV_SALFONT_H
  33
  34 // -=-= exports =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  35 class   SalFontCache;
  36 struct  SalFontDimension;
  37 class   SalFontFamily;
  38 class   SalFontFamilyList;
  39 class   SalFontStruct;
  40 class   SalFontStructList;
  41 class   SalFonts;
  42
  43 // -=-= includes -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  44 #include <salstd.hxx>
  45 #include <vcl/outfont.hxx>
  46
  47 // -=-= forwards =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  48 typedef ULONG XFP_FLAGS;
  49
  50 class   SalDisplay;
  51 class   SalFontCacheItem;
  52
  53 // -=-= SalFontCache -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  54 DECLARE_LIST( SalFontCache, SalFontCacheItem* )
  55
  56 // -=-= SalFontDimension -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  57 struct SalFontDimension
  58 {
  59             USHORT              nHeight_;                               // [pixel]
  60             USHORT              nPtHeight_;                             // [point/10]
  61             USHORT              nAverage_;                              // [pixel/10]
  62             USHORT              nXRes_;                                 // [dpi]
  63             USHORT              nYRes_;                                 // [dpi]
  64             USHORT      nSlant_;                                // [pixel]
  65 //                      size_t          nUnderlineThickness_;   // [pixel]
  66 //                      size_t      nUnderlinePosition_;    // [pixel]
  67 //                      size_t      nStrikeoutAscent_;      // [pixel]
  68 //                      size_t      nStrikeoutDescent_;     // [pixel]
  69 //                      Subscript, Superscript, Capital, Space ...
  70
  71     inline                              SalFontDimension( USHORT nA = 0, USHORT nH = 0 );
  72
  73     inline      BOOL            IsScalable() const;
  74     inline      USHORT          GetWidth() const { return (nAverage_ + 5) / 10; }
  75     inline      Size            GetSize() const;
  76     inline      void            SetSize( const Size & rSize );
  77     inline      BOOL            operator == ( const SalFontDimension &r ) const;
  78     inline      BOOL            operator != ( const SalFontDimension &r ) const;
  79     inline      BOOL            operator >= ( const SalFontDimension &r ) const;
  80 };
  81
  82 inline SalFontDimension::SalFontDimension( USHORT nA, USHORT nH )
  83     : nHeight_( nH ), nAverage_( nA )
  84 { nPtHeight_ = nXRes_ = nYRes_ = nSlant_ = 0; }
  85
  86 inline BOOL     SalFontDimension::IsScalable() const
  87 { return !nHeight_ && !nPtHeight_ && !nAverage_; }
  88
  89 inline Size     SalFontDimension::GetSize() const
  90 { return Size( (nAverage_ + 5) / 10, nHeight_ ); }
  91
  92 inline void     SalFontDimension::SetSize( const Size & rSize )
  93 { nAverage_ = (USHORT)rSize.Width() * 10; nHeight_ = (USHORT)rSize.Height(); }
  94
  95 inline BOOL     SalFontDimension::operator == ( const SalFontDimension &r ) const
  96 { return nHeight_ == r.nHeight_ && (!r.nAverage_ || nAverage_ == r.nAverage_); }
  97
  98 inline BOOL     SalFontDimension::operator != ( const SalFontDimension &r ) const
  99 { return !(*this == r); }
 100
 101 inline BOOL     SalFontDimension::operator >= ( const SalFontDimension &r ) const
 102 { return nHeight_ > r.nHeight_
 103          || (nHeight_ == r.nHeight_ && nAverage_ >= r.nAverage_); }
 104
 105 // -=-= SalFontStruct =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 106 class SalFontStruct : public ImplFontMetricData
 107 {
 108     friend class SalDisplay;
 109     friend class SalGraphicsData;
 110
 111             SalFontCacheItem*pCache_;
 112
 113 #if (OSL_DEBUG_LEVEL > 1) || defined  DBG_UTIL
 114             ByteString          aFontName_;
 115 #endif
 116             USHORT                      nHeightCount_;          // Anzahl der Hoehen-Eintraege
 117             SalFontDimension*pDimensions_;              // Hoehen-Array
 118             USHORT                      nWeight_;
 119
 120             USHORT                      nFoundry_;                      // properties indexies
 121             USHORT                      nFamily_;
 122             USHORT                      nWeightName_;
 123             USHORT                      nSlant_;
 124             USHORT                      nSetWidthName_;
 125             ByteString          aAddStyleName_;
 126             USHORT                      nSpacing_;
 127             USHORT                      nCharSet_;
 128             USHORT                      nFaceName_;
 129             BOOL            mbValidFontDescription;     // valid xlfd entries
 130
 131             void                        Init();
 132             BOOL                        Init( SalDisplay*               pDisp,
 133                                   const char*           pFontName,
 134                                   SalFontDimension&     rDim );
 135
 136             ByteString          GetXFontName( const SalFontDimension& );
 137
 138     inline      void                    SetFoundry( USHORT n )
 139         { nFoundry_ = n; }
 140     inline      void                    SetFamily( USHORT n )
 141         { meFamily = sal_FamilyToSal( nFamily_ = n ); }
 142     inline      void                    SetWeightName( USHORT n )
 143         { meWeight = sal_WeightToSal( nWeightName_ = n ); }
 144     inline      void                    SetSlant( USHORT n )
 145         { meItalic = sal_ItalicToSal( nSlant_ = n ); }
 146     inline      void                    SetSetWidthName( USHORT n )
 147         { nSetWidthName_ = n; }
 148     inline      void                    SetAddStyleName( const ByteString& rAddStyle )
 149         { aAddStyleName_ = rAddStyle; aAddStyleName_.ToLowerAscii(); }
 150     inline      void                    SetSpacing( USHORT n )
 151         { mePitch = sal_PitchToSal( nSpacing_ = n ); }
 152     inline      void                    SetAverage( long n )
 153         { mnWidth = (n + 5) / 10; }
 154     void                                        SetCharSet( USHORT n );
 155
 156                             SalFontStruct( const SalFontStruct& rFont );
 157 public:
 158                             SalFontStruct( SalDisplay*                  pDisp,
 159                                            const char*                  pFontName,
 160                                            SalFontDimension&    rDim );
 161
 162                             ~SalFontStruct();
 163
 164     inline      void                    Cache( SalFontCacheItem *p ) { pCache_ = p; }
 165     inline      SalFontCacheItem*IsCache() const { return pCache_; }
 166     inline      BOOL                    IsScalable() const { return TYPE_SCALABLE==meType; }
 167     inline      SalFontDimension*GetDim() const { return pDimensions_; }
 168     inline  BOOL                        IsValid() const { return mbValidFontDescription; }
 169 #ifdef DBG_UTIL
 170             const ByteString&   GetName() const { return aFontName_; }
 171 #endif
 172
 173             ImplFontData   *GetDevFontData();
 174             SalFontCacheItem*Load( SalDisplay *pDisp, const SalFontDimension &rDim );
 175             CharSet GetCharSet() { return meCharSet; }
 176
 177 };
 178
 179 // -=-= SalFontStructList =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 180 DECLARE_LIST( SalFontStructList, SalFontStruct* )
 181
 182 #endif // _SV_SALFONT_H
 183