//------------------------------------------------------------------------------
// Lamp : Open source game middleware
// Copyright (C) 2004  Junpei Ohtani ( Email : junpee@users.sourceforge.jp )
//
// 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; either
// version 2.1 of the License, or (at your option) any later version.
//
// 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//------------------------------------------------------------------------------

/** @file
 * パッドヘッダ
 * @author Junpee
 */

#ifndef PAD_H_
#define PAD_H_

namespace Lamp{

class Joystick;

//------------------------------------------------------------------------------
/**
 * パッド
 */
class Pad{
public:
	/**
	 * コンストラクタ
	 * @param joystick 使用するジョイスティック
	 */
	Pad(Joystick* joystick);

	/**
	 * デストラクタ
	 */
	virtual ~Pad();

	//--------------------------------------------------------------------------
	/**
	 * ジョイスティックの取得
	 * @return ジョイスティック
	 */
	virtual Joystick* getJoystick(){ return joystick_; }

	/**
	 * 名前の取得
	 * @return 名前
	 */
	virtual String getName() const;

	/**
	 * アタッチされているか
	 * @return アタッチされていればtrue
	 */
	virtual bool isAttached() const;

	/**
	 * クリア
	 */
	virtual void clear();

	//--------------------------------------------------------------------------
	/**
	 * 協調レベルの設定
	 * @param exclusive 排他モードならtrue
	 * @param foreground フォアグラウンドモードならtrue
	 * @return 成功すればtrue
	 */
	virtual bool setCooperativeLevel(bool exclusive, bool foreground);

	/**
	 * 排他モードか
	 * @return 排他モードならtrue
	 */
	virtual bool isExclusive() const;

	/**
	 * フォアグラウンドモードか
	 * @return フォアグラウンドモードならtrue、バックグラウンドモードならfalse
	 */
	virtual bool isForeground() const;

	//--------------------------------------------------------------------------
	/**
	 * 文字列への変換
	 * @return 文字列
	 */
	virtual String toString() const;

protected:
	//--------------------------------------------------------------------------
	/// ジョイスティック
	Joystick* joystick_;

private:
	//--------------------------------------------------------------------------
	// コピーコンストラクタの隠蔽
	Pad(const Pad& copy);

	// 代入コピーの隠蔽
	void operator =(const Pad& copy);

};

//------------------------------------------------------------------------------
} // End of namespace Lamp
#endif // End of PAD_H_
//------------------------------------------------------------------------------
