office-gobmx/include/editeng/boxitem.hxx
Bjoern Michaelsen b9337e22ce execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/
and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details

Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
2013-04-23 22:20:31 +02:00

226 lines
9.6 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 _SVX_BOXITEM_HXX
#define _SVX_BOXITEM_HXX
#include <svl/poolitem.hxx>
#include <editeng/borderline.hxx>
#include <editeng/editengdllapi.h>
#include <com/sun/star/table/BorderLine2.hpp>
// class SvxBoxItem ------------------------------------------------------
/* [Description]
This item describes a border attribute
(all four edges and the inward distance)
*/
#define BOX_LINE_TOP ((sal_uInt16)0)
#define BOX_LINE_BOTTOM ((sal_uInt16)1)
#define BOX_LINE_LEFT ((sal_uInt16)2)
#define BOX_LINE_RIGHT ((sal_uInt16)3)
/**
This version causes SvxBoxItem to store the 4 cell spacing distances separately
when serializing to stream.
*/
#define BOX_4DISTS_VERSION ((sal_uInt16)1)
/**
This version causes SvxBoxItem to store the styles for its border lines when
serializing to stream.
*/
#define BOX_BORDER_STYLE_VERSION ((sal_uInt16)2)
class EDITENG_DLLPUBLIC SvxBoxItem : public SfxPoolItem
{
editeng::SvxBorderLine *pTop,
*pBottom,
*pLeft,
*pRight;
sal_uInt16 nTopDist,
nBottomDist,
nLeftDist,
nRightDist;
public:
TYPEINFO();
explicit SvxBoxItem( const sal_uInt16 nId );
SvxBoxItem( const SvxBoxItem &rCpy );
~SvxBoxItem();
SvxBoxItem &operator=( const SvxBoxItem& rBox );
// "pure virtual Methods" from SfxPoolItem
virtual int operator==( const SfxPoolItem& ) const;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 );
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString &rText, const IntlWrapper * = 0 ) const;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const;
virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const;
virtual SvStream& Store(SvStream &, sal_uInt16 nItemVersion ) const;
virtual sal_uInt16 GetVersion( sal_uInt16 nFileVersion ) const;
virtual bool ScaleMetrics( long nMult, long nDiv );
virtual bool HasMetrics() const;
const editeng::SvxBorderLine* GetTop() const { return pTop; }
const editeng::SvxBorderLine* GetBottom() const { return pBottom; }
const editeng::SvxBorderLine* GetLeft() const { return pLeft; }
const editeng::SvxBorderLine* GetRight() const { return pRight; }
const editeng::SvxBorderLine* GetLine( sal_uInt16 nLine ) const;
//The Pointers are being copied!
void SetLine( const editeng::SvxBorderLine* pNew, sal_uInt16 nLine );
sal_uInt16 GetDistance( sal_uInt16 nLine ) const;
sal_uInt16 GetDistance() const;
void SetDistance( sal_uInt16 nNew, sal_uInt16 nLine );
inline void SetDistance( sal_uInt16 nNew );
// Line width plus Space plus inward distance
//bIgnoreLine = TRUE -> Also return distance, when no Line is set
sal_uInt16 CalcLineSpace( sal_uInt16 nLine, sal_Bool bIgnoreLine = sal_False ) const;
static com::sun::star::table::BorderLine2 SvxLineToLine( const editeng::SvxBorderLine* pLine, sal_Bool bConvert );
static sal_Bool LineToSvxLine(const ::com::sun::star::table::BorderLine& rLine, editeng::SvxBorderLine& rSvxLine, sal_Bool bConvert);
static sal_Bool LineToSvxLine(const ::com::sun::star::table::BorderLine2& rLine, editeng::SvxBorderLine& rSvxLine, sal_Bool bConvert);
};
inline void SvxBoxItem::SetDistance( sal_uInt16 nNew )
{
nTopDist = nBottomDist = nLeftDist = nRightDist = nNew;
}
// class SvxBoxInfoItem --------------------------------------------------
/* [Description]
Another item for the border. This item has only limited functionality.
On one hand, the general Dialog is told by the item which options it
should offer. On the other hand, this attribute may be used to
transported the borderline for the inner horizontal and vertical lines.
*/
#define BOXINFO_LINE_HORI ((sal_uInt16)0)
#define BOXINFO_LINE_VERT ((sal_uInt16)1)
#define VALID_TOP 0x01
#define VALID_BOTTOM 0x02
#define VALID_LEFT 0x04
#define VALID_RIGHT 0x08
#define VALID_HORI 0x10
#define VALID_VERT 0x20
#define VALID_DISTANCE 0x40
#define VALID_DISABLE 0x80
class EDITENG_DLLPUBLIC SvxBoxInfoItem : public SfxPoolItem
{
editeng::SvxBorderLine* pHori; //inner horizontal Line
editeng::SvxBorderLine* pVert; //inner vertical Line
bool mbEnableHor; /// true = Enable inner horizontal line.
bool mbEnableVer; /// true = Enable inner vertical line.
/*
Currently only for StarWriter: distance inward from SvxBoxItem. If the
distance is requested, then the field for the distance from the dialog be
activated. nDefDist is regarded as a default value. If any line is
turned on or will be turned on it must this distance be set to default.
bMinDist indicates whether the user can go below this value or not.
With NDIST is the current distance from the app transported back and
forth to the dialogue.
*/
sal_Bool bDist :1; // TRUE, Unlock Distance.
sal_Bool bMinDist :1; // TRUE, Going below minimum Distance is prohibited
sal_uInt8 nValidFlags; // 0000 0000
// ³³³³ ³³³ÀÄ VALID_TOP
// ³³³³ ³³ÀÄÄ VALID_BOTTOM
// ³³³³ ³ÀÄÄÄ VALID_LEFT
// ³³³³ ÀÄÄÄÄ VALID_RIGHT
// ³³³ÀÄÄÄÄÄÄ VALID_HORI
// ³³ÀÄÄÄÄÄÄÄ VALID_VERT
// ³ÀÄÄÄÄÄÄÄÄ VALID_DIST
// ÀÄÄÄÄÄÄÄÄÄ VALID_DISABLE
sal_uInt16 nDefDist; // The default or minimum distance.
public:
TYPEINFO();
explicit SvxBoxInfoItem( const sal_uInt16 nId );
SvxBoxInfoItem( const SvxBoxInfoItem &rCpy );
~SvxBoxInfoItem();
SvxBoxInfoItem &operator=( const SvxBoxInfoItem &rCpy );
// "pure virtual Methods" from SfxPoolItem
virtual int operator==( const SfxPoolItem& ) const;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString &rText, const IntlWrapper * = 0 ) const;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 );
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const;
virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const;
virtual SvStream& Store(SvStream &, sal_uInt16 nItemVersion ) const;
virtual bool ScaleMetrics( long nMult, long nDiv );
virtual bool HasMetrics() const;
const editeng::SvxBorderLine* GetHori() const { return pHori; }
const editeng::SvxBorderLine* GetVert() const { return pVert; }
//The Pointers are being copied!
void SetLine( const editeng::SvxBorderLine* pNew, sal_uInt16 nLine );
sal_Bool IsTable() const { return mbEnableHor && mbEnableVer; }
void SetTable( sal_Bool bNew ) { mbEnableHor = mbEnableVer = bNew; }
inline bool IsHorEnabled() const { return mbEnableHor; }
inline void EnableHor( bool bEnable ) { mbEnableHor = bEnable; }
inline bool IsVerEnabled() const { return mbEnableVer; }
inline void EnableVer( bool bEnable ) { mbEnableVer = bEnable; }
sal_Bool IsDist() const { return bDist; }
void SetDist( sal_Bool bNew ) { bDist = bNew; }
sal_Bool IsMinDist() const { return bMinDist; }
void SetMinDist( sal_Bool bNew ) { bMinDist = bNew; }
sal_uInt16 GetDefDist() const { return nDefDist; }
void SetDefDist( sal_uInt16 nNew ) { nDefDist = nNew; }
sal_Bool IsValid( sal_uInt8 nValid ) const
{ return ( nValidFlags & nValid ) == nValid; }
void SetValid( sal_uInt8 nValid, sal_Bool bValid = sal_True )
{ bValid ? ( nValidFlags |= nValid )
: ( nValidFlags &= ~nValid ); }
void ResetFlags();
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */