offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.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: DefaultFormComponentInspectorModel.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 #ifndef __com_sun_star_form_DefaultFormComponentInspectorModel_idl__
  31 #define __com_sun_star_form_DefaultFormComponentInspectorModel_idl__
  32
  33 #ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__
  34 #include <com/sun/star/inspection/XObjectInspectorModel.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  37 #include <com/sun/star/lang/IllegalArgumentException.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42 module com {  module sun {  module star {  module form { module inspection {
  43
  44 //=============================================================================
  45
  46 /** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for
  47     inspecting form components, in particular all components implementing the <type>FormComponent</type>
  48     service.
  49
  50     <p>A <type>DefaultFormComponentInspectorModel</type> provides the following handlers by default:
  51     <ul><li><type>ButtonNavigationHandler</type></li>
  52         <li><type>CellBindingPropertyHandler</type></li>
  53         <li><type>EditPropertyHandler</type></li>
  54         <li><type>EventHandler</type></li>
  55         <li><type>FormComponentPropertyHandler</type></li>
  56         <li><type>SubmissionPropertyHandler</type></li>
  57         <li><type>XMLFormsPropertyHandler</type></li>
  58         <li><type>XSDValidationPropertyHandler</type></li>
  59     </ul></p>
  60
  61     @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
  62 */
  63 service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
  64 {
  65     /** creates a default DefaultFormComponentInspectorModel, providing factories for all
  66         handlers listed above.
  67
  68         @since OOo 2.2.0
  69     */
  70     createDefault();
  71
  72     /** creates a default DefaultFormComponentInspectorModel, providing factories for all
  73         handlers listed above, and describing an ObjectInspector which has a help section.
  74
  75         @param minHelpTextLines
  76             denotes the minimum number of lines of text to be reserved for the help
  77             section.
  78
  79         @param maxHelpTextLines
  80             denotes the maximum number of lines of text to be reserved for the help
  81             section.
  82
  83         @throws ::com::sun::star::lang::IllegalArgumentException
  84             if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
  85             or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
  86
  87         @see XObjectInspectorModel::HasHelpSection
  88         @see XObjectInspectorModel::MinHelpTextLines
  89         @see XObjectInspectorModel::MaxHelpTextLines
  90
  91         @since OOo 2.2.0
  92     */
  93     createWithHelpSection(
  94         [in] long minHelpTextLines,
  95         [in] long maxHelpTextLines
  96     )
  97         raises ( ::com::sun::star::lang::IllegalArgumentException );
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; }; };
 103
 104 #endif