summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/util/XStringWidth.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/util/XStringWidth.idl')
-rw-r--r--offapi/com/sun/star/util/XStringWidth.idl66
1 files changed, 66 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XStringWidth.idl b/offapi/com/sun/star/util/XStringWidth.idl
new file mode 100644
index 000000000000..d2f055b23325
--- /dev/null
+++ b/offapi/com/sun/star/util/XStringWidth.idl
@@ -0,0 +1,66 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: XStringWidth.idl,v $
+ * $Revision: 1.5 $
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_util_XStringWidth_idl__
+#define __com_sun_star_util_XStringWidth_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+module com { module sun { module star { module util {
+
+//============================================================================
+/** An interface that encapsulates the abstract notion of string width.
+
+ @see XStringAbbreviation
+ */
+published interface XStringWidth: com::sun::star::uno::XInterface
+{
+ //------------------------------------------------------------------------
+ /** compute the width of a given string.
+
+ <p>Depending on the implementation of this interface, the width of a
+ string can be rather different things, like the number of characters
+ in the string, or the width in pixel when displayed with a specific
+ font.</p>
+
+ @param aString
+ The string that is to be measured.
+
+ @returns
+ the string's width.
+ */
+ long queryStringWidth([in] string aString);
+};
+
+}; }; }; };
+
+#endif