summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/control/InteractionGridControl.idl
blob: db14a209c0b05a9f4b3cede41bb2b03373312d14 (plain)
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
/*************************************************************************
 *
 * 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_form_component_InteractionGridControl_idl__
#define __com_sun_star_form_component_InteractionGridControl_idl__

#include <com/sun/star/form/control/GridControl.idl>
#include <com/sun/star/frame/XDispatch.idl>

//=============================================================================

 module com {  module sun {  module star {  module form {  module control {

//=============================================================================

/** is an extended grid control, which allows the user to customize some of it's user interface's aspects.
*/
published service InteractionGridControl
{
    service com::sun::star::form::control::GridControl;

    /** allows access to the UI features of the control

        <p>Though concrete implementations of the service may offer different sets of aspects which can be customized,
        the following commands have, if supported, a defined meaning:
        <dl>
            <dt>.uno:GridSlots/BrowserAttribs</dt><dd> (interactively) customize the overall appearance of the grid (font etc.)</dd>
            <dt>.uno:GridSlots/RowHeight</dt><dd> (interactively) customize the row height appearance of the grid</dd>
            <dt>.uno:GridSlots/ColumnAttribs</dt><dd> (interactively) customize the format of a given column</dd>
            <dt>.uno:GridSlots/ColumnWidth</dt><dd> (interactively) customize the width of a given column</dd>
        </dl>
        </p>

        <p>The following parameters may be passed when dispatching the commands above (as before, concrete implementations
        may extend this list):
        <dl>
            <dt>ColumnId</dt><dd> the id of the column in question, if the command is executed for a column</dd>
            <dt>ColumnModelPos</dt><dd> the model position of the column in question, if the command is executed for a column</dd>
            <dt>ColumnViewPos</dt><dd> the view position of the column in question, if the command is executed for a column. The
            view position may differ from the model position, as in a grid control, columns can be hidden.</dd>
        </dl>
        </p>
    */
    interface com::sun::star::frame::XDispatch;
};

//=============================================================================

}; }; }; }; };

/*=============================================================================

=============================================================================*/

#endif