xref: /aoo41x/main/svx/inc/svx/svdotable.hxx (revision c2b18395)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef _SVX_SVDOTABLE_HXX
#define _SVX_SVDOTABLE_HXX

#include <com/sun/star/text/WritingMode.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/table/XTable.hpp>
#include <rtl/ref.hxx>
#include "svdotext.hxx"
#include "svx/svxdllapi.h"

//------------------------------------------------------------------------

class SvStream;
class SfxStyleSheet;

namespace sdr { namespace contact {
	class ViewContactOfTableObj;
}}

namespace sdr { namespace table {

class TableLayouter;
struct ImplTableShadowPaintInfo;

#ifndef CellRef
	class Cell;
	typedef rtl::Reference< Cell > CellRef;
#endif

//------------------------------------------------------------------------
// SdrTableHitKind
//------------------------------------------------------------------------

enum TableHitKind
{
	SDRTABLEHIT_NONE,
	SDRTABLEHIT_CELL,
	SDRTABLEHIT_CELLTEXTAREA,
	SDRTABLEHIT_HORIZONTAL_BORDER,
	SDRTABLEHIT_VERTICAL_BORDER
};

//------------------------------------------------------------------------

struct CellPos
{
	sal_Int32 mnCol;
	sal_Int32 mnRow;

	CellPos() : mnCol( 0 ), mnRow( 0 ) {}
	CellPos( sal_Int32 nCol, sal_Int32 nRow ) { mnCol = nCol; mnRow = nRow; }

	bool operator==( const CellPos& r ) const { return (r.mnCol == mnCol) && (r.mnRow == mnRow); }
	bool operator!=( const CellPos& r ) const { return (r.mnCol != mnCol) || (r.mnRow != mnRow); }
};

//------------------------------------------------------------------------
// TableStyleSettings
//------------------------------------------------------------------------

struct SVX_DLLPUBLIC TableStyleSettings
{
	bool mbUseFirstRow;
	bool mbUseLastRow;
	bool mbUseFirstColumn;
	bool mbUseLastColumn;
	bool mbUseRowBanding;
	bool mbUseColumnBanding;

	TableStyleSettings();
	TableStyleSettings( const TableStyleSettings& rStyle );
	TableStyleSettings& operator=(const TableStyleSettings& rStyle);

	bool operator==( const TableStyleSettings& r ) const;
};

//------------------------------------------------------------------------
//   SdrTableObj
//------------------------------------------------------------------------

class SdrTableObjImpl;

class SVX_DLLPUBLIC SdrTableObj : public ::SdrTextObj
{
	friend class Cell;
	friend class SdrTableObjImpl;
	friend class SdrTableModifyGuard;

public:
	SdrTableObj(SdrModel* _pModel);
	SdrTableObj(SdrModel* _pModel, const ::Rectangle& rNewRect, sal_Int32 nColumns, sal_Int32 nRows);
	virtual ~SdrTableObj();

	TYPEINFO();

	// table stuff

	SdrTableObj* CloneRange( const CellPos& rStartPos, const CellPos& rEndPos );
	void DistributeColumns( sal_Int32 nFirstColumn, sal_Int32 nLastColumn );
	void DistributeRows( sal_Int32 nFirstRow, sal_Int32 nLastRow );

	com::sun::star::uno::Reference< com::sun::star::table::XTable > getTable() const;

	bool isValid( const sdr::table::CellPos& rPos ) const;
	CellPos getFirstCell() const;
	CellPos getLastCell() const;
	CellPos getLeftCell( const CellPos& rPos, bool bEdgeTravel ) const;
	CellPos getRightCell( const CellPos& rPos, bool bEdgeTravel  ) const;
	CellPos getUpCell( const CellPos& rPos, bool bEdgeTravel ) const;
	CellPos getDownCell( const CellPos& rPos, bool bEdgeTravel ) const;
	CellPos getPreviousCell( const CellPos& rPos, bool bEdgeTravel ) const;
	CellPos getNextCell( const CellPos& rPos, bool bEdgeTravel ) const;
	CellPos getPreviousRow( const CellPos& rPos, bool bEdgeTravel ) const;
	CellPos getNextRow( const CellPos& rPos, bool bEdgeTravel ) const;

	void createCell( ::sdr::table::CellRef& xCell );

	const ::sdr::table::TableStyleSettings& getTableStyleSettings() const;
	void setTableStyleSettings( const ::sdr::table::TableStyleSettings& rStyle );

	TableHitKind CheckTableHit( const Point& rPos, sal_Int32& rnX, sal_Int32& rnY, int nTol ) const;

	void uno_lock();
	void uno_unlock();

	/** the active table has the focus or is currently edited */
	const ::sdr::table::CellRef& getActiveCell() const;

	void setActiveCell( const sdr::table::CellPos& rPos );
	void getActiveCellPos( sdr::table::CellPos& rPos ) const;

	sal_Int32 getRowCount() const;
	sal_Int32 getColumnCount() const;

	void getCellBounds( const sdr::table::CellPos& rPos, ::Rectangle& rCellRect );

	const SfxItemSet& GetActiveCellItemSet() const;

	 void InsertRows( sal_Int32 nIndex, sal_Int32 nCount = 1 );
	 void InsertColumns( sal_Int32 nIndex, sal_Int32 nCount = 1 );
	 void DeleteRows( sal_Int32 nIndex, sal_Int32 nCount = 1 );
	 void DeleteColumns( sal_Int32 nIndex, sal_Int32 nCount = 1 );

	 void setTableStyle( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& xAutoFormatStyle );
	 const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& getTableStyle() const;

	 // text stuff

	/** returns the currently active text. */
	virtual SdrText* getActiveText() const;

	/** returns the nth available text. */
	virtual SdrText* getText( sal_Int32 nIndex ) const;

	/** returns the number of texts available for this object. */
	virtual sal_Int32 getTextCount() const;

	/** changes the current active text */
	virtual void setActiveText( sal_Int32 nIndex );

	/** returns the index of the text that contains the given point or -1 */
	virtual sal_Int32 CheckTextHit(const Point& rPnt) const;

    // #121917#
    virtual bool HasText() const;

	sal_Bool IsTextEditActive() const { return (pEdtOutl != 0L); }
	bool IsTextEditActive( const sdr::table::CellPos& rPos );

	/** returns true only if we are in edit mode and the user actually changed anything */
	virtual bool IsRealyEdited() const;

	void FitFrameToTextSize();

	SdrOutliner* GetCellTextEditOutliner( const sdr::table::CellPos& rPos ) const;

	// Gleichzeitig wird der Text in den Outliner gesetzt (ggf.
	// der des EditOutliners) und die PaperSize gesetzt.
	virtual void TakeTextRect( const sdr::table::CellPos& rPos, SdrOutliner& rOutliner, ::Rectangle& rTextRect, FASTBOOL bNoEditText=sal_False, ::Rectangle* pAnchorRect=NULL, sal_Bool bLineWidth=sal_True ) const;
	virtual void TakeTextRect( SdrOutliner& rOutliner, Rectangle& rTextRect, FASTBOOL bNoEditText=sal_False, Rectangle* pAnchorRect=NULL, sal_Bool bLineWidth=sal_True ) const;
	virtual void TakeTextAnchorRect(const sdr::table::CellPos& rPos, ::Rectangle& rAnchorRect ) const;
	virtual void TakeTextAnchorRect(::Rectangle& rAnchorRect) const;

	virtual FASTBOOL IsAutoGrowHeight() const;
	long GetMinTextFrameHeight() const;
	long GetMaxTextFrameHeight() const;
	virtual FASTBOOL IsAutoGrowWidth() const;
	long GetMinTextFrameWidth() const;
	long GetMaxTextFrameWidth() const;

	virtual FASTBOOL IsFontwork() const;

	virtual void SetPage(SdrPage* pNewPage);
	virtual void SetModel(SdrModel* pNewModel);
	virtual void TakeObjInfo(SdrObjTransformInfoRec& rInfo) const;
	virtual sal_uInt16 GetObjIdentifier() const;
	virtual void SetChanged();

	virtual FASTBOOL AdjustTextFrameWidthAndHeight(Rectangle& rR, FASTBOOL bHgt=sal_True, FASTBOOL bWdt=sal_True) const;
	virtual FASTBOOL AdjustTextFrameWidthAndHeight(FASTBOOL bHgt=sal_True, FASTBOOL bWdt=sal_True);
	virtual void TakeObjNameSingul(String& rName) const;
	virtual void TakeObjNamePlural(String& rName) const;
	virtual void operator=(const SdrObject& rObj);
	virtual basegfx::B2DPolyPolygon TakeXorPoly() const;
	virtual basegfx::B2DPolyPolygon TakeContour() const;
	virtual void RecalcSnapRect();
	virtual const Rectangle& GetSnapRect() const;
	virtual void NbcSetSnapRect(const Rectangle& rRect);

	virtual const Rectangle& GetLogicRect() const;
	virtual void NbcSetLogicRect(const Rectangle& rRect);
	virtual void AdjustToMaxRect( const Rectangle& rMaxRect, bool bShrinkOnly = false );

	virtual sal_uInt32 GetSnapPointCount() const;
	virtual Point GetSnapPoint(sal_uInt32 i) const;

	virtual sal_uInt32 GetHdlCount() const;
	virtual SdrHdl* GetHdl(sal_uInt32 nHdlNum) const;
	virtual void AddToHdlList(SdrHdlList& rHdlList) const;

    // special drag methods
    virtual bool hasSpecialDrag() const;
	virtual bool beginSpecialDrag(SdrDragStat& rDrag) const;
	virtual bool applySpecialDrag(SdrDragStat& rDrag);
	virtual String getSpecialDragComment(const SdrDragStat& rDrag) const;
	virtual basegfx::B2DPolyPolygon getSpecialDragPoly(const SdrDragStat& rDrag) const;

	virtual FASTBOOL BegCreate(SdrDragStat& rStat);
	virtual FASTBOOL MovCreate(SdrDragStat& rStat);
	virtual FASTBOOL EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd);
	virtual FASTBOOL BckCreate(SdrDragStat& rStat);
	virtual void BrkCreate(SdrDragStat& rStat);
	virtual basegfx::B2DPolyPolygon TakeCreatePoly(const SdrDragStat& rDrag) const;
	virtual Pointer GetCreatePointer() const;

	virtual void NbcMove(const Size& rSiz);
	virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact);

    virtual sal_Bool BegTextEdit(SdrOutliner& rOutl);
	virtual void EndTextEdit(SdrOutliner& rOutl);
	virtual void TakeTextEditArea(Size* pPaperMin, Size* pPaperMax, Rectangle* pViewInit, Rectangle* pViewMin) const;
	virtual void TakeTextEditArea(const sdr::table::CellPos& rPos, Size* pPaperMin, Size* pPaperMax, Rectangle* pViewInit, Rectangle* pViewMin) const;
	virtual sal_uInt16 GetOutlinerViewAnchorMode() const;

	virtual void NbcSetOutlinerParaObject(OutlinerParaObject* pTextObject);

	virtual OutlinerParaObject* GetOutlinerParaObject() const;
	virtual OutlinerParaObject* GetEditOutlinerParaObject() const;

	virtual void NbcReformatText();
	virtual void ReformatText();

	void SetTextEditOutliner(SdrOutliner* pOutl) { pEdtOutl=pOutl; }

	virtual sal_Bool IsVerticalWriting() const;
	virtual void SetVerticalWriting(sal_Bool bVertical);

	com::sun::star::text::WritingMode GetWritingMode() const;

	virtual void onEditOutlinerStatusEvent( EditStatus* pEditStatus );

	////////////////////////////////////////////////////////////////////////////////////////////////////
	//
	// transformation interface for StarOfficeAPI. This implements support for
	// homogen 3x3 matrices containing the transformation of the SdrObject. At the
	// moment it contains a shearX, rotation and translation, but for setting all linear
	// transforms like Scale, ShearX, ShearY, Rotate and Translate are supported.
	//
	////////////////////////////////////////////////////////////////////////////////////////////////////
	// gets base transformation and rectangle of object. If it's an SdrPathObj it fills the PolyPolygon
	// with the base geometry and returns TRUE. Otherwise it returns FALSE.
	virtual sal_Bool TRGetBaseGeometry(basegfx::B2DHomMatrix& rMatrix, basegfx::B2DPolyPolygon& rPolyPolygon) const;

	// sets the base geometry of the object using infos contained in the homogen 3x3 matrix.
	// If it's an SdrPathObj it will use the provided geometry information. The Polygon has
	// to use (0,0) as upper left and will be scaled to the given size in the matrix.
	virtual void TRSetBaseGeometry(const basegfx::B2DHomMatrix& rMatrix, const basegfx::B2DPolyPolygon& rPolyPolygon);

	// #103836# iterates over the paragraphs of a given SdrObject and removes all
	//			hard set character attributes with the which ids contained in the
	//			given vector
//	virtual void RemoveOutlinerCharacterAttribs( const std::vector<sal_uInt16>& rCharWhichIds );

	/** hack for clipboard with calc and writer, export and import table content as rtf table */
	static void ExportAsRTF( SvStream& rStrm, SdrTableObj& rObj );
	static void ImportAsRTF( SvStream& rStrm, SdrTableObj& rObj );

private:
	void init( sal_Int32 nColumns, sal_Int32 nRows );

protected:
	virtual sdr::properties::BaseProperties* CreateObjectSpecificProperties();
	virtual sdr::contact::ViewContact* CreateObjectSpecificViewContact();

    virtual SdrObjGeoData* NewGeoData() const;
	virtual void SaveGeoData(SdrObjGeoData& rGeo) const;
	virtual void RestGeoData(const SdrObjGeoData& rGeo);

private:
	SdrOutliner* GetCellTextEditOutliner( const ::sdr::table::Cell& rCell ) const;

private:
	// for the ViewContactOfTableObj to build the primitive representation, it is necessary to access the
	// TableLayouter for position and attribute informations
	friend class sdr::contact::ViewContactOfTableObj;
	const TableLayouter& getTableLayouter() const;

	Rectangle	maLogicRect;
private:
	SdrTableObjImpl*	mpImpl;
};

////////////////////////////////////////////////////////////////////////////////////////////////////

} }

#endif