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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_rendering_FontInfo_idl__
  20 #define __com_sun_star_rendering_FontInfo_idl__
  21
  22 #include <com/sun/star/util/TriState.idl>
  23 #include <com/sun/star/rendering/Panose.idl>
  24
  25
  26 module com { module sun { module star { module rendering {
  27
  28 /** This structure provides information about a specific font.<p>
  29
  30     @since OOo 2.0
  31  */
  32 struct FontInfo
  33 {
  34     /** The PANOSE font classification.<p>
  35
  36         TODO: Document semantics in Panose.idl
  37      */
  38     Panose                              FontDescription;
  39
  40
  41     /** The name of the font family.<p>
  42
  43         The family name is the one normally associated to a font, such
  44         as Times New Roman, Thorndale, Andale or Arial.<p>
  45
  46         Note: outlined fonts are now specified with "outline" as part
  47         of the family name.<p>
  48      */
  49     string                              FamilyName;
  50
  51
  52     /** The name of the specific font style within its family.<p>
  53
  54         For example, oblique, italic, or narrow.<p>
  55      */
  56     string                              StyleName;
  57
  58
  59     /** This value specifies which Unicode ranges are supported by
  60         this font.<p>
  61
  62         This is to be interpreted as a split-up 128-bit value, see <a
  63         href=http://partners.adobe.com/asn/tech/type/opentype/os2.jsp#ur>Adobe's
  64         OpenType specification</a> for the specific meaning of each
  65         bit. UnicodeRanges0 contains the least significant bits,
  66         UnicodeRanges3 the most significant ones.<p>
  67
  68         const int128       UNICODE_RANGE_BASIC_LATIN = 1;
  69         const int128       UNICODE_RANGE_LATIN_SUPPLEMENT = 2;
  70         const int128       UNICODE_RANGE_LATIN_EXTENDED_A = 4;
  71         const int128       UNICODE_RANGE_LATIN_EXTENDED_B = 4;
  72         ...
  73         const int128       UNICODE_RANGE_MASK_LATIN = 1;
  74         const int128       UNICODE_RANGE_MASK_CJK   = (31<<48) + (3<<55) +
  75         (1<<59);
  76         const int128       UNICODE_RANGE_MASK_CTL   = (1<<11) + (1<<13) +
  77         (0x3FFF<<15) + (0x0FFF<<70);
  78
  79      */
  80     long                                UnicodeRanges0;
  81     long                                UnicodeRanges1;
  82     long                                UnicodeRanges2;
  83     long                                UnicodeRanges3;
  84
  85
  86     /** Specifies whether the font is a symbol font.<p>
  87
  88         If yes, text written in this symbol font does not have a
  89         specified meaning.<p>
  90      */
  91     ::com::sun::star::util::TriState    IsSymbolFont;
  92
  93
  94     /** Set to true, if the font is usable for vertical text
  95         output.<p>
  96
  97         Vertical fonts have subtle differences to horizontal ones,
  98         e.g. rotated or differently shaped glyphs, or special rotated
  99         versions of normally upright glyphs (e.g. brackets).<p>
 100      */
 101     ::com::sun::star::util::TriState    IsVertical;
 102
 103
 104 };
 105
 106 }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */