GridTableViewOptions Class Reference

(Qtitan::GridTableViewOptions)

The GridTableViewOptions class is used for configuring the behavior and display of different parts of the grid table view. More...

Inherits GridViewOptions.

Inherited by Qtitan::GridBandedTableViewOptions.

Public Functions

bool alternatingRowColors () const
const QFont & cellFont () const
const QPalette & cellPalette () const
bool columnAutoWidth () const
bool columnHeaderHints () const
int columnHeight () const
bool columnsHeader () const
bool columnsQuickCustomization () const
int columnsQuickCustomizationMaxDropDownCount () const
int dataRowHeight () const
bool fastScrollEffect () const
const QColor & fixedSeparatorColor () const
void fixedSeparatorColor ( const QColor & color )
int fixedSeparatorWidth () const
void fixedSeparatorWidth ( int width )
const QBrush & gridLineBrush () const
const QColor & gridLineColor () const
int gridLineWidth () const
GridLinesStyle gridLines () const
const QPalette & groupPalette ( int depth )
int groupRowHeight () const
GridGroupRowStyle groupRowStyle () const
bool isColumnHidingEnabled () const
bool isColumnHidingOnGroupingEnabled () const
bool isColumnHorSizingEnabled () const
bool isColumnMovingEnabled () const
bool isFocusFollowsMouse () const
bool isFooterSummaryVisible () const
bool isGroupSummaryVisible () const
bool isGroupingEnabled () const
bool isMainMenuDisabled () const
bool isSummaryMenuDisabled () const
int newRowFlashInterval () const
RowHighlightEffect newRowHighlightEffect () const
double newRowOpacity () const
GridNewRowPlace newRowPlace () const
const QString & newRowText () const
bool rowAutoHeight () const
GridSelectionPolicy selectionPolicy () const
void setAlternatingRowColors ( bool alternating )
void setCellFont ( const QFont & f )
void setCellPalette ( const QPalette & palette )
void setColumnAutoWidth ( bool autoWidth )
void setColumnHeight ( int height )
void setColumnHidingEnabled ( bool enabled )
void setColumnHidingOnGroupingEnabled ( bool enabled )
void setColumnHorSizingEnabled ( bool enabled )
void setColumnMovingEnabled ( bool enabled )
void setColumnsHeader ( bool columnsHeader )
void setColumnsQuickCustomization ( bool quickCustomization )
void setColumnsQuickCustomizationMaxDropDownCount ( bool dropDownCount )
void setDataRowHeight ( int height )
void setFastScrollEffect ( bool value )
void setFocusFollowsMouse ( bool enabled )
void setFooterSummaryVisible ( bool visible )
void setGridLineBrush ( const QBrush & brush )
void setGridLineColor ( const QColor & color )
void setGridLineWidth ( int width )
void setGridLines ( GridLinesStyle lines )
void setGroupPalette ( int depth, const QPalette & palette )
void setGroupRowHeight ( int height )
void setGroupRowStyle ( GridGroupRowStyle style )
void setGroupSummaryVisible ( bool visible )
void setGroupingEnabled ( bool enabled )
void setMainMenuDisabled ( bool disabled )
void setNewRowFlashInterval ( int interval )
void setNewRowHighlightEffect ( RowHighlightEffect effect )
void setNewRowOpacity ( double opcity )
void setNewRowPlace ( GridNewRowPlace place )
void setNewRowText ( const QString & text )
void setRowAutoHeight ( bool autoHeight )
void setSelectionPolicy ( GridSelectionPolicy policy )
void setSummaryMenuDisabled ( bool disabled )
void setcolumnHeaderHints ( bool headerHints )
void setshowFocusDecoration ( bool value )
bool showFocusDecoration () const

Protected Functions

GridTableViewOptions ( GridTableView * view )

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 signal inherited from QObject
  • 1 public variable inherited from QObject
  • 4 static public members inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The GridTableViewOptions class is used for configuring the behavior and display of different parts of the grid table view.

Member Function Documentation

GridTableViewOptions::GridTableViewOptions ( GridTableView * view ) [protected]

Constructor of the GridTableViewOptions class. The class is constructed automatically when the table view is created.

bool GridTableViewOptions::alternatingRowColors () const

Returns the value of the flag that defines whether alternating colors should be used for drawing grid cells. If the returned value is true, the item background will be drawn using QPalette::Base and QPalette::AlternateBase; otherwise the background will be drawn using the QPalette::Base color. By default, this property is true.

See also setAlternatingRowColors().

const QFont & GridTableViewOptions::cellFont () const

Returns the font that will be used for rendering text information in the grid cell.

See also setCellFont().

const QPalette & GridTableViewOptions::cellPalette () const

Returns the value of the palette that is used for rendering the grid cell.

See also setCellPalette().

bool GridTableViewOptions::columnAutoWidth () const

Returns true if the column width autoselection mode is on. The column width is calculated automatically and depends on the view width - if possible, all columns shoud fit within the view.

See also setColumnAutoWidth().

bool GridTableViewOptions::columnHeaderHints () const

Returns "true" if the component is configured to show a popup tip over the column header if the column does not completely fit on the screen and the user cannot read the column header.

int GridTableViewOptions::columnHeight () const

Returns the default value of the grid height. If the returned value is -1, the height will be calculated automatically and will depend on the size of the column font used for displaying text information.

See also setColumnHeight().

bool GridTableViewOptions::columnsHeader () const

Returns "true" if grid columns are displayed. Otherwise, "false" is returned.

See also setColumnsHeader().

bool GridTableViewOptions::columnsQuickCustomization () const

Returns the visibility value of a small button to the left of the columns that forms a margin on the left side of the view. If the button is shown, the funtion returns "true" (default value).

See also setColumnsQuickCustomization().

int GridTableViewOptions::columnsQuickCustomizationMaxDropDownCount () const

Returns the number of items in the popup window that is shown when the quick customization button (a small icon to the left of the columns) is clicked and before the vertical scrollbar is shown.

See also setColumnsQuickCustomizationMaxDropDownCount().

int GridTableViewOptions::dataRowHeight () const

Returns the height of the row where information is displayed. If the returned value is -1, the height of the row will depend on the settings of the font used in the cells of the row. If the autoHeight mode is on, this value is only used if it is impossible to automatically determine the row height for optimal data output.

See also setDataRowHeight() and groupRowHeight().

bool GridTableViewOptions::fastScrollEffect () const

See also setFastScrollEffect().

const QColor & GridTableViewOptions::fixedSeparatorColor () const

Returns the color of the vertical line used for delimiting fixed cells to the left or to the right of the non-fixed cells.

See also fixedSeparatorWidth().

void GridTableViewOptions::fixedSeparatorColor ( const QColor & color )

Sets the color of the vertical line used for delimiting fixed cells to the left or to the right of the non-fixed cells.

See also fixedSeparatorWidth().

int GridTableViewOptions::fixedSeparatorWidth () const

Returns the width of the vertical line used for delimiting fixed cells to the left or to the right of the non-fixed cells.

See also fixedSeparatorColor().

void GridTableViewOptions::fixedSeparatorWidth ( int width )

Sets the width of the vertical line used for delimiting fixed cells to the left or to the right of the non-fixed cells.

See also fixedSeparatorColor().

const QBrush & GridTableViewOptions::gridLineBrush () const

Returns the value of the brush used for drawing lines delimiting grid cells.

See also setGridLineBrush().

const QColor & GridTableViewOptions::gridLineColor () const

Returns the color of the line delimiting grid cells.

See also setGridLineColor().

int GridTableViewOptions::gridLineWidth () const

Returns the width of the lines delimiting grid cells.

See also setGridLineWidth().

GridLinesStyle GridTableViewOptions::gridLines () const

Returns the style of the grid cell delimiting lines. Possible variants: show only horizontal, only vertical, horizontal and vertical, do not show lines.

See also setGridLines().

const QPalette & GridTableViewOptions::groupPalette ( int depth )

Returns the palette used for displaying the visual elements of a row representing a group. For instance, margins, background, font color. By default, the grid widget palette is returned.

See also setGroupPalette().

int GridTableViewOptions::groupRowHeight () const

Returns the height of group rows. If the returned value is -1, the height of the row will depend on the settings of the font used in the cells of the row. The default value is -1.

See also setGroupRowHeight() and dataRowHeight().

GridGroupRowStyle GridTableViewOptions::groupRowStyle () const

Returns the way of grouping the grid rows.

See also setGroupRowStyle() and Qtitan::GridGroupRowStyle.

bool GridTableViewOptions::isColumnHidingEnabled () const

Returns "true" if the user can hide columns by dragging them outside the grid view. Returns "true" by default.

bool GridTableViewOptions::isColumnHidingOnGroupingEnabled () const

Returns the status of the grid column hiding function after the column was dragged onto the group panel and grouping was performed.

bool GridTableViewOptions::isColumnHorSizingEnabled () const

Returns "true" if the user can change the column width. The flag is applied to all columns at once.

bool GridTableViewOptions::isColumnMovingEnabled () const

Returns "true" if the user can change the position of columns by dragging them. This flag is applied to all columns at once.

bool GridTableViewOptions::isFocusFollowsMouse () const

Returns a flag that the focus of cells or rows of the grid will follow the mouse moves over the grid.

bool GridTableViewOptions::isFooterSummaryVisible () const

Returns the visibility of the panel to display the summaries at the footer of the grid.

bool GridTableViewOptions::isGroupSummaryVisible () const

Returns the visibility of a special panel to display the summaries, which is located at the bottom each group of rows.

bool GridTableViewOptions::isGroupingEnabled () const

Returns "true" if the user can group rows by a column by dragging the column onto the group panel. This flag is applied to all columns at once.

bool GridTableViewOptions::isMainMenuDisabled () const

Returns the accessibility of the grid main context menu which popup on the right mouse click.

bool GridTableViewOptions::isSummaryMenuDisabled () const

Returns the accessibility of the grid summary context menu which popup on the right mouse click on the summary group or footer panel.

int GridTableViewOptions::newRowFlashInterval () const

Returns the flash interval row that is able to insert.

See also setNewRowFlashInterval().

RowHighlightEffect GridTableViewOptions::newRowHighlightEffect () const

Returns effect highlighting row in a state of inserting into grid.

See also setNewRowHighlightEffect().

double GridTableViewOptions::newRowOpacity () const

Returns the value of opacity for the row while it in a state of inserting into grid.

See also setNewRowOpacity().

GridNewRowPlace GridTableViewOptions::newRowPlace () const

Returns the location of a special line for creating and editing the new row of the grid.

See also setNewRowPlace().

const QString & GridTableViewOptions::newRowText () const

Returns the text that is typed on a special line for creating and editing the new row of the grid.

See also setNewRowText().

bool GridTableViewOptions::rowAutoHeight () const

See also setRowAutoHeight().

GridSelectionPolicy GridTableViewOptions::selectionPolicy () const

Returns the rows/cells selection mode.

See also setSelectionPolicy() and Qtitan::GridSelectionPolicy.

void GridTableViewOptions::setAlternatingRowColors ( bool alternating )

Sets the flag indicating that alternating colors should be used for drawing grid cells. If the set value is "true", the item background will be drawn using QPalette::Base and QPalette::AlternateBase; otherwise the background will be drawn using the QPalette::Base color. By default, this property is set to "false".

See also alternatingRowColors().

void GridTableViewOptions::setCellFont ( const QFont & f )

Sets the font to be used for rendering text in the grid cell.

See also cellFont().

void GridTableViewOptions::setCellPalette ( const QPalette & palette )

Sets the value of the palette that is used for rendering the grid cell.

See also cellPalette().

void GridTableViewOptions::setColumnAutoWidth ( bool autoWidth )

Sets the column width autoselection mode.

See also columnAutoWidth().

void GridTableViewOptions::setColumnHeight ( int height )

Sets the default height of grid columns. If the passed value is -1, the height will be automatically calculated based on the column font used for displaying text information.

See also columnHeight().

void GridTableViewOptions::setColumnHidingEnabled ( bool enabled )

Enables or disables the user's ability to hide columns by dragging them outside of the grid view.

See also isColumnHidingEnabled().

void GridTableViewOptions::setColumnHidingOnGroupingEnabled ( bool enabled )

Enables or disables the grid column hiding function after the column was dragged onto the group panel and grouping was performed.

See also isColumnHidingOnGroupingEnabled().

void GridTableViewOptions::setColumnHorSizingEnabled ( bool enabled )

Enables or disables the user's ability to change the column width. This flag is applied to all columns at once. If you need to prohibit size changes for one column only, you need to change the corresponding property of this specific column - GridTableColumn::setHorSizingEnabled() - and leave the global flag set to "true".

See also isColumnHorSizingEnabled().

void GridTableViewOptions::setColumnMovingEnabled ( bool enabled )

Enables or disables the user's ability to change column positions by dragging. This flag is applied to all columns at once. If you need to prohibit dragging for one column only, you need to change the corresponding property of this specific column - GridTableColumn::setMovingEnabled() - and leave the global flag set to "true".

See also isColumnMovingEnabled().

void GridTableViewOptions::setColumnsHeader ( bool columnsHeader )

Enables or disables the display of grid columns.

See also columnsHeader().

void GridTableViewOptions::setColumnsQuickCustomization ( bool quickCustomization )

Sets the visibility value of a small button to the left of the columns that forms a margin on the left side of the view.

See also columnsQuickCustomization().

void GridTableViewOptions::setColumnsQuickCustomizationMaxDropDownCount ( bool dropDownCount )

Sets the number of items in the popup window that is shown when the quick customization button (a small icon to the left of the columns) is clicked and before the vertical scrollbar is shown.

See also columnsQuickCustomizationMaxDropDownCount().

void GridTableViewOptions::setDataRowHeight ( int height )

Returns the height of the row where information is displayed. If the returned value is -1, the height of the row will depend on the settings of the font used in the cells of the row. If the autoHeight mode is on, this value is only used if it is impossible to automatically determine the row height for optimal data output.

See also dataRowHeight() and setGroupRowHeight().

void GridTableViewOptions::setFastScrollEffect ( bool value )

See also fastScrollEffect().

void GridTableViewOptions::setFocusFollowsMouse ( bool enabled )

Defines a flag that the focus of cells or rows of the grid will follow the mouse moves over the grid.

See also isFocusFollowsMouse().

void GridTableViewOptions::setFooterSummaryVisible ( bool visible )

Defines the visibility of the panel to display the summaries at the footer of the grid.

See also isFooterSummaryVisible().

void GridTableViewOptions::setGridLineBrush ( const QBrush & brush )

Sets the brush used for drawing lines delimiting grid cells.

See also gridLineBrush().

void GridTableViewOptions::setGridLineColor ( const QColor & color )

Sets the color of the line delimiting grid cells.

See also gridLineColor().

void GridTableViewOptions::setGridLineWidth ( int width )

Sets the width of the lines delimiting grid cells.

See also gridLineWidth().

void GridTableViewOptions::setGridLines ( GridLinesStyle lines )

Sets the style of the grid cell delimiting lines. Possible variants: show only horizontal, only vertical, horizontal and vertical, do not show lines.

See also gridLines().

void GridTableViewOptions::setGroupPalette ( int depth, const QPalette & palette )

Sets the palette used for displaying the visual elements of a row representing a group. For instance, margins, background, font color.

See also groupPalette().

void GridTableViewOptions::setGroupRowHeight ( int height )

Sets the height of group rows. If the returned value is -1, the height of the row will depend on the settings of the font used in the cells of the row.

See also groupRowHeight() and setDataRowHeight().

void GridTableViewOptions::setGroupRowStyle ( GridGroupRowStyle style )

Defines the way of grouping the grid rows.

See also groupRowStyle() and Qtitan::GridGroupRowStyle.

void GridTableViewOptions::setGroupSummaryVisible ( bool visible )

Defines the visibility of a special panel to display the summaries, which is located at the bottom each group of rows.

See also isGroupSummaryVisible().

void GridTableViewOptions::setGroupingEnabled ( bool enabled )

Enables or disables the user's ability to group rows by a column by dragging the column onto the group panel. This flag is applied to all columns at once. If you need to prohibit grouping for one column only, you need to change the corresponding property of this specific column - GridTableColumn::setGroupingEnabled(), and leave the global flag set to "true".

See also isGroupingEnabled().

void GridTableViewOptions::setMainMenuDisabled ( bool disabled )

Defines the accessibility of the grid main context menu which popup on the right mouse click.

See also isMainMenuDisabled().

void GridTableViewOptions::setNewRowFlashInterval ( int interval )

Sets the flash interval row that is able to insert.

See also newRowFlashInterval().

void GridTableViewOptions::setNewRowHighlightEffect ( RowHighlightEffect effect )

Sets effect highlighting row in a state of inserting into grid.

See also newRowHighlightEffect().

void GridTableViewOptions::setNewRowOpacity ( double opcity )

Sets the value of opacity for the row while it in a state of inserting into grid.

See also newRowOpacity().

void GridTableViewOptions::setNewRowPlace ( GridNewRowPlace place )

Sets the location of a special line for creating and editing the new row of the grid.

See also newRowPlace().

void GridTableViewOptions::setNewRowText ( const QString & text )

Sets the text that is typed on a special line for creating and editing the new row of the grid.

See also newRowText().

void GridTableViewOptions::setRowAutoHeight ( bool autoHeight )

See also rowAutoHeight().

void GridTableViewOptions::setSelectionPolicy ( GridSelectionPolicy policy )

Sets the rows/cells selection mode.

See also selectionPolicy() and Qtitan::GridSelectionPolicy.

void GridTableViewOptions::setSummaryMenuDisabled ( bool disabled )

See also isSummaryMenuDisabled().

void GridTableViewOptions::setcolumnHeaderHints ( bool headerHints )

Sets the flag that adds a popup hint over the column header if the header does not fit on the screen and the user cannot read the column header.

See also columnHeaderHints().

void GridTableViewOptions::setshowFocusDecoration ( bool value )

Sets a flag that you want to use focus decoration adopted for the current operating system or for the current style.

See also showFocusDecoration().

bool GridTableViewOptions::showFocusDecoration () const

Returns a flag that you want to use focus decoration adopted for the current operating system or for the current style.