office-gobmx/sc/inc/attrib.hxx
Noel Grandin 7e018afaf7 simplify return argument of SfxPoolItem::GetPresentation
since all two of the actual call-sites only care about whether
it is a valid presentation or not, not what kind of presentation it is.

Change-Id: I75717c88878d37b2897741b0c833ff283b3fee59
2014-07-29 11:04:01 +02:00

392 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_SC_INC_ATTRIB_HXX
#define INCLUDED_SC_INC_ATTRIB_HXX
#include <svl/poolitem.hxx>
#include <svl/intitem.hxx>
#include <svl/eitem.hxx>
#include "scdllapi.h"
#include "global.hxx"
#include "address.hxx"
// flags for cells hidden by merge
// and control for auto filter
#define SC_MF_HOR 0x0001
#define SC_MF_VER 0x0002
#define SC_MF_AUTO 0x0004 /// autofilter arrow
#define SC_MF_BUTTON 0x0008 /// field button for datapilot
#define SC_MF_SCENARIO 0x0010
#define SC_MF_BUTTON_POPUP 0x0020 /// dp button with popup arrow
#define SC_MF_HIDDEN_MEMBER 0x0040 /// dp field button with presence of hidden member
#define SC_MF_DP_TABLE 0x0080 /// dp table output
#define SC_MF_ALL 0x00FF
class EditTextObject;
namespace editeng { class SvxBorderLine; }
bool SC_DLLPUBLIC ScHasPriority( const ::editeng::SvxBorderLine* pThis, const ::editeng::SvxBorderLine* pOther );
class SC_DLLPUBLIC ScMergeAttr: public SfxPoolItem
{
SCsCOL nColMerge;
SCsROW nRowMerge;
public:
TYPEINFO_OVERRIDE();
ScMergeAttr();
ScMergeAttr( SCsCOL nCol, SCsROW nRow = 0);
ScMergeAttr( const ScMergeAttr& );
virtual ~ScMergeAttr();
virtual OUString GetValueText() const;
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Create( SvStream& rStream, sal_uInt16 nVer ) const SAL_OVERRIDE;
SCsCOL GetColMerge() const {return nColMerge; }
SCsROW GetRowMerge() const {return nRowMerge; }
bool IsMerged() const { return nColMerge>1 || nRowMerge>1; }
inline ScMergeAttr& operator=(const ScMergeAttr& rMerge)
{
nColMerge = rMerge.nColMerge;
nRowMerge = rMerge.nRowMerge;
return *this;
}
};
class SC_DLLPUBLIC ScMergeFlagAttr: public SfxInt16Item
{
public:
ScMergeFlagAttr();
ScMergeFlagAttr(sal_Int16 nFlags);
virtual ~ScMergeFlagAttr();
bool IsHorOverlapped() const { return ( GetValue() & SC_MF_HOR ) != 0; }
bool IsVerOverlapped() const { return ( GetValue() & SC_MF_VER ) != 0; }
bool IsOverlapped() const { return ( GetValue() & ( SC_MF_HOR | SC_MF_VER ) ) != 0; }
bool HasAutoFilter() const { return ( GetValue() & SC_MF_AUTO ) != 0; }
bool IsScenario() const { return ( GetValue() & SC_MF_SCENARIO ) != 0; }
bool HasPivotButton() const;
bool HasPivotPopupButton() const;
};
class SC_DLLPUBLIC ScProtectionAttr: public SfxPoolItem
{
bool bProtection; ///< protect cell
bool bHideFormula; ///< hide formula
bool bHideCell; ///< hide cell
bool bHidePrint; ///< don't print cell
public:
TYPEINFO_OVERRIDE();
ScProtectionAttr();
ScProtectionAttr( bool bProtect,
bool bHFormula = false,
bool bHCell = false,
bool bHPrint = false);
ScProtectionAttr( const ScProtectionAttr& );
virtual ~ScProtectionAttr();
virtual OUString GetValueText() const;
virtual bool GetPresentation(
SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString& rText,
const IntlWrapper* pIntl = 0 ) const SAL_OVERRIDE;
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Create( SvStream& rStream, sal_uInt16 nVer ) const SAL_OVERRIDE;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
bool GetProtection() const { return bProtection; }
bool SetProtection( bool bProtect);
bool GetHideFormula() const { return bHideFormula; }
bool SetHideFormula( bool bHFormula);
bool GetHideCell() const { return bHideCell; }
bool SetHideCell( bool bHCell);
bool GetHidePrint() const { return bHidePrint; }
bool SetHidePrint( bool bHPrint);
inline ScProtectionAttr& operator=(const ScProtectionAttr& rProtection)
{
bProtection = rProtection.bProtection;
bHideFormula = rProtection.bHideFormula;
bHideCell = rProtection.bHideCell;
bHidePrint = rProtection.bHidePrint;
return *this;
}
};
// ScRangeItem: manages an area of a table
#define SCR_INVALID 0x01
#define SCR_ALLTABS 0x02
#define SCR_TONEWTAB 0x04
class ScRangeItem : public SfxPoolItem
{
public:
TYPEINFO_OVERRIDE();
inline ScRangeItem( const sal_uInt16 nWhich );
inline ScRangeItem( const sal_uInt16 nWhich,
const ScRange& rRange,
const sal_uInt16 nNewFlags = 0 );
inline ScRangeItem( const ScRangeItem& rCpy );
inline ScRangeItem& operator=( const ScRangeItem &rCpy );
// "pure virtual methods" from SfxPoolItem
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual bool GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString &rText,
const IntlWrapper* pIntl = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
const ScRange& GetRange() const { return aRange; }
void SetRange( const ScRange& rNew ) { aRange = rNew; }
sal_uInt16 GetFlags() const { return nFlags; }
void SetFlags( sal_uInt16 nNew ) { nFlags = nNew; }
private:
ScRange aRange;
sal_uInt16 nFlags;
};
inline ScRangeItem::ScRangeItem( const sal_uInt16 nWhichP )
: SfxPoolItem( nWhichP ), nFlags( SCR_INVALID ) // == invalid area
{
}
inline ScRangeItem::ScRangeItem( const sal_uInt16 nWhichP,
const ScRange& rRange,
const sal_uInt16 nNew )
: SfxPoolItem( nWhichP ), aRange( rRange ), nFlags( nNew )
{
}
inline ScRangeItem::ScRangeItem( const ScRangeItem& rCpy )
: SfxPoolItem( rCpy.Which() ), aRange( rCpy.aRange ), nFlags( rCpy.nFlags )
{}
inline ScRangeItem& ScRangeItem::operator=( const ScRangeItem &rCpy )
{
aRange = rCpy.aRange;
return *this;
}
// ScTableListItem: manages a list of tables
class ScTableListItem : public SfxPoolItem
{
public:
TYPEINFO_OVERRIDE();
inline ScTableListItem( const sal_uInt16 nWhich );
ScTableListItem( const ScTableListItem& rCpy );
virtual ~ScTableListItem();
ScTableListItem& operator=( const ScTableListItem &rCpy );
// "pure virtual Methoden" from SfxPoolItem
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual bool GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString &rText,
const IntlWrapper* pIntl = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
public:
sal_uInt16 nCount;
SCTAB* pTabArr;
};
inline ScTableListItem::ScTableListItem( const sal_uInt16 nWhichP )
: SfxPoolItem(nWhichP), nCount(0), pTabArr(NULL)
{}
// page format item: contents of header and footer
#define SC_HF_LEFTAREA 1
#define SC_HF_CENTERAREA 2
#define SC_HF_RIGHTAREA 3
class SC_DLLPUBLIC ScPageHFItem : public SfxPoolItem
{
EditTextObject* pLeftArea;
EditTextObject* pCenterArea;
EditTextObject* pRightArea;
public:
TYPEINFO_OVERRIDE();
ScPageHFItem( sal_uInt16 nWhich );
ScPageHFItem( const ScPageHFItem& rItem );
virtual ~ScPageHFItem();
virtual OUString GetValueText() const;
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Create( SvStream& rStream, sal_uInt16 nVer ) const SAL_OVERRIDE;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
const EditTextObject* GetLeftArea() const { return pLeftArea; }
const EditTextObject* GetCenterArea() const { return pCenterArea; }
const EditTextObject* GetRightArea() const { return pRightArea; }
void SetLeftArea( const EditTextObject& rNew );
void SetCenterArea( const EditTextObject& rNew );
void SetRightArea( const EditTextObject& rNew );
// Set method with pointer assignment, nArea see defines above
void SetArea( EditTextObject *pNew, int nArea );
};
// page format item: contents of header and footer
class SC_DLLPUBLIC ScViewObjectModeItem: public SfxEnumItem
{
public:
TYPEINFO_OVERRIDE();
ScViewObjectModeItem( sal_uInt16 nWhich );
ScViewObjectModeItem( sal_uInt16 nWhich, ScVObjMode eMode );
virtual ~ScViewObjectModeItem();
virtual sal_uInt16 GetValueCount() const SAL_OVERRIDE;
virtual OUString GetValueText( sal_uInt16 nVal ) const;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Create(SvStream &, sal_uInt16) const SAL_OVERRIDE;
virtual sal_uInt16 GetVersion( sal_uInt16 nFileVersion ) const SAL_OVERRIDE;
virtual bool GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
SfxMapUnit ePresMetric,
OUString& rText,
const IntlWrapper* pIntl = 0 ) const SAL_OVERRIDE;
};
class ScDoubleItem : public SfxPoolItem
{
public:
TYPEINFO_OVERRIDE();
ScDoubleItem( sal_uInt16 nWhich, double nVal=0 );
ScDoubleItem( const ScDoubleItem& rItem );
virtual ~ScDoubleItem();
virtual OUString GetValueText() const;
virtual bool operator==( const SfxPoolItem& ) const SAL_OVERRIDE;
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const SAL_OVERRIDE;
virtual SfxPoolItem* Create( SvStream& rStream, sal_uInt16 nVer ) const SAL_OVERRIDE;
double GetValue() const { return nValue; }
void SetValue( const double nVal ) { nValue = nVal;}
private:
double nValue;
};
/** Member ID for "page scale to width" value in QueryValue() and PutValue(). */
const sal_uInt8 SC_MID_PAGE_SCALETO_WIDTH = 1;
/** Member ID for "page scale to height" value in QueryValue() and PutValue(). */
const sal_uInt8 SC_MID_PAGE_SCALETO_HEIGHT = 2;
/** Contains the "scale to width/height" attribute in page styles. */
class SC_DLLPUBLIC ScPageScaleToItem : public SfxPoolItem
{
public:
TYPEINFO_OVERRIDE();
/** Default c'tor sets the width and height to 0. */
explicit ScPageScaleToItem();
explicit ScPageScaleToItem( sal_uInt16 nWidth, sal_uInt16 nHeight );
virtual ~ScPageScaleToItem();
virtual ScPageScaleToItem* Clone( SfxItemPool* = 0 ) const SAL_OVERRIDE;
virtual bool operator==( const SfxPoolItem& rCmp ) const SAL_OVERRIDE;
inline sal_uInt16 GetWidth() const { return mnWidth; }
inline sal_uInt16 GetHeight() const { return mnHeight; }
inline bool IsValid() const { return mnWidth || mnHeight; }
inline void SetWidth( sal_uInt16 nWidth ) { mnWidth = nWidth; }
inline void SetHeight( sal_uInt16 nHeight ) { mnHeight = nHeight; }
inline void Set( sal_uInt16 nWidth, sal_uInt16 nHeight )
{ mnWidth = nWidth; mnHeight = nHeight; }
inline void SetInvalid() { mnWidth = mnHeight = 0; }
virtual bool GetPresentation(
SfxItemPresentation ePresentation,
SfxMapUnit, SfxMapUnit,
OUString& rText,
const IntlWrapper* = 0 ) const SAL_OVERRIDE;
virtual bool QueryValue( ::com::sun::star::uno::Any& rAny, sal_uInt8 nMemberId = 0 ) const SAL_OVERRIDE;
virtual bool PutValue( const ::com::sun::star::uno::Any& rAny, sal_uInt8 nMemberId = 0 ) SAL_OVERRIDE;
private:
sal_uInt16 mnWidth;
sal_uInt16 mnHeight;
};
class ScCondFormatItem : public SfxPoolItem
{
public:
TYPEINFO_OVERRIDE();
explicit ScCondFormatItem();
explicit ScCondFormatItem(const std::vector<sal_uInt32>& nIndex);
virtual ~ScCondFormatItem();
virtual bool operator==(const SfxPoolItem& rCmp ) const SAL_OVERRIDE;
virtual ScCondFormatItem* Clone( SfxItemPool* = 0 ) const SAL_OVERRIDE;
const std::vector<sal_uInt32>& GetCondFormatData() const { return maIndex;}
void AddCondFormatData( sal_uInt32 nIndex );
void SetCondFormatData( const std::vector<sal_uInt32>& aIndex );
void RemoveCondFormatData( sal_uInt32 nIndex );
private:
std::vector<sal_uInt32> maIndex;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */