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

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