Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

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 © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.