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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XFormController.idl,v $
* $Revision: 1.9 $
*
* 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_XFormController_idl__
#define __com_sun_star_form_XFormController_idl__
#ifndef __com_sun_star_awt_XTabController_idl__
#include <com/sun/star/awt/XTabController.idl>
#endif
#ifndef __com_sun_star_awt_XControl_idl__
#include <com/sun/star/awt/XControl.idl>
#endif
#ifndef __com_sun_star_form_XFormControllerListener_idl__
#include <com/sun/star/form/XFormControllerListener.idl>
#endif
//=============================================================================
module com { module sun { module star { module form {
//=============================================================================
/** provides functionality to control the activation of forms controls.
<p>There is a duality of forms (<type scope="com::sun::star::form::component">DataForm</type>)
and form controllers. In a document view, for every loaded form there is a form controller which is
responsible for exactly the controls which's models are direct children of the form.<br/>
In some sense, a form controller is the view representation of a form, like a <em>form control</em> is the
view representation of a <em>form control model</em>.<br/>
This is also reflected in this interface: If you call
<method scope="com::sun::star::awt">XTabController::getModel</method> on a form controller, the form which
the controller is responsible for will be returned.<br/>
As always in the model-view-paradigm, there is no way from a model to its controller, mostly, because for
<em>one</em> given form, there is one controller for <em>every</em> view of the document.</p>
<p>A controller is called <em>active</em> if one of the controls it is responsible for has the focus,
else inactive. To be notified whenever this activation state of a given controller changes, you can
add listeners.</p>
@see com::sun::star::form::component::Form
*/
published interface XFormController: com::sun::star::awt::XTabController
{
//-------------------------------------------------------------------------
/** access to the currently active control
@returns
the currently active control, or <NULL/> if there is no such control
*/
com::sun::star::awt::XControl getCurrentControl();
//-------------------------------------------------------------------------
/** adds the specified listener to receive notifications whenever the activation state of
the controller changes.
@param l
the listener to add.
*/
[oneway] void addActivateListener( [in] com::sun::star::form::XFormControllerListener l );
//-------------------------------------------------------------------------
/** removes the specified listener
@param l
the listener to remove.
*/
[oneway] void removeActivateListener( [in] com::sun::star::form::XFormControllerListener l );
};
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif
|
