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