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