6ed4be1257
Change-Id: Ib65abd0546f1219387fe3fd7ad4f6ba0eb029bd1 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/131987 Tested-by: Jenkins Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
326 lines
16 KiB
C++
326 lines
16 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_SVX_FRAMELINKARRAY_HXX
|
|
#define INCLUDED_SVX_FRAMELINKARRAY_HXX
|
|
|
|
#include <drawinglayer/primitive2d/Primitive2DContainer.hxx>
|
|
#include <svx/svxdllapi.h>
|
|
#include <svx/rotmodit.hxx>
|
|
#include <memory>
|
|
|
|
class Color;
|
|
|
|
namespace svx::frame {
|
|
|
|
struct ArrayImpl;
|
|
class Style;
|
|
|
|
/** Stores frame styles of an array of cells, supports merged ranges.
|
|
|
|
This class is able to store the frame styles of an array of cells and to
|
|
draw the entire array or parts of it to any output device.
|
|
|
|
Every cell contains the style of the left, right, top, bottom, top-left to
|
|
bottom-right, and bottom-left to top-right frame border.
|
|
|
|
On drawing, the thicker frame border of neighbored cells is selected
|
|
automatically. All borders are drawn "connected", that means, the correct
|
|
start and end coordinates of all lines of the borders are calculated,
|
|
especially, if they are drawn together with diagonal frame borders.
|
|
|
|
This array fully supports merged cell ranges. In a merged range, the frame
|
|
borders of the top-left cell is extended to the entire range, and all other
|
|
cells in that range are overlapped. Again, all connected frame borders,
|
|
also diagonals and frame borders from adjacent merged ranges, are handled
|
|
automatically.
|
|
|
|
Additionally, a clipping range can be set. If such a range is used, all
|
|
frame borders outside this range are completely ignored, and are not used
|
|
in the connected border calculation anymore.
|
|
|
|
The array can be mirrored in both directions. It is possible to specify,
|
|
whether to mirror the double frame styles, and whether to swap diagonal
|
|
frame borders.
|
|
*/
|
|
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC Array
|
|
{
|
|
public:
|
|
/** Constructs an empty array. */
|
|
explicit Array();
|
|
|
|
/** Destructs the array. */
|
|
~Array();
|
|
|
|
// array size and column/row indexes
|
|
|
|
/** Reinitializes the array with the specified size. Clears all styles. */
|
|
void Initialize( sal_Int32 nWidth, sal_Int32 nHeight );
|
|
|
|
/** Returns the number of columns in the array. */
|
|
sal_Int32 GetColCount() const;
|
|
|
|
/** Returns the number of rows in the array. */
|
|
sal_Int32 GetRowCount() const;
|
|
|
|
/** Returns the number of cells in the array. */
|
|
sal_Int32 GetCellCount() const;
|
|
|
|
/** Returns the cell index from the cell address (nCol,nRow). */
|
|
sal_Int32 GetCellIndex( sal_Int32 nCol, sal_Int32 nRow, bool bRTL) const;
|
|
|
|
// cell border styles
|
|
|
|
/** Sets the left frame style of the cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleLeft( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the right frame style of the cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleRight( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the top frame style of the cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleTop( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the bottom frame style of the specified cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleBottom( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the top-left to bottom-right frame style of the cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleTLBR( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the bottom-left to top-right frame style of the cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleBLTR( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets both diagonal frame styles of the specified cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellStyleDiag( sal_Int32 nCol, sal_Int32 nRow, const Style& rTLBR, const Style& rBLTR );
|
|
|
|
/** Sets the left frame style of the specified column. Ignores merged ranges. */
|
|
void SetColumnStyleLeft( sal_Int32 nCol, const Style& rStyle );
|
|
|
|
/** Sets the right frame style of the specified column. Ignores merged ranges. */
|
|
void SetColumnStyleRight( sal_Int32 nCol, const Style& rStyle );
|
|
|
|
/** Sets the top frame style of the specified row. Ignores merged ranges. */
|
|
void SetRowStyleTop( sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the bottom frame style of the specified row. Ignores merged ranges. */
|
|
void SetRowStyleBottom( sal_Int32 nRow, const Style& rStyle );
|
|
|
|
/** Sets the rotation parameters of the cell (nCol,nRow). Ignores merged ranges. */
|
|
void SetCellRotation(sal_Int32 nCol, sal_Int32 nRow, SvxRotateMode eRotMode, double fOrientation);
|
|
|
|
/** Check if at least one cell is rotated */
|
|
bool HasCellRotation() const;
|
|
|
|
/** Returns the left frame style of the cell (nCol,nRow).
|
|
Returns thicker of own left style or right style of the cell to the left.
|
|
Returns the style only if visible (i.e. at left border of a merged range).
|
|
@return
|
|
The left frame style or an invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleLeft( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the right frame style of the cell (nCol,nRow).
|
|
Returns thicker of own right style or left style of the cell to the right.
|
|
Returns the style only if visible (i.e. at right border of a merged range).
|
|
@return
|
|
The left frame style or an invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleRight( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the top frame style of the cell (nCol,nRow).
|
|
Returns thicker of own top style or bottom style of the cell above.
|
|
Returns the style only if visible (i.e. at top border of a merged range).
|
|
@return
|
|
The top frame style or an invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleTop( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the top frame style of the cell (nCol,nRow).
|
|
Returns thicker of own top style or bottom style of the cell above.
|
|
Returns the style only if visible (i.e. at top border of a merged range).
|
|
@return
|
|
The top frame style or an invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleBottom( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the top-left to bottom-right frame style of the cell (nCol,nRow).
|
|
Ignores merged ranges;
|
|
@return
|
|
The top-left to bottom-right frame style or an invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleTLBR( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the bottom-left to top-right frame style of the cell (nCol,nRow).
|
|
Ignores merged ranges;
|
|
@return
|
|
The bottom-left to top-right frame style or an invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleBLTR( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the top-left to bottom-right frame style of the cell (nCol,nRow).
|
|
@return
|
|
The top-left to bottom-right frame style, if the cell is not part of
|
|
a merged range, or if (nCol,nRow) is the top-left corner of a merged
|
|
range (useful to find connected frame styles).
|
|
An invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleTL( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the top-left to bottom-right frame style of the cell (nCol,nRow).
|
|
@return
|
|
The top-left to bottom-right frame style, if the cell is not part of
|
|
a merged range, or if (nCol,nRow) is the bottom-right corner of a
|
|
merged range (useful to find connected frame styles).
|
|
An invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleBR( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the bottom-left to top-right frame style of the cell (nCol,nRow).
|
|
@return
|
|
The bottom-left to top-right frame style, if the cell is not part of
|
|
a merged range, or if (nCol,nRow) is the bottom-left corner of a
|
|
merged range (useful to find connected frame styles).
|
|
An invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleBL( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the bottom-left to top-right frame style of the cell (nCol,nRow).
|
|
@return
|
|
The bottom-left to top-right frame style, if the cell is not part of
|
|
a merged range, or if (nCol,nRow) is the top-right corner of a
|
|
merged range (useful to find connected frame styles).
|
|
An invisible style for invalid cell addresses. */
|
|
const Style& GetCellStyleTR( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
// cell merging
|
|
|
|
/** Inserts a new merged cell range.
|
|
@precond The range must not intersect other merged ranges. */
|
|
void SetMergedRange( sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow );
|
|
|
|
/** Sets an additional left width for the merged range that contains (nCol,nRow).
|
|
@descr Useful to handle merged ranges that are not completely part of the array.
|
|
@precond The merged range must be at the left border of the array. */
|
|
void SetAddMergedLeftSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
|
|
|
|
/** Sets an additional right width for the merged range that contains (nCol,nRow).
|
|
@descr Useful to handle merged ranges that are not completely part of the array.
|
|
@precond The merged range must be at the right border of the array. */
|
|
void SetAddMergedRightSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
|
|
|
|
/** Sets an additional top height for the merged range that contains (nCol,nRow).
|
|
@descr Useful to handle merged ranges that are not completely part of the array.
|
|
@precond The merged range must be at the top border of the array. */
|
|
void SetAddMergedTopSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
|
|
|
|
/** Sets an additional bottom height for the merged range that contains (nCol,nRow).
|
|
@descr Useful to handle merged ranges that are not completely part of the array.
|
|
@precond The merged range must be at the bottom border of the array. */
|
|
void SetAddMergedBottomSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
|
|
|
|
/** Returns true, if the cell (nCol,nRow) is part of a merged range. */
|
|
bool IsMerged( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the address of the top-left cell of the merged range that contains (nCol,nRow). */
|
|
void GetMergedOrigin( sal_Int32& rnFirstCol, sal_Int32& rnFirstRow, sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
/** Returns the top-left and bottom-right address of the merged range that contains (nCol,nRow). */
|
|
void GetMergedRange( sal_Int32& rnFirstCol, sal_Int32& rnFirstRow,
|
|
sal_Int32& rnLastCol, sal_Int32& rnLastRow, sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
// clipping
|
|
|
|
/** Sets a clipping range.
|
|
@descr
|
|
No cell borders outside of this clipping range will be drawn. In
|
|
difference to simply using the CreateB2DPrimitiveRange() function with the same
|
|
range, a clipping range causes the drawing functions to completely
|
|
ignore the frame styles connected from outside. This is used i.e.
|
|
in Calc to print single pages and to draw the print preview.
|
|
Partly visible diagonal frame borders in merged ranges are correctly
|
|
clipped too. This array can handle only one clip range at a time. */
|
|
void SetClipRange( sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow );
|
|
|
|
// cell coordinates
|
|
|
|
/** Sets the X output coordinate of the left column. */
|
|
void SetXOffset( sal_Int32 nXOffset );
|
|
|
|
/** Sets the Y output coordinate of the top row. */
|
|
void SetYOffset( sal_Int32 nYOffset );
|
|
|
|
/** Sets the output width of the specified column. */
|
|
void SetColWidth( sal_Int32 nCol, sal_Int32 nWidth );
|
|
|
|
/** Sets the output height of the specified row. */
|
|
void SetRowHeight( sal_Int32 nRow, sal_Int32 nHeight );
|
|
|
|
/** Sets the same output width for all columns. */
|
|
void SetAllColWidths( sal_Int32 nWidth );
|
|
|
|
/** Sets the same output height for all rows. */
|
|
void SetAllRowHeights( sal_Int32 nHeight );
|
|
|
|
/** Returns the X output coordinate of the left border of the specified column.
|
|
@descr The column index <array-width> returns the X output coordinate
|
|
of the right array border. */
|
|
sal_Int32 GetColPosition( sal_Int32 nCol ) const;
|
|
|
|
/** Returns the Y output coordinate of the top border of the specified row.
|
|
@descr The row index <array-height> returns the Y output coordinate
|
|
of the bottom array border. */
|
|
sal_Int32 GetRowPosition( sal_Int32 nRow ) const;
|
|
|
|
/** Returns the output width of the specified range of columns. */
|
|
sal_Int32 GetColWidth( sal_Int32 nFirstCol, sal_Int32 nLastCol ) const;
|
|
|
|
/** Returns the output height of the specified range of rows. */
|
|
sal_Int32 GetRowHeight( sal_Int32 nFirstRow, sal_Int32 nLastRow ) const;
|
|
|
|
/** Returns the output width of the entire array. */
|
|
sal_Int32 GetWidth() const;
|
|
|
|
/** Returns the output height of the entire array. */
|
|
sal_Int32 GetHeight() const;
|
|
|
|
/** Returns the output range of the cell (nCol,nRow).
|
|
Returns total output range of merged ranges. */
|
|
basegfx::B2DRange GetCellRange( sal_Int32 nCol, sal_Int32 nRow ) const;
|
|
|
|
// return output range of given row/col range in logical coordinates
|
|
basegfx::B2DRange GetB2DRange( sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow ) const;
|
|
|
|
// mirroring
|
|
|
|
/** Mirrors the entire array horizontally. */
|
|
void MirrorSelfX();
|
|
|
|
// drawing
|
|
|
|
/** Draws the part of the specified range, that is inside the clipping range.
|
|
@param pForceColor
|
|
If not NULL, only this color will be used to draw all frame borders. */
|
|
drawinglayer::primitive2d::Primitive2DContainer CreateB2DPrimitiveRange(
|
|
sal_Int32 nFirstCol, sal_Int32 nFirstRow,
|
|
sal_Int32 nLastCol, sal_Int32 nLastRow,
|
|
const Color* pForceColor ) const;
|
|
|
|
/** Draws the part of the array, that is inside the clipping range. */
|
|
drawinglayer::primitive2d::Primitive2DContainer CreateB2DPrimitiveArray() const;
|
|
|
|
private:
|
|
std::unique_ptr<ArrayImpl> mxImpl;
|
|
};
|
|
|
|
}
|
|
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|