diff options
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/text/XRubySelection.idl | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XRubySelection.idl b/offapi/com/sun/star/text/XRubySelection.idl new file mode 100644 index 000000000..3d04094f3 --- /dev/null +++ b/offapi/com/sun/star/text/XRubySelection.idl @@ -0,0 +1,59 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_text_XRubySelection_idl__ +#define __com_sun_star_text_XRubySelection_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/beans/PropertyValues.idl> + + + + + module com { module sun { module star { module text { + + +/** This interface enables the object to handle list of ruby lines (aka Furigana lines). + + */ +published interface XRubySelection : com::sun::star::uno::XInterface +{ + /** returns a sequence of ruby elements. + <p>Each element contains at least a string that contains the selected text and the ruby text. + Additional parameters can be the ruby adjustment, the name of a character style.</p> + @returns + a sequence of ruby properties + @param Automatic + if Automatic is set the selection is parsed for words and applied ruby attributes + */ + sequence<com::sun::star::beans::PropertyValues> getRubyList( [in] boolean Automatic ); + /** applies the RubyList to the current selection. The number of elements must be + equal to the number of elements that are returned by getRubyList. Automatic must be + set equally, too. + */ + void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic ); + +}; + + +}; }; }; }; + +#endif + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |