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

   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: SymbolDescriptor.idl,v $
  10  * $Revision: 1.7 $
  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 #ifndef __com_sun_star_formula_Symbol_idl__
  31 #define __com_sun_star_formula_Symbol_idl__
  32
  33 //=============================================================================
  34
  35  module com {  module sun {  module star {  module formula {
  36
  37 //=============================================================================
  38 /** @deprecated draft
  39     - nWeight should be changed to float as in FontWeight.idl
  40     - nItalic probably needs to have FontItalic extended by the two
  41       extra defines REVERSE_* listed in FontSlant.idl
  42     - nCharSet should have the CharSet.idl extended by the new defines
  43       from rtl/textenc.h
  44 */
  45 published struct SymbolDescriptor
  46 {
  47     /** The name of the symbol.
  48     */
  49     string sName;
  50
  51     /** The export name of the symbol.
  52     */
  53     string sExportName;
  54
  55     /** Specifies the name of the symbol set to which this symbol belongs.
  56     */
  57     string sSymbolSet;
  58
  59     /** Specifies the unicode character of the symbol.
  60     */
  61     long nCharacter;
  62
  63     /** Specifies the exact name of the font ("Arial", "Courier", etc.).
  64     */
  65     string sFontName;
  66
  67     /** Specifies the character set which is supported by the font.
  68
  69         @see   <type scope="com::sun::star::awt">CharSet</type>
  70     */
  71     short nCharSet;
  72
  73     /** Specifies the general style of the font.
  74
  75         @see   <type scope="com::sun::star::awt">FontFamily</type>
  76     */
  77     short nFamily;
  78
  79     /** Specifies the pitch of the font.
  80
  81         @see   <type scope="com::sun::star::awt">FontPitch</type>
  82     */
  83     short nPitch;
  84
  85     /** Specifies the thickness of the line.
  86
  87         @see   <type scope="com::sun::star::awt">FontWeight</type>
  88
  89         The allowed integer values correspond as follows:
  90         0 : <member scope="com::sun::star::awt">FontWeight::DONTKNOW</member>
  91         1 : <member scope="com::sun::star::awt">FontWeight::THIN</member>
  92         2 : <member scope="com::sun::star::awt">FontWeight::ULTRALIGHT</member>
  93         3 : <member scope="com::sun::star::awt">FontWeight::LIGHT</member>
  94         4 : <member scope="com::sun::star::awt">FontWeight::SEMILIGHT</member>
  95         5 : <member scope="com::sun::star::awt">FontWeight::NORMAL</member>
  96         7 : <member scope="com::sun::star::awt">FontWeight::SEMIBOLD</member>
  97         8 : <member scope="com::sun::star::awt">FontWeight::BOLD</member>
  98         9 : <member scope="com::sun::star::awt">FontWeight::ULTRABOLD</member>
  99         10 : <member scope="com::sun::star::awt">FontWeight::BLACK</member>
 100
 101     */
 102     short nWeight;
 103
 104     /** Specifies if the font is italic.
 105
 106         @see   <type scope="com::sun::star::awt">FontSlant</type>
 107
 108         The values
 109         <member cope"com::sun::star::awt">FontSlant::REVERSE_OBLIQUE</member> and
 110         <member scope="com::sun::star::awt">FontSlant::REVERSE_ITALIC</member>
 111         may not be used.
 112     */
 113     short nItalic;
 114 };
 115 }; }; }; };
 116 #endif