/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XRubySelection.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:45:26 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XRubySelection_idl__
#define __com_sun_star_text_XRubySelection_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_PropertyValues_idl__
#include <com/sun/star/beans/PropertyValues.idl>
#endif



//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

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

 */
published interface XRubySelection : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** returns a sequence of ruby elements.
    <p>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.</p>
            @returns
                a sequence of ruby properties
            @param Automatic
                if Automatic is set the selection is parsed for words and applied ruby attributes
     */
    sequence<com::sun::star::beans::PropertyValues>  getRubyList( [in] boolean Automatic );
    //-------------------------------------------------------------------------
    /** 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.
     */
    void setRubyList( [in] sequence<com::sun::star::beans::PropertyValues > RubyList, [in] boolean Automatic );

};

//=============================================================================

}; }; }; };

#endif


