diff options
14 files changed, 257 insertions, 7 deletions
diff --git a/offapi/com/sun/star/i18n/XBreakIterator.idl b/offapi/com/sun/star/i18n/XBreakIterator.idl index 7ea9c5d5b023..f4536b33e85f 100644 --- a/offapi/com/sun/star/i18n/XBreakIterator.idl +++ b/offapi/com/sun/star/i18n/XBreakIterator.idl @@ -43,10 +43,26 @@ published interface XBreakIterator: com::sun::star::uno::XInterface CharacterIteratorMode can be cell based or character based. A cell is made of more than one character. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + + @param nCharacterIteratorMode + A constant from CharacterIteratorMode + @param nCount Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use XBreakIterator::previousCharacters() instead. + + @param nDone + Out parameter to receive the number of cells/Unicode characters + traversed. */ long nextCharacters( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, @@ -58,10 +74,27 @@ published interface XBreakIterator: com::sun::star::uno::XInterface CharacterIteratorMode can be cell based or character based. A cell is made of more than one character. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + + @param nCharacterIteratorMode + A constant from CharacterIteratorMode + @param nCount Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use XBreakIterator::nextCharacters() instead. + + @param nDone + Out parameter to receive the number of cells/Unicode characters + traversed. + */ long previousCharacters( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, @@ -70,6 +103,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses one word in Text from <em>nStartPos</em> forwards. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nWordType One of WordType, specifies the type of traveling. @@ -84,6 +126,12 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses one word in Text from <em>nStartPos</em> backwards. + @param aText + The input text. + + @param nStartPos + The start index in aText. + @param aLocale The locale of the character preceding <em>nStartPos</em>. @@ -128,9 +176,24 @@ published interface XBreakIterator: com::sun::star::uno::XInterface <em>nPos</em> is considered to be the start of the next word and we look forwards for the end of the word. </p> + @param aText + The input text. + + @param nPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nWordType One of WordType. + @param bPreferForward + If `TRUE`, nPos should be considered the start of the next + word and search proceeds forwards. + If `FALSE`, nPos should be considered the end of the + current word, and search proceeds backwards. + @returns The Boundary of the current word. */ @@ -174,6 +237,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the start of a sentence. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @returns The position where the sentence starts. */ @@ -183,6 +255,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the end of a sentence. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @returns The position where the sentence ends. */ @@ -192,6 +273,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Calculate the line break position in the Text from the specified <em>nStartPos</em>. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nMinBreakPos Defines a minimum break position for hyphenated line break. When the position for hyphenated line break is less than @@ -219,6 +309,12 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the beginning of the specified script type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + @param nScriptType One of ScriptType. @@ -231,6 +327,12 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the end of the specified script type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + @param nScriptType One of ScriptType. @@ -243,6 +345,12 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the next start of the specified script type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + @param nScriptType One of ScriptType. @@ -255,6 +363,12 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the previous start of the specified script type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + @param nScriptType One of ScriptType. @@ -266,6 +380,12 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Get the script type of the character at position <em>nPos</em>. + @param aText + The input text. + + @param nPos + The index in aText. + @returns One of ScriptType. */ @@ -274,6 +394,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the beginning of the specified character type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nCharType One of CharType @@ -287,6 +416,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the end of the specified character type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nCharType One of CharType @@ -300,6 +438,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the next start of the specified character type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nCharType One of CharType @@ -313,6 +460,15 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses in Text from <em>nStartPos</em> to the previous start of the specified character type. + @param aText + The input text. + + @param nStartPos + The start index in aText. + + @param aLocale + The locale of the character preceding <em>nStartPos</em>. + @param nCharType One of CharType diff --git a/offapi/com/sun/star/i18n/XCharacterClassification.idl b/offapi/com/sun/star/i18n/XCharacterClassification.idl index c209bcfe05e8..9540f7c44076 100644 --- a/offapi/com/sun/star/i18n/XCharacterClassification.idl +++ b/offapi/com/sun/star/i18n/XCharacterClassification.idl @@ -219,6 +219,21 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface @param nTokenType One or more of the KParseType constants. + @param aText + See #parseAnyToken + @param nPos + See #parseAnyToken + @param aLocale + See #parseAnyToken + @param nStartCharFlags + See #parseAnyToken + @param aUserDefinedCharactersStart + See #parseAnyToken + @param nContCharFlags + See #parseAnyToken + @param aUserDefinedCharactersCont + See #parseAnyToken + @code{.cpp} // Determine if a given name is a valid name (not quoted) and contains // only allowed characters. diff --git a/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl b/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl index 60568c8620cd..e640fceda081 100644 --- a/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl +++ b/offapi/com/sun/star/i18n/XExtendedIndexEntrySupplier.idl @@ -70,6 +70,9 @@ published interface XExtendedIndexEntrySupplier : ::com::sun::star::i18n::XIndex /** Loads index algorithm for the locale. + @param aLocale + The locale. + @param aIndexAlgorithm Index algorithm to be loaded. diff --git a/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl b/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl index c8156900fde0..af429a253075 100644 --- a/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl +++ b/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl @@ -41,6 +41,17 @@ published interface XExtendedInputSequenceChecker : ::com::sun::star::i18n::XInp /** @returns Next nPos, or length of aText if nothing is corrected. + @param aText + Text to be checked and corrected. + + @param nPos + Index in aText where checking starts. + + @param cInputChar + The input character. Or at least, a UTF16 code unit thereof. + It looks like this interface was not designed with non-BMP + characters in mind. Not sure if that is a problem. + @param nInputCheckMode One of InputSequenceCheckMode constants. */ diff --git a/offapi/com/sun/star/i18n/XExtendedTextConversion.idl b/offapi/com/sun/star/i18n/XExtendedTextConversion.idl index 590c3ab0d4c5..2ef853aab31c 100644 --- a/offapi/com/sun/star/i18n/XExtendedTextConversion.idl +++ b/offapi/com/sun/star/i18n/XExtendedTextConversion.idl @@ -44,6 +44,19 @@ published interface XExtendedTextConversion : ::com::sun::star::i18n::XTextConve ::com::sun::star::i18n::XTextConversion::getConversion(), except an additional output parameter rOffset. + @param aText + See ::com::sun::star::i18n::XTextConversion::getConversion() + @param nStartPos + See ::com::sun::star::i18n::XTextConversion::getConversion() + @param nLength + See ::com::sun::star::i18n::XTextConversion::getConversion() + @param aLocale + See ::com::sun::star::i18n::XTextConversion::getConversion() + @param nTextConversionType + See ::com::sun::star::i18n::XTextConversion::getConversion() + @param nTextConversionOptions + See ::com::sun::star::i18n::XTextConversion::getConversion() + @param rOffset To find the grapheme of input string corresponding to the grapheme of output string, rOffset provides the offset array diff --git a/offapi/com/sun/star/i18n/XInputSequenceChecker.idl b/offapi/com/sun/star/i18n/XInputSequenceChecker.idl index a1e09fe4fe96..0e61ce9363c5 100644 --- a/offapi/com/sun/star/i18n/XInputSequenceChecker.idl +++ b/offapi/com/sun/star/i18n/XInputSequenceChecker.idl @@ -36,6 +36,17 @@ published interface XInputSequenceChecker : ::com::sun::star::uno::XInterface /** @returns true/false for the input check + @param aText + Text to be checked. + + @param nPos + Index in aText where checking starts. + + @param cInputChar + The input character. Or at least, a UTF16 code unit thereof. + It looks like this interface was not designed with non-BMP + characters in mind. Not sure if that is a problem. + @param nInputCheckMode One of InputSequenceCheckMode constants. */ diff --git a/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl b/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl index e9886f3499d1..a6a8a13c1b06 100644 --- a/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl +++ b/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl @@ -37,10 +37,15 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface { /** Returns native number string for given number string. + @param aNumberString + The input string. + @param nNativeNumberMode One of NativeNumberMode values. - */ + @param aLocale + The locale. + */ string getNativeNumberString( [in] string aNumberString, [in] ::com::sun::star::lang::Locale aLocale, [in] short nNativeNumberMode ); @@ -49,8 +54,10 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface @param nNativeNumberMode One of NativeNumberMode values. - */ + @param aLocale + The locale. + */ boolean isValidNatNum( [in] ::com::sun::star::lang::Locale aLocale, [in] short nNativeNumberMode ); @@ -59,8 +66,10 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface @param nNativeNumberMode One of NativeNumberMode values. - */ + @param aLocale + The locale. + */ NativeNumberXmlAttributes convertToXmlAttributes( [in] ::com::sun::star::lang::Locale aLocale, [in] short nNativeNumberMode ); @@ -70,7 +79,6 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface @returns One of NativeNumberMode */ - short convertFromXmlAttributes( [in] NativeNumberXmlAttributes aAttr ); }; diff --git a/offapi/com/sun/star/i18n/XNumberFormatCode.idl b/offapi/com/sun/star/i18n/XNumberFormatCode.idl index b6feea9da0aa..31af781c5cd2 100644 --- a/offapi/com/sun/star/i18n/XNumberFormatCode.idl +++ b/offapi/com/sun/star/i18n/XNumberFormatCode.idl @@ -43,6 +43,9 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface @param nFormatUsage one of KNumberFormatUsage values + + @param rLocale + The locale for which the format code is requested. */ NumberFormatCode getDefault( [in] short nFormatType, [in] short nFormatUsage, @@ -54,6 +57,9 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface @param nFormatIndex one of NumberFormatIndex values + + @param rLocale + The locale for which the format code is requested. */ NumberFormatCode getFormatCode( [in] short nFormatIndex, [in] com::sun::star::lang::Locale rLocale ); @@ -63,6 +69,9 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface @param nFormatUsage one of KNumberFormatUsage values + + @param rLocale + The locale for which the format codes are requested. */ sequence< NumberFormatCode > getAllFormatCode( [in] short nFormatUsage, @@ -70,6 +79,9 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface /** returns all format codes for a given locale. + + @param rLocale + The locale for which the format codes are requested. */ sequence< NumberFormatCode > getAllFormatCodes( [in] com::sun::star::lang::Locale rLocale ); diff --git a/offapi/com/sun/star/i18n/XTransliteration.idl b/offapi/com/sun/star/i18n/XTransliteration.idl index 730ba787e153..4c6144776b36 100644 --- a/offapi/com/sun/star/i18n/XTransliteration.idl +++ b/offapi/com/sun/star/i18n/XTransliteration.idl @@ -137,6 +137,8 @@ published interface XTransliteration: com::sun::star::uno::XInterface @param aImplName The module's {implName} under which it is registered with com.sun.star.i18n.Transliteration.l10n.{implName}. + @param aLocale + The locale for which the module is requested. */ void loadModuleByImplName( [in] string aImplName, [in] ::com::sun::star::lang::Locale aLocale ); @@ -148,6 +150,8 @@ published interface XTransliteration: com::sun::star::uno::XInterface @param aImplNameList Only IGNORE type modules can be specified. + @param aLocale + The locale for which the modules are requested. */ void loadModulesByImplNames( [in] sequence <string> aImplNameList, [in] ::com::sun::star::lang::Locale aLocale ); @@ -158,6 +162,8 @@ published interface XTransliteration: com::sun::star::uno::XInterface @param nType A bitmask field of values defined in TransliterationType + @param aLocale + The locale for which the modules are requested. */ sequence<string> getAvailableModules( [in] ::com::sun::star::lang::Locale aLocale, diff --git a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl index 4d841f984989..fd8ff0eecbd6 100644 --- a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl @@ -81,6 +81,8 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D This method can either set the whole poly-polygon to the new data, or insert the segments at the given index + @param points the points. + @param nPolygonIndex The index of the polygon to start segment insertion with. This index must be in the range [0,numPolygons], and the insertion diff --git a/offapi/com/sun/star/rendering/XColorSpace.idl b/offapi/com/sun/star/rendering/XColorSpace.idl index de47f2abf4c8..12d9c27056b7 100644 --- a/offapi/com/sun/star/rendering/XColorSpace.idl +++ b/offapi/com/sun/star/rendering/XColorSpace.idl @@ -98,6 +98,8 @@ interface XColorSpace therefore, batch conversion of multiple color values is possible. + @param targetColorSpace the color space to convert to. + @return the corresponding sequence of device colors in the target color space (e.g. `sequence<double>` or `sequence<byte>`). diff --git a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl index c15285ef1a1d..cf7fa97b2fcf 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl @@ -96,6 +96,8 @@ interface XIntegerBitmapColorSpace : XColorSpace therefore, batch conversion of multiple color values is possible.<p> + @param targetColorSpace the color space to convert to. + @return the corresponding sequence of device colors in the target color space @@ -117,6 +119,8 @@ interface XIntegerBitmapColorSpace : XColorSpace therefore, batch conversion of multiple color values is possible.<p> + @param targetColorSpace the color space to convert to. + @return the corresponding sequence of device colors in the target color space diff --git a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl index abd9ed3e7185..57874794922d 100644 --- a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl @@ -66,6 +66,8 @@ interface XLinePolyPolygon2D : XPolyPolygon2D This method can either set the whole poly-polygon to the new data, or insert the points at the given index + @param points the points. + @param nPolygonIndex The index of the polygon to start point insertion with. This index must be in the range [0,numPolygons], and the insertion diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index 8d0b0ba830e2..c19fbaba26ad 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -250,9 +250,9 @@ interface XTextLayout : ::com::sun::star::uno::XInterface in the range 0 up to the number of characters in the string. @param bExcludeLigatures - Set this to `TRUE`, to skip the positions inside ligatures as - valid caret placements. That means, on cannot e.g. set the - caret between the "f" and the "i" in a "fi" ligature. + Set this to `TRUE` to skip the positions inside ligatures as + valid caret placements. For example, this would avoid setting + the caret between the "f" and the "i" in a "fi" ligature. @returns the generated Caret structure. @@ -278,6 +278,11 @@ interface XTextLayout : ::com::sun::star::uno::XInterface right. For values smaller than 0, the caret is visually moved to the left. + @param bExcludeLigatures + Set this to `TRUE` to skip the positions inside ligatures as + valid caret placements. For example, this would avoid setting + the caret between the "f" and the "i" in a "fi" ligature. + @returns the new insertion index. @throws com::sun::star::lang::IndexOutOfBoundsException |