1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XRubySelection_idl__
24#define __com_sun_star_text_XRubySelection_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29#ifndef __com_sun_star_beans_PropertyValues_idl__
30#include <com/sun/star/beans/PropertyValues.idl>
31#endif
32
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module text {
38
39//=============================================================================
40
41/** This interface enables the object to handle list of ruby lines (aka Furigana lines).
42
43 */
44published interface XRubySelection : com::sun::star::uno::XInterface
45{
46	//-------------------------------------------------------------------------
47	/** returns a sequence of ruby elements.
48	<p>Each element contains at least a string that contains the selected text and the ruby text.
49		Additional parameters can be the ruby adjustment, the name of a character style.</p>
50			@returns
51				a sequence of ruby properties
52			@param Automatic
53				if Automatic is set the selection is parsed for words and applied ruby attributes
54	 */
55	sequence<com::sun::star::beans::PropertyValues>  getRubyList( [in] boolean Automatic );
56	//-------------------------------------------------------------------------
57	/** applies the RubyList to the current selection. The number of elements must be
58		equal to the number of elements that are returned by getRubyList. Automatic must be
59		set equally, too.
60	 */
61	void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic );
62
63};
64
65//=============================================================================
66
67}; }; }; };
68
69#endif
70
71
72