summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/FontDescriptor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/awt/FontDescriptor.idl')
-rw-r--r--offapi/com/sun/star/awt/FontDescriptor.idl272
1 files changed, 272 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/FontDescriptor.idl b/offapi/com/sun/star/awt/FontDescriptor.idl
new file mode 100644
index 000000000000..79470c7e657b
--- /dev/null
+++ b/offapi/com/sun/star/awt/FontDescriptor.idl
@@ -0,0 +1,272 @@
+/*************************************************************************
+ *
+ * $RCSfile: FontDescriptor.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:21:05 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_awt_FontDescriptor_idl__
+#define __com_sun_star_awt_FontDescriptor_idl__
+
+#ifndef __com_sun_star_awt_FontSlant_idl__
+#include <com/sun/star/awt/FontSlant.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module awt {
+
+//=============================================================================
+
+// DocMerge from xml: struct com::sun::star::awt::FontDescriptor
+/** describes the characteristics of a font.
+
+
+
+ <p>For example, this can be used to select a font.</p>
+ */
+struct FontDescriptor
+{
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Name
+ /** specifies the exact name of the font ("Arial",
+ "Courier", "Frutiger").
+ */
+ string Name;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Height
+ /** specifies the height of the font in the measure of the
+ destination.
+ */
+ short Height;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Width
+ /** specifies the width of the font in the measure of the
+ destination.
+ */
+ short Width;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::StyleName
+ /** specifies the style name of the font ("Bold", "Fett", "Italic
+ Bold").
+ */
+ string StyleName;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Family
+ /** specifies the general style of the font.
+
+
+
+ <p>Use one value out of the constant group
+ <type>FontFamily</type>.</p>
+ */
+ short Family;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::CharSet
+ /** specifies the character set which is supported by the font.
+
+ <p>Use one value out of the constant group
+ <type scope="com::sun::star::awt">CharSet</type>.</p>
+ */
+ short CharSet;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Pitch
+ /** specifies the pitch of the font.
+
+ <p>Use one value out of the constant group
+ <type scope="com::sun::star::awt">FontPitch</type>.</p>
+ */
+ short Pitch;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::CharacterWidth
+ /** specifies the character width.
+
+
+
+ <p>Depending on the specified width, a font that supports this
+ width may be selected.
+
+ </p>
+ <p>The value is expressed as a percentage.</p>
+ */
+ float CharacterWidth;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Weight
+ /** specifies the thickness of the line.
+
+
+
+ <p>Depending on the specified weight, a font that supports this thickness may be selected.
+
+ </p>
+ <p>The value is expressed as a percentage.</p>
+ */
+ float Weight;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Slant
+ /** specifies if there is a character slant (italic).
+ */
+ com::sun::star::awt::FontSlant Slant;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Underline
+ /** use one value out of the constant group <type>FontUnderline</type>.
+ */
+ short Underline;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Strikeout
+ /** use one value out of the constant group <type scope="com::sun::star::awt">FontStrikeout</type>.
+ */
+ short Strikeout;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Orientation
+ /** specifies the rotation of the font.
+
+
+
+ <p>The unit of measure is degrees; 0 is the baseline.</p>
+ */
+ float Orientation;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Kerning
+ /** for requesting, it specifies if there is a kerning table available.
+ For selecting, it specifies if the kerning table is to be used.
+ */
+ boolean Kerning;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::WordLineMode
+ /** specifies if only words get underlined.
+
+
+
+ <p>
+ <true></true> means that only non-space characters get underlined,
+ <false></false> means that the spacing also gets underlined.
+
+ </p>
+ <p>This property is only valid if the property
+ <member scope="com::sun::star::awt">FontDescriptor::Underline</member> is not
+ <const>FontUnderline::NONE</const>.</p>
+ */
+ boolean WordLineMode;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::awt::FontDescriptor::Type
+ /** specifies the technology of the font representation.
+
+
+
+ <p>One or more values out of the constant group
+ <type scope="com::sun::star::awt">FontType</type> can be combined by an arithmetical
+ or-operation.</p>
+ */
+ short Type;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+ $Log: not supported by cvs2svn $
+ Revision 1.1.1.1 2000/09/18 23:34:49 hjs
+ initial import
+
+ Revision 1.5 2000/09/11 11:52:04 mi
+ documentation merged from XML
+
+ Revision 1.3 2000/02/21 16:17:46 mi
+ string documentation from stardiv...*.idl-files
+
+ Revision 1.2 2000/02/07 11:24:11 mi
+ zu #70728# missing documentation marked
+
+ Revision 1.1.1.1 1999/11/11 09:48:40 jsc
+ new
+
+
+=============================================================================*/
+#endif