1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/BACELL.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,227 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +// Written by DanH, Sept 1995
1.20 +#if !defined(__BACELL_H__)
1.21 +#define __BACELL_H__
1.22 +
1.23 +#if !defined(__E32DEF_H_)
1.24 +#include <e32def.h>
1.25 +#endif
1.26 +
1.27 +#if !defined(__S32STRM_H__)
1.28 +#include <s32strm.h>
1.29 +#endif
1.30 +
1.31 +//class RReadStream;
1.32 +//class RWriteStream;
1.33 +
1.34 +class TCellRef
1.35 +/**
1.36 +Identifies a cell by row and column number.
1.37 +@publishedAll
1.38 +@released
1.39 +*/
1.40 + {
1.41 +public:
1.42 + inline TCellRef();
1.43 + inline TCellRef(TInt aRow,TInt aCol);
1.44 +
1.45 + inline TBool operator==(const TCellRef& aCell) const;
1.46 + inline TBool operator!=(const TCellRef& aCell) const;
1.47 +
1.48 + inline TCellRef& operator+=(const TCellRef& aCell);
1.49 + inline TCellRef& operator-=(const TCellRef& aCell);
1.50 +
1.51 + IMPORT_C void Offset(TInt aRowOffset,TInt aColOffset);
1.52 +//
1.53 + IMPORT_C void InternalizeL(RReadStream& aStream);
1.54 + inline void ExternalizeL(RWriteStream& aStream) const;
1.55 +public:
1.56 + /** The row number. */
1.57 + TInt iRow;
1.58 + /** The column number. */
1.59 + TInt iCol;
1.60 + };
1.61 +
1.62 +/**
1.63 +@publishedAll
1.64 +@released
1.65 +*/
1.66 +IMPORT_C TCellRef operator+(const TCellRef& aLeft,const TCellRef& aRight);
1.67 +IMPORT_C TCellRef operator-(const TCellRef& aLeft,const TCellRef& aRight);
1.68 +
1.69 +inline TCellRef::TCellRef()
1.70 + /** Default constructor.
1.71 +
1.72 + The object's row and column number are undefined. */
1.73 + {}
1.74 +inline TCellRef::TCellRef(TInt aRow,TInt aCol)
1.75 + : iRow(aRow),iCol(aCol)
1.76 + /** Constructor taking a row and column number.
1.77 +
1.78 + @param aRow The row number.
1.79 + @param aCol The column number. */
1.80 + {}
1.81 +inline TBool TCellRef::operator==(const TCellRef& aCell) const
1.82 + /** Compares this cell with the specified cell for equality.
1.83 +
1.84 + @param aCell The cell to be compared.
1.85 + @return ETrue, if the row numbers are the same and column numbers are
1.86 + the same. */
1.87 + {return aCell.iRow==iRow && aCell.iCol==iCol;}
1.88 +inline TBool TCellRef::operator!=(const TCellRef& aCell) const
1.89 + /** Compares this cell with the specified cell for inequality.
1.90 +
1.91 + @param aCell The cell to be compared.
1.92 + @return ETrue, if the row numbers are different or the column numbers are
1.93 + different. */
1.94 + {return aCell.iRow!=iRow || aCell.iCol!=iCol;}
1.95 +inline TCellRef& TCellRef::operator+=(const TCellRef& aCell)
1.96 + /** Adds the specified cell to this cell.
1.97 +
1.98 + Addition is the process of adding the specified cell's row and column
1.99 + numbers to this cell's row and column numbers respectively.
1.100 +
1.101 + @param aCell The cell to be added.
1.102 + @return A reference to this cell object. */
1.103 + {Offset(aCell.iRow,aCell.iCol);return *this;}
1.104 +inline TCellRef& TCellRef::operator-=(const TCellRef& aCell)
1.105 + /** Subtracts the specified cell from this cell.
1.106 +
1.107 + Subtraction is the process of subtracting the specified cell's row and
1.108 + column numbers from this cell's row and column numbers respectively.
1.109 +
1.110 + @param aCell The cell to be subtracted.
1.111 + @return A reference to this cell object. */
1.112 + {Offset(-aCell.iRow,-aCell.iCol);return *this;}
1.113 +inline void TCellRef::ExternalizeL(RWriteStream& aStream) const
1.114 + /** Externalises an object of this class to a write stream.
1.115 +
1.116 + The presence of this function means that the standard templated operator<<()
1.117 + can be used to externalise objects of this class.
1.118 +
1.119 + @param aStream Stream to which the object should be externalised. */
1.120 + {aStream.WriteInt32L(iRow);aStream.WriteInt32L(iCol);}
1.121 +
1.122 +
1.123 +class TRangeRef
1.124 +/**
1.125 +Identifies a range of cells by start and end cell references.
1.126 +The range is inclusive of both the start and end cells.
1.127 +@see TCellRef
1.128 +@publishedAll
1.129 +@released
1.130 +*/
1.131 + {
1.132 +public:
1.133 + inline TRangeRef();
1.134 + inline TRangeRef(const TCellRef& aFrom,const TCellRef& aTo);
1.135 + inline TRangeRef(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol);
1.136 +
1.137 + IMPORT_C TBool operator==(const TRangeRef& aRange) const;
1.138 + inline TBool operator!=(const TRangeRef& aRange) const;
1.139 +
1.140 + inline void SetRange(const TCellRef& aFrom,const TCellRef& aTo);
1.141 + inline void SetRange(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol);
1.142 + inline TInt NoRows() const;
1.143 + inline TInt NoCols() const;
1.144 + IMPORT_C TInt NoCells() const;
1.145 + IMPORT_C TBool Contains(const TCellRef& aCell) const;
1.146 + IMPORT_C void InternalizeL(RReadStream& aStream);
1.147 + IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
1.148 +public:
1.149 + /** The start cell. */
1.150 + TCellRef iFrom;
1.151 + /** The end cell. */
1.152 + TCellRef iTo;
1.153 +public:
1.154 + class TIter; // defined outside TRangeRef class as contains TRangeRef
1.155 + };
1.156 +class TRangeRef::TIter
1.157 +/**
1.158 +@publishedAll
1.159 +@released
1.160 +*/
1.161 + {
1.162 +public:
1.163 + IMPORT_C TIter(const TRangeRef& aRangeRef);
1.164 + IMPORT_C TBool operator++();
1.165 + inline TBool InRange() const;
1.166 +public:
1.167 + TCellRef iCurrent;
1.168 +private:
1.169 + TRangeRef iRange;
1.170 + };
1.171 +
1.172 +
1.173 +inline TRangeRef::TRangeRef()
1.174 + /** Default constructor.
1.175 +
1.176 + The object's start cell and end cell are undefined. */
1.177 + {}
1.178 +inline TRangeRef::TRangeRef(const TCellRef& aFrom,const TCellRef& aTo)
1.179 + : iFrom(aFrom),iTo(aTo)
1.180 + /** Constructor taking a start and end cell.
1.181 +
1.182 + @param aFrom The start cell.
1.183 + @param aTo The end cell. */
1.184 + {}
1.185 +inline TRangeRef::TRangeRef(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol)
1.186 + : iFrom(aFromRow,aFromCol),iTo(aToRow,aToCol)
1.187 + /** Constructor taking a start row and start column number, and an end row and
1.188 + end column number.
1.189 +
1.190 + @param aFromRow The start row number.
1.191 + @param aFromCol The start column number.
1.192 + @param aToRow The end row number.
1.193 + @param aToCol The end column number. */
1.194 + {}
1.195 +inline void TRangeRef::SetRange(const TCellRef& aFrom,const TCellRef& aTo)
1.196 + /** Sets the cell range to the specified cells.
1.197 +
1.198 + @param aFrom The start cell for the range.
1.199 + @param aTo The end cell for the range. */
1.200 + {iFrom=aFrom;iTo=aTo;}
1.201 +inline void TRangeRef::SetRange(TInt aFromRow,TInt aFromCol,TInt aToRow,TInt aToCol)
1.202 + /** Sets the cell range to the specified start row and column, and end row
1.203 + and column.
1.204 +
1.205 + @param aFromRow The start row number.
1.206 + @param aFromCol The start column number.
1.207 + @param aToRow The end row number.
1.208 + @param aToCol The end column number. */
1.209 + {iFrom.iRow=aFromRow;iFrom.iCol=aFromCol;iTo.iRow=aToRow;iTo.iCol=aToCol;}
1.210 +inline TBool TRangeRef::operator!=(const TRangeRef& aRange) const
1.211 + /** Compares this cell range with the specified cell range for inequality.
1.212 +
1.213 + @param aRange The cell to be compared.
1.214 + @return ETrue, if the start cells are different or the end cells are
1.215 + different. */
1.216 + {return !operator==(aRange);}
1.217 +inline TInt TRangeRef::NoRows() const
1.218 + /** Gets the number of rows represented by the range.
1.219 +
1.220 + @return The number of rows. */
1.221 + {return iTo.iRow - iFrom.iRow + 1;}
1.222 +inline TInt TRangeRef::NoCols() const
1.223 + /** Gets the number of columns represented by the range.
1.224 +
1.225 + @return The number of columns. */
1.226 + {return iTo.iCol - iFrom.iCol + 1;}
1.227 +inline TBool TRangeRef::TIter::InRange() const
1.228 + {return iRange.Contains(iCurrent);}
1.229 +
1.230 +#endif