Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt :: grid ::

service UnoControlGridModel
Description
specifies the standard model of a UnoControlGrid control.
Since
OOo 3.3

Included Services - Summary
::com::sun::star::awt::UnoControlModel

specifies the standard model of an ::com::sun::star::awt::UnoControl.

Properties' Summary
boolean
ShowRowHeader
Specifies whether the grid control should display a special header column.  
long
RowHeaderWidth
specifies the width of the row header column, if applicable.  
boolean
ShowColumnHeader
Specifies whether the grid control should display a title row.  
[ maybevoid ] long
ColumnHeaderHeight
specifies the height of the column header row, if applicable.  
[ maybevoid ] long
RowHeight
Specifies the height of rows in the grid control.  
XGridColumnModel
ColumnModel
Specifies the XGridColumnModel that is providing the column structure.  
XGridDataModel
GridDataModel
Specifies the XGridDataModel that is providing the hierarchical data.  
boolean
HScroll
Specifies the vertical scrollbar mode.  
boolean
VScroll
Specifies the horizontal scrollbar mode.  
boolean
Tabstop
Specifies that the control can be reached with the TAB key.  
::com::sun::star::view::SelectionType
SelectionModel
Specifies the selection mode that is enabled for this grid control.  
boolean
UseGridLines
controls whether or not to paint horizontal and vertical lines between the grid cells.  
[ maybevoid ] ::com::sun::star::util::Color
GridLineColor
specifies the color to be used when drawing lines between cells  
[ maybevoid ] ::com::sun::star::util::Color
HeaderBackgroundColor
specifies the color to be used when drawing the background of row or column headers  
[ maybevoid ] ::com::sun::star::util::Color
HeaderTextColor
specifies the color to be used when drawing the text within row or column headers  
[ maybevoid ] ::com::sun::star::util::Color
ActiveSelectionBackgroundColor
specifies the color to be used when drawing the background of selected cells, while the control has the focus.  
[ maybevoid ] ::com::sun::star::util::Color
InactiveSelectionBackgroundColor
specifies the color to be used when drawing the background of selected cells, while the control does not have the focus.  
[ maybevoid ] ::com::sun::star::util::Color
ActiveSelectionTextColor
specifies the color to be used when drawing the text of selected cells, while the control has the focus.  
[ maybevoid ] ::com::sun::star::util::Color
InactiveSelectionTextColor
specifies the color to be used when drawing the text of selected cells, while the control does not have the focus.  
[ maybevoid ] sequence< ::com::sun::star::util::Color >
RowBackgroundColors
specifies the colors to be used as background for data rows.  
::com::sun::star::style::VerticalAlignment
VerticalAlign
specifies the vertical alignment of the content in the control.  
::com::sun::star::awt::FontDescriptor
FontDescriptor
specifies the font attributes of the text in the control.  
[ maybevoid ] ::com::sun::star::util::Color
TextColor
specifies the color to be used when drawing cell texts  
[ maybevoid ] ::com::sun::star::util::Color
TextLineColor
specifies the color to be used when drawing text lines (underlining and strikethrough)  
short
FontEmphasisMark
specifies the ::com::sun::star::text::FontEmphasis value of the text in the control.  
short
FontRelief
specifies the ::com::sun::star::text::FontRelief value of the text in the control.  
string
HelpText
specifies the help text of the control.  
string
HelpURL
specifies the help URL of the control.  
Included Services - Details
::com::sun::star::awt::UnoControlModel
Description
specifies the standard model of an ::com::sun::star::awt::UnoControl.
Properties' Details
ShowRowHeader
boolean ShowRowHeader;
Description
Specifies whether the grid control should display a special header column.

The default value is false

RowHeaderWidth
long RowHeaderWidth;
Description
specifies the width of the row header column, if applicable.

The width is specified in application font units - see ::com::sun::star::util::MeasureUnit.

The value given here is ignored if ShowRowHeader is false.

ShowColumnHeader
boolean ShowColumnHeader;
Description
Specifies whether the grid control should display a title row.

The default value is true

ColumnHeaderHeight
[ maybevoid ] long ColumnHeaderHeight;
Description
specifies the height of the column header row, if applicable.

The height is specified in application font units - see ::com::sun::star::util::MeasureUnit.

The value given here is ignored if ShowColumnHeader is false.

If the property is void, the grid control shall automatically determine a height which conveniently allows, according to the used font, to display one line of text.

RowHeight
[ maybevoid ] long RowHeight;
Description
Specifies the height of rows in the grid control.

The height is specified in application font units - see ::com::sun::star::util::MeasureUnit.

ColumnModel
XGridColumnModel ColumnModel;
Description
Specifies the XGridColumnModel that is providing the column structure.

You can implement your own instance of XGridColumnModel or use the DefaultGridColumnModel.

The column model is in the ownership of the grid model: When you set a new column model, or dispose the grid model, then the (old) column model is disposed, too.

The default for this property is an empty instance of the DefaultGridColumnModel.

GridDataModel
XGridDataModel GridDataModel;
Description
Specifies the XGridDataModel that is providing the hierarchical data.

You can implement your own instance of XGridDataModel or use the DefaultGridDataModel.

The data model is in the ownership of the grid model: When you set a new data model, or dispose the grid model, then the (old) data model is disposed, too.

The default for this property is an empty instance of the DefaultGridDataModel.

HScroll
boolean HScroll;
Description
Specifies the vertical scrollbar mode.

The default value is false

VScroll
boolean VScroll;
Description
Specifies the horizontal scrollbar mode.

The default value is false

Tabstop
boolean Tabstop;
Description
Specifies that the control can be reached with the TAB key.
SelectionModel
::com::sun::star::view::SelectionType SelectionModel;
Description
Specifies the selection mode that is enabled for this grid control.

The default value is ::com::sun::star::view::SelectionType::SINGLE

UseGridLines
boolean UseGridLines;
Description
controls whether or not to paint horizontal and vertical lines between the grid cells.
See also
GridLineColor
GridLineColor
[ maybevoid ] ::com::sun::star::util::Color GridLineColor;
Description
specifies the color to be used when drawing lines between cells

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

See also
UseGridLines
HeaderBackgroundColor
[ maybevoid ] ::com::sun::star::util::Color HeaderBackgroundColor;
Description
specifies the color to be used when drawing the background of row or column headers

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

HeaderTextColor
[ maybevoid ] ::com::sun::star::util::Color HeaderTextColor;
Description
specifies the color to be used when drawing the text within row or column headers

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

ActiveSelectionBackgroundColor
[ maybevoid ] ::com::sun::star::util::Color ActiveSelectionBackgroundColor;
Description
specifies the color to be used when drawing the background of selected cells, while the control has the focus.

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

InactiveSelectionBackgroundColor
[ maybevoid ] ::com::sun::star::util::Color InactiveSelectionBackgroundColor;
Description
specifies the color to be used when drawing the background of selected cells, while the control does not have the focus.

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

ActiveSelectionTextColor
[ maybevoid ] ::com::sun::star::util::Color ActiveSelectionTextColor;
Description
specifies the color to be used when drawing the text of selected cells, while the control has the focus.

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

InactiveSelectionTextColor
[ maybevoid ] ::com::sun::star::util::Color InactiveSelectionTextColor;
Description
specifies the color to be used when drawing the text of selected cells, while the control does not have the focus.

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

RowBackgroundColors
[ maybevoid ] sequence< ::com::sun::star::util::Color > RowBackgroundColors;
Description
specifies the colors to be used as background for data rows.

If this sequence is non-empty, the data rows will be rendered with alternating background colors: Assuming the sequence has n elements, each row will use the background color as specified by its number's remainder modulo n.

If this sequence is empty, all rows will use the same background color as the control as whole.

If this property has a value of void, rows will be painted in alternating background colors, every second row having a background color derived from the control's selection color.

VerticalAlign
::com::sun::star::style::VerticalAlignment VerticalAlign;
Description
specifies the vertical alignment of the content in the control.
FontDescriptor
::com::sun::star::awt::FontDescriptor FontDescriptor;
Description
specifies the font attributes of the text in the control.
TextColor
[ maybevoid ] ::com::sun::star::util::Color TextColor;
Description
specifies the color to be used when drawing cell texts

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

TextLineColor
[ maybevoid ] ::com::sun::star::util::Color TextLineColor;
Description
specifies the color to be used when drawing text lines (underlining and strikethrough)

If this property has a value of void, the grid control renderer will use some default color, depending on the control's style settings.

FontEmphasisMark
short FontEmphasisMark;
Description
specifies the ::com::sun::star::text::FontEmphasis value of the text in the control.
FontRelief
short FontRelief;
Description
specifies the ::com::sun::star::text::FontRelief value of the text in the control.
HelpText
string HelpText;
Description
specifies the help text of the control.
HelpURL
string HelpURL;
Description
specifies the help URL of the control.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.