xlnt
Public Member Functions | Public Attributes | List of all members
xlnt::pane Struct Reference

A fixed portion of a worksheet. More...

#include <pane.hpp>

Public Member Functions

bool operator== (const pane &rhs) const
 Returns true if this pane is equal to rhs based on its top-left cell, state, active pane, and x/y split location. More...
 

Public Attributes

optional< cell_referencetop_left_cell
 The optional top left cell More...
 
pane_state state = pane_state::split
 The state of the pane More...
 
pane_corner active_pane = pane_corner::top_left
 The pane which contains the active cell More...
 
row_t y_split = 1
 The row where the split should take place More...
 
column_t x_split = 1
 The column where the split should take place More...
 

Detailed Description

A fixed portion of a worksheet.

Member Function Documentation

◆ operator==()

bool xlnt::pane::operator== ( const pane rhs) const
inline

Returns true if this pane is equal to rhs based on its top-left cell, state, active pane, and x/y split location.

Member Data Documentation

◆ active_pane

pane_corner xlnt::pane::active_pane = pane_corner::top_left

The pane which contains the active cell

◆ state

pane_state xlnt::pane::state = pane_state::split

The state of the pane

◆ top_left_cell

optional<cell_reference> xlnt::pane::top_left_cell

The optional top left cell

◆ x_split

column_t xlnt::pane::x_split = 1

The column where the split should take place

◆ y_split

row_t xlnt::pane::y_split = 1

The row where the split should take place


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