offapi/com/sun/star/form/component/RichTextControl.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 #ifndef __com_sun_star_form_component_RichTextControl_idl__
  21 #define __com_sun_star_form_component_RichTextControl_idl__
  22
  23 #include <com/sun/star/awt/UnoControlEditModel.idl>
  24 #include <com/sun/star/form/FormControlModel.idl>
  25 #include <com/sun/star/text/TextRange.idl>
  26
  27
  28  module com {  module sun {  module star {  module form {  module component {
  29
  30
  31 /** specifies a component which extends the com::sun::star::awt::UnoControlEditModel
  32     with capabilities to display and input formatted text.
  33 */
  34 published service RichTextControl
  35 {
  36     service com::sun::star::awt::UnoControlEditModel;
  37
  38     service com::sun::star::form::FormControlModel;
  39
  40     /** specifies capabilities to provide rich text, as opposed to the simple text provided by the
  41         com::sun::star::awt::UnoControlEditModel
  42     */
  43     service com::sun::star::text::TextRange;
  44
  45     /** specifies whether text should be automatically wrapped to fit into the control.
  46
  47         <p>If set to `TRUE`, users need to manually press the enter key to insert a line break.
  48         If set to `FALSE`, text is automatically wrapped at the control border.</p>
  49     */
  50     [property] boolean HardLineBreaks;
  51
  52     /** specifies whether the control should display the text including all its formatting.
  53
  54         <p>If this is set to `FALSE`, the control will act as ordinary
  55         com::sun::star::awt::UnoControlEditModel.</p>
  56
  57         <p>If the property is set to `TRUE`, the control will ignore the following properties:
  58         <ul>
  59             <li>com::sun::star::awt::UnoControlEditModel::EchoChar</li>
  60             <li>com::sun::star::awt::UnoControlEditModel::MaxTextLen</li>
  61             <li>com::sun::star::awt::UnoControlEditModel::MultiLine</li>
  62             <li>com::sun::star::awt::UnoControlEditModel::Align</li>
  63         </ul>
  64         </p>
  65     */
  66     [property] boolean RichText;
  67 };
  68
  69
  70 }; }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */