framelinkarray.hxx

Go to the documentation of this file.

/* -*- 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;
 
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC Array
{
public:
    explicit            Array();
 
                        ~Array();
 
    // array size and column/row indexes
 
    void                Initialize( sal_Int32 nWidth, sal_Int32 nHeight );
 
    sal_Int32           GetColCount() const;
 
    sal_Int32           GetRowCount() const;
 
    sal_Int32           GetCellCount() const;
 
    sal_Int32           GetCellIndex( sal_Int32 nCol, sal_Int32 nRow, bool bRTL) const;
 
    // cell border styles
 
    void                SetCellStyleLeft( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellStyleRight( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellStyleTop( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellStyleBottom( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellStyleTLBR( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellStyleBLTR( sal_Int32 nCol, sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellStyleDiag( sal_Int32 nCol, sal_Int32 nRow, const Style& rTLBR, const Style& rBLTR );
 
    void                SetColumnStyleLeft( sal_Int32 nCol, const Style& rStyle );
 
    void                SetColumnStyleRight( sal_Int32 nCol, const Style& rStyle );
 
    void                SetRowStyleTop( sal_Int32 nRow, const Style& rStyle );
 
    void                SetRowStyleBottom( sal_Int32 nRow, const Style& rStyle );
 
    void                SetCellRotation(sal_Int32 nCol, sal_Int32 nRow, SvxRotateMode eRotMode, double fOrientation);
 
    bool                HasCellRotation() const;
 
    const Style&        GetCellStyleLeft( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleRight( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleTop( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleBottom( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleTLBR( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleBLTR( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleTL( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleBR( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleBL( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    const Style&        GetCellStyleTR( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    // cell merging
 
    void                SetMergedRange( sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow );
 
    void                SetAddMergedLeftSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
 
    void                SetAddMergedRightSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
 
    void                SetAddMergedTopSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
 
    void                SetAddMergedBottomSize( sal_Int32 nCol, sal_Int32 nRow, sal_Int32 nAddSize );
 
    bool                IsMerged( sal_Int32 nCol, sal_Int32 nRow ) const;
 
    void                GetMergedOrigin( sal_Int32& rnFirstCol, sal_Int32& rnFirstRow, sal_Int32 nCol, sal_Int32 nRow ) const;
 
    void                GetMergedRange( sal_Int32& rnFirstCol, sal_Int32& rnFirstRow,
                            sal_Int32& rnLastCol, sal_Int32& rnLastRow, sal_Int32 nCol, sal_Int32 nRow ) const;
 
    // clipping
 
    void                SetClipRange( sal_Int32 nFirstCol, sal_Int32 nFirstRow, sal_Int32 nLastCol, sal_Int32 nLastRow );
 
    // cell coordinates
 
    void                SetXOffset( sal_Int32 nXOffset );
 
    void                SetYOffset( sal_Int32 nYOffset );
 
    void                SetColWidth( sal_Int32 nCol, sal_Int32 nWidth );
 
    void                SetRowHeight( sal_Int32 nRow, sal_Int32 nHeight );
 
    void                SetAllColWidths( sal_Int32 nWidth );
 
    void                SetAllRowHeights( sal_Int32 nHeight );
 
    sal_Int32           GetColPosition( sal_Int32 nCol ) const;
 
    sal_Int32           GetRowPosition( sal_Int32 nRow ) const;
 
    sal_Int32           GetColWidth( sal_Int32 nFirstCol, sal_Int32 nLastCol ) const;
 
    sal_Int32           GetRowHeight( sal_Int32 nFirstRow, sal_Int32 nLastRow ) const;
 
    sal_Int32           GetWidth() const;
 
    sal_Int32           GetHeight() const;
 
    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
 
    void                MirrorSelfX();
 
    // drawing
 
    drawinglayer::primitive2d::Primitive2DContainer CreateB2DPrimitiveRange(
        sal_Int32 nFirstCol, sal_Int32 nFirstRow,
        sal_Int32 nLastCol, sal_Int32 nLastRow,
        const Color* pForceColor ) const;
 
    drawinglayer::primitive2d::Primitive2DContainer CreateB2DPrimitiveArray() const;
 
private:
    std::unique_ptr<ArrayImpl>        mxImpl;
};
 
}
 
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */