142 lines
5.2 KiB
Text
142 lines
5.2 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
|
|
|
|
module com { module sun { module star { module form { module component {
|
|
|
|
|
|
/** specifies a model for a control which can display form data in a table-like way.
|
|
|
|
<p>In opposite to other form controls, grid controls do not only
|
|
display the single current value of a column they are bound to. Moreover, they do
|
|
display not only the current row of the form, but all rows (at least potentially, limited
|
|
by the control size, of course).</p>
|
|
|
|
<p>The table rows in a grid control correspond to the rows in the DataForm
|
|
the control belongs to, and the columns correspond to single columns of the form's row set.</p>
|
|
|
|
<p>Columns of a grid control are modeled by own objects, too. They are very similar to usual
|
|
com::sun::star::form::DataAwareControlModels modeling other "single-value" controls, but they are not described
|
|
as own services. Instead, they need to be created using the com::sun::star::form::XGridColumnFactory interface.</p>
|
|
*/
|
|
published service GridControl
|
|
{
|
|
service com::sun::star::form::FormControlModel;
|
|
|
|
/** provides basic functionality of a container of com::sun::star::form::FormComponents.
|
|
|
|
<p>All the container-related methods of this service related to control models,
|
|
this is what are the container elements for a GridControl.</p>
|
|
|
|
<p>As the com::sun::star::form::FormComponents service also specifies
|
|
the com::sun::star::script::XEventAttacherManager service, grid control
|
|
models also provide a scripting environment for their columns.</p>
|
|
*/
|
|
service com::sun::star::form::FormComponents;
|
|
|
|
/** allows to create column models to be inserted into the control model.
|
|
|
|
<p>Note that the object returned by the com::sun::star::form::XGridColumnFactory::createColumn()
|
|
method is not part of the grid control, yet. It needs to be inserted using any of the
|
|
container interfaces.</p>
|
|
|
|
<p>You always need to use this interface for creating columns for the grid control.
|
|
Column models not created this way will not be accepted when inserted later on.</p>
|
|
*/
|
|
interface com::sun::star::form::XGridColumnFactory;
|
|
|
|
/** gives access to the currently selection.
|
|
|
|
<p>In a grid control, single columns can be selected (at most one at a time).<br/>
|
|
For various unfortunate reasons, this selection is an aspect of the model, not of the
|
|
control as you would expect.</p>
|
|
|
|
<p>This interface is deprecated, new implementations should not use it anymore, as it is to
|
|
be superseded by a solution which is bound to the control, not the model.</p>
|
|
|
|
@deprecated
|
|
*/
|
|
interface com::sun::star::view::XSelectionSupplier;
|
|
|
|
/** resets the control.
|
|
|
|
<p>The reset of the control is forwarded to all its elements, means to all the column models.
|
|
As grid columns are very much like data-aware stand-alone controls, you can find a description
|
|
of the reset functionality in com::sun::star::form::DataAwareControlModel::XReset.
|
|
*/
|
|
interface com::sun::star::form::XReset;
|
|
|
|
|
|
/** returns the border style of the control.
|
|
|
|
<pre>
|
|
0: No border
|
|
1: 3D border
|
|
2: simple border
|
|
</pre>
|
|
*/
|
|
[property] short Border;
|
|
|
|
|
|
/** specifies the color of the border, if present
|
|
|
|
<p>Not every border style (see #Border) may support coloring.
|
|
For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
|
|
|
|
@since OOo 2.0
|
|
*/
|
|
[optional, property] long BorderColor;
|
|
|
|
|
|
/** determines whether the control is enabled or disabled.
|
|
*/
|
|
[property] boolean Enabled;
|
|
|
|
|
|
/** contains the font attributes of the text in the control.
|
|
*/
|
|
[property] com::sun::star::awt::FontDescriptor FontDescriptor;
|
|
|
|
|
|
/** specifies the height of a row of the grid.
|
|
|
|
<p>If the value is set to `NULL`, the height is determined automatically according
|
|
to the current font used.</p>
|
|
|
|
@see GridControl::FontDescriptor
|
|
*/
|
|
[property] long RowHeight;
|
|
|
|
|
|
/** determines whether the control can be reached by the tabulator key.
|
|
*/
|
|
[property] boolean Tabstop;
|
|
|
|
|
|
/** specifies the text color (RGB) of the control.
|
|
*/
|
|
[property] com::sun::star::util::Color TextColor;
|
|
|
|
};
|
|
|
|
|
|
}; }; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|