xlnt
Public Member Functions | Static Public Member Functions | List of all members
xlnt::protection Class Reference

Describes the protection style of a particular cell. More...

#include <protection.hpp>

Public Member Functions

 protection ()
 Constructs a default unlocked unhidden protection object. More...
 
bool locked () const
 Returns true if cells using this protection should be locked. More...
 
protectionlocked (bool locked)
 Sets the locked state of the protection to locked and returns a reference to the protection. More...
 
bool hidden () const
 Returns true if cells using this protection should be hidden. More...
 
protectionhidden (bool hidden)
 Sets the hidden state of the protection to hidden and returns a reference to the protection. More...
 
bool operator== (const protection &other) const
 Returns true if this protections is equivalent to right. More...
 
bool operator!= (const protection &other) const
 Returns true if this protection is not equivalent to right. More...
 

Static Public Member Functions

static protection unlocked_and_visible ()
 Returns an unlocked and unhidden protection object. More...
 
static protection locked_and_visible ()
 Returns a locked and unhidden protection object. More...
 
static protection unlocked_and_hidden ()
 Returns an unlocked and hidden protection object. More...
 
static protection locked_and_hidden ()
 Returns a locked and hidden protection object. More...
 

Detailed Description

Describes the protection style of a particular cell.

Constructor & Destructor Documentation

◆ protection()

xlnt::protection::protection ( )

Constructs a default unlocked unhidden protection object.

Member Function Documentation

◆ hidden() [1/2]

bool xlnt::protection::hidden ( ) const

Returns true if cells using this protection should be hidden.

◆ hidden() [2/2]

protection& xlnt::protection::hidden ( bool  hidden)

Sets the hidden state of the protection to hidden and returns a reference to the protection.

◆ locked() [1/2]

bool xlnt::protection::locked ( ) const

Returns true if cells using this protection should be locked.

◆ locked() [2/2]

protection& xlnt::protection::locked ( bool  locked)

Sets the locked state of the protection to locked and returns a reference to the protection.

◆ locked_and_hidden()

static protection xlnt::protection::locked_and_hidden ( )
static

Returns a locked and hidden protection object.

◆ locked_and_visible()

static protection xlnt::protection::locked_and_visible ( )
static

Returns a locked and unhidden protection object.

◆ operator!=()

bool xlnt::protection::operator!= ( const protection other) const

Returns true if this protection is not equivalent to right.

◆ operator==()

bool xlnt::protection::operator== ( const protection other) const

Returns true if this protections is equivalent to right.

◆ unlocked_and_hidden()

static protection xlnt::protection::unlocked_and_hidden ( )
static

Returns an unlocked and hidden protection object.

◆ unlocked_and_visible()

static protection xlnt::protection::unlocked_and_visible ( )
static

Returns an unlocked and unhidden protection object.


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