// EMERGENT GAME TECHNOLOGIES PROPRIETARY INFORMATION
//
// This software is supplied under the terms of a license agreement or
// nondisclosure agreement with Emergent Game Technologies and may not 
// be copied or disclosed except in accordance with the terms of that 
// agreement.
//
//      Copyright (c) 1996-2007 Emergent Game Technologies.
//      All Rights Reserved.
//
// Emergent Game Technologies, Chapel Hill, North Carolina 27517
// http://www.emergent.net

#ifndef NIUIBUTTON_H
#define NIUIBUTTON_H

#include "NiUserInterfaceLibType.h"
#include "NiUIHotkeyImage.h"
#include "NiUILabel.h"
//---------------------------------------------------------------------------
class NIUSERINTERFACE_ENTRY NiUIButton : public NiUIBaseElement
{
    NiDeclareRTTI;
public:
    enum NiButtonType
    {
        PRESSBUTTON,
        TOGGLEBUTTON
    };

    NiUIButton(const char* pcButtonText = "", 
        NiButtonType eButtonType = PRESSBUTTON);
    virtual ~NiUIButton();

    // Rendering functions
    virtual void Draw(NiRenderer* pkRenderer);

    // Set and Get functions
    virtual void SetVisible(bool bVisible);
    void SetPressed(bool bPressed = true);
    bool IsPressed() const;
    void SetButtonType(NiButtonType eButtonType);
    NiButtonType GetButtonType() const;
    void SetText(const char* pcButtonText);

    // Event functions
    virtual void EnterPressed(unsigned char ucButtonState);
    virtual void LeftMouseButton(unsigned char ucButtonState);
    virtual bool MouseLocation(unsigned int uiMouseX, unsigned int uiMouseY);
    void SubscribeToPressEvent(NiUIBaseSlot0* pkSlot);
    void SubscribeToReleaseEvent(NiUIBaseSlot0* pkSlot);
    void SubscribeToWhilePressedEvent(NiUIBaseSlot0* pkSlot);
    void SubscribeToToggleEvent(NiUIBaseSlot1<bool>* pkSlot);
    // These return true if the hotkey could be reserved
    bool AddKeyboardHotkey(NiInputKeyboard::KeyCode eKey,
        NiInputKeyboard::Modifiers eModifier = NiInputKeyboard::KMOD_NONE);
    bool AddGamePadAxis(NiInputGamePad::DefaultAxis eAxis, 
        bool bUseBothDirs = false);
    bool AddGamePadHotkey(NiInputGamePad::Button eButton, 
        NiInputGamePad::ButtonMask eModifier = NiInputGamePad::NIGP_MASK_NONE);
    bool AddMouseHotkey(NiInputMouse::Button eButton,
        NiInputMouse::Modifiers eModifier = NiInputMouse::MMOD_NONE);
    bool AddMouseMotion();
    virtual bool SetFocus(bool bFocus);

    virtual unsigned int GetChildElementCount() const;
    virtual NiUIBaseElement* GetChildElement(unsigned int uiElement) const;

protected:
    enum {NUM_QUADS = 9};
    virtual unsigned int NumQuadsRequired();
    virtual void ReinitializeDisplayElements();
    virtual void UpdateLayout();

    // Communication members
    NiUISignal0 m_kPressEvent;
    NiUISignal0 m_kReleaseEvent;
    NiUISignal0 m_kWhilePressEvent;
    NiUISignal1<bool> m_kToggleEvent;
    NiUIMemberSlot1<NiUIButton, unsigned char> m_kHotkeyPressed;
    void HotkeyPressed(unsigned char ucButtonState);
    void PressLogic(unsigned char ucButtonState, bool bHotkeyCaused);

    static const float ms_fHotkeyImageWidth;
    static const float ms_fHotkeyImageTotalWidth;
    NiButtonType m_eButtonType;
    NiUIHotkeyImagePtr m_spHotkeyImages;
    NiUILabelPtr m_spLabel;

    NiRect<float> m_kStoredRect;
    NiRect<float> m_kInnerNSCRect;
    bool m_bPressed;
    bool m_bHighlit;
    bool m_bMouseHeld;
};
NiSmartPointer(NiUIButton);
//---------------------------------------------------------------------------
#include "NiUIButton.inl"

#endif