offapi/com/sun/star/awt/grid/UnoControlGridModel.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 module com {  module sun {  module star {  module awt { module grid {
  22
  23
  24 /** specifies the standard model of a UnoControlGrid control.
  25
  26     @since OOo 3.3
  27  */
  28 published service UnoControlGridModel
  29 {
  30     /** specifies the standard model of a com::sun::star::awt::UnoControl. */
  31     service com::sun::star::awt::UnoControlModel;
  32
  33     /** Specifies whether the grid control should display a special header column.
  34
  35     <p>The default value is `FALSE`</p>
  36     */
  37     [property] boolean ShowRowHeader;
  38
  39     /** specifies the width of the row header column, if applicable.
  40
  41         <p>The width is specified in application font units - see com::sun::star::util::MeasureUnit.</p>
  42
  43         <p>The value given here is ignored if #ShowRowHeader is `FALSE`.</p>
  44     */
  45     [property] long RowHeaderWidth;
  46
  47     /** Specifies whether the grid control should display a title row.
  48
  49     <p>The default value is `TRUE`</p>
  50     */
  51     [property] boolean ShowColumnHeader;
  52
  53     /** specifies the height of the column header row, if applicable.
  54
  55         <p>The height is specified in application font units - see com::sun::star::util::MeasureUnit.</p>
  56
  57         <p>The value given here is ignored if #ShowColumnHeader is `FALSE`.</p>
  58
  59         <p>If the property is `VOID`, the grid control shall automatically determine a height which conveniently allows,
  60         according to the used font, to display one line of text.</p>
  61     */
  62     [property, maybevoid] long ColumnHeaderHeight;
  63
  64     /** Specifies the height of rows in the grid control.
  65
  66         <p>The height is specified in application font units - see com::sun::star::util::MeasureUnit.</p>
  67     */
  68     [property, maybevoid] long RowHeight;
  69
  70     /** Specifies the XGridColumnModel that is providing the column structure.
  71
  72         <p>You can implement your own instance of XGridColumnModel or use
  73         the DefaultGridColumnModel.
  74
  75         <p>The column model is in the ownership of the grid model: When you set a new column model, or dispose
  76         the grid model, then the (old) column model is disposed, too.</p>
  77
  78         <p>The default for this property is an empty instance of the DefaultGridColumnModel.</p>
  79     */
  80     [property] XGridColumnModel ColumnModel;
  81
  82     /** Specifies the XGridDataModel that is providing the hierarchical data.
  83
  84         <p>You can implement your own instance of XGridDataModel or use
  85         the DefaultGridDataModel.
  86
  87         <p>The data model is in the ownership of the grid model: When you set a new data model, or dispose
  88         the grid model, then the (old) data model is disposed, too.</p>
  89
  90         <p>The default for this property is an empty instance of the DefaultGridDataModel.</p>
  91     */
  92     [property] XGridDataModel GridDataModel;
  93
  94     /** Specifies the vertical scrollbar mode.
  95         <p>The default value is `FALSE`</p>
  96     */
  97     [property] boolean HScroll;
  98
  99     /** Specifies the horizontal scrollbar mode.
 100         <p>The default value is `FALSE`</p>
 101     */
 102     [property] boolean VScroll;
 103
 104     /** Specifies that the control can be reached with the TAB key.
 105      */
 106     [property] boolean Tabstop;
 107
 108     /** Specifies the selection mode that is enabled for this grid control.
 109         <p>The default value is com::sun::star::view::SelectionType::SINGLE</p>
 110     */
 111     [property] ::com::sun::star::view::SelectionType SelectionModel;
 112
 113     /** controls whether or not to paint horizontal and vertical lines between the grid cells.
 114
 115         @see GridLineColor
 116     */
 117     [property] boolean UseGridLines;
 118
 119     /** specifies the color to be used when drawing lines between cells
 120
 121         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 122         depending on the control's style settings.</p>
 123
 124         @see UseGridLines
 125     */
 126     [property, maybevoid] ::com::sun::star::util::Color             GridLineColor;
 127
 128     /** specifies the color to be used when drawing the background of row or column headers
 129
 130         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 131         depending on the control's style settings.</p>
 132     */
 133     [property, maybevoid] ::com::sun::star::util::Color             HeaderBackgroundColor;
 134
 135     /** specifies the color to be used when drawing the text within row or column headers
 136
 137         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 138         depending on the control's style settings.</p>
 139     */
 140     [property, maybevoid] ::com::sun::star::util::Color             HeaderTextColor;
 141
 142     /** specifies the color to be used when drawing the background of selected cells, while the control has the focus.
 143
 144         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 145         depending on the control's style settings.</p>
 146     */
 147     [property, maybevoid] ::com::sun::star::util::Color             ActiveSelectionBackgroundColor;
 148
 149     /** specifies the color to be used when drawing the background of selected cells, while the control does not have
 150         the focus.
 151
 152         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 153         depending on the control's style settings.</p>
 154     */
 155     [property, maybevoid] ::com::sun::star::util::Color             InactiveSelectionBackgroundColor;
 156
 157     /** specifies the color to be used when drawing the text of selected cells, while the control has the focus.
 158
 159         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 160         depending on the control's style settings.</p>
 161     */
 162     [property, maybevoid] ::com::sun::star::util::Color             ActiveSelectionTextColor;
 163
 164     /** specifies the color to be used when drawing the text of selected cells, while the control does not have
 165         the focus.
 166
 167         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 168         depending on the control's style settings.</p>
 169     */
 170     [property, maybevoid] ::com::sun::star::util::Color             InactiveSelectionTextColor;
 171
 172     /** specifies the colors to be used as background for data rows.
 173
 174         <p>If this sequence is non-empty, the data rows will be rendered with alternating background colors: Assuming
 175         the sequence has <code>n</code> elements, each row will use the background color as specified by its number's
 176         remainder modulo <code>n</code>.</p>
 177
 178         <p>If this sequence is empty, all rows will use the same background color as the control as whole.</p>
 179
 180         <p>If this property has a value of `VOID`, rows will be painted
 181         in alternating background colors, every second row having a background color derived from the control's
 182         selection color.</p>
 183     */
 184     [property, maybevoid] sequence< ::com::sun::star::util::Color > RowBackgroundColors;
 185
 186     /** specifies the vertical alignment of the content in the control.
 187      */
 188     [property] com::sun::star::style::VerticalAlignment VerticalAlign;
 189
 190     /** specifies the font attributes of the text in the control.
 191      */
 192     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 193
 194     /** specifies the color to be used when drawing cell texts
 195
 196         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 197         depending on the control's style settings.</p>
 198     */
 199     [property, maybevoid] ::com::sun::star::util::Color             TextColor;
 200
 201     /** specifies the color to be used when drawing text lines (underlining and strikethrough)
 202
 203         <p>If this property has a value of `VOID`, the grid control renderer will use some default color,
 204         depending on the control's style settings.</p>
 205      */
 206     [property, maybevoid] com::sun::star::util::Color               TextLineColor;
 207
 208     /** specifies the com::sun::star::text::FontEmphasis
 209         value of the text in the control.
 210      */
 211     [property] short FontEmphasisMark;
 212
 213     /** specifies the com::sun::star::text::FontRelief
 214         value of the text in the control.
 215      */
 216     [property] short FontRelief;
 217
 218     /** specifies the help text of the control.
 219      */
 220     [property] string HelpText;
 221
 222     /** specifies the help URL of the control.
 223      */
 224     [property] string HelpURL;
 225
 226 };
 227
 228
 229 }; }; }; }; };
 230
 231 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */