diff options
| author | Kohei Yoshida <kohei.yoshida@collabora.com> | 2015-01-12 18:50:11 -0500 |
|---|---|---|
| committer | Kohei Yoshida <kohei.yoshida@collabora.com> | 2015-01-14 22:17:18 -0500 |
| commit | 83e8b259c3c0c0bc593ea0eb60dde0dc8299d970 (patch) | |
| tree | 839cac069eceb9d4134fd8b33dbe8232640fb038 /sc/inc/document.hxx | |
| parent | Provide const version that returns a const pointer. (diff) | |
| download | core-83e8b259c3c0c0bc593ea0eb60dde0dc8299d970.tar.gz core-83e8b259c3c0c0bc593ea0eb60dde0dc8299d970.zip | |
Annotate this method.
Change-Id: Ia8f518fd6e61562e95eddacafc9f7e49656826e8
Diffstat (limited to 'sc/inc/document.hxx')
| -rw-r--r-- | sc/inc/document.hxx | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/sc/inc/document.hxx b/sc/inc/document.hxx index 57fcf7425ed0..61fa81d00cb9 100644 --- a/sc/inc/document.hxx +++ b/sc/inc/document.hxx @@ -1104,8 +1104,23 @@ public: */ SCROW GetLastDataRow( SCTAB nTab, SCCOL nCol1, SCCOL nCol2, SCROW nLastRow ) const; - SC_DLLPUBLIC void GetDataArea( SCTAB nTab, SCCOL& rStartCol, SCROW& rStartRow, - SCCOL& rEndCol, SCROW& rEndRow, bool bIncludeOld, bool bOnlyDown ) const; + /** + * Return the smallest area containing at least all contiguous cells + * having data. This area is a square containing also empty cells. It may + * shrink or extend the area given as input Flags as modifiers: + * + * @param bIncludeOld when true, ensure that the returned area contains at + * least the initial area even if the actual data area + * is smaller than the initial area. + * + * @param bOnlyDown when true, extend / shrink the data area only in a + * downward direction i.e. only modify the end row + * position. + */ + SC_DLLPUBLIC void GetDataArea( + SCTAB nTab, SCCOL& rStartCol, SCROW& rStartRow, SCCOL& rEndCol, SCROW& rEndRow, + bool bIncludeOld, bool bOnlyDown ) const; + SC_DLLPUBLIC bool GetCellArea( SCTAB nTab, SCCOL& rEndCol, SCROW& rEndRow ) const; SC_DLLPUBLIC bool GetTableArea( SCTAB nTab, SCCOL& rEndCol, SCROW& rEndRow ) const; SC_DLLPUBLIC bool GetPrintArea( SCTAB nTab, SCCOL& rEndCol, SCROW& rEndRow, |