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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XRubySelection_idl__
  28 #define __com_sun_star_text_XRubySelection_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33 #ifndef __com_sun_star_beans_PropertyValues_idl__
  34 #include <com/sun/star/beans/PropertyValues.idl>
  35 #endif
  36
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module text {
  42
  43 //=============================================================================
  44
  45 /** This interface enables the object to handle list of ruby lines (aka Furigana lines).
  46
  47  */
  48 published interface XRubySelection : com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51     /** returns a sequence of ruby elements.
  52     <p>Each element contains at least a string that contains the selected text and the ruby text.
  53         Additional parameters can be the ruby adjustment, the name of a character style.</p>
  54             @returns
  55                 a sequence of ruby properties
  56             @param Automatic
  57                 if Automatic is set the selection is parsed for words and applied ruby attributes
  58      */
  59     sequence<com::sun::star::beans::PropertyValues>  getRubyList( [in] boolean Automatic );
  60     //-------------------------------------------------------------------------
  61     /** applies the RubyList to the current selection. The number of elements must be
  62         equal to the number of elements that are returned by getRubyList. Automatic must be
  63         set equally, too.
  64      */
  65     void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic );
  66
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75