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 #ifndef __com_sun_star_text_XRubySelection_idl__
  20 #define __com_sun_star_text_XRubySelection_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValues.idl>
  24
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30
  31 /** This interface enables the object to handle list of ruby lines (aka Furigana lines).
  32
  33  */
  34 published interface XRubySelection : com::sun::star::uno::XInterface
  35 {
  36     /** returns a sequence of ruby elements.
  37     <p>Each element contains at least a string that contains the selected text and the ruby text.
  38         Additional parameters can be the ruby adjustment, the name of a character style.</p>
  39             @returns
  40                 a sequence of ruby properties
  41             @param Automatic
  42                 if Automatic is set the selection is parsed for words and applied ruby attributes
  43      */
  44     sequence<com::sun::star::beans::PropertyValues>  getRubyList( [in] boolean Automatic );
  45     /** applies the RubyList to the current selection. The number of elements must be
  46         equal to the number of elements that are returned by getRubyList. Automatic must be
  47         set equally, too.
  48      */
  49     void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic );
  50
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */