xref: /AOO41X/main/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl (revision d695a2a01c88463caf485fe1626e0c4587baa3be)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_report_inspection__DefaultComponentInspectorModel_idl__
#define __com_sun_star_report_inspection_DefaultComponentInspectorModel_idl__

#ifndef __com_sun_star_inspection_XObjectInspectorModel_idl__
#include <com/sun/star/inspection/XObjectInspectorModel.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module report { module inspection {

//=============================================================================

/** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for
    inspecting form components, in particular all components implementing the <type>ReportComponent</type>
    service.

    <p>A <type>DefaultComponentInspectorModel</type> provides the following handlers by default:
    <ul><li><type>GeometryHandler</type></li>
        <li><type>ReportComponentHandler</type></li>
        <li><typescope="com::sun::star::form::inspection">EditPropertyHandler</type></li>
    </ul></p>

    @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
*/
published service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
{
    /** creates a default DefaultComponentInspectorModel, providing factories for all
        handlers listed above.

        @since OpenOffice 2.2
    */
    createDefault();

    /** creates a default DefaultComponentInspectorModel, providing factories for all
        handlers listed above, and describing an ObjectInspector which has a help section.

        @param minHelpTextLines
            denotes the minimum number of lines of text to be reserved for the help
            section.

        @param maxHelpTextLines
            denotes the maximum number of lines of text to be reserved for the help
            section.

        @throws ::com::sun::star::lang::IllegalArgumentException
            if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative,
            or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>.

        @see XObjectInspectorModel::HasHelpSection
        @see XObjectInspectorModel::MinHelpTextLines
        @see XObjectInspectorModel::MaxHelpTextLines

        @since OpenOffice 2.2
    */
    createWithHelpSection(
        [in] long minHelpTextLines,
        [in] long maxHelpTextLines
    )
        raises ( ::com::sun::star::lang::IllegalArgumentException );
};

//=============================================================================

}; }; }; }; };

#endif