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 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: InteractionGridControl.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_component_InteractionGridControl_idl__
  32 #define __com_sun_star_form_component_InteractionGridControl_idl__
  33
  34 #ifndef __com_sun_star_form_control_GridControl_idl__
  35 #include <com/sun/star/form/control/GridControl.idl>
  36 #endif
  37 #ifndef __com_sun_star_frame_XDispatch_idl__
  38 #include <com/sun/star/frame/XDispatch.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module form {  module control {
  44
  45 //=============================================================================
  46
  47 /** is an extended grid control, which allows the user to customize some of it's user interface's aspects.
  48 */
  49 published service InteractionGridControl
  50 {
  51     service com::sun::star::form::control::GridControl;
  52
  53     /** allows access to the UI features of the control
  54
  55         <p>Though concret implementations of the service may offer different sets of aspects which can be customized,
  56         the following commands have, if supported, a defined meaning:
  57         <dl>
  58             <dt>.uno:GridSlots/BrowserAttribs</dt><dd> (interactively) customize the overall appearance of the grid (font etc.)</dd>
  59             <dt>.uno:GridSlots/RowHeight</dt><dd> (interactively) customize the row height appearance of the grid</dd>
  60             <dt>.uno:GridSlots/ColumnAttribs</dt><dd> (interactively) customize the format of a given column</dd>
  61             <dt>.uno:GridSlots/ColumnWidth</dt><dd> (interactively) customize the width of a given column</dd>
  62         </dl>
  63         </p>
  64
  65         <p>The following parameters may be passed when dispatching the commands above (as before, concrete implementations
  66         may extend this list):
  67         <dl>
  68             <dt>ColumnId</dt><dd> the id of the column in question, if the command is executed for a column</dd>
  69             <dt>ColumnModelPos</dt><dd> the model position of the column in question, if the command is executed for a column</dd>
  70             <dt>ColumnViewPos</dt><dd> the view position of the column in question, if the command is executed for a column. The
  71             view position may differ from the model position, as in a grid control, columns can be hidden.</dd>
  72         </dl>
  73         </p>
  74     */
  75     interface com::sun::star::frame::XDispatch;
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; }; };
  81
  82 /*=============================================================================
  83
  84 =============================================================================*/
  85
  86 #endif
  87
  88