offapi/com/sun/star/inspection/ObjectInspectorModel.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 #ifndef __com_sun_star_inspection_ObjectInspectorModel_idl__
  21 #define __com_sun_star_inspection_ObjectInspectorModel_idl__
  22
  23 #include <com/sun/star/inspection/XObjectInspectorModel.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26 module com {  module sun {  module star {  module inspection {
  27
  28 /** describes a default implementation of an ObjectInspectorModel
  29
  30     <p>This service simplifies usage of an ObjectInspector.</p>
  31
  32     <p>The XObjectInspectorModel implemented by this service will not provide any property
  33     categories, nor apply any particular order to the properties provided by its handler(s).</p>
  34
  35     @see ObjectInspector
  36     @see XObjectInspectorModel
  37     @see XObjectInspectorModel::describeCategories
  38     @see XObjectInspectorModel::getPropertyOrderIndex
  39
  40     @since OOo 2.0.3
  41 */
  42 service ObjectInspectorModel : XObjectInspectorModel
  43 {
  44     /** creates a default ObjectInspectorModel, whose one and only handler factory
  45         creates a GenericPropertyHandler.
  46     */
  47     createDefault();
  48
  49     /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
  50         factories.
  51
  52         @param handlerFactories
  53             a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
  54             method.
  55         @throws ::com::sun::star::lang::IllegalArgumentException
  56             if the given sequence is empty.
  57
  58         @see XObjectInspectorModel::HandlerFactories
  59     */
  60     createWithHandlerFactories( [in] sequence< any > handlerFactories )
  61         raises ( ::com::sun::star::lang::IllegalArgumentException );
  62
  63     /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
  64         factories, and describing an ObjectInspector which has a help section.
  65
  66         @param handlerFactories
  67             a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
  68             method.
  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 handlerFactories is empty.
  80
  81         @throws ::com::sun::star::lang::IllegalArgumentException
  82             if minHelpTextLines or maxHelpTextLines are negative,
  83             or if minHelpTextLines is greater than maxHelpTextLines.
  84
  85         @see XObjectInspectorModel::HandlerFactories
  86         @see XObjectInspectorModel::HasHelpSection
  87         @see XObjectInspectorModel::MinHelpTextLines
  88         @see XObjectInspectorModel::MaxHelpTextLines
  89
  90         @since OOo 2.2
  91     */
  92     createWithHandlerFactoriesAndHelpSection(
  93         [in] sequence< any > handlerFactories,
  94         [in] long minHelpTextLines,
  95         [in] long maxHelpTextLines
  96     )
  97         raises ( ::com::sun::star::lang::IllegalArgumentException );
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */