offapi/com/sun/star/form/inspection/EditPropertyHandler.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: EditPropertyHandler.idl,v $
  10  * $Revision: 1.4 $
  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_inspection_EditPropertyHandler_idl__
  32 #define __com_sun_star_form_inspection_EditPropertyHandler_idl__
  33
  34 #ifndef __com_sun_star_inspection_XPropertyHandler_idl__
  35 #include <com/sun/star/inspection/XPropertyHandler.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module form { module inspection {
  41
  42 //=============================================================================
  43
  44 /** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
  45     which provides convinience wrappers for some properties existing at a form component
  46     derived from <type scope="com::sun::star::awt">UnoControlEditModel</type>.
  47
  48     <p>First, the handler supersedes the HScroll and the VScroll properties of a <type scope="com::sun::star::awt">UnoControlEditModel</type>
  49     and puts them into one common property, allowing the user to choose whether she want to
  50     have "no", a "vertical", a "horizontal", or "both" scrollbars.<p>
  51
  52     <p>Second, if it detects a <type scope="com::sun::star::form::component">RichTextControl</type> to inspect,
  53     it supersedes the <member scope="com::sun::star::form::component">RichTextControl::RichText</member>
  54     and the <member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member> properties with a new
  55     one which allows choosing the text type with one single action.</p>
  56
  57     @see com::sun::star::inspection::XPropertyHandler
  58     @see com::sun::star::awt::UnoControlEditModel
  59     @see com::sun::star::form::component::RichTextControl
  60     @see com::sun::star::form::component::TextField
  61 */
  62 service EditPropertyHandler
  63 {
  64     interface com::sun::star::inspection::XPropertyHandler;
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; }; };
  70
  71 #endif
  72