blob: ef1cf2657f558a060315048467213406dcc86320 (
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
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*************************************************************************
*
* 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_control_GridControl_idl__
#define __com_sun_star_form_control_GridControl_idl__
#include <com/sun/star/awt/UnoControl.idl>
#include <com/sun/star/form/XGrid.idl>
#include <com/sun/star/form/XBoundComponent.idl>
#include <com/sun/star/form/XGridFieldDataSupplier.idl>
#include <com/sun/star/util/XModifyBroadcaster.idl>
#include <com/sun/star/util/XModeSelector.idl>
#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>
#include <com/sun/star/container/XContainer.idl>
#include <com/sun/star/frame/XDispatchProviderInterception.idl>
#include <com/sun/star/view/XSelectionSupplier.idl>
//=============================================================================
module com { module sun { module star { module form {
published interface XGridControl;
module control {
//=============================================================================
/** describes a table-like control for displaying data.
<p>The model of the control has to support the <type scope="com::sun::star::form::component">GridControl</type>
service.</p>
@see com::sun::star::awt::UnoControl
@see com::sun::star::awt::UnoControlModel
*/
published service GridControl
{
service com::sun::star::awt::UnoControl;
/** allows committing the content of the active cell of the control.
*/
interface com::sun::star::form::XBoundComponent;
/** allows access to the active cell within the grid.
<p>Only the column position can be modified using this interface, as the row position within
a table control bound to a data source is given implicitly (by the cursor position of the data source).</p>
*/
interface com::sun::star::form::XGrid;
[optional] interface com::sun::star::form::XGridControl;
/** used to broadcast modifications made by the user (within the active cell)
*/
interface com::sun::star::util::XModifyBroadcaster;
/** allows access to the field data of the grid's current row in different formats
*/
[optional] interface com::sun::star::form::XGridFieldDataSupplier;
/** allows access to objects wrapping a single column
*/
interface com::sun::star::container::XIndexAccess;
/** allows creation of an enumeration for the column objects
*/
interface com::sun::star::container::XEnumerationAccess;
/** is used to switch the operating modes of the control.
<p>Besides the normal operation mode (which is used to display the database form's data) the control may
for instance support a filter mode.</p>
*/
[optional] interface com::sun::star::util::XModeSelector;
/** used to control the selection of rows in the grid control.
<p>The selection used with the methods <method scope="com::sun::star::view">XSelectionSupplier::getSelection</method>
and <method scope="com::sun::star::view">XSelectionSupplier::select</method> is a sequence of Any's.<br/>
Here the elements of the Sequence are the bookmarks (in the <type scope="com::sun::star::sdb">RowSet</type>)
of the (to-be-) selected rows.</p>
*/
[optional] interface com::sun::star::view::XSelectionSupplier;
/** allows external components to register dispatchers for some common form actions.
<p>A grid control can contain own UI elements for traveling within the database form it belongs to (This
concept seems to make sense, as a grid control - in opposite to other data aware controls - displays
not only one record at a time, but a larger number of records of the database form.)<br/>
With the help of this interface, external components which wish to handle such travelings themselves can
register interceptors for the actions in question.</p>
<p>Usual URLs to use include
<dl>
<dt>.uno:FormSlots/moveToFirst</dt><dd> move the cursor to the first record</dd>
<dt>.uno:FormSlots/moveToPrev</dt><dd> move the cursor to the previous record</dd>
<dt>.uno:FormSlots/moveToNext</dt><dd> move the cursor to the next record</dd>
<dt>.uno:FormSlots/moveToLast</dt><dd> move the cursor to the last record</dd>
<dt>.uno:FormSlots/moveToNew</dt><dd> move the cursor to the (one and only) <em>new</em> record</dd>
<dt>.uno:FormSlots/undoRecord</dt><dd> undo the changes done so far in the current record</dd>
</dl>
</p>
<p>A concrete implementation of this service may offer more or less URLs, but if it offers some of the URLs
above, it must stick to the meanings defined above.</p>
*/
[optional] interface com::sun::star::frame::XDispatchProviderInterception;
};
//=============================================================================
}; }; }; }; };
#endif
|
