office-gobmx/sc/inc/stringutil.hxx
2011-01-21 10:13:09 +01:00

93 lines
3 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SC_STRINGUTIL_HXX
#define SC_STRINGUTIL_HXX
#include "rtl/ustring.hxx"
#include "scdllapi.h"
class SvNumberFormatter;
/**
* Store parameters used in the ScDocument::SetString() method. Various
* options for string-setting operation are specified herein.
*/
struct SC_DLLPUBLIC ScSetStringParam
{
/**
* Stores the pointer to the number formatter instance to be used during
* number format detection. The caller must manage the life cycle of the
* instance.
*/
SvNumberFormatter* mpNumFormatter;
/**
* When true, we try to detect special number format (dates etc) from the
* input string, when false, we only try to detect a basic decimal number
* format.
*/
bool mbDetectNumberFormat;
/**
* When true, set the format of the cell to Text when a string cell is
* requested for a number input. We may want to do this during text file
* import (csv, html etc).
*/
bool mbSetTextCellFormat;
ScSetStringParam();
};
// ============================================================================
class ScStringUtil
{
public:
/**
* Check if a given string is a simple decimal number (e.g. 12.345). We
* don't do any elaborate parsing here; we only check for the simplest
* case of decimal number format.
*
* Note that preceding and trailing spaces are ignored during parsing.
*
* @param rStr string to parse
* @param dsep decimal separator
* @param gsep group separator (aka thousands separator)
* @param rVal value of successfully parsed number
*
* @return true if the string is a valid number, false otherwise.
*/
static bool parseSimpleNumber(
const ::rtl::OUString& rStr, sal_Unicode dsep, sal_Unicode gsep, double& rVal);
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */