diff options
Diffstat (limited to 'offapi/com/sun/star/text/XRubySelection.idl')
-rw-r--r-- | offapi/com/sun/star/text/XRubySelection.idl | 75 |
1 files changed, 75 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 000000000000..156f501ec4ba --- /dev/null +++ b/offapi/com/sun/star/text/XRubySelection.idl @@ -0,0 +1,75 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * 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_text_XRubySelection_idl__ +#define __com_sun_star_text_XRubySelection_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif +#ifndef __com_sun_star_beans_PropertyValues_idl__ +#include <com/sun/star/beans/PropertyValues.idl> +#endif + + + +//============================================================================= + + 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 + + |