A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window. More...

#include <workbook_view.hpp>

Public Attributes
bool	auto_filter_date_grouping = true
	If true, dates will be grouped when presenting the user with filtering options. More...

bool	minimized = false
	If true, the view will be minimized. More...

bool	show_horizontal_scroll = true
	If true, the horizontal scroll bar will be displayed. More...

bool	show_sheet_tabs = true
	If true, the sheet tabs will be displayed. More...

bool	show_vertical_scroll = true
	If true, the vertical scroll bar will be displayed. More...

bool	visible = true
	If true, the workbook window will be visible. More...

optional< std::size_t >	active_tab
	The optional index to the active sheet in this view. More...

optional< std::size_t >	first_sheet
	The optional index to the first sheet in this view. More...

optional< std::size_t >	tab_ratio
	The optional ratio between the tabs bar and the horizontal scroll bar. More...

optional< std::size_t >	window_width
	The width of the workbook window in twips. More...

optional< std::size_t >	window_height
	The height of the workbook window in twips. More...

optional< int >	x_window
	The distance of the workbook window from the left side of the screen in twips. More...

optional< int >	y_window
	The distance of the workbook window from the top of the screen in twips. More...

Detailed Description

A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window.

Member Data Documentation

◆ active_tab

optional<std::size_t> xlnt::workbook_view::active_tab

The optional index to the active sheet in this view.

◆ auto_filter_date_grouping

bool xlnt::workbook_view::auto_filter_date_grouping = true

If true, dates will be grouped when presenting the user with filtering options.

◆ first_sheet

optional<std::size_t> xlnt::workbook_view::first_sheet

The optional index to the first sheet in this view.

◆ minimized

bool xlnt::workbook_view::minimized = false

If true, the view will be minimized.

◆ show_horizontal_scroll

bool xlnt::workbook_view::show_horizontal_scroll = true

If true, the horizontal scroll bar will be displayed.

◆ show_sheet_tabs

bool xlnt::workbook_view::show_sheet_tabs = true

If true, the sheet tabs will be displayed.

◆ show_vertical_scroll

bool xlnt::workbook_view::show_vertical_scroll = true

If true, the vertical scroll bar will be displayed.

◆ tab_ratio

optional<std::size_t> xlnt::workbook_view::tab_ratio

The optional ratio between the tabs bar and the horizontal scroll bar.

◆ visible

bool xlnt::workbook_view::visible = true

If true, the workbook window will be visible.

◆ window_height

optional<std::size_t> xlnt::workbook_view::window_height

The height of the workbook window in twips.

◆ window_width

optional<std::size_t> xlnt::workbook_view::window_width

The width of the workbook window in twips.

◆ x_window

optional<int> xlnt::workbook_view::x_window

The distance of the workbook window from the left side of the screen in twips.

◆ y_window

optional<int> xlnt::workbook_view::y_window

The distance of the workbook window from the top of the screen in twips.

The documentation for this class was generated from the following file:

xlnt/workbook/workbook_view.hpp

Public Attributes