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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*************************************************************************
*
* 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_ucb_ListActionType_idl__
#define __com_sun_star_ucb_ListActionType_idl__
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** These values are used to specify the type of change happened to a list.
<p>A change happened is sent from an <type>XDynamicResultSet</type>
as <type>ListAction</type> to a <type>XDynamicResultSetListener</type>.
<p>The values are contained in <member>ListAction::ListActionType</member>.
*/
published constants ListActionType
{
//-------------------------------------------------------------------------
/** First notification to a single listener for purpose of initialization.
<p>This type of notification is required to be sent first and only once
to a new listener.
<p>The member <member>ListAction::ActionInfo</member> is required to
contain a struct <type>WelcomeDynamicResultSetStruct</type>.
This struct contains two
<type scope="com::sun::star::sdbc">XResultSet</type>s (old and new).
During and after the notification only the new set is valid for access.
But the listener is required to remind both
<type scope="com::sun::star::sdbc">XResultSet</type>s as he will not get
another chance to get them again.
<p>The members <member>ListAction::Count</member> and
<member>ListAction::Position</member> are not used.
*/
const long WELCOME = 20;
//-------------------------------------------------------------------------
/** One or more rows were inserted into the list.
<p>This action is related to <member>ContentAction::INSERTED</member>.
<p>The members <member>ListAction::Count</member> and
<member>ListAction::Position</member> contain the position and count of
newly inserted rows. If the count is greater than one, the inserted rows
have to be one after the other.
<p> <member>ListAction::ActionInfo</member> could contain something but
this is not required. For example, it could contain the properties of
the new rows (i.e. for remote optimizing), but this is not required
nor unrestrictedly recommended.
<p>@todo ... further description of allowed contents for
<member>ListAction::ActionInfo</member> is needed
*/
const long INSERTED = 21;
//-------------------------------------------------------------------------
/** One or more rows were removed from the list.
<p>This action is related to <member>ContentAction::REMOVED</member>.
<p>The members <member>ListAction::Count</member> and
<member>ListAction::Position</member> contain the position and count of the
removed rows. If the count is greater than one, the removed rows have to be
one after the other.
<p>The member <member>ListAction::ListActionType</member> is not used.
*/
const long REMOVED = 22;
//-------------------------------------------------------------------------
/** The whole list was destroyed and independently rebuild.
<p>If "CLEARED" is sent you don't need to refer to the old ResultSet.
<p>The members <member>ListAction::ListActionType</member>,
<member>ListAction::Count</member> and <member>ListAction::Position</member>
are ignored.
*/
const long CLEARED = 23;
//-------------------------------------------------------------------------
/** One or more rows were moved to another position.
<p>The members <member>ListAction::Count</member> and
<member>ListAction::Position</member> contain the position and count of the
moved rows. If the count is greater than one, the moved rows have to be
one after the other.
<p><member>ListAction::ListActionType</member> is required to contain a "long",
which gives the shift of position.
(i.e. When two rows at position 3 and 4 are moved for a shift "+1",
they will appear at the positions 4 and 5. In this action is included, that
the row on old position 5 now appears on position 3.
No other notification is needed, to explain or complete this action).
*/
const long MOVED = 24;
//-------------------------------------------------------------------------
/** The properties of one or more rows have changed.
<p>This action is related to a <type scope="com::sun::star::beans">PropertyChangeEvent</type>.
<p>The members <member>ListAction::Count</member> and
<member>ListAction::Position</member> contain the position and count of the
rows, whose properties have changed. If the count is greater than one, the
rows with modified properties have to be one after the other.
<p> <member>ListAction::ActionInfo</member> could contain something but
this is not required. For example, it could contain the new properties
(i.e. for remote optimizing), but this is not required nor unrestrictedly
recommended.
<p>@todo ... further description of allowed contents for
<member>ListAction::ActionInfo</member> is needed
*/
const long PROPERTIES_CHANGED = 25;
//-------------------------------------------------------------------------
/*??????????????????????????? we probably will not need this
The identity of a row has changed.
<p>This action is related to <type>ContentAction</type> == EXCHANGED.
<p>The members <member>ListAction::Count</member> and
<member>ListAction::Position</member> contain the position and count of the
rows, whose identity have changed. If the count is greater than one, the
rows with changed identity have to be one after the other.
<p><member>ListAction::ListActionType</member> must contain the new identities
<p>@todo ...
const long EXCHANGED = 26;
*/
//-------------------------------------------------------------------------
/*??????????????????????????? we probably will need this
After a completely notified Iteration send "COMPLETED".
<p>This notification is required to be send, to indicate, that now the full
result is reached.
<p>E.g. while a new given list is sorted, some intermediate states are
notified. After the last portion of sorting is done and notified you have
to send "COMPLETED". So a listener has the possibility to wait for
"COMPLETED" e.g. to print the full result. )
<p>The members <member>ListAction::ListActionType</member>,
<member>ListAction::Count</member> and <member>ListAction::Position</member>
are useless.
*/
const long COMPLETED = 27;
};
//=============================================================================
}; }; }; };
#endif
|
