LibreOffice LibreOffice 25.2 SDK API Reference

XHyphenator.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22module com { module sun { module star { module linguistic2 {
23
43published interface XHyphenator : com::sun::star::linguistic2::XSupportedLocales
44{
79 com::sun::star::linguistic2::XHyphenatedWord hyphenate(
80 [in] string aWord,
81 [in] com::sun::star::lang::Locale aLocale,
82 [in] short nMaxLeading,
83 [in] com::sun::star::beans::PropertyValues aProperties )
84 raises( com::sun::star::lang::IllegalArgumentException );
85
126 com::sun::star::linguistic2::XHyphenatedWord queryAlternativeSpelling(
127 [in] string aWord,
128 [in] com::sun::star::lang::Locale aLocale,
129 [in] short nIndex,
130 [in] com::sun::star::beans::PropertyValues aProperties )
131 raises( com::sun::star::lang::IllegalArgumentException );
132
158 com::sun::star::linguistic2::XPossibleHyphens createPossibleHyphens(
159 [in] string aWord,
160 [in] com::sun::star::lang::Locale aLocale,
161 [in] com::sun::star::beans::PropertyValues aProperties )
162 raises( com::sun::star::lang::IllegalArgumentException );
163
164};
165
166
167}; }; }; };
168
169/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::linguistic2::XHyphenatedWord
gives information obtained by a successful hyphenation attempt.
Definition: XHyphenatedWord.idl:32
com::sun::star::linguistic2::XHyphenator
provides functionality for hyphenation of single words.
Definition: XHyphenator.idl:44
com::sun::star::linguistic2::XHyphenator::createPossibleHyphens
com::sun::star::linguistic2::XPossibleHyphens createPossibleHyphens([in] string aWord, [in] com::sun::star::lang::Locale aLocale, [in] com::sun::star::beans::PropertyValues aProperties)
returns information about all possible hyphenation positions of a word.
com::sun::star::linguistic2::XHyphenator::hyphenate
com::sun::star::linguistic2::XHyphenatedWord hyphenate([in] string aWord, [in] com::sun::star::lang::Locale aLocale, [in] short nMaxLeading, [in] com::sun::star::beans::PropertyValues aProperties)
tries to find a valid hyphenation position relative to the beginning of a word.
com::sun::star::linguistic2::XHyphenator::queryAlternativeSpelling
com::sun::star::linguistic2::XHyphenatedWord queryAlternativeSpelling([in] string aWord, [in] com::sun::star::lang::Locale aLocale, [in] short nIndex, [in] com::sun::star::beans::PropertyValues aProperties)
checks whether hyphenation at a position in a word will result in an alternative spelling or not.
com::sun::star::linguistic2::XPossibleHyphens
Gives information about a word's possible hyphenation points.
Definition: XPossibleHyphens.idl:38
com::sun::star::linguistic2::XSupportedLocales
Offers information about which languages are supported by the object.
Definition: XSupportedLocales.idl:37
com::sun::star::beans::PropertyValues
sequence< PropertyValue > PropertyValues
specifies a sequence of PropertyValue instances.
Definition: PropertyValues.idl:27
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34