File indexing completed on 2024-04-28 16:21:34

 /* This file is part of the KDE project
    Copyright 2006,2007 Stefan Nikolaus <stefan.nikolaus@kdemail.net>
    Copyright 1998,1999 Torben Weis <weis@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */
 
 #ifndef CALLIGRA_SHEETS_UTIL
 #define CALLIGRA_SHEETS_UTIL
 
 #include <QString>
 #include <QRect>
 
 #include <KoXmlReader.h>
 
 #include "sheets_odf_export.h"
 #include "Global.h"
 #include "Value.h"
 
 class QFont;
 class QPen;
 class QDomElement;
 class QDomDocument;
 
 class KLocale;
 
 bool util_isPointValid(const QPoint& point);
 bool util_isRectValid(const QRect& rect);
 
 namespace Calligra
 {
 namespace Sheets
 {
 class Cell;
 class Sheet;
 
 namespace Util
 {
 /**
  * Call this function to decode the text of a column label to an integer,
  * e.g. 1 for A and 27 for AA.
  * Converted are all characters matching [A-Za-z]+ regular expression, the rest is ignored.
  * 0 is returned if no characters match.
  */
 CALLIGRA_SHEETS_ODF_EXPORT int decodeColumnLabelText(const QString &labelText);
 
 /**
  * Call this function to decode the text of a row label to an integer,
  * e.g. B7 is translated to 7.
  */
 CALLIGRA_SHEETS_ODF_EXPORT int decodeRowLabelText(const QString &labelText);
 
 /**
  * Call this function to encode an integer to the text of the column label
  * i.e. 27->AA
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString encodeColumnLabelText(int column);
 
 /**
  * Returns true if the given text is a cell-reference.
  *
  * This is an optimized version of QRegExp("^(\\$?)([a-zA-Z]+)(\\$?)([0-9]+)$")
  * to check if the given string is a cell-reference like $A$1 or D17. Note
  * that this will return false for cell-ranges like A1:B2 or cell-references
  * given with sheet-name like Sheet1:A1.
  *
  * @param text The text to check
  * @param startPos The position in the string where we should start to check
  */
 CALLIGRA_SHEETS_ODF_EXPORT bool isCellReference(const QString &text, int startPos = 0);
 
 /**
  * Generate and return the ODF formula for this cell (\p thisRow, \p thisColumn) based on the formula in the
  * defined cell (\p referencedRow, \p referencedColumn ).
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString adjustFormulaReference(const QString& formula, int referencedRow, int referencedColumn, int thisRow, int thisColumn);
 
 //Return true when it's a reference to cell from sheet.
 CALLIGRA_SHEETS_ODF_EXPORT bool localReferenceAnchor(const QString &_ref);
 
 // TODO Stefan: used nowhere
 int         penCompare(QPen const & pen1, QPen const & pen2);
 }
 
 /**
  * \ingroup NativeFormat
  * This namespace collects methods related to old KSpread file format
  * encoding/decoding.
  */
 namespace NativeFormat
 {
 /**
  * \ingroup NativeFormat
  */
 QDomElement createElement(const QString & tagName, const QFont & font, QDomDocument & doc);
 
 /**
  * \ingroup NativeFormat
  */
 QDomElement createElement(const QString & tagname, const QPen & pen, QDomDocument & doc);
 
 /**
  * \ingroup NativeFormat
  */
 QFont       toFont(KoXmlElement & element);
 
 /**
  * \ingroup NativeFormat
  */
 QPen        toPen(KoXmlElement & element);
 }
 
 /**
  * \ingroup OpenDocument
  * This namespace collects methods related to OpenDocument
  * encoding/decoding.
  */
 namespace Odf
 {
 /**
  * \ingroup OpenDocument
  * Converts an OpenDocument representation of a formula to a localized formula.
  * @param expression_ The expression to convert from OpenDocument format.
  * @param locale The locale to which the expression should be converted.
  * @param namespacePrefix The namespace prefix.
  * \note Use Odf::loadRegion() for plain cell references.
  */
 // TODO check visibility
 CALLIGRA_SHEETS_ODF_EXPORT QString decodeFormula(const QString& expression_, const KLocale *locale = 0, const QString &namespacePrefix = QString());
 
 /**
  * \ingroup OpenDocument
  * Converts a localized formula to an OpenDocument representation of a formula.
  * @param expr The expression to convert to OpenDocument format.
  * @param locale The locale from which the expression should be converted.
  * \note Use Region::saveOdf() for plain cell references.
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString encodeFormula(const QString& expr, const KLocale* locale = 0);
 
 /**
  * \ingroup OpenDocument
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString convertRefToRange(const QString & sheet, const QRect & rect);
 
 /**
  * \ingroup OpenDocument
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString convertRefToBase(const QString & sheet, const QRect & rect);
 
 /**
  * \ingroup OpenDocument
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString convertRangeToRef(const QString & sheetName, const QRect & _area);
 }
 
 namespace MSOOXML
 {
 /**
  * Convert the MSOOXML \p formula into a ODF formula and return that ODF formula.
  */
 CALLIGRA_SHEETS_ODF_EXPORT QString convertFormula(const QString& formula);
 }
 
 } // namespace Sheets
 } // namespace Calligra
 
 #endif // CALLIGRA_SHEETS_UTIL