summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl
blob: b9deb1f74be154bf451f8071aaf42c0481a47f47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#ifndef __com_sun_star_form_inspection_DefaultFormComponentInspectorModel_idl__
#define __com_sun_star_form_inspection_DefaultFormComponentInspectorModel_idl__

#include <com/sun/star/inspection/XObjectInspectorModel.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>


module com {  module sun {  module star {  module form { module inspection {


/** implements a com::sun::star::inspection::XObjectInspectorModel for
    inspecting form components, in particular all components implementing the FormComponent
    service.

    <p>A DefaultFormComponentInspectorModel provides the following handlers by default:
    <ul><li>ButtonNavigationHandler</li>
        <li>CellBindingPropertyHandler</li>
        <li>EditPropertyHandler</li>
        <li>EventHandler</li>
        <li>FormComponentPropertyHandler</li>
        <li>SubmissionPropertyHandler</li>
        <li>XMLFormsPropertyHandler</li>
        <li>XSDValidationPropertyHandler</li>
    </ul></p>

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

        @since OOo 2.2
    */
    createDefault();

    /** creates a default DefaultFormComponentInspectorModel, 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 minHelpTextLines or maxHelpTextLines are negative,
            or if minHelpTextLines is greater than maxHelpTextLines.

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

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


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */