offapi/com/sun/star/awt/FontDescriptor.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_awt_FontDescriptor_idl__
  20 #define __com_sun_star_awt_FontDescriptor_idl__
  21
  22 #include <com/sun/star/awt/FontSlant.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module awt {
  27
  28
  29 /** describes the characteristics of a font.
  30
  31     <p>For example, this can be used to select a font.</p>
  32  */
  33 published struct FontDescriptor
  34 {
  35
  36     /** specifies the exact name of the font.
  37      */
  38     string Name;
  39
  40
  41     /** specifies the height of the font in the measure of the
  42         destination.
  43      */
  44     short Height;
  45
  46
  47     /** specifies the width of the font in the measure of the
  48         destination.
  49      */
  50     short Width;
  51
  52
  53     /** specifies the style name of the font.
  54      */
  55     string StyleName;
  56
  57
  58     /** specifies the general style of the font.
  59
  60         <p>Use one value out of the constant group
  61         com::sun::star::awt::FontFamily.</p>
  62      */
  63     short Family;
  64
  65
  66     /** specifies the character set which is supported by the font.
  67
  68         <p>Use one value out of the constant group
  69         com::sun::star::awt::CharSet.</p>
  70      */
  71     short CharSet;
  72
  73
  74     /** specifies the pitch of the font.
  75
  76         <p>Use one value out of the constant group
  77         com::sun::star::awt::FontPitch.</p>
  78      */
  79     short Pitch;
  80
  81
  82     /** specifies the character width.
  83
  84         <p>Depending on the specified width, a font that supports this
  85         width may be selected.</p>
  86
  87         <p>The value is expressed as a percentage.</p>
  88      */
  89     float CharacterWidth;
  90
  91
  92     /** specifies the thickness of the line.
  93
  94         <p>Depending on the specified weight, a font that supports this
  95         thickness may be selected.</p>
  96
  97         <p>The value is expressed as a percentage.</p>
  98      */
  99     float Weight;
 100
 101
 102     /** specifies the slant of the font.
 103      */
 104     com::sun::star::awt::FontSlant Slant;
 105
 106
 107     /** specifies the kind of underlining.
 108
 109         <p>Use one value out of the constant group
 110         com::sun::star::awt::FontUnderline.</p>
 111      */
 112     short Underline;
 113
 114
 115     /** specifies the kind of strikeout.
 116
 117         <p>Use one value out of the constant group
 118         com::sun::star::awt::FontStrikeout.</p>
 119      */
 120     short Strikeout;
 121
 122
 123     /** specifies the rotation of the font.
 124
 125         <p>The unit of measure is degrees; 0 is the baseline.</p>
 126      */
 127     float Orientation;
 128
 129
 130     /** For requesting, it specifies if there is a kerning table available.
 131         For selecting, it specifies if the kerning table is to be used.
 132      */
 133     boolean Kerning;
 134
 135
 136     /** specifies if only words get underlined.
 137
 138         <p>`TRUE` means that only non-space characters get underlined,
 139         `FALSE` means that the spacing also gets underlined.</p>
 140
 141         <p>This property is only valid if the property
 142         com::sun::star::awt::FontDescriptor::Underline
 143         is not FontUnderline::NONE.</p>
 144      */
 145     boolean WordLineMode;
 146
 147
 148     /** specifies the technology of the font representation.
 149
 150         <p>One or more values out of the constant group
 151         com::sun::star::awt::FontType can be combined by
 152         an arithmetical or-operation.</p>
 153      */
 154     short Type;
 155
 156 };
 157
 158
 159 }; }; }; };
 160
 161 #endif
 162
 163 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */