ScClipParam Struct Reference

This struct stores general clipboard parameters associated with a ScDocument instance created in clipboard mode. More...

#include <clipparam.hxx>

Collaboration diagram for ScClipParam:

Public Types
enum	Direction {   Unspecified ,   Column ,   Row }

Public Member Functions
	ScClipParam ()
	ScClipParam (const ScRange &rRange, bool bCutMode)
bool	isMultiRange () const
SCCOL	getPasteColSize ()
	Get the column size of a pasted range. More...
SCROW	getPasteRowSize (const ScDocument &rSrcDoc, bool bIncludeFiltered)
	Same as the above method, but returns the row size of the compressed range. More...
ScRange	getWholeRange () const
	Return a single range that encompasses all individual ranges. More...
void	transpose (const ScDocument &rSrcDoc, bool bIncludeFiltered, bool bIsMultiRangeRowFilteredTranspose)
	Transpose the clip parameters. More...
sal_uInt32	getSourceDocID () const
void	setSourceDocID (sal_uInt32 nVal)
bool	isTransposed () const
	Was this clip transposed? More...

Public Attributes
ScRangeList	maRanges
Direction	meDirection
bool	mbCutMode
sal_uInt32	mnSourceDocID
ScRangeListVector	maProtectedChartRangesVector
bool	mbTransposed = false
	Was this clip transposed? More...

Detailed Description

This struct stores general clipboard parameters associated with a ScDocument instance created in clipboard mode.

Definition at line 30 of file clipparam.hxx.

Member Enumeration Documentation

Direction

enum ScClipParam::Direction

Enumerator
Unspecified
Column
Row

Definition at line 32 of file clipparam.hxx.

Constructor & Destructor Documentation

ScClipParam() [1/2]

ScClipParam::ScClipParam

(

)

Definition at line 23 of file clipparam.cxx.

ScClipParam() [2/2]

ScClipParam::ScClipParam	(	const ScRange &	rRange,
		bool	bCutMode
	)

Definition at line 30 of file clipparam.cxx.

References maRanges, and ScRangeList::push_back().

Member Function Documentation

getPasteColSize()

SCCOL ScClipParam::getPasteColSize

(

)

Get the column size of a pasted range.

Note that when the range is non-contiguous, we first compress all individual ranges into a single range, and the size of that compressed range is returned.

Definition at line 43 of file clipparam.cxx.

References ScRange::aEnd, ScRange::aStart, ScAddress::Col(), Column, ScRangeList::empty(), ScRangeList::front(), i, maRanges, meDirection, Row, ScRangeList::size(), and Unspecified.

Referenced by ScDocument::CopyMultiRangeFromClip(), and ScViewFunc::PasteMultiRangesFromClip().

getPasteRowSize()

SCROW ScClipParam::getPasteRowSize	(	const ScDocument &	rSrcDoc,
		bool	bIncludeFiltered
	)

Same as the above method, but returns the row size of the compressed range.

Definition at line 73 of file clipparam.cxx.

References ScRange::aEnd, ScRange::aStart, Column, ScDocument::CountNonFilteredRows(), ScRangeList::empty(), ScRangeList::front(), i, maRanges, meDirection, ScAddress::Row(), Row, ScRangeList::size(), ScAddress::Tab(), and Unspecified.

Referenced by ScDocument::CopyMultiRangeFromClip(), and ScViewFunc::PasteMultiRangesFromClip().

getSourceDocID()

sal_uInt32 ScClipParam::getSourceDocID ( ) const

inline

Definition at line 72 of file clipparam.hxx.

Referenced by ScViewFunc::PasteFromClip().

getWholeRange()

ScRange ScClipParam::getWholeRange

(

)

const

Return a single range that encompasses all individual ranges.

Definition at line 109 of file clipparam.cxx.

References ScRangeList::Combine(), and maRanges.

Referenced by ScDocument::CopyFromClip(), ScTable::CopyOneCellFromClip(), ScDocument::CopyOneCellFromClip(), ScColumn::CopyOneCellFromClip(), ScDocument::CopyToClip(), ScColumn::DeleteBeforeCopyFromClip(), ScTable::DeleteBeforeCopyFromClip(), ScViewFunc::PasteFromClipToMultiRanges(), ScViewData::SelectionForbidsPaste(), sc::CopyFromClipContext::setSingleCell(), and ScDocument::TransposeClip().

isMultiRange()

bool ScClipParam::isMultiRange

(

)

const

Definition at line 38 of file clipparam.cxx.

References maRanges, and ScRangeList::size().

Referenced by ScImportExport::Doc2Text(), ScViewFunc::PasteFromClip(), ScClipUtil::PasteFromClipboard(), and ScDocument::TransposeClip().

isTransposed()

bool ScClipParam::isTransposed ( ) const

inline

Was this clip transposed?

Definition at line 78 of file clipparam.hxx.

Referenced by ScDrawLayer::CopyFromClip().

setSourceDocID()

void ScClipParam::setSourceDocID ( sal_uInt32  nVal )

inline

Definition at line 73 of file clipparam.hxx.

Referenced by ScViewFunc::CopyToClipSingleRange().

transpose()

void ScClipParam::transpose	(	const ScDocument &	rSrcDoc,
		bool	bIncludeFiltered,
		bool	bIsMultiRangeRowFilteredTranspose
	)

Transpose the clip parameters.

Filtered rows are removed from parameters.

Definition at line 114 of file clipparam.cxx.

References ScRange::aEnd, ScRange::aStart, ScAddress::Col(), Column, ScDocument::CountNonFilteredRows(), ScRangeList::empty(), ScRangeList::front(), i, maRanges, mbTransposed, meDirection, n, ScRangeList::push_back(), ScAddress::Row(), Row, ScRangeList::size(), ScAddress::Tab(), and Unspecified.

Referenced by ScDocument::TransposeClip().

Member Data Documentation

maProtectedChartRangesVector

ScRangeListVector ScClipParam::maProtectedChartRangesVector

Definition at line 38 of file clipparam.hxx.

Referenced by ScViewFunc::CopyToClipSingleRange(), and ScViewFunc::PasteFromClip().

maRanges

ScRangeList ScClipParam::maRanges

Definition at line 34 of file clipparam.hxx.

Referenced by ScDocument::CopyMultiRangeFromClip(), ScDocument::CopyTabToClip(), ScDocument::CopyToClip(), ScViewFunc::CopyToClipMultiRange(), ScViewFunc::CopyToClipSingleRange(), ScDocument::GetClipArea(), ScDocument::GetClipStart(), getPasteColSize(), getPasteRowSize(), getWholeRange(), ScDocument::HasClipFilteredRows(), isMultiRange(), ScViewFunc::MoveTable(), ScClipUtil::PasteFromClipboard(), ScClipParam(), ScDocument::SetClipArea(), ScDocShell::TransferTab(), transpose(), ScDocument::TransposeClip(), ScGridWindow::UpdateCopySourceOverlay(), and ScDocument::UpdateTranspose().

mbCutMode

bool ScClipParam::mbCutMode

Definition at line 36 of file clipparam.hxx.

Referenced by ScDocument::CopyBlockFromClip(), ScDocument::CopyFromClip(), ScDocument::CopyMultiRangeFromClip(), ScDocument::CopyOneCellFromClip(), ScDocument::CopyTabToClip(), ScViewFunc::CopyToClipMultiRange(), ScDocument::IsCutMode(), ScViewFunc::PasteFromClipToMultiRanges(), ScDocument::SetClipArea(), ScDocument::SetCutMode(), ScDocument::TransposeClip(), and ScDocument::UpdateReference().

mbTransposed

bool ScClipParam::mbTransposed = false

Was this clip transposed?

Definition at line 40 of file clipparam.hxx.

Referenced by transpose().

meDirection

Direction ScClipParam::meDirection

Definition at line 35 of file clipparam.hxx.

Referenced by ScDocument::CopyMultiRangeFromClip(), ScViewFunc::CopyToClipMultiRange(), getPasteColSize(), getPasteRowSize(), transpose(), and ScDocument::TransposeClip().

mnSourceDocID

sal_uInt32 ScClipParam::mnSourceDocID

Definition at line 37 of file clipparam.hxx.

---

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

• clipparam.hxx
• clipparam.cxx