xref: /AOO41X/main/offapi/com/sun/star/form/control/InteractionGridControl.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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
24#ifndef __com_sun_star_form_component_InteractionGridControl_idl__
25#define __com_sun_star_form_component_InteractionGridControl_idl__
26
27#ifndef __com_sun_star_form_control_GridControl_idl__
28#include <com/sun/star/form/control/GridControl.idl>
29#endif
30#ifndef __com_sun_star_frame_XDispatch_idl__
31#include <com/sun/star/frame/XDispatch.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module form {  module control {
37
38//=============================================================================
39
40/** is an extended grid control, which allows the user to customize some of it's user interface's aspects.
41*/
42published service InteractionGridControl
43{
44    service com::sun::star::form::control::GridControl;
45
46    /** allows access to the UI features of the control
47
48        <p>Though concret implementations of the service may offer different sets of aspects which can be customized,
49        the following commands have, if supported, a defined meaning:
50        <dl>
51            <dt>.uno:GridSlots/BrowserAttribs</dt><dd> (interactively) customize the overall appearance of the grid (font etc.)</dd>
52            <dt>.uno:GridSlots/RowHeight</dt><dd> (interactively) customize the row height appearance of the grid</dd>
53            <dt>.uno:GridSlots/ColumnAttribs</dt><dd> (interactively) customize the format of a given column</dd>
54            <dt>.uno:GridSlots/ColumnWidth</dt><dd> (interactively) customize the width of a given column</dd>
55        </dl>
56        </p>
57
58        <p>The following parameters may be passed when dispatching the commands above (as before, concrete implementations
59        may extend this list):
60        <dl>
61            <dt>ColumnId</dt><dd> the id of the column in question, if the command is executed for a column</dd>
62            <dt>ColumnModelPos</dt><dd> the model position of the column in question, if the command is executed for a column</dd>
63            <dt>ColumnViewPos</dt><dd> the view position of the column in question, if the command is executed for a column. The
64            view position may differ from the model position, as in a grid control, columns can be hidden.</dd>
65        </dl>
66        </p>
67    */
68    interface com::sun::star::frame::XDispatch;
69};
70
71//=============================================================================
72
73}; }; }; }; };
74
75/*=============================================================================
76
77=============================================================================*/
78
79#endif
80
81
82