sc/inc/stringutil.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: table.hxx,v $
  10  * $Revision: 1.35 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_STRINGUTIL_HXX
  32 #define SC_STRINGUTIL_HXX
  33
  34 #include "rtl/ustring.hxx"
  35 #include "scdllapi.h"
  36
  37 class SvNumberFormatter;
  38
  39 /**
  40  * Store parameters used in the ScDocument::SetString() method.  Various
  41  * options for string-setting operation are specified herein.
  42  */
  43 struct SC_DLLPUBLIC ScSetStringParam
  44 {
  45     /**
  46      * Stores the pointer to the number formatter instance to be used during
  47      * number format detection.  The caller must manage the life cycle of the
  48      * instance.
  49      */
  50     SvNumberFormatter* mpNumFormatter;
  51
  52     /**
  53      * When true, we try to detect special number format (dates etc) from the
  54      * input string, when false, we only try to detect a basic decimal number
  55      * format.
  56      */
  57     bool mbDetectNumberFormat;
  58
  59     /**
  60      * When true, set the format of the cell to Text when a string cell is
  61      * requested for a number input.  We may want to do this during text file
  62      * import (csv, html etc).
  63      */
  64     bool mbSetTextCellFormat;
  65
  66     ScSetStringParam();
  67 };
  68
  69 // ============================================================================
  70
  71 class ScStringUtil
  72 {
  73 public:
  74     /**
  75      * Check if a given string is a simple decimal number (e.g. 12.345). We
  76      * don't do any elaborate parsing here; we only check for the simplest
  77      * case of decimal number format.
  78      *
  79      * @param rStr string to parse
  80      * @param dsep decimal separator
  81      * @param gsep group separator (aka thousands separator)
  82      * @param rVal value of successfully parsed number
  83      *
  84      * @return true if the string is a valid number, false otherwise.
  85      */
  86     static bool parseSimpleNumber(
  87         const ::rtl::OUString& rStr, sal_Unicode dsep, sal_Unicode gsep, double& rVal);
  88 };
  89
  90
  91 #endif