/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XTextComponent.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:55:57 $
 *
 *  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_awt_XTextComponent_idl__
#define __com_sun_star_awt_XTextComponent_idl__

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

#ifndef __com_sun_star_awt_XTextListener_idl__
#include <com/sun/star/awt/XTextListener.idl>
#endif

#ifndef __com_sun_star_awt_Selection_idl__
#include <com/sun/star/awt/Selection.idl>
#endif


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

 module com {  module sun {  module star {  module awt {

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

/** gives access to the text of a component and makes it possible
    to register event listeners.
 */
published interface XTextComponent: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** registers a text event listener.
     */
    [oneway] void addTextListener( [in] com::sun::star::awt::XTextListener l );

    //-------------------------------------------------------------------------

    /** unregisters a text event listener.
     */
    [oneway] void removeTextListener( [in] com::sun::star::awt::XTextListener l );

    //-------------------------------------------------------------------------

    /** sets the text of the component.
     */
    [oneway] void setText( [in] string aText );

    //-------------------------------------------------------------------------

    /** inserts text at the specified position.
     */
    [oneway] void insertText( [in] com::sun::star::awt::Selection Sel,
             [in] string Text );

    //-------------------------------------------------------------------------

    /** returns the text of the component.
     */
    string getText();

    //-------------------------------------------------------------------------

    /** returns the currently selected text.
     */
    string getSelectedText();

    //-------------------------------------------------------------------------

    /** sets the user selection.
     */
    [oneway] void setSelection( [in] com::sun::star::awt::Selection aSelection );

    //-------------------------------------------------------------------------

    /** returns the current user selection.
     */
    com::sun::star::awt::Selection getSelection();

    //-------------------------------------------------------------------------

    /** returns if the text is editable by the user.
     */
    boolean isEditable();

    //-------------------------------------------------------------------------

    /** makes the text editable for the user or read-only.
     */
    [oneway] void setEditable( [in] boolean bEditable );

    //-------------------------------------------------------------------------

    /** sets the maximum text length.
     */
    [oneway] void setMaxTextLen( [in] short nLen );

    //-------------------------------------------------------------------------

    /** returns the currently set maximum text length.
     */
    short getMaxTextLen();

};

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

}; }; }; };

#endif