sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: // Written by DanH, Sept 1995
sl@0: #if !defined(__BACELL_H__)
sl@0: #define __BACELL_H__
sl@0: 
sl@0: #if !defined(__E32DEF_H_)
sl@0: #include <e32def.h>
sl@0: #endif
sl@0: 
sl@0: #if !defined(__S32STRM_H__)
sl@0: #include <s32strm.h>
sl@0: #endif
sl@0: 
sl@0: //class RReadStream;
sl@0: //class RWriteStream;
sl@0: 
sl@0: class TCellRef
sl@0: /** 
sl@0: Identifies a cell by row and column number. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	inline TCellRef();
sl@0: 	inline TCellRef(TInt aRow,TInt aCol);
sl@0: 
sl@0: 	inline TBool operator==(const TCellRef& aCell) const;
sl@0: 	inline TBool operator!=(const TCellRef& aCell) const;
sl@0: 
sl@0: 	inline TCellRef& operator+=(const TCellRef& aCell);
sl@0: 	inline TCellRef& operator-=(const TCellRef& aCell);
sl@0: 
sl@0: 	IMPORT_C void Offset(TInt aRowOffset,TInt aColOffset);
sl@0: //
sl@0: 	IMPORT_C void InternalizeL(RReadStream& aStream);
sl@0: 	inline void ExternalizeL(RWriteStream& aStream) const;
sl@0: public:
sl@0: 	/** The row number. */
sl@0: 	TInt iRow;
sl@0: 	/** The column number. */
sl@0: 	TInt iCol;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: IMPORT_C TCellRef operator+(const TCellRef& aLeft,const TCellRef& aRight);
sl@0: IMPORT_C TCellRef operator-(const TCellRef& aLeft,const TCellRef& aRight);
sl@0: 
sl@0: inline TCellRef::TCellRef()
sl@0: 	/** Default constructor.
sl@0: 	
sl@0: 	The object's row and column number are undefined. */
sl@0: 	{}
sl@0: inline TCellRef::TCellRef(TInt aRow,TInt aCol)
sl@0:     : iRow(aRow),iCol(aCol)
sl@0: 	/** Constructor taking a row and column number.
sl@0: 	
sl@0: 	@param aRow The row number.
sl@0: 	@param aCol The column number. */
sl@0: 	{}
sl@0: inline TBool TCellRef::operator==(const TCellRef& aCell) const
sl@0: 	/** Compares this cell with the specified cell for equality.
sl@0: 	
sl@0: 	@param aCell The cell to be compared.
sl@0: 	@return ETrue, if the row numbers are the same and column numbers are 
sl@0: 	the same. */
sl@0: 	{return aCell.iRow==iRow && aCell.iCol==iCol;}
sl@0: inline TBool TCellRef::operator!=(const TCellRef& aCell) const
sl@0: 	/** Compares this cell with the specified cell for inequality.
sl@0: 	
sl@0: 	@param aCell The cell to be compared.
sl@0: 	@return ETrue, if the row numbers are different or the column numbers are 
sl@0: 	different. */
sl@0: 	{return aCell.iRow!=iRow || aCell.iCol!=iCol;}
sl@0: inline TCellRef& TCellRef::operator+=(const TCellRef& aCell)
sl@0: 	/** Adds the specified cell to this cell.
sl@0: 	
sl@0: 	Addition is the process of adding the specified cell's row and column 
sl@0: 	numbers to this cell's row and column numbers respectively.
sl@0: 	
sl@0: 	@param aCell The cell to be added.
sl@0: 	@return A reference to this cell object. */
sl@0: 	{Offset(aCell.iRow,aCell.iCol);return *this;}
sl@0: inline TCellRef& TCellRef::operator-=(const TCellRef& aCell)
sl@0: 	/** Subtracts the specified cell from this cell.
sl@0: 	
sl@0: 	Subtraction is the process of subtracting the specified cell's row and 
sl@0: 	column numbers from this cell's row and column numbers respectively.
sl@0: 	
sl@0: 	@param aCell The cell to be subtracted.
sl@0: 	@return A reference to this cell object. */
sl@0: 	{Offset(-aCell.iRow,-aCell.iCol);return *this;}
sl@0: inline void TCellRef::ExternalizeL(RWriteStream& aStream) const
sl@0: 	/** Externalises an object of this class to a write stream.
sl@0: 	
sl@0: 	The presence of this function means that the standard templated operator<<() 
sl@0: 	can be used to externalise objects of this class. 
sl@0: 	
sl@0: 	@param aStream Stream to which the object should be externalised. */
sl@0: 	{aStream.WriteInt32L(iRow);aStream.WriteInt32L(iCol);}
sl@0: 
sl@0: 
sl@0: class TRangeRef
sl@0: /** 
sl@0: Identifies a range of cells by start and end cell references.
sl@0: The range is inclusive of both the start and end cells.
sl@0: @see TCellRef
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	inline TRangeRef();
sl@0: 	inline TRangeRef(const TCellRef& aFrom,const TCellRef& aTo);
sl@0: 	inline TRangeRef(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol);
sl@0: 
sl@0: 	IMPORT_C TBool operator==(const TRangeRef& aRange) const;
sl@0: 	inline TBool operator!=(const TRangeRef& aRange) const;
sl@0: 
sl@0: 	inline void SetRange(const TCellRef& aFrom,const TCellRef& aTo);
sl@0: 	inline void SetRange(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol);
sl@0: 	inline TInt NoRows() const;
sl@0: 	inline TInt NoCols() const;
sl@0: 	IMPORT_C TInt NoCells() const;
sl@0: 	IMPORT_C TBool Contains(const TCellRef& aCell) const;
sl@0: 	IMPORT_C void InternalizeL(RReadStream& aStream);
sl@0: 	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
sl@0: public:
sl@0: 	/** The start cell. */
sl@0: 	TCellRef	iFrom;
sl@0: 	/** The end cell. */
sl@0: 	TCellRef	iTo;
sl@0: public:
sl@0: 	class TIter;	// defined outside TRangeRef class as contains TRangeRef
sl@0: 	};
sl@0: class TRangeRef::TIter
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TIter(const TRangeRef& aRangeRef);
sl@0: 	IMPORT_C TBool operator++();
sl@0: 	inline TBool InRange() const;
sl@0: public:
sl@0: 	TCellRef	iCurrent;
sl@0: private:
sl@0: 	TRangeRef	iRange;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: inline TRangeRef::TRangeRef()
sl@0: 	/** Default constructor.
sl@0: 	
sl@0: 	The object's start cell and end cell are undefined. */
sl@0: 	{}
sl@0: inline TRangeRef::TRangeRef(const TCellRef& aFrom,const TCellRef& aTo)
sl@0: 	: iFrom(aFrom),iTo(aTo)
sl@0: 	/** Constructor taking a start and end cell.
sl@0: 	
sl@0: 	@param aFrom The start cell.
sl@0: 	@param aTo The end cell. */
sl@0: 	{}
sl@0: inline TRangeRef::TRangeRef(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol)
sl@0: 	: iFrom(aFromRow,aFromCol),iTo(aToRow,aToCol)
sl@0: 	/** Constructor taking a start row and start column number, and an end row and 
sl@0: 	end column number.
sl@0: 	
sl@0: 	@param aFromRow The start row number.
sl@0: 	@param aFromCol The start column number.
sl@0: 	@param aToRow The end row number.
sl@0: 	@param aToCol The end column number. */
sl@0: 	{}
sl@0: inline void TRangeRef::SetRange(const TCellRef& aFrom,const TCellRef& aTo)
sl@0: 	/** Sets the cell range to the specified cells.
sl@0: 	
sl@0: 	@param aFrom The start cell for the range.
sl@0: 	@param aTo The end cell for the range. */
sl@0: 	{iFrom=aFrom;iTo=aTo;}
sl@0: inline void TRangeRef::SetRange(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol)
sl@0: 	/** Sets the cell range to the specified start row and column, and end row 
sl@0: 	and column.
sl@0: 	
sl@0: 	@param aFromRow The start row number.
sl@0: 	@param aFromCol The start column number.
sl@0: 	@param aToRow The end row number.
sl@0: 	@param aToCol The end column number. */
sl@0: 	{iFrom.iRow=aFromRow;iFrom.iCol=aFromCol;iTo.iRow=aToRow;iTo.iCol=aToCol;}
sl@0: inline TBool TRangeRef::operator!=(const TRangeRef& aRange) const
sl@0: 	/** Compares this cell range with the specified cell range for inequality.
sl@0: 	
sl@0: 	@param aRange The cell to be compared.
sl@0: 	@return ETrue, if the start cells are different or the end cells are 
sl@0: 	different. */
sl@0: 	{return !operator==(aRange);}
sl@0: inline TInt TRangeRef::NoRows() const
sl@0: 	/** Gets the number of rows represented by the range.
sl@0: 	
sl@0: 	@return The number of rows. */
sl@0: 	{return iTo.iRow - iFrom.iRow + 1;}
sl@0: inline TInt TRangeRef::NoCols() const
sl@0: 	/** Gets the number of columns represented by the range.
sl@0: 	
sl@0: 	@return The number of columns. */
sl@0: 	{return iTo.iCol - iFrom.iCol + 1;}
sl@0: inline TBool TRangeRef::TIter::InRange() const
sl@0: 	{return iRange.Contains(iCurrent);}
sl@0: 
sl@0: #endif