summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/runtime/XFormControllerContext.idl
blob: da0999ee17a73296bfdaaefaa97ec0a377959daa (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
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2009 by Sun Microsystems, Inc.
*
* 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 __offapi_com_sun_star_form_runtime_XFormControllerContext_idl__
#define __offapi_com_sun_star_form_runtime_XFormControllerContext_idl__

#include <com/sun/star/awt/XControl.idl>

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

module com { module sun { module star { module form { module runtime {

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

/** provides a context for a <type>FormController</type>

<p>A <type>FormController</type> knows about the controls it is responsible
    for, and about the control container which those controls live in. However, it doesn't know
    about a possible larger context, like a scrollable view which the controls are embedded into.
    To compensate this, it can be provided a <code>XFormControllerContext</code>.</p>
 */
interface XFormControllerContext
{
    /** ensures the given control is visible, by scrolling the view if necessary.
    */
    void    makeVisible( [in] ::com::sun::star::awt::XControl _Control );
};

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

}; }; }; }; };

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

#endif