LibreOffice Module sc (master) 1
Public Member Functions | Private Types | Private Attributes | List of all members
oox::xls::LinkSheetRange Class Reference

Contains indexes for a range of sheets in the spreadsheet document. More...

#include <externallinkbuffer.hxx>

Public Member Functions

 LinkSheetRange ()
 
void setDeleted ()
 Sets this struct to deleted state. More...
 
void setSameSheet ()
 Sets this struct to "use current sheet" state. More...
 
void setRange (sal_Int32 nFirst, sal_Int32 nLast)
 Sets the passed absolute sheet range to the members of this struct. More...
 
void setExternalRange (sal_Int32 nDocLink, sal_Int32 nFirst, sal_Int32 nLast)
 Sets the passed external sheet cache range to the members of this struct. More...
 
bool isDeleted () const
 Returns true, if the sheet indexes are valid and different. More...
 
bool isExternal () const
 Returns true, if the sheet range points to an external document. More...
 
bool isSameSheet () const
 Returns true, if the sheet indexes are valid and different. More...
 
bool is3dRange () const
 Returns true, if the sheet indexes are valid and different. More...
 
sal_Int32 getDocLinkIndex () const
 
sal_Int32 getFirstSheet () const
 
sal_Int32 getLastSheet () const
 

Private Types

enum  LinkSheetRangeType {
  LINKSHEETRANGE_INTERNAL ,
  LINKSHEETRANGE_EXTERNAL ,
  LINKSHEETRANGE_SAMESHEET
}
 

Private Attributes

LinkSheetRangeType meType
 
sal_Int32 mnDocLink
 Link sheet range type. More...
 
sal_Int32 mnFirst
 Document link token index for external links. More...
 
sal_Int32 mnLast
 Index of the first sheet or index of first external sheet cache. More...
 

Detailed Description

Contains indexes for a range of sheets in the spreadsheet document.

Definition at line 118 of file externallinkbuffer.hxx.

Member Enumeration Documentation

◆ LinkSheetRangeType

Enumerator
LINKSHEETRANGE_INTERNAL 
LINKSHEETRANGE_EXTERNAL 

Sheet range in the own document.

LINKSHEETRANGE_SAMESHEET 

Sheet range in an external document.

Current sheet depending on context.

Definition at line 146 of file externallinkbuffer.hxx.

Constructor & Destructor Documentation

◆ LinkSheetRange()

oox::xls::LinkSheetRange::LinkSheetRange ( )
inlineexplicit

Definition at line 121 of file externallinkbuffer.hxx.

References setDeleted().

Member Function Documentation

◆ getDocLinkIndex()

sal_Int32 oox::xls::LinkSheetRange::getDocLinkIndex ( ) const
inline

Definition at line 141 of file externallinkbuffer.hxx.

References mnDocLink.

Referenced by oox::xls::FormulaParserImpl::pushReferenceOperand().

◆ getFirstSheet()

sal_Int32 oox::xls::LinkSheetRange::getFirstSheet ( ) const
inline

◆ getLastSheet()

sal_Int32 oox::xls::LinkSheetRange::getLastSheet ( ) const
inline

Definition at line 143 of file externallinkbuffer.hxx.

References mnLast.

Referenced by oox::xls::FormulaParserImpl::convertReference3d().

◆ is3dRange()

bool oox::xls::LinkSheetRange::is3dRange ( ) const
inline

Returns true, if the sheet indexes are valid and different.

Definition at line 139 of file externallinkbuffer.hxx.

References mnFirst, and mnLast.

Referenced by oox::xls::FormulaParserImpl::convertReference3d(), and oox::xls::FormulaParserImpl::pushReferenceOperand().

◆ isDeleted()

bool oox::xls::LinkSheetRange::isDeleted ( ) const
inline

Returns true, if the sheet indexes are valid and different.

Definition at line 133 of file externallinkbuffer.hxx.

References mnFirst.

Referenced by isExternal().

◆ isExternal()

bool oox::xls::LinkSheetRange::isExternal ( ) const
inline

Returns true, if the sheet range points to an external document.

Definition at line 135 of file externallinkbuffer.hxx.

References isDeleted(), LINKSHEETRANGE_EXTERNAL, and meType.

Referenced by oox::xls::FormulaParserImpl::pushReferenceOperand().

◆ isSameSheet()

bool oox::xls::LinkSheetRange::isSameSheet ( ) const
inline

Returns true, if the sheet indexes are valid and different.

Definition at line 137 of file externallinkbuffer.hxx.

References LINKSHEETRANGE_SAMESHEET, and meType.

Referenced by oox::xls::FormulaParserImpl::convertReference3d(), and oox::xls::FormulaParserImpl::pushReferenceOperand().

◆ setDeleted()

void oox::xls::LinkSheetRange::setDeleted ( )

Sets this struct to deleted state.

Definition at line 247 of file externallinkbuffer.cxx.

References LINKSHEETRANGE_INTERNAL, meType, mnDocLink, mnFirst, and mnLast.

Referenced by oox::xls::ExternalLink::getSheetRange(), LinkSheetRange(), and setExternalRange().

◆ setExternalRange()

void oox::xls::LinkSheetRange::setExternalRange ( sal_Int32  nDocLink,
sal_Int32  nFirst,
sal_Int32  nLast 
)

Sets the passed external sheet cache range to the members of this struct.

Definition at line 268 of file externallinkbuffer.cxx.

References LINKSHEETRANGE_EXTERNAL, meType, mnDocLink, mnFirst, mnLast, and setDeleted().

Referenced by oox::xls::ExternalLink::getSheetRange().

◆ setRange()

void oox::xls::LinkSheetRange::setRange ( sal_Int32  nFirst,
sal_Int32  nLast 
)

Sets the passed absolute sheet range to the members of this struct.

Definition at line 260 of file externallinkbuffer.cxx.

References LINKSHEETRANGE_INTERNAL, meType, mnDocLink, mnFirst, and mnLast.

Referenced by oox::xls::ExternalLink::getSheetRange().

◆ setSameSheet()

void oox::xls::LinkSheetRange::setSameSheet ( )

Sets this struct to "use current sheet" state.

Definition at line 253 of file externallinkbuffer.cxx.

References LINKSHEETRANGE_SAMESHEET, meType, mnDocLink, mnFirst, and mnLast.

Referenced by oox::xls::ExternalLink::getSheetRange().

Member Data Documentation

◆ meType

LinkSheetRangeType oox::xls::LinkSheetRange::meType
private

◆ mnDocLink

sal_Int32 oox::xls::LinkSheetRange::mnDocLink
private

Link sheet range type.

Definition at line 154 of file externallinkbuffer.hxx.

Referenced by getDocLinkIndex(), setDeleted(), setExternalRange(), setRange(), and setSameSheet().

◆ mnFirst

sal_Int32 oox::xls::LinkSheetRange::mnFirst
private

Document link token index for external links.

Definition at line 155 of file externallinkbuffer.hxx.

Referenced by getFirstSheet(), is3dRange(), isDeleted(), setDeleted(), setExternalRange(), setRange(), and setSameSheet().

◆ mnLast

sal_Int32 oox::xls::LinkSheetRange::mnLast
private

Index of the first sheet or index of first external sheet cache.

Definition at line 156 of file externallinkbuffer.hxx.

Referenced by getLastSheet(), is3dRange(), setDeleted(), setExternalRange(), setRange(), and setSameSheet().


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