offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.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: DefaultComponentInspectorModel.idl,v $
  10  * $Revision: 1.3 $
  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_report_inspection__DefaultComponentInspectorModel_idl__
  31 #define __com_sun_star_report_inspection_DefaultComponentInspectorModel_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 report { 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>ReportComponent</type>
  48     service.
  49
  50     <p>A <type>DefaultComponentInspectorModel</type> provides the following handlers by default:
  51     <ul><li><type>GeometryHandler</type></li>
  52         <li><type>ReportComponentHandler</type></li>
  53         <li><typescope="com::sun::star::form::inspection">EditPropertyHandler</type></li>
  54     </ul></p>
  55
  56     @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
  57 */
  58 service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
  59 {
  60     /** creates a default DefaultComponentInspectorModel, providing factories for all
  61         handlers listed above.
  62
  63         @since OOo 2.2
  64     */
  65     createDefault();
  66
  67     /** creates a default DefaultComponentInspectorModel, providing factories for all
  68         handlers listed above, and describing an ObjectInspector which has a help section.
  69
  70         @param minHelpTextLines
  71             denotes the minimum number of lines of text to be reserved for the help
  72             section.
  73
  74         @param maxHelpTextLines
  75             denotes the maximum number of lines of text to be reserved for the help
  76             section.
  77
  78         @throws ::com::sun::star::lang::IllegalArgumentException
  79             if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
  80             or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
  81
  82         @see XObjectInspectorModel::HasHelpSection
  83         @see XObjectInspectorModel::MinHelpTextLines
  84         @see XObjectInspectorModel::MaxHelpTextLines
  85
  86         @since OOo 2.2
  87     */
  88     createWithHelpSection(
  89         [in] long minHelpTextLines,
  90         [in] long maxHelpTextLines
  91     )
  92         raises ( ::com::sun::star::lang::IllegalArgumentException );
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; }; };
  98
  99 #endif