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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_form_control_InteractionGridControl_idl__
  21 #define __com_sun_star_form_control_InteractionGridControl_idl__
  22
  23 #include <com/sun/star/form/control/GridControl.idl>
  24 #include <com/sun/star/frame/XDispatch.idl>
  25
  26
  27  module com {  module sun {  module star {  module form {  module control {
  28
  29
  30 /** is an extended grid control, which allows the user to customize some of its user interface's aspects.
  31 */
  32 published service InteractionGridControl
  33 {
  34     service com::sun::star::form::control::GridControl;
  35
  36     /** allows access to the UI features of the control
  37
  38         <p>Though concrete implementations of the service may offer different sets of aspects which can be customized,
  39         the following commands have, if supported, a defined meaning:
  40         <dl>
  41             <dt>.uno:GridSlots/BrowserAttribs</dt><dd> (interactively) customize the overall appearance of the grid (font etc.)</dd>
  42             <dt>.uno:GridSlots/RowHeight</dt><dd> (interactively) customize the row height appearance of the grid</dd>
  43             <dt>.uno:GridSlots/ColumnAttribs</dt><dd> (interactively) customize the format of a given column</dd>
  44             <dt>.uno:GridSlots/ColumnWidth</dt><dd> (interactively) customize the width of a given column</dd>
  45         </dl>
  46         </p>
  47
  48         <p>The following parameters may be passed when dispatching the commands above (as before, concrete implementations
  49         may extend this list):
  50         <dl>
  51             <dt>ColumnId</dt><dd> the id of the column in question, if the command is executed for a column</dd>
  52             <dt>ColumnModelPos</dt><dd> the model position of the column in question, if the command is executed for a column</dd>
  53             <dt>ColumnViewPos</dt><dd> the view position of the column in question, if the command is executed for a column. The
  54             view position may differ from the model position, as in a grid control, columns can be hidden.</dd>
  55         </dl>
  56         </p>
  57     */
  58     interface com::sun::star::frame::XDispatch;
  59 };
  60
  61
  62 }; }; }; }; };
  63
  64 #endif
  65
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */