xref: /aoo41x/main/offapi/com/sun/star/form/XGridPeer.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_XGridPeer_idl__
28#define __com_sun_star_form_XGridPeer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_container_XIndexContainer_idl__
35#include <com/sun/star/container/XIndexContainer.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module form {
42
43//=============================================================================
44
45/** represents the window peer of a GridControl and allows you to set
46	and retrieve the model data.
47
48	<p>Usually, the columns used are the columns as supplied by the grid control model.</p>
49
50	<p>You should use this interface only if you know exactly what you are doing. Tampering
51	with the columns of a grid control which is part of a complex form can really hurt ....</p>
52
53	@deprecated
54	@see com::sun::star::awt::XWindowPeer
55	@see com::sun::star::form::component::GridControl
56 */
57published interface XGridPeer: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60
61	/** retrieves the currently used column definitions of the peer.
62	 */
63	com::sun::star::container::XIndexContainer getColumns();
64
65	//-------------------------------------------------------------------------
66
67	/** sets the column definition for the peer.
68	 */
69	[oneway] void setColumns( [in] com::sun::star::container::XIndexContainer aColumns );
70
71};
72
73//=============================================================================
74
75}; }; }; };
76
77/*=============================================================================
78
79=============================================================================*/
80#endif
81