xref: /AOO41X/main/offapi/com/sun/star/form/runtime/XFormControllerContext.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * Copyright 2000, 2010 Oracle and/or its affiliates.
5 *
6 * OpenOffice.org - a multi-platform office productivity suite
7 *
8 * This file is part of OpenOffice.org.
9 *
10 * OpenOffice.org is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 3
12 * only, as published by the Free Software Foundation.
13 *
14 * OpenOffice.org is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU Lesser General Public License version 3 for more details
18 * (a copy is included in the LICENSE file that accompanied this code).
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with OpenOffice.org.  If not, see
22 * <http://www.openoffice.org/license.html>
23 * for a copy of the LGPLv3 License.
24 *
25************************************************************************/
26
27#ifndef __offapi_com_sun_star_form_runtime_XFormControllerContext_idl__
28#define __offapi_com_sun_star_form_runtime_XFormControllerContext_idl__
29
30#include <com/sun/star/awt/XControl.idl>
31
32//=============================================================================
33
34module com { module sun { module star { module form { module runtime {
35
36//=============================================================================
37
38/** provides a context for a <type>FormController</type>
39
40<p>A <type>FormController</type> knows about the controls it is responsible
41    for, and about the control container which those controls live in. However, it doesn't know
42    about a possible larger context, like a scrollable view which the controls are embedded into.
43    To compensate this, it can be provided a <code>XFormControllerContext</code>.</p>
44 */
45interface XFormControllerContext
46{
47    /** ensures the given control is visible, by scrolling the view if necessary.
48    */
49    void    makeVisible( [in] ::com::sun::star::awt::XControl _Control );
50};
51
52//=============================================================================
53
54}; }; }; }; };
55
56//=============================================================================
57
58#endif
59