summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl
blob: 99145dc4f0363dd8ff13362da22c4c72224869b6 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_form_ButtonNavigationHandler_idl__
#define __com_sun_star_form_ButtonNavigationHandler_idl__

#ifndef __com_sun_star_inspection_XPropertyHandler_idl__
#include <com/sun/star/inspection/XPropertyHandler.idl>
#endif

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

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

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

/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type>
    which is able to enhance the <member scope="com::sun::star::form::component">CommandButton::ButtonType</member>
    and <member scope="com::sun::star::form::component">CommandButton::TargetURL</member> properties of a
    <type scope="com::sun::star::form::component">CommandButton</type>.

    <p>For this, the two properties are superseded by new versions, where as button type, additional
    possible values are added for navigating the parent form of the button. For instance, in an
    <type scope="com::sun::star::inspection">ObjectInspector</type> using this handler, the user will be able
    to choose a button type saying "move to the next record", which, when chosen, well, moves the parent
    database form of the button to the next record.</p>

    @see com::sun::star::inspection::XPropertyHandler
    @see com::sun::star::form::component::CommandButton
*/
service ButtonNavigationHandler
{
    interface com::sun::star::inspection::XPropertyHandler;
};

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

}; }; }; }; };

#endif