koffice/kexi/kexiutils/validator.h

/* This file is part of the KDE project
   Copyright (C) 2004, 2006 Jaroslaw Staniek <js@iidea.pl>

   This program 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 program 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 program; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef KEXI_VALIDATOR_H
#define KEXI_VALIDATOR_H

#include "kexiutils_export.h"

#include <tqvalidator.h>
#include <tqvariant.h>
#include <tqstring.h>

#include <klocale.h>

namespace KexiUtils {

//! @short A validator extending TQValidator with offline-checking for value's validity
/*! 
 The offline-checking for value's validity is provided by \ref Validator::check() method.
 The validator groups two purposes into one container:
 - string validator for line editors (online checking, "on typing");
 - offline-checking for TQVariant values, reimplementing validate().

 It also offers error and warning messages for check() method. 
 You may need to reimplement: 
 -  TQValidator::State IdentifierValidator::validate( TQString& input, int& pos ) const;
 -  Result check(const TQString &valueName, TQVariant v, TQString &message, TQString &details);
 */
class KEXIUTILS_EXPORT Validator : public TQValidator
{
	public:
		typedef enum Result { Error = 0, Ok = 1, Warning = 2 };

		Validator(TQObject * parent = 0, const char * name = 0);
		virtual ~Validator();

		/*! Sets accepting empty values on (true) or off (false). 
		 By default the validator does not accepts empty values. */
		void setAcceptsEmptyValue( bool set ) { m_acceptsEmptyValue = set; }

		/*! \return true if the validator accepts empty values
			@see setAcceptsEmptyValue() */
		bool acceptsEmptyValue() const { return m_acceptsEmptyValue; }

		/*! Checks if value \a v is ok and returns one of \a Result value:
		 - \a Error is returned on error;
		 - \a Ok on success;
		 - \a Warning if there is something to warn about.
		 In any case except \a Ok, i18n'ed message will be set in \a message 
		 and (optionally) datails are set in \a details, e.g. for use in a message box.
		 \a valueName can be used to contruct \a message as well, for example:
		 "[valueName] is not a valid login name". 
		 Depending on acceptsEmptyValue(), immediately accepts empty values or not. */
		Result check(const TQString &valueName, const TQVariant& v, TQString &message,
			TQString &details);

		/*! This implementation always returns value TQValidator::Acceptable. */
		virtual TQValidator::State validate ( TQString & input, int & pos ) const;

		//! A generic error/warning message
		static const TQString msgColumnNotEmpty() {
			return I18N_NOOP("\"%1\" value has to be entered.");
		}

		//! Adds a child validator \a v
		void addChildValidator( Validator* v );

	protected:
		/* Used by check(), for reimplementation, by default returns \a Error.*/
		virtual Result internalCheck(const TQString &valueName, const TQVariant& v, 
			TQString &message, TQString &details);

		bool m_acceptsEmptyValue : 1;

	friend class MultiValidator;
};

//! @short A validator groupping multiple TQValidators
/*! MultiValidator behaves like normal KexiUtils::Validator,
 but it allows to add define more than one different validator.
 Given validation is successful if every subvalidator accepted given value.

 - acceptsEmptyValue() is used globally here 
   (no matter what is defined in subvalidators).

 - result of calling check() depends on value of check() returned by subvalidators:
   - Error is returned if at least one subvalidator returned Error;
   - Warning is returned if at least one subvalidator returned Warning and 
     no validator returned error;
   - Ok is returned only if exactly all subvalidators returned Ok.
   - If there is no subvalidators defined, Error is always returned.
   - If a given subvalidator is not of class Validator but ust TQValidator,
     it's assumed it's check() method returned Ok.

 - result of calling validate() (a method implemented for TQValidator)
   depends on value of validate() returned by subvalidators:
   - Invalid is returned if at least one subvalidator returned Invalid
   - Intermediate is returned if at least one subvalidator returned Intermediate
   - Acceptable is returned if exactly all subvalidators returned Acceptable.
   - If there is no subvalidators defined, Invalid is always returned.

 If there are no subvalidators, the multi validator always accepts the input.
*/
class KEXIUTILS_EXPORT MultiValidator : public Validator
{
	public:
		/*! Constructs multivalidator with no subvalidators defined.
		 You can add more validators with addSubvalidator(). */
		MultiValidator(TQObject * parent = 0, const char * name = 0);

		/*! Constructs multivalidator with one validator \a validator.
		 It will be owned if has no parent defined.
		 You can add more validators with addSubvalidator(). */
		MultiValidator(TQValidator *validator, TQObject * parent = 0, const char * name = 0);

		/*! Adds validator \a validator as another subvalidator.
		 Subvalidator will be owned by this multivalidator if \a owned is true
		 and its parent is NULL. */
		void addSubvalidator( TQValidator* validator, bool owned = true );

		/*! Reimplemented to call validate() on subvalidators. */
		virtual TQValidator::State validate ( TQString & input, int & pos ) const;

		/*! Calls TQValidator::fixup() on every subvalidator. 
		 This may be senseless to use this methog in certain cases 
		 (can return weir results), so think twice before.. */
		virtual void fixup ( TQString & input ) const;

	private:
		virtual Validator::Result internalCheck(
			const TQString &valueName, const TQVariant& v, 
			TQString &message, TQString &details);


	protected:
		TQPtrList<TQValidator> m_ownedSubValidators;
		TQValueList<TQValidator*> m_subValidators;
};

}

#endif