offapi/com/sun/star/form/component/RichTextControl.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: RichTextControl.idl,v $
  10  * $Revision: 1.5 $
  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
  31 #ifndef __com_sun_star_form_component_RichTextControl_idl__
  32 #define __com_sun_star_form_component_RichTextControl_idl__
  33
  34 #ifndef __com_sun_star_awt_UnoControlEditModel_idl__
  35 #include <com/sun/star/awt/UnoControlEditModel.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_form_FormControlModel_idl__
  39 #include <com/sun/star/form/FormControlModel.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_text_TextRange_idl__
  43 #include <com/sun/star/text/TextRange.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module form {  module component {
  49
  50 //=============================================================================
  51
  52 /** specifies a component which extends the <type scope="com::sun::star::awt">UnoControlEditModel</type>
  53     with capabilities to display and input formatted text.
  54 */
  55 published service RichTextControl
  56 {
  57     service com::sun::star::awt::UnoControlEditModel;
  58
  59     service com::sun::star::form::FormControlModel;
  60
  61     /** specifies capabilities to provide rich text, as opposed to the simple text provided by the
  62         <type scope="com::sun::star::awt">UnoControlEditModel</type>
  63     */
  64     service com::sun::star::text::TextRange;
  65
  66     /** specifies whether text should be automatically wrapped to fit into the control.
  67
  68         <p>If set to <TRUE/>, users need to manually press the enter key to insert a line break.
  69         If set to <FALSE/>, text is automatically wrapped at the control border.</p>
  70     */
  71     [property] boolean HardLineBreaks;
  72
  73     /** specifies whether the control should display the text including all its formatting.
  74
  75         <p>If this is set to <FALSE/>, the control will act as ordinary
  76         <type scope="com::sun::star::awt">UnoControlEditModel</type>.</p>
  77
  78         <p>If the property is set to <TRUE/>, the control will ignore the following properties:
  79         <ul>
  80             <li><member scope="com::sun::star::awt">UnoControlEditModel::EchoChar</member></li>
  81             <li><member scope="com::sun::star::awt">UnoControlEditModel::MaxTextLen</member></li>
  82             <li><member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member></li>
  83             <li><member scope="com::sun::star::awt">UnoControlEditModel::Align</member></li>
  84         </ul>
  85         </p>
  86     */
  87     [property] boolean RichText;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; }; };
  93
  94 #endif