offapi/com/sun/star/form/control/InteractionGridControl.idl

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