Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: text ::
interface XRubySelection
Description This interface enables the object to handle list of ruby lines (aka Furigana lines). Developers Guide Text - Ruby

Methods' Summary
getRubyList | returns a sequence of ruby elements.
setRubyList | 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.

Methods' Details
getRubyList
sequence< ::com::sun::star::beans::PropertyValues >
getRubyList( | [in] boolean | Automatic );
Description returns a sequence of ruby elements. 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. Returns a sequence of ruby properties Parameter Automatic if Automatic is set the selection is parsed for words and applied ruby attributes
setRubyList
void
setRubyList( | [in] sequence< ::com::sun::star::beans::PropertyValues > | RubyList,
| [in] boolean | Automatic );
Description 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.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.