offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.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 #ifndef __com_sun_star_report_inspection_DefaultComponentInspectorModel_idl__
  20 #define __com_sun_star_report_inspection_DefaultComponentInspectorModel_idl__
  21
  22 #include <com/sun/star/inspection/XObjectInspectorModel.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25
  26 module com {  module sun {  module star {  module report { module inspection {
  27
  28
  29 /** implements a com::sun::star::inspection::XObjectInspectorModel for
  30     inspecting form components, in particular all components implementing the ReportComponent
  31     service.
  32
  33     <p>A DefaultComponentInspectorModel provides the following handlers by default:
  34     <ul><li>GeometryHandler</li>
  35         <li>ReportComponentHandler</li>
  36         <li>com::sun::star::form::inspection::EditPropertyHandler</li>
  37     </ul></p>
  38
  39     @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
  40 */
  41 service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
  42 {
  43     /** creates a default DefaultComponentInspectorModel, providing factories for all
  44         handlers listed above.
  45
  46         @since OOo 2.2
  47     */
  48     createDefault();
  49
  50     /** creates a default DefaultComponentInspectorModel, providing factories for all
  51         handlers listed above, and describing an ObjectInspector which has a help section.
  52
  53         @param minHelpTextLines
  54             denotes the minimum number of lines of text to be reserved for the help
  55             section.
  56
  57         @param maxHelpTextLines
  58             denotes the maximum number of lines of text to be reserved for the help
  59             section.
  60
  61         @throws ::com::sun::star::lang::IllegalArgumentException
  62             if minHelpTextLines or maxHelpTextLines are negative,
  63             or if minHelpTextLines is greater than maxHelpTextLines.
  64
  65         @see XObjectInspectorModel::HasHelpSection
  66         @see XObjectInspectorModel::MinHelpTextLines
  67         @see XObjectInspectorModel::MaxHelpTextLines
  68
  69         @since OOo 2.2
  70     */
  71     createWithHelpSection(
  72         [in] long minHelpTextLines,
  73         [in] long maxHelpTextLines
  74     )
  75         raises ( ::com::sun::star::lang::IllegalArgumentException );
  76 };
  77
  78
  79 }; }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */