offapi/com/sun/star/inspection/ObjectInspectorModel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_inspection_ObjectInspectorModel_idl__
  29 #define __com_sun_star_inspection_ObjectInspectorModel_idl__
  30
  31 #ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__
  32 #include <com/sun/star/inspection/XObjectInspectorModel.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  36 #include <com/sun/star/lang/IllegalArgumentException.idl>
  37 #endif
  38
  39 //=============================================================================
  40 module com {  module sun {  module star {  module inspection {
  41
  42 //-----------------------------------------------------------------------------
  43 /** describes a default implementation of an ObjectInspectorModel
  44
  45     <p>This service simplifies usage of an <type>ObjectInspector</type>.</p>
  46
  47     <p>The <type>XObjectInspectorModel</type> implemented by this service will not provide any property
  48     categories, nor apply any particular order to the properties provided by its handler(s).</p>
  49
  50     @see ObjectInspector
  51     @see XObjectInspectorModel
  52     @see XObjectInspectorModel::describeCategories
  53     @see XObjectInspectorModel::getPropertyOrderIndex
  54
  55     @since OOo 2.0.3
  56 */
  57 service ObjectInspectorModel : XObjectInspectorModel
  58 {
  59     /** creates a default ObjectInspectorModel, whose one and only handler factory
  60         creates a <type>GenericPropertyHandler</type>.
  61     */
  62     createDefault();
  63
  64     /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
  65         factories.
  66
  67         @param handlerFactories
  68             a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
  69             method.
  70         @throws ::com::sun::star::lang::IllegalArgumentException
  71             if the given sequence is empty.
  72
  73         @see XObjectInspectorModel::HandlerFactories
  74     */
  75     createWithHandlerFactories( [in] sequence< any > handlerFactories )
  76         raises ( ::com::sun::star::lang::IllegalArgumentException );
  77
  78     /** creates a default ObjectInspectorModel, using an externally provided sequence of property handler
  79         factories, and describing an ObjectInspector which has a help section.
  80
  81         @param handlerFactories
  82             a sequence of handler factories, as to be provided in the XObjectInspectorModel::HandlerFactories
  83             method.
  84
  85         @param minHelpTextLines
  86             denotes the minimum number of lines of text to be reserved for the help
  87             section.
  88
  89         @param maxHelpTextLines
  90             denotes the maximum number of lines of text to be reserved for the help
  91             section.
  92
  93         @throws ::com::sun::star::lang::IllegalArgumentException
  94             if <arg>handlerFactories</arg> is empty.
  95
  96         @throws ::com::sun::star::lang::IllegalArgumentException
  97             if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
  98             or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.
  99
 100         @see XObjectInspectorModel::HandlerFactories
 101         @see XObjectInspectorModel::HasHelpSection
 102         @see XObjectInspectorModel::MinHelpTextLines
 103         @see XObjectInspectorModel::MaxHelpTextLines
 104
 105         @since OOo 2.2
 106     */
 107     createWithHandlerFactoriesAndHelpSection(
 108         [in] sequence< any > handlerFactories,
 109         [in] long minHelpTextLines,
 110         [in] long maxHelpTextLines
 111     )
 112         raises ( ::com::sun::star::lang::IllegalArgumentException );
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif
 120
 121