offapi/com/sun/star/form/component/GridControl.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
  21
  22  module com {  module sun {  module star {  module form {  module component {
  23
  24
  25 /** specifies a model for a control which can display form data in a table-like way.
  26
  27     <p>In opposite to other form controls, grid controls do not only
  28     display the single current value of a column they are bound to. Moreover, they do
  29     display not only the current row of the form, but all rows (at least potentially, limited
  30     by the control size, of course).</p>
  31
  32     <p>The table rows in a grid control correspond to the rows in the DataForm
  33     the control belongs to, and the columns correspond to single columns of the form's row set.</p>
  34
  35     <p>Columns of a grid control are modeled by own objects, too. They are very similar to usual
  36     com::sun::star::form::DataAwareControlModels modeling other "single-value" controls, but they are not described
  37     as own services. Instead, they need to be created using the com::sun::star::form::XGridColumnFactory interface.</p>
  38  */
  39 published service GridControl
  40 {
  41     service com::sun::star::form::FormControlModel;
  42
  43     /** provides basic functionality of a container of com::sun::star::form::FormComponents.
  44
  45         <p>All the container-related methods of this service related to control models,
  46         this is what are the container elements for a GridControl.</p>
  47
  48         <p>As the com::sun::star::form::FormComponents service also specifies
  49         the com::sun::star::script::XEventAttacherManager service, grid control
  50         models also provide a scripting environment for their columns.</p>
  51     */
  52     service com::sun::star::form::FormComponents;
  53
  54     /** allows to create column models to be inserted into the control model.
  55
  56         <p>Note that the object returned by the com::sun::star::form::XGridColumnFactory::createColumn()
  57         method is not part of the grid control, yet. It needs to be inserted using any of the
  58         container interfaces.</p>
  59
  60         <p>You always need to use this interface for creating columns for the grid control.
  61         Column models not created this way will not be accepted when inserted later on.</p>
  62     */
  63     interface com::sun::star::form::XGridColumnFactory;
  64
  65     /** gives access to the currently selection.
  66
  67         <p>In a grid control, single columns can be selected (at most one at a time).<br/>
  68         For various unfortunate reasons, this selection is an aspect of the model, not of the
  69         control as you would expect.</p>
  70
  71         <p>This interface is deprecated, new implementations should not use it anymore, as it is to
  72         be superseded by a solution which is bound to the control, not the model.</p>
  73
  74         @deprecated
  75     */
  76     interface com::sun::star::view::XSelectionSupplier;
  77
  78     /** resets the control.
  79
  80         <p>The reset of the control is forwarded to all its elements, means to all the column models.
  81         As grid columns are very much like data-aware stand-alone controls, you can find a description
  82         of the reset functionality in com::sun::star::form::DataAwareControlModel::XReset.
  83     */
  84     interface com::sun::star::form::XReset;
  85
  86
  87     /** returns the border style of the control.
  88
  89         <pre>
  90         0: No border
  91         1: 3D border
  92         2: simple border
  93         </pre>
  94      */
  95     [property] short Border;
  96
  97
  98     /** specifies the color of the border, if present
  99
 100         <p>Not every border style (see #Border) may support coloring.
 101         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
 102
 103         @since OOo 2.0
 104      */
 105     [optional, property] long BorderColor;
 106
 107
 108     /** determines whether the control is enabled or disabled.
 109      */
 110     [property] boolean Enabled;
 111
 112
 113     /** contains the font attributes of the text in the control.
 114      */
 115     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 116
 117
 118     /** specifies the height of a row of the grid.
 119
 120         <p>If the value is set to `NULL`, the height is determined automatically according
 121         to the current font used.</p>
 122
 123         @see GridControl::FontDescriptor
 124      */
 125     [property] long RowHeight;
 126
 127
 128     /** determines whether the control can be reached by the tabulator key.
 129      */
 130     [property] boolean Tabstop;
 131
 132
 133     /** specifies the text color (RGB) of the control.
 134      */
 135     [property] com::sun::star::util::Color TextColor;
 136
 137 };
 138
 139
 140 }; }; }; }; };
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */