GridTableViewOptions Class

Member Function Documentation

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

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

bool GridTableViewOptions::columnAutoWidth() const

Returns true if the auto column width feature 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::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().

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 setFixedSeparatorColor(), fixedSeparatorWidth(), and fixedSeparatorPen().

QPen GridTableViewOptions::fixedSeparatorPen() const

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

See also setFixedSeparatorPen(), fixedSeparatorColor(), and 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 setFixedSeparatorWidth(), fixedSeparatorColor(), and fixedSeparatorPen().

bool GridTableViewOptions::frozenPlaceQuickSelection() const

Returns the visibility of quick button for selection of place for freeze. By default it is false.

See also setFrozenPlaceQuickSelection().

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::isRowFrozenButtonVisible() const

Returns the visibility of buttons that allow to freeze the row. By default it is false.

bool GridTableViewOptions::rowSizingEnabled() const

See also setRowSizingEnabled.

bool GridTableViewOptions::rowsQuickSelection() const

Returns true if a quick rows quick selection feature is enabled. Otherwise returns false. By default it is false.

See also setRowsQuickSelection().

void GridTableViewOptions::setColumnAutoWidth(bool autoWidth)

Sets the column's auto width feature. If autoWidth is a true then the columns will be adjasted to the entire with of the view. For this, all the columns will be stretched or narrowed proportionally. But at the same time takes into account the settings of maximum/minimum column's width. The option has effect if the type of view orientation is Qt::Vertical only. for Qt::Horizontal orientation of the view it is not used.

See also columnAutoWidth().

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::setColumnsHeader(bool columnsHeader)

Enables or disables the display of grid columns depending on columnsHeader.

See also columnsHeader().

void GridTableViewOptions::setColumnsQuickCustomization(bool quickCustomization)

Sets the visibility to quickCustomization 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(int 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::setFixedSeparatorColor(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 fixedSeparatorColor(), setFixedSeparatorWidth(), and setFixedSeparatorPen().

void GridTableViewOptions::setFixedSeparatorPen(const QPen &pen)

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

See also fixedSeparatorPen(), setFixedSeparatorColor(), and setFixedSeparatorWidth().

void GridTableViewOptions::setFixedSeparatorWidth(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 fixedSeparatorWidth(), setFixedSeparatorColor(), and setFixedSeparatorPen().

void GridTableViewOptions::setFrozenPlaceQuickSelection(bool visible)

Sets the visibility of quick button for selection of place for freeze to visible.

See also frozenPlaceQuickSelection().

void GridTableViewOptions::setRowFrozenButtonVisible(bool visible)

Sets the visibility of button at the left of row to visible that allow to freeze the row.

See also isRowFrozenButtonVisible().

void GridTableViewOptions::setRowSizingEnabled(bool enabled)

Allows to enable the end-user to resize the rows by means of a special splitter bar at the bottom of the row. To return all the rows sizes to their original state, press F5 or call GridViewBase::bestFit() method. The parameter enabled - enables or disables the setting. By default it is disabled.

See also rowSizingEnabled() and GridViewBase::bestFit().

void GridTableViewOptions::setRowsQuickSelection(bool quickSelection)

Enables a quick rows selection feature. If quickSelection is true grid will show a special check boxes for quick rows selection. Check boxes are located opposite each row at the left. In addition to the left of the column headers there is a separate check box that is make possible to select all or de-select all rows. For single row selection policy the radio box is used instead of check box.

See also rowsQuickSelection().

void GridTableViewOptions::setShowResizeContent(bool show)

The option allows you to set whether or not to display the contents of the grid during column resize. Parameter show can take a boolean value - "true" or "false". By the default the option is enabled.

See also showResizeContent().

bool GridTableViewOptions::showResizeContent() const

See also setShowResizeContent.