offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.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
  21 module com {  module sun {  module star {  module form { module inspection {
  22
  23
  24 /** implements a com::sun::star::inspection::XObjectInspectorModel for
  25     inspecting form components, in particular all components implementing the FormComponent
  26     service.
  27
  28     <p>A DefaultFormComponentInspectorModel provides the following handlers by default:
  29     <ul><li>ButtonNavigationHandler</li>
  30         <li>CellBindingPropertyHandler</li>
  31         <li>EditPropertyHandler</li>
  32         <li>EventHandler</li>
  33         <li>FormComponentPropertyHandler</li>
  34         <li>SubmissionPropertyHandler</li>
  35         <li>XMLFormsPropertyHandler</li>
  36         <li>XSDValidationPropertyHandler</li>
  37     </ul></p>
  38
  39     @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
  40 */
  41 service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
  42 {
  43     /** creates a default DefaultFormComponentInspectorModel, providing factories for all
  44         handlers listed above.
  45
  46         @since OOo 2.2
  47     */
  48     createDefault();
  49
  50     /** creates a default DefaultFormComponentInspectorModel, 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 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */