offapi/com/sun/star/form/inspection/EditPropertyHandler.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_inspection_EditPropertyHandler_idl__
  21 #define __com_sun_star_form_inspection_EditPropertyHandler_idl__
  22
  23 #include <com/sun/star/inspection/XPropertyHandler.idl>
  24
  25
  26 module com {  module sun {  module star {  module form { module inspection {
  27
  28
  29 /** implements a property handler for use with an com::sun::star::inspection::ObjectInspector
  30     which provides convenience wrappers for some properties existing at a form component
  31     derived from com::sun::star::awt::UnoControlEditModel.
  32
  33     <p>First, the handler supersedes the HScroll and the VScroll properties of a com::sun::star::awt::UnoControlEditModel
  34     and puts them into one common property, allowing the user to choose whether she want to
  35     have "no", a "vertical", a "horizontal", or "both" scrollbars.<p>
  36
  37     <p>Second, if it detects a com::sun::star::form::component::RichTextControl to inspect,
  38     it supersedes the com::sun::star::form::component::RichTextControl::RichText
  39     and the com::sun::star::awt::UnoControlEditModel::MultiLine properties with a new
  40     one which allows choosing the text type with one single action.</p>
  41
  42     @see com::sun::star::inspection::XPropertyHandler
  43     @see com::sun::star::awt::UnoControlEditModel
  44     @see com::sun::star::form::component::RichTextControl
  45     @see com::sun::star::form::component::TextField
  46 */
  47 service EditPropertyHandler
  48 {
  49     interface com::sun::star::inspection::XPropertyHandler;
  50 };
  51
  52
  53 }; }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */