/* -*- 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_SW_INC_TBLAFMT_HXX
#define INCLUDED_SW_INC_TBLAFMT_HXX
/*
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
*
* The structure of table auto formatting should not be changed. It is used
* by different code of Writer and Calc. If a change is necessary, the
* source code of both applications must be changed!
*
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
*/
#include <boost/scoped_ptr.hpp>
#include "hintids.hxx"
#include <svx/algitem.hxx>
#include <editeng/fontitem.hxx>
#include <editeng/fhgtitem.hxx>
#include <editeng/wghtitem.hxx>
#include <editeng/postitem.hxx>
#include <editeng/udlnitem.hxx>
#include <editeng/crossedoutitem.hxx>
#include <editeng/contouritem.hxx>
#include <editeng/shdditem.hxx>
#include <editeng/colritem.hxx>
#include <editeng/boxitem.hxx>
#include <editeng/brushitem.hxx>
#include <editeng/adjustitem.hxx>
#include <editeng/justifyitem.hxx>
#include <editeng/formatbreakitem.hxx>
#include <editeng/keepitem.hxx>
#include <editeng/frmdiritem.hxx>
#include <editeng/shaditem.hxx>
#include <svx/rotmodit.hxx>
#include <svl/intitem.hxx>
#include <editeng/lineitem.hxx>
#include <fmtpdsc.hxx>
#include <fmtlsplt.hxx>
#include <fmtrowsplt.hxx>
#include <fmtornt.hxx>
#include "swdllapi.h"
struct SwAfVersions;
class SvNumberFormatter;
class SwBoxAutoFmt
{
// common attributes of Calc and Writer
// --- from 641 on: CJK and CTL font settings
SvxFontItem aFont;
SvxFontHeightItem aHeight;
SvxWeightItem aWeight;
SvxPostureItem aPosture;
SvxFontItem aCJKFont;
SvxFontHeightItem aCJKHeight;
SvxWeightItem aCJKWeight;
SvxPostureItem aCJKPosture;
SvxFontItem aCTLFont;
SvxFontHeightItem aCTLHeight;
SvxWeightItem aCTLWeight;
SvxPostureItem aCTLPosture;
SvxUnderlineItem aUnderline;
SvxOverlineItem aOverline;
SvxCrossedOutItem aCrossedOut;
SvxContourItem aContour;
SvxShadowedItem aShadowed;
SvxColorItem aColor;
SvxBoxItem aBox;
SvxLineItem aTLBR;
SvxLineItem aBLTR;
SvxBrushItem aBackground;
// Writer specific
SvxAdjustItem aAdjust;
SvxFrameDirectionItem m_aTextOrientation;
SwFmtVertOrient m_aVerticalAlignment;
// Calc specific
SvxHorJustifyItem aHorJustify;
SvxVerJustifyItem aVerJustify;
SfxBoolItem aStacked;
SvxMarginItem aMargin;
SfxBoolItem aLinebreak;
SfxInt32Item aRotateAngle;
SvxRotateModeItem aRotateMode;
// number format
OUString sNumFmtString;
LanguageType eSysLanguage, eNumFmtLanguage;
public:
SwBoxAutoFmt();
SwBoxAutoFmt( const SwBoxAutoFmt& rNew );
~SwBoxAutoFmt();
int operator==( const SwBoxAutoFmt& rCmp ) const;
SwBoxAutoFmt& operator=( const SwBoxAutoFmt& rNew );
// The get-methods.
const SvxFontItem &GetFont() const { return aFont; }
const SvxFontHeightItem &GetHeight() const { return aHeight; }
const SvxWeightItem &GetWeight() const { return aWeight; }
const SvxPostureItem &GetPosture() const { return aPosture; }
const SvxFontItem &GetCJKFont() const { return aCJKFont; }
const SvxFontHeightItem &GetCJKHeight() const { return aCJKHeight; }
const SvxWeightItem &GetCJKWeight() const { return aCJKWeight; }
const SvxPostureItem &GetCJKPosture() const { return aCJKPosture; }
const SvxFontItem &GetCTLFont() const { return aCTLFont; }
const SvxFontHeightItem &GetCTLHeight() const { return aCTLHeight; }
const SvxWeightItem &GetCTLWeight() const { return aCTLWeight; }
const SvxPostureItem &GetCTLPosture() const { return aCTLPosture; }
const SvxUnderlineItem &GetUnderline() const { return aUnderline; }
const SvxOverlineItem &GetOverline() const { return aOverline; }
const SvxCrossedOutItem &GetCrossedOut() const { return aCrossedOut; }
const SvxContourItem &GetContour() const { return aContour; }
const SvxShadowedItem &GetShadowed() const { return aShadowed; }
const SvxColorItem &GetColor() const { return aColor; }
const SvxAdjustItem &GetAdjust() const { return aAdjust; }
const SvxFrameDirectionItem& GetTextOrientation() const { return m_aTextOrientation; }
const SwFmtVertOrient& GetVerticalAlignment() const { return m_aVerticalAlignment; }
const SvxBoxItem &GetBox() const { return aBox; }
const SvxLineItem &GetTLBR() const { return aTLBR; }
const SvxLineItem &GetBLTR() const { return aBLTR; }
const SvxBrushItem &GetBackground() const { return aBackground; }
void GetValueFormat( OUString& rFmt, LanguageType& rLng, LanguageType& rSys ) const
{ rFmt = sNumFmtString; rLng = eNumFmtLanguage; rSys = eSysLanguage; }
// The set-methods.
void SetFont( const SvxFontItem& rNew ) { aFont = rNew; }
void SetHeight( const SvxFontHeightItem& rNew ) { aHeight = rNew; }
void SetWeight( const SvxWeightItem& rNew ) { aWeight = rNew; }
void SetPosture( const SvxPostureItem& rNew ) { aPosture = rNew; }
void SetCJKFont( const SvxFontItem& rNew ) { aCJKFont = rNew; }
void SetCJKHeight( const SvxFontHeightItem& rNew ) { aCJKHeight = rNew; }
void SetCJKWeight( const SvxWeightItem& rNew ) { aCJKWeight = rNew; }
void SetCJKPosture( const SvxPostureItem& rNew ) { aCJKPosture = rNew; }
void SetCTLFont( const SvxFontItem& rNew ) { aCTLFont = rNew; }
void SetCTLHeight( const SvxFontHeightItem& rNew ) { aCTLHeight = rNew; }
void SetCTLWeight( const SvxWeightItem& rNew ) { aCTLWeight = rNew; }
void SetCTLPosture( const SvxPostureItem& rNew ) { aCTLPosture = rNew; }
void SetUnderline( const SvxUnderlineItem& rNew ) { aUnderline = rNew; }
void SetOverline( const SvxOverlineItem& rNew ) { aOverline = rNew; }
void SetCrossedOut( const SvxCrossedOutItem& rNew ) { aCrossedOut = rNew; }
void SetContour( const SvxContourItem& rNew ) { aContour = rNew; }
void SetShadowed( const SvxShadowedItem& rNew ) { aShadowed = rNew; }
void SetColor( const SvxColorItem& rNew ) { aColor = rNew; }
void SetAdjust( const SvxAdjustItem& rNew )
{
aAdjust.SetAdjust( rNew.GetAdjust() );
aAdjust.SetOneWord( rNew.GetOneWord() );
aAdjust.SetLastBlock( rNew.GetLastBlock() );
}
void SetTextOrientation(const SvxFrameDirectionItem& rNew) { m_aTextOrientation = rNew; }
void SetVerticalAlignment(const SwFmtVertOrient& rNew) { m_aVerticalAlignment = rNew; }
void SetBox( const SvxBoxItem& rNew ) { aBox = rNew; }
void SetBackground( const SvxBrushItem& rNew ) { aBackground = rNew; }
void SetValueFormat( const OUString& rFmt, LanguageType eLng, LanguageType eSys )
{ sNumFmtString = rFmt; eNumFmtLanguage = eLng; eSysLanguage = eSys; }
bool Load( SvStream& rStream, const SwAfVersions& rVersions, sal_uInt16 nVer );
bool Save( SvStream& rStream, sal_uInt16 fileVersion ) const;
bool SaveVersionNo( SvStream& rStream, sal_uInt16 fileVersion ) const;
};
/*
@remarks
A table has a number of lines. These lines seem to correspond with rows, except in the case of
rows spanning more than one line. Each line contains a number of boxes/cells.
AutoFormat properties are retrieved and stored in a grid of 16 table boxes. A sampling approach
is used to read the data. 4 lines are picked, and 4 boxes are picked from each.
The line picking and box picking algorithms are similar. We start at the first line/box, and pick
lines/boxes one by one for a maximum of 3. The 4th line/box is the last line/box in the current
table/line. If we hit the end of lines/boxes, the last line/box encountered is picked several times.
For example, in a 2x3 table, the 4 lines will be [0, 1, 1, 1]. In each line, the boxes will be
[0, 1, 2, 2]. In a 6x5 table, the 4 lines will be [0, 1, 2, 4] and the boxes per line will be
[0, 1, 2, 5].
As you can see, property extraction/application is lossless for tables that are 4x4 or smaller
(and in fact has a bit of redundnacy). For larger tables, we lose any individual cell formatting
for the range [(3,rows - 1) -> (3, cols - 1)]. That formatting is replaced by formatting from
the saved cells:
0 1 2 3 4 5
+-----------------------------------------------------------------------+
0 | Saved | Saved | Saved | | | Saved |
+-----------------------------------------------------------------------+
1 | Saved | Saved | Saved | | | Saved |
+-----------------------------------------------------------------------+
2 | Saved | Saved | Saved | | | Saved |
+-----------------------------------------------------------------------+
3 | | | | | | |
+-----------------------------------------------------------------------+
4 | | | | | | |
+-----------------------------------------------------------------------+
5 | Saved | Saved | Saved | | | Saved |
+-----------+-----------+-----------+-----------+-----------+-----------+
The properties saved are divided into three categories:
1. Character properties: Font, font size, weight, etc.
2. Box properties: Box, cell background
3. Table properties: Properties that are set in the Table->Table Properties dialog.
Character and box properties are stored per cell (and are lossy for tables larger than 4x4). Table
properties are stored per-table, and are lossless.
*/
class SW_DLLPUBLIC SwTableAutoFmt
{
friend void _FinitCore(); // To destroy default pointer.
static SwBoxAutoFmt* pDfltBoxAutoFmt;
OUString m_aName;
sal_uInt16 nStrResId;
// Common flags of Calc and Writer.
bool bInclFont : 1;
bool bInclJustify : 1;
bool bInclFrame : 1;
bool bInclBackground : 1;
bool bInclValueFormat : 1;
// Calc specific flags.
bool bInclWidthHeight : 1;
SwBoxAutoFmt* aBoxAutoFmt[ 16 ];
// Writer-specific options
SvxFmtBreakItem m_aBreak;
SwFmtPageDesc m_aPageDesc;
SvxFmtKeepItem m_aKeepWithNextPara;
sal_uInt16 m_aRepeatHeading;
bool m_bLayoutSplit;
bool m_bRowSplit;
bool m_bCollapsingBorders;
SvxShadowItem m_aShadow;
public:
SwTableAutoFmt( const OUString& rName );
SwTableAutoFmt( const SwTableAutoFmt& rNew );
~SwTableAutoFmt();
SwTableAutoFmt& operator=( const SwTableAutoFmt& rNew );
void SetBoxFmt( const SwBoxAutoFmt& rNew, sal_uInt8 nPos );
const SwBoxAutoFmt& GetBoxFmt( sal_uInt8 nPos ) const;
void SetName( const OUString& rNew ) { m_aName = rNew; nStrResId = USHRT_MAX; }
OUString GetName() const { return m_aName; }
enum UpdateFlags { UPDATE_CHAR = 1, UPDATE_BOX = 2, UPDATE_ALL = 3 };
void UpdateFromSet( sal_uInt8 nPos, const SfxItemSet& rSet,
UpdateFlags eFlags, SvNumberFormatter* );
void UpdateToSet( sal_uInt8 nPos, SfxItemSet& rSet, UpdateFlags eFlags,
SvNumberFormatter* ) const ;
void RestoreTableProperties(SwTable &table) const;
void StoreTableProperties(const SwTable &table);
bool IsFont() const { return bInclFont; }
bool IsJustify() const { return bInclJustify; }
bool IsFrame() const { return bInclFrame; }
bool IsBackground() const { return bInclBackground; }
bool IsValueFormat() const { return bInclValueFormat; }
void SetFont( const bool bNew ) { bInclFont = bNew; }
void SetJustify( const bool bNew ) { bInclJustify = bNew; }
void SetFrame( const bool bNew ) { bInclFrame = bNew; }
void SetBackground( const bool bNew ) { bInclBackground = bNew; }
void SetValueFormat( const bool bNew ) { bInclValueFormat = bNew; }
void SetWidthHeight( const bool bNew ) { bInclWidthHeight = bNew; }
bool Load( SvStream& rStream, const SwAfVersions& );
bool Save( SvStream& rStream, sal_uInt16 fileVersion ) const;
};
class SW_DLLPUBLIC SwTableAutoFmtTbl
{
struct Impl;
::boost::scoped_ptr<Impl> m_pImpl;
SAL_DLLPRIVATE bool Load( SvStream& rStream );
SAL_DLLPRIVATE bool Save( SvStream& rStream ) const;
public:
explicit SwTableAutoFmtTbl();
~SwTableAutoFmtTbl();
size_t size() const;
SwTableAutoFmt const& operator[](size_t i) const;
SwTableAutoFmt & operator[](size_t i);
void InsertAutoFmt(size_t i, SwTableAutoFmt * pFmt);
void EraseAutoFmt(size_t i);
SwTableAutoFmt* ReleaseAutoFmt(size_t i);
bool Load();
bool Save() const;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */