xref: /trunk/main/offapi/com/sun/star/form/XGridPeer.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_XGridPeer_idl__
24#define __com_sun_star_form_XGridPeer_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_container_XIndexContainer_idl__
31#include <com/sun/star/container/XIndexContainer.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/** represents the window peer of a GridControl and allows you to set
42	and retrieve the model data.
43
44	<p>Usually, the columns used are the columns as supplied by the grid control model.</p>
45
46	<p>You should use this interface only if you know exactly what you are doing. Tampering
47	with the columns of a grid control which is part of a complex form can really hurt ....</p>
48
49	@deprecated
50	@see com::sun::star::awt::XWindowPeer
51	@see com::sun::star::form::component::GridControl
52 */
53published interface XGridPeer: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56
57	/** retrieves the currently used column definitions of the peer.
58	 */
59	com::sun::star::container::XIndexContainer getColumns();
60
61	//-------------------------------------------------------------------------
62
63	/** sets the column definition for the peer.
64	 */
65	[oneway] void setColumns( [in] com::sun::star::container::XIndexContainer aColumns );
66
67};
68
69//=============================================================================
70
71}; }; }; };
72
73/*=============================================================================
74
75=============================================================================*/
76#endif
77