libRocket/Source/Controls/WidgetTextInputSingleLine.h

/*
 * This source file is part of libRocket, the HTML/CSS Interface Middleware
 *
 * For the latest information, see http://www.librocket.com
 *
 * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

#ifndef ROCKETCONTROLSWIDGETTEXTINPUTSINGLELINE_H
#define ROCKETCONTROLSWIDGETTEXTINPUTSINGLELINE_H

#include "WidgetTextInput.h"

namespace Rocket {
namespace Controls {

/**
	A specialisation of the text input widget for single-line input fields.

	@author Peter Curry
 */

class WidgetTextInputSingleLine : public WidgetTextInput
{
public:
	WidgetTextInputSingleLine(ElementFormControl* parent);
	virtual ~WidgetTextInputSingleLine();

	/// Sets the value of the text field. The value will be stripped of end-lines.
	/// @param value[in] The new value to set on the text field.
	virtual void SetValue(const Core::String& value);

protected:
	/// Returns true if the given character is permitted in the input field, false if not.
	/// @param[in] character The character to validate.
	/// @return True if the character is allowed, false if not.
	virtual bool IsCharacterValid(Rocket::Core::word character);
	/// Called when the user pressed enter.
	virtual void LineBreak();

	/// Strips all \n and \r characters from the string.
	void SanitiseValue(Core::String& value);
};

}
}

#endif