offapi/com/sun/star/text/XRubySelection.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22
  23  module com {  module sun {  module star {  module text {
  24
  25
  26 /** This interface enables the object to handle list of ruby lines (aka Furigana lines).
  27
  28  */
  29 published interface XRubySelection : com::sun::star::uno::XInterface
  30 {
  31     /** returns a sequence of ruby elements.
  32     <p>Each element contains at least a string that contains the selected text and the ruby text.
  33         Additional parameters can be the ruby adjustment, the name of a character style.</p>
  34             @returns
  35                 a sequence of ruby properties
  36             @param Automatic
  37                 if Automatic is set the selection is parsed for words and applied ruby attributes
  38      */
  39     sequence<com::sun::star::beans::PropertyValues>  getRubyList( [in] boolean Automatic );
  40     /** applies the RubyList to the current selection. The number of elements must be
  41         equal to the number of elements that are returned by getRubyList. Automatic must be
  42         set equally, too.
  43      */
  44     void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic );
  45
  46 };
  47
  48
  49 }; }; }; };
  50
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */