summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/control/InteractionGridControl.idl
blob: f8daf141b9de7618c93bc749f3e558e1bee9ae43 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_form_control_InteractionGridControl_idl__
#define __com_sun_star_form_control_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


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */