offapi/com/sun/star/formula/SymbolDescriptor.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_formula_Symbol_idl__
  29 #define __com_sun_star_formula_Symbol_idl__
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module formula {
  34
  35 //=============================================================================
  36 /** @deprecated draft
  37     - nWeight should be changed to float as in FontWeight.idl
  38     - nItalic probably needs to have FontItalic extended by the two
  39       extra defines REVERSE_* listed in FontSlant.idl
  40     - nCharSet should have the CharSet.idl extended by the new defines
  41       from rtl/textenc.h
  42 */
  43 published struct SymbolDescriptor
  44 {
  45     /** The name of the symbol.
  46     */
  47     string sName;
  48
  49     /** The export name of the symbol.
  50     */
  51     string sExportName;
  52
  53     /** Specifies the name of the symbol set to which this symbol belongs.
  54     */
  55     string sSymbolSet;
  56
  57     /** Specifies the Unicode character of the symbol.
  58     */
  59     long nCharacter;
  60
  61     /** Specifies the exact name of the font ("Arial", "Courier", etc.).
  62     */
  63     string sFontName;
  64
  65     /** Specifies the character set which is supported by the font.
  66
  67         @see   <type scope="com::sun::star::awt">CharSet</type>
  68     */
  69     short nCharSet;
  70
  71     /** Specifies the general style of the font.
  72
  73         @see   <type scope="com::sun::star::awt">FontFamily</type>
  74     */
  75     short nFamily;
  76
  77     /** Specifies the pitch of the font.
  78
  79         @see   <type scope="com::sun::star::awt">FontPitch</type>
  80     */
  81     short nPitch;
  82
  83     /** Specifies the thickness of the line.
  84
  85         @see   <type scope="com::sun::star::awt">FontWeight</type>
  86
  87         The allowed integer values correspond as follows:
  88         0 : <member scope="com::sun::star::awt">FontWeight::DONTKNOW</member>
  89         1 : <member scope="com::sun::star::awt">FontWeight::THIN</member>
  90         2 : <member scope="com::sun::star::awt">FontWeight::ULTRALIGHT</member>
  91         3 : <member scope="com::sun::star::awt">FontWeight::LIGHT</member>
  92         4 : <member scope="com::sun::star::awt">FontWeight::SEMILIGHT</member>
  93         5 : <member scope="com::sun::star::awt">FontWeight::NORMAL</member>
  94         7 : <member scope="com::sun::star::awt">FontWeight::SEMIBOLD</member>
  95         8 : <member scope="com::sun::star::awt">FontWeight::BOLD</member>
  96         9 : <member scope="com::sun::star::awt">FontWeight::ULTRABOLD</member>
  97         10 : <member scope="com::sun::star::awt">FontWeight::BLACK</member>
  98
  99     */
 100     short nWeight;
 101
 102     /** Specifies if the font is italic.
 103
 104         @see   <type scope="com::sun::star::awt">FontSlant</type>
 105
 106         The values
 107         <member cope"com::sun::star::awt">FontSlant::REVERSE_OBLIQUE</member> and
 108         <member scope="com::sun::star::awt">FontSlant::REVERSE_ITALIC</member>
 109         may not be used.
 110     */
 111     short nItalic;
 112 };
 113 }; }; }; };
 114 #endif
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */