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