xlnt::sheet_view Class Reference

Describes a view of a worksheet. Worksheets can have multiple views which show the data differently. More...

#include <sheet_view.hpp>

Public Member Functions
void	id (std::size_t new_id)
	Sets the ID of this view to new_id. More...
std::size_t	id () const
	Returns the ID of this view. More...
bool	has_pane () const
	Returns true if this view has a pane defined. More...
struct pane &	pane ()
	Returns a reference to this view's pane. More...
const struct pane &	pane () const
	Returns a reference to this view's pane. More...
void	clear_pane ()
	Removes the defined pane from this view. More...
void	pane (const struct pane &new_pane)
	Sets the pane of this view to new_pane. More...
bool	has_selections () const
	Returns true if this view has any selections. More...
void	add_selection (const class selection &new_selection)
	Adds the given selection to the collection of selections. More...
void	clear_selections ()
	Removes all selections. More...
std::vector< xlnt::selection >	selections () const
	Returns the collection of selections as a vector. More...
class xlnt::selection &	selection (std::size_t index)
	Returns the selection at the given index. More...
void	show_grid_lines (bool show)
	If show is true, grid lines will be shown for sheets using this view. More...
bool	show_grid_lines () const
	Returns true if grid lines will be shown for sheets using this view. More...
void	default_grid_color (bool is_default)
	If is_default is true, the default grid color will be used. More...
bool	default_grid_color () const
	Returns true if the default grid color will be used. More...
void	type (sheet_view_type new_type)
	Sets the type of this view. More...
sheet_view_type	type () const
	Returns the type of this view. More...
bool	has_top_left_cell () const
	has a top left cell? More...
void	top_left_cell (const cell_reference &ref)
	Sets the top left cell of this view. More...
cell_reference	top_left_cell () const
	Returns the top left cell of this view. More...
bool	operator== (const sheet_view &rhs) const
	Returns true if this view is equal to rhs based on its id, grid lines setting, default grid color, pane, and selections. More...
bool	operator!= (const sheet_view &rhs) const
	Returns the negation of the equality operator. More...

Detailed Description

Describes a view of a worksheet. Worksheets can have multiple views which show the data differently.

Member Function Documentation

add_selection()

void xlnt::sheet_view::add_selection ( const class selection &  new_selection )

inline

Adds the given selection to the collection of selections.

clear_pane()

void xlnt::sheet_view::clear_pane ( )

inline

Removes the defined pane from this view.

clear_selections()

void xlnt::sheet_view::clear_selections ( )

inline

Removes all selections.

default_grid_color() [1/2]

void xlnt::sheet_view::default_grid_color ( bool  is_default )

inline

If is_default is true, the default grid color will be used.

default_grid_color() [2/2]

bool xlnt::sheet_view::default_grid_color ( ) const

inline

Returns true if the default grid color will be used.

has_pane()

bool xlnt::sheet_view::has_pane ( ) const

inline

Returns true if this view has a pane defined.

has_selections()

bool xlnt::sheet_view::has_selections ( ) const

inline

Returns true if this view has any selections.

has_top_left_cell()

bool xlnt::sheet_view::has_top_left_cell ( ) const

inline

has a top left cell?

id() [1/2]

void xlnt::sheet_view::id ( std::size_t  new_id )

inline

Sets the ID of this view to new_id.

id() [2/2]

std::size_t xlnt::sheet_view::id ( ) const

inline

Returns the ID of this view.

operator!=()

bool xlnt::sheet_view::operator!= ( const sheet_view &  rhs ) const

inline

Returns the negation of the equality operator.

operator==()

bool xlnt::sheet_view::operator== ( const sheet_view &  rhs ) const

inline

Returns true if this view is equal to rhs based on its id, grid lines setting, default grid color, pane, and selections.

pane() [1/3]

struct pane& xlnt::sheet_view::pane ( )

inline

Returns a reference to this view's pane.

pane() [2/3]

const struct pane& xlnt::sheet_view::pane ( ) const

inline

Returns a reference to this view's pane.

pane() [3/3]

void xlnt::sheet_view::pane ( const struct pane &  new_pane )

inline

Sets the pane of this view to new_pane.

selection()

class xlnt::selection& xlnt::sheet_view::selection ( std::size_t  index )

inline

Returns the selection at the given index.

selections()

std::vector<xlnt::selection> xlnt::sheet_view::selections ( ) const

inline

Returns the collection of selections as a vector.

show_grid_lines() [1/2]

void xlnt::sheet_view::show_grid_lines ( bool  show )

inline

If show is true, grid lines will be shown for sheets using this view.

show_grid_lines() [2/2]

bool xlnt::sheet_view::show_grid_lines ( ) const

inline

Returns true if grid lines will be shown for sheets using this view.

top_left_cell() [1/2]

void xlnt::sheet_view::top_left_cell ( const cell_reference &  ref )

inline

Sets the top left cell of this view.

top_left_cell() [2/2]

cell_reference xlnt::sheet_view::top_left_cell ( ) const

inline

Returns the top left cell of this view.

type() [1/2]

void xlnt::sheet_view::type ( sheet_view_type  new_type )

inline

Sets the type of this view.

type() [2/2]

sheet_view_type xlnt::sheet_view::type ( ) const

inline

Returns the type of this view.

---

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

• xlnt/worksheet/sheet_view.hpp