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