Orcus
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_sheet_view Class Referenceabstract

#include <import_interface_view.hpp>

Public Member Functions

virtual void set_sheet_active ()=0
 
virtual void set_split_pane (double hor_split, double ver_split, const address_t &top_left_cell, sheet_pane_t active_pane)=0
 
virtual void set_frozen_pane (col_t visible_columns, row_t visible_rows, const address_t &top_left_cell, sheet_pane_t active_pane)=0
 
virtual void set_selected_range (sheet_pane_t pane, range_t range)=0
 

Detailed Description

Interface for importing view properties. This interface may be obtained from the import_sheet interface.

Member Function Documentation

◆ set_frozen_pane()

virtual void orcus::spreadsheet::iface::import_sheet_view::set_frozen_pane ( col_t  visible_columns,
row_t  visible_rows,
const address_t top_left_cell,
sheet_pane_t  active_pane 
)
pure virtual

Set the state of frozen view in the current sheet.

Parameters
visible_columnsnumber of visible columns in the left pane.
visible_rowsnumber of visible rows in the top pane.
top_left_cellthe top left visible cell in the bottom right pane.
active_paneactive pane in this sheet.

◆ set_selected_range()

virtual void orcus::spreadsheet::iface::import_sheet_view::set_selected_range ( sheet_pane_t  pane,
range_t  range 
)
pure virtual

Set the selected cursor range in a specified sheet pane.

Parameters
panesheet pane associated with the selection. The top-left pane is used for a non-split sheet view.
rangeselected cursor range. The range will be 1 column by 1 row when the cursor is on a single cell only.

◆ set_sheet_active()

virtual void orcus::spreadsheet::iface::import_sheet_view::set_sheet_active ( )
pure virtual

Set the current sheet as the active sheet.

◆ set_split_pane()

virtual void orcus::spreadsheet::iface::import_sheet_view::set_split_pane ( double  hor_split,
double  ver_split,
const address_t top_left_cell,
sheet_pane_t  active_pane 
)
pure virtual

Set the information about split view in the current sheet.

Parameters
hor_splithorizontal position of the split in 1/20th of a point, or 0 if none. "Horizontal" in this case indicates the column direction.
ver_splitvertical position of the split in 1/20th of a point, or 0 if none. "Vertical" in this case indicates the row direction.
top_left_cellthe top left visible cell in the bottom right pane.
active_paneactive pane in this sheet.