offapi/com/sun/star/rendering/FontInfo.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_rendering_FontInfo_idl__
  28 #define __com_sun_star_rendering_FontInfo_idl__
  29
  30 #ifndef __com_sun_star_util_TriState_idl__
  31 #include <com/sun/star/util/TriState.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_rendering_Panose_idl__
  35 #include <com/sun/star/rendering/Panose.idl>
  36 #endif
  37
  38
  39 module com { module sun { module star { module rendering {
  40
  41 /** This structure provides information about a specific font.<p>
  42
  43     @since OOo 2.0.0
  44  */
  45 struct FontInfo
  46 {
  47     /** The PANOSE font classification.<p>
  48
  49         TODO: Document semantics in Panose.idl
  50      */
  51     Panose                              FontDescription;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** The name of the font family.<p>
  56
  57         The family name is the one normally associated to a font, such
  58         as Times New Roman, Thorndale, Andale or Arial.<p>
  59
  60         Note: outlined fonts are now specified with 'outline' as part
  61         of the family name.<p>
  62      */
  63     string                              FamilyName;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** The name of the specific font style within its family.<p>
  68
  69         For example, oblique, italic, or narrow.<p>
  70      */
  71     string                              StyleName;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** This value specifies which unicode ranges are supported by
  76          this font.<p>
  77
  78         This is to be interpreted as a split-up 128bit value, see <a
  79         href=http://partners.adobe.com/asn/tech/type/opentype/os2.jsp#ur>Adobe's
  80         OpenType specification</a> for the specific meaning of each
  81         bit. UnicodeRanges0 contains the least significant bits,
  82         UnicodeRanges3 the most significant ones.<p>
  83
  84         const int128       UNICODE_RANGE_BASIC_LATIN = 1;
  85         const int128       UNICODE_RANGE_LATIN_SUPPLEMENT = 2;
  86         const int128       UNICODE_RANGE_LATIN_EXTENDED_A = 4;
  87         const int128       UNICODE_RANGE_LATIN_EXTENDED_B = 4;
  88         ...
  89         const int128       UNICODE_RANGE_MASK_LATIN = 1;
  90         const int128       UNICODE_RANGE_MASK_CJK   = (31<<48) + (3<<55) +
  91         (1<<59);
  92         const int128       UNICODE_RANGE_MASK_CTL   = (1<<11) + (1<<13) +
  93         (0x3FFF<<15) + (0x0FFF<<70);
  94
  95      */
  96     long                                UnicodeRanges0;
  97     long                                UnicodeRanges1;
  98     long                                UnicodeRanges2;
  99     long                                UnicodeRanges3;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** Specifies whether the font is a symbol font.<p>
 104
 105         If yes, text written in this symbol font does not have a
 106         specified meaning.<p>
 107      */
 108     ::com::sun::star::util::TriState    IsSymbolFont;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** Set to true, if the font is usable for vertical text
 113         output.<p>
 114
 115         Vertical fonts have subtle differences to horizontal ones,
 116         e.g. rotated or differently shaped glyphs, or special rotated
 117         versions of normally upright glyphs (e.g. brackets).<p>
 118      */
 119     ::com::sun::star::util::TriState    IsVertical;
 120
 121
 122 };
 123
 124 }; }; }; };
 125
 126 #endif