xref: /aoo4110/main/offapi/com/sun/star/form/XGrid.idl (revision b1cdbd2c)
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_XGrid_idl__
24#define __com_sun_star_form_XGrid_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module form {
34
35//=============================================================================
36
37/** provides the possibility of setting and retrieving the position
38	of the current cell in a grid control.
39
40	<p>Note that a grid control does not allow free control over the current row:
41	In such a control, every line represents a row of data of the underlying
42	<type scope="com::sun::star::form::component">DataForm</type>. Thus, the <em>current
43	row</em> of the grid control always equals the current row of the
44	<type scope="com::sun::star::form::component">DataForm</type>, and can be affected only
45	by changing the latter.<br/>
46	The current column of a grid control, whoever, can be freely controlled.</p>
47
48	@see com::sun::star::form::component::GridControl
49	@see com::sun::star::form::control::GridControl
50	@deprecated
51 */
52published interface XGrid: com::sun::star::uno::XInterface
53{
54	//-------------------------------------------------------------------------
55
56	/** retrieves the current column position.
57	 */
58	short getCurrentColumnPosition();
59
60	//-------------------------------------------------------------------------
61
62	/** sets the current column position.
63	 */
64	[oneway] void setCurrentColumnPosition( [in] short nPos );
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72/*=============================================================================
73
74=============================================================================*/
75#endif
76