offapi/com/sun/star/awt/XTextComponent.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_awt_XTextComponent_idl__
  20 #define __com_sun_star_awt_XTextComponent_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XTextListener.idl>
  25
  26 #include <com/sun/star/awt/Selection.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module awt {
  31
  32
  33 /** gives access to the text of a component and makes it possible
  34     to register event listeners.
  35  */
  36 published interface XTextComponent: com::sun::star::uno::XInterface
  37 {
  38
  39     /** registers a text event listener.
  40      */
  41     void addTextListener( [in] com::sun::star::awt::XTextListener l );
  42
  43
  44     /** unregisters a text event listener.
  45      */
  46     void removeTextListener( [in] com::sun::star::awt::XTextListener l );
  47
  48
  49     /** sets the text of the component.
  50      */
  51     void setText( [in] string aText );
  52
  53
  54     /** inserts text at the specified position.
  55      */
  56     void insertText( [in] com::sun::star::awt::Selection Sel,
  57              [in] string Text );
  58
  59
  60     /** returns the text of the component.
  61      */
  62     string getText();
  63
  64
  65     /** returns the currently selected text.
  66      */
  67     string getSelectedText();
  68
  69
  70     /** sets the user selection.
  71      */
  72     void setSelection( [in] com::sun::star::awt::Selection aSelection );
  73
  74
  75     /** returns the current user selection.
  76      */
  77     com::sun::star::awt::Selection getSelection();
  78
  79
  80     /** returns if the text is editable by the user.
  81      */
  82     boolean isEditable();
  83
  84
  85     /** makes the text editable for the user or read-only.
  86      */
  87     void setEditable( [in] boolean bEditable );
  88
  89
  90     /** sets the maximum text length.
  91      */
  92     void setMaxTextLen( [in] short nLen );
  93
  94
  95     /** returns the currently set maximum text length.
  96      */
  97     short getMaxTextLen();
  98
  99 };
 100
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */