xref: /aoo42x/main/offapi/com/sun/star/awt/XFont.idl (revision a893be29)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XFont_idl__
24#define __com_sun_star_awt_XFont_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_awt_FontDescriptor_idl__
31#include <com/sun/star/awt/FontDescriptor.idl>
32#endif
33
34#ifndef __com_sun_star_awt_SimpleFontMetric_idl__
35#include <com/sun/star/awt/SimpleFontMetric.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module awt {
42
43//=============================================================================
44
45/** describes a font on a specific device.
46
47	<p>All values are in pixels within this device.</p>
48 */
49published interface XFont: com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52
53	/** returns the description of the font.
54
55	    <p>The unit of measurement is pixels for the device.
56	 */
57	com::sun::star::awt::FontDescriptor getFontDescriptor();
58
59	//-------------------------------------------------------------------------
60
61	/** returns additional information about the font.
62	 */
63	com::sun::star::awt::SimpleFontMetric getFontMetric();
64
65	//-------------------------------------------------------------------------
66
67	/** returns the width of the specified character.
68
69        @returns
70				the character width measured in pixels for the device.
71	 */
72	short getCharWidth( [in] char c );
73
74	//-------------------------------------------------------------------------
75
76	/** returns the widths of the specified characters.
77
78        @returns
79				a sequence of the widths of subsequent characters for this font.
80	 */
81	sequence<short> getCharWidths( [in] char nFirst, [in] char nLast );
82
83	//-------------------------------------------------------------------------
84
85	/** returns the string width.
86
87        @returns
88				the width of the specified string of characters
89				measured in pixels for the device.
90	 */
91	long getStringWidth( [in] string str );
92
93	//-------------------------------------------------------------------------
94
95	/** returns the string and the character widths.
96
97        @returns
98				the width of the specified string of characters
99				measured in pixels for the device.
100
101	    @param aDXArray
102				receives the width of every single character
103				measured in pixels for the device.
104	 */
105	long getStringWidthArray( [in] string str,
106			 [out] sequence<long> aDXArray );
107
108	//-------------------------------------------------------------------------
109
110	/** queries the kerning pair table.
111	 */
112	void getKernPairs( [out] sequence<char> Chars1,
113			 [out] sequence<char> Chars2,
114			 [out] sequence<short> Kerns );
115
116};
117
118//=============================================================================
119
120}; }; }; };
121
122#endif
123