offapi/com/sun/star/awt/grid/UnoControlGridModel.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_grid_UnoControlGridModel_idl__
  29 #define __com_sun_star_awt_grid_UnoControlGridModel_idl__
  30
  31 #include <com/sun/star/awt/grid/XGridColumnModel.idl>
  32 #include <com/sun/star/awt/grid/XGridDataModel.idl>
  33 #include <com/sun/star/awt/UnoControlModel.idl>
  34 #include <com/sun/star/view/SelectionType.idl>
  35 #include <com/sun/star/awt/FontDescriptor.idl>
  36 #include <com/sun/star/style/VerticalAlignment.idl>
  37 #include <com/sun/star/util/Color.idl>
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module awt { module grid {
  42
  43 //=============================================================================
  44
  45 /** specifies the standard model of a <type>UnoControlGrid</type> control.
  46
  47     @since OOo 3.3
  48  */
  49 service UnoControlGridModel
  50 {
  51     /** specifies the standard model of an <type scope="com::sun::star::awt">UnoControl</type>. */
  52     service com::sun::star::awt::UnoControlModel;
  53
  54     /** Specifies whether the grid control should display a special header column.
  55
  56     <p>The default value is <FALSE/></p>
  57     */
  58     [property] boolean ShowRowHeader;
  59
  60     /** specifies the width of the row header column, if applicable.
  61
  62         <p>The width is specified in application font units - see <type scope="com::sun::star::util">MeasureUnit</type>.</p>
  63
  64         <p>The value given here is ignored if <member>ShowRowHeader</member> is <FALSE/>.</p>
  65     */
  66     [property] long RowHeaderWidth;
  67
  68     /** Specifies whether the grid control should display a title row.
  69
  70     <p>The default value is <TRUE/></p>
  71     */
  72     [property] boolean ShowColumnHeader;
  73
  74     /** specifies the height of the column header row, if applicable.
  75
  76         <p>The height is specified in application font units - see <type scope="com::sun::star::util">MeasureUnit</type>.</p>
  77
  78         <p>The value given here is ignored if <member>ShowColumnHeader</member> is <FALSE/>.</p>
  79
  80         <p>If the property is <void/>, the grid control shall automatically determine a height which conveniently allows,
  81         according to the used font, to display one line of text.</p>
  82     */
  83     [property, maybevoid] long ColumnHeaderHeight;
  84
  85     /** Specifies the height of rows in the grid control.
  86
  87         <p>The height is specified in application font units - see <type scope="com::sun::star::util">MeasureUnit</type>.</p>
  88     */
  89     [property, maybevoid] long RowHeight;
  90
  91     /** Specifies the <type>XGridColumnModel</type> that is providing the column structure.
  92
  93         <p>You can implement your own instance of <type>XGridColumnModel</type> or use
  94         the <type>DefaultGridColumnModel</type>.
  95
  96         <p>The column model is in the ownership of the grid model: When you set a new column model, or dispose
  97         the grid model, then the (old) column model is disposed, too.</p>
  98
  99         <p>The default for this property is an empty instance of the <type>DefaultGridColumnModel</type>.</p>
 100     */
 101     [property] XGridColumnModel ColumnModel;
 102
 103     /** Specifies the <type>XGridDataModel</type> that is providing the hierarchical data.
 104
 105         <p>You can implement your own instance of <type>XGridDataModel</type> or use
 106         the <type>DefaultGridDataModel</type>.
 107
 108         <p>The data model is in the ownership of the grid model: When you set a new data model, or dispose
 109         the grid model, then the (old) data model is disposed, too.</p>
 110
 111         <p>The default for this property is an empty instance of the <type>DefaultGridDataModel</type>.</p>
 112     */
 113     [property] XGridDataModel GridDataModel;
 114
 115     /** Specifies the vertical scrollbar mode.
 116         <p>The default value is <FALSE/></p>
 117     */
 118     [property] boolean HScroll;
 119
 120     /** Specifies the horizontal scrollbar mode.
 121         <p>The default value is <FALSE/></p>
 122     */
 123     [property] boolean VScroll;
 124
 125     /** Specifies that the control can be reached with the TAB key.
 126      */
 127     [property] boolean Tabstop;
 128
 129     /** Specifies the selection mode that is enabled for this grid control.
 130         <p>The default value is <member scope="com::sun::star::view">SelectionType::SINGLE</member></p>
 131     */
 132     [property] ::com::sun::star::view::SelectionType SelectionModel;
 133
 134     /** controls whether or not to paint horizontal and vertical lines between the grid cells.
 135
 136         @see LineColor
 137     */
 138     [property] boolean UseGridLines;
 139
 140     /** specifies the color to be used when drawing lines between cells
 141
 142         <p>If this property has a value of <VOID/>, the grid control renderer will use some default color,
 143         depending on the system's style settings.</p>
 144
 145         @see UseGridLines
 146     */
 147     [property, maybevoid] ::com::sun::star::util::Color             GridLineColor;
 148
 149     /** specifies the color to be used when drawing the background of row or column headers
 150
 151         <p>If this property has a value of <VOID/>, the grid control renderer will use some default color,
 152         depending on the system's style settings.</p>
 153     */
 154     [property, maybevoid] ::com::sun::star::util::Color             HeaderBackgroundColor;
 155
 156     /** specifies the color to be used when drawing the text within row or column headers
 157
 158         <p>If this property has a value of <VOID/>, the grid control renderer will use some default color,
 159         depending on the system's style settings.</p>
 160     */
 161     [property, maybevoid] ::com::sun::star::util::Color             HeaderTextColor;
 162
 163     /** specifies the colors to be used as background for data rows.
 164
 165         <p>If this sequence is non-empty, the data rows will be rendered with alternating background colors: Assuming
 166         the sequence has <code>n</code> elements, each row will use the background color as specified by its number's
 167         remainder modulo <code>n</code>.</p>
 168
 169         <p>If this sequence is empty, all rows will use the same background color as the control as whole.</p>
 170
 171         <p>If this property does not exist at a particular implementation, or is <VOID/>, rows will be painted
 172         in alternating background colors, every second row having a background color derived from the control's
 173         selection color.</p>
 174     */
 175     [property, maybevoid] sequence< ::com::sun::star::util::Color > RowBackgroundColors;
 176
 177     /** specifies the vertical alignment of the content in the control.
 178
 179         <pre>
 180             TOP
 181             MIDDLE
 182             BOTTOM
 183         </pre>
 184      */
 185     [property] com::sun::star::style::VerticalAlignment VerticalAlign;
 186
 187     /** specifies the font attributes of the text in the control.
 188      */
 189     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 190
 191     /** specifies the color to be used when drawing cell texts
 192
 193         <p>If this property has a value of <VOID/>, the grid control renderer will use some default color,
 194         depending on the system's style settings.</p>
 195     */
 196     [property, maybevoid] ::com::sun::star::util::Color             TextColor;
 197
 198     /** specifies the color to be used when drawing text lines (underlining and strikethrough)
 199
 200         <p>If this property has a value of <VOID/>, the grid control renderer will use some default color,
 201         depending on the system's style settings.</p>
 202      */
 203     [property, maybevoid] com::sun::star::util::Color               TextLineColor;
 204
 205     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 206         value of the text in the control.
 207      */
 208     [property] short FontEmphasisMark;
 209
 210     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 211         value of the text in the control.
 212      */
 213     [property] short FontRelief;
 214
 215     /** specifies the help text of the control.
 216      */
 217     [property] string HelpText;
 218
 219     /** specifies the help URL of the control.
 220      */
 221     [property] string HelpURL;
 222
 223 };
 224
 225 //=============================================================================
 226
 227 }; }; }; }; };
 228
 229 #endif
 230
 231 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */