/***********************************************************************
* fbutton.h - Widget FButton                                           *
*                                                                      *
* This file is part of the Final Cut widget toolkit                    *
*                                                                      *
* Copyright 2012-2017 Markus Gans                                      *
*                                                                      *
* The Final Cut 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 3 of    *
* the License, or (at your option) any later version.                  *
*                                                                      *
* The Final Cut 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 program.  If not, see                        *
* <http://www.gnu.org/licenses/>.                                      *
***********************************************************************/

/*  Inheritance diagram
 *  ═══════════════════
 *
 * ▕▔▔▔▔▔▔▔▔▔▏
 * ▕  FTerm  ▏
 * ▕▁▁▁▁▁▁▁▁▁▏
 *      ▲
 *      │
 * ▕▔▔▔▔▔▔▔▔▔▏ ▕▔▔▔▔▔▔▔▔▔▏
 * ▕ FVTerm  ▏ ▕ FObject ▏
 * ▕▁▁▁▁▁▁▁▁▁▏ ▕▁▁▁▁▁▁▁▁▁▏
 *      ▲           ▲
 *      │           │
 *      └─────┬─────┘
 *            │
 *       ▕▔▔▔▔▔▔▔▔▔▏
 *       ▕ FWidget ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 *            ▲
 *            │
 *       ▕▔▔▔▔▔▔▔▔▔▏
 *       ▕ FButton ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 */

#ifndef FBUTTON_H
#define FBUTTON_H

#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
  #error "Only <final/final.h> can be included directly."
#endif

#include "final/fwidget.h"


//----------------------------------------------------------------------
// class FButton
//----------------------------------------------------------------------

#pragma pack(push)
#pragma pack(1)

class FButton : public FWidget
{
  public:
    // Constructors
    explicit FButton (FWidget* = 0);
    FButton (const FString&, FWidget* = 0);

    // Destructor
    virtual ~FButton();

    // Accessors
    const char*  getClassName() const;
    FString&     getText();

    // Mutators
    void         setForegroundColor (short);
    void         setBackgroundColor (short);
    void         setHotkeyForegroundColor (short);
    void         setFocusForegroundColor (short);
    void         setFocusBackgroundColor (short);
    void         setInactiveForegroundColor (short);
    void         setInactiveBackgroundColor (short);
    bool         setNoUnderline(bool);
    bool         setNoUnderline();
    bool         unsetNoUnderline();
    bool         setEnable(bool);
    bool         setEnable();
    bool         unsetEnable();
    bool         setDisable();
    bool         setFocus(bool);
    bool         setFocus();
    bool         unsetFocus();
    bool         setFlat(bool);
    bool         setFlat();
    bool         unsetFlat();
    bool         setShadow(bool);
    bool         setShadow();
    bool         unsetShadow();
    bool         setDown(bool);
    bool         setDown();
    bool         setUp();
    bool         setClickAnimation(bool);
    bool         setClickAnimation();
    bool         unsetClickAnimation();
    void         setText (const FString&);

    // Inquiries
    bool         isFlat() const;
    bool         isDown() const;
    bool         hasShadow() const;
    bool         hasClickAnimation();

    // Methods
    void         hide();

    // Event handlers
    void         onKeyPress (FKeyEvent*);
    void         onMouseDown (FMouseEvent*);
    void         onMouseUp (FMouseEvent*);
    void         onMouseMove (FMouseEvent*);
    void         onTimer (FTimerEvent*);
    void         onAccel (FAccelEvent*);
    void         onFocusIn (FFocusEvent*);
    void         onFocusOut (FFocusEvent*);

  private:
    // Disable copy constructor
    FButton (const FButton&);

    // Disable assignment operator (=)
    FButton& operator = (const FButton&);

    // Methods
    void         init();
    void         getButtonState();
    uChar        getHotkey();
    void         setHotkeyAccelerator();
    void         detectHotkey();
    int          getHotkeyPos (wchar_t[], wchar_t[], uInt);
    int          clickAnimationIndent (FWidget*);
    void         clearRightMargin (FWidget*);
    void         drawMarginLeft();
    void         drawMarginRight();
    void         drawTopBottomBackground();
    void         drawButtonTextLine (wchar_t[]);
    void         draw();
    void         updateStatusBar();
    void         updateButtonColor();
    void         processClick();

    // Data Members
    FString      text;
    bool         button_down;
    bool         click_animation;
    int          click_time;
    int          indent;
    int          space;
    int          center_offset;
    int          vcenter_offset;
    int          txtlength;
    int          hotkeypos;
    short        button_fg;
    short        button_bg;
    short        button_hotkey_fg;
    short        button_focus_fg;
    short        button_focus_bg;
    short        button_inactive_fg;
    short        button_inactive_bg;

    struct state
    {
      uChar focus           : 1;
      uChar active_focus    : 1;
      uChar active          : 1;
      uChar flat            : 1;
      uChar non_flat_shadow : 1;
      uChar no_underline    : 1;
      uChar                 : 2;  // padding bits
    } is;
};
#pragma pack(pop)


// FButton inline functions
//----------------------------------------------------------------------
inline const char* FButton::getClassName() const
{ return "FButton"; }

//----------------------------------------------------------------------
inline FString& FButton::getText()
{ return text; }

//----------------------------------------------------------------------
inline bool FButton::setNoUnderline()
{ return setNoUnderline(true); }

//----------------------------------------------------------------------
inline bool FButton::unsetNoUnderline()
{ return setNoUnderline(false); }

//----------------------------------------------------------------------
inline bool FButton::setEnable()
{ return setEnable(true); }

//----------------------------------------------------------------------
inline bool FButton::unsetEnable()
{ return setEnable(false); }

//----------------------------------------------------------------------
inline bool FButton::setDisable()
{ return setEnable(false); }

//----------------------------------------------------------------------
inline bool FButton::setFocus()
{ return setFocus(true); }

//----------------------------------------------------------------------
inline bool FButton::unsetFocus()
{ return setFocus(false); }

//----------------------------------------------------------------------
inline bool FButton::setFlat()
{ return setFlat(true); }

//----------------------------------------------------------------------
inline bool FButton::unsetFlat()
{ return setFlat(false); }

//----------------------------------------------------------------------
inline bool FButton::setShadow()
{ return setShadow(true); }

//----------------------------------------------------------------------
inline bool FButton::unsetShadow()
{ return setShadow(false); }

//----------------------------------------------------------------------
inline bool FButton::setDown()
{ return setDown(true); }

//----------------------------------------------------------------------
inline bool FButton::setUp()
{ return setDown(false); }

//----------------------------------------------------------------------
inline bool FButton::setClickAnimation(bool on)
{ return click_animation = on; }

//----------------------------------------------------------------------
inline bool FButton::setClickAnimation()
{ return setClickAnimation(true); }

//----------------------------------------------------------------------
inline bool FButton::unsetClickAnimation()
{ return setClickAnimation(false); }

//----------------------------------------------------------------------
inline bool FButton::isFlat() const
{ return ((flags & fc::flat) != 0); }

//----------------------------------------------------------------------
inline bool FButton::isDown() const
{ return button_down; }

//----------------------------------------------------------------------
inline bool FButton::hasShadow() const
{ return ((flags & fc::shadow) != 0); }

//----------------------------------------------------------------------
inline bool FButton::hasClickAnimation()
{ return click_animation; }

#endif  // FBUTTON_H