/indra/llui/lltimectrl.h

/**
 * @file lltimectrl.h
 * @brief Time control
 *
 * $LicenseInfo:firstyear=2002&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2011, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LLTIMECTRL_H_
#define LLTIMECTRL_H_

#include "stdtypes.h"
#include "llbutton.h"
#include "v4color.h"
#include "llrect.h"

class LLLineEditor;

class LLTimeCtrl
: public LLUICtrl
{
	LOG_CLASS(LLTimeCtrl);
public:
	struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
	{
		Optional<S32> label_width;
		Optional<S32> snap_to;
		Optional<bool> allow_text_entry;

		Optional<LLUIColor> text_enabled_color;
		Optional<LLUIColor> text_disabled_color;

		Optional<LLButton::Params> up_button;
		Optional<LLButton::Params> down_button;

		Params();
	};

	F32 getTime24() const;		// 0.0 - 24.0
	U32 getHours24() const;		// 0 - 23
	U32 getMinutes() const;		// 0 - 59

	void setTime24(F32 time);	// 0.0 - 23.98(3)

protected:
	LLTimeCtrl(const Params&);
	friend class LLUICtrlFactory;

private:

	enum EDayPeriod
	{
		AM,
		PM
	};

	enum EEditingPart
	{
		HOURS,
		MINUTES,
		DAYPART,
		NONE
	};

	virtual void	onFocusLost();
	virtual BOOL	handleKeyHere(KEY key, MASK mask);

	void	onUpBtn();
	void	onDownBtn();
	void	onTextEntry(LLLineEditor* line_editor);

	bool	isTimeStringValid(const LLWString& wstr);

	void increaseMinutes();
	void increaseHours();

	void decreaseMinutes();
	void decreaseHours();

	bool isPM() const;
	void switchDayPeriod();

	void updateText();

	EEditingPart getEditingPart();

	static std::string getHoursString(const std::string& str);
	static std::string getMinutesString(const std::string& str);
	static std::string getAMPMString(const std::string& str);

	static bool isHoursStringValid(const std::string& str);
	static bool isMinutesStringValid(const std::string& str);
	static bool isPMAMStringValid(const std::string& str);

	static U32		parseHours(const std::string& str);
	static U32		parseMinutes(const std::string& str);
	static bool		parseAMPM(const std::string& str);

	class LLTextBox*	mLabelBox;

	class LLLineEditor*	mEditor;
	LLUIColor			mTextEnabledColor;
	LLUIColor			mTextDisabledColor;

	class LLButton*		mUpBtn;
	class LLButton*		mDownBtn;

	U32				mTime;				// minutes since midnight: 0 - 1439
	U32				mSnapToMin;			// interval in minutes to snap to

	BOOL			mAllowEdit;
};
#endif /* LLTIMECTRL_H_ */