offapi/com/sun/star/awt/XTextComponent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTextComponent.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XTextComponent_idl__
  31 #define __com_sun_star_awt_XTextComponent_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XTextListener_idl__
  38 #include <com/sun/star/awt/XTextListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Selection_idl__
  42 #include <com/sun/star/awt/Selection.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** gives access to the text of a component and makes it possible
  53     to register event listeners.
  54  */
  55 published interface XTextComponent: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** registers a text event listener.
  60      */
  61     [oneway] void addTextListener( [in] com::sun::star::awt::XTextListener l );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** unregisters a text event listener.
  66      */
  67     [oneway] void removeTextListener( [in] com::sun::star::awt::XTextListener l );
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** sets the text of the component.
  72      */
  73     [oneway] void setText( [in] string aText );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** inserts text at the specified position.
  78      */
  79     [oneway] void insertText( [in] com::sun::star::awt::Selection Sel,
  80              [in] string Text );
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** returns the text of the component.
  85      */
  86     string getText();
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** returns the currently selected text.
  91      */
  92     string getSelectedText();
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** sets the user selection.
  97      */
  98     [oneway] void setSelection( [in] com::sun::star::awt::Selection aSelection );
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** returns the current user selection.
 103      */
 104     com::sun::star::awt::Selection getSelection();
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** returns if the text is editable by the user.
 109      */
 110     boolean isEditable();
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** makes the text editable for the user or read-only.
 115      */
 116     [oneway] void setEditable( [in] boolean bEditable );
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** sets the maximum text length.
 121      */
 122     [oneway] void setMaxTextLen( [in] short nLen );
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** returns the currently set maximum text length.
 127      */
 128     short getMaxTextLen();
 129
 130 };
 131
 132 //=============================================================================
 133
 134 }; }; }; };
 135
 136 #endif