interface XRubySelection in module com::sun::star::text::

(Global Index)

Syntax

interface XRubySelection : com::sun::star::uno::XInterface ;

Description

This interface enables the object to handle list of ruby lines (aka Furigana lines).

Method 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.

Method Details



getRubyList

Syntax

sequence< com::sun::star::beans::PropertyValues > getRubyList (
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

Syntax

void setRubyList (
sequence< com::sun::star::beans::PropertyValues > RubyList,
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