Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: text ::
interface XRubySelection
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XRubySelection
Description This interface enables the object to handle list of ruby lines (aka Furigana lines). Developers Guide 7.3.12 Text Documents - Working with Text Documents - 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 > [in] boolean | RubyList, 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 © 2003 Sun Microsystems, Inc.