finalcut/src/include/final/fdialog.h

/***********************************************************************
* fdialog.h - Widget FDialog                                           *
*                                                                      *
* This file is part of the FINAL CUT widget toolkit                    *
*                                                                      *
* Copyright 2012-2020 Markus Gans                                      *
*                                                                      *
* 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.                  *
*                                                                      *
* 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
 *  ═══════════════════
 *
 * ▕▔▔▔▔▔▔▔▔▔▏ ▕▔▔▔▔▔▔▔▔▔▏
 * ▕ FVTerm  ▏ ▕ FObject ▏
 * ▕▁▁▁▁▁▁▁▁▁▏ ▕▁▁▁▁▁▁▁▁▁▏
 *      ▲           ▲
 *      │           │
 *      └─────┬─────┘
 *            │
 *       ▕▔▔▔▔▔▔▔▔▔▏
 *       ▕ FWidget ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 *            ▲
 *            │
 *       ▕▔▔▔▔▔▔▔▔▔▏
 *       ▕ FWindow ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 *            ▲
 *            │
 *       ▕▔▔▔▔▔▔▔▔▔▏
 *       ▕ FDialog ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 */

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

#include "final/fmenu.h"
#include "final/fwindow.h"

namespace finalcut
{

// class forward declaration
class FToolTip;

//----------------------------------------------------------------------
// class FDialog
//----------------------------------------------------------------------

class FDialog : public FWindow
{
  public:
    // Using-declaration
    using FWindow::setResizeable;

    // Enumeration
    enum DialogCode
    {
      Reject = 0,
      Accept = 1
    };

    // Constructors
    explicit FDialog (FWidget* = nullptr);
    explicit FDialog (const FString&, FWidget* = nullptr);

    // Disable copy constructor
    FDialog (const FDialog&) = delete;

    // Destructor
    ~FDialog() override;

    // Disable copy assignment operator (=)
    FDialog& operator = (const FDialog&) = delete;

    // Accessors
    const FString         getClassName() const override;
    virtual const FString getText() const;

    // Mutators
    bool                  setDialogWidget (bool);
    bool                  setDialogWidget();
    bool                  unsetDialogWidget();
    bool                  setModal (bool);
    bool                  setModal();
    bool                  unsetModal();
    bool                  setResizeable (bool) override;
    bool                  setScrollable (bool);
    bool                  setScrollable();
    bool                  unsetScrollable();
    bool                  setBorder (bool);
    bool                  setBorder();
    bool                  unsetBorder();
    void                  resetColors() override;
    virtual void          setText (const FString&);

    // Inquiries
    bool                  isModal() const;
    bool                  isScrollable() const;
    bool                  hasBorder() const;

    // Methods
    void                  show() override;
    void                  hide() override;
    int                   exec();
    void                  setPos (const FPoint&, bool = true) override;
    void                  move (const FPoint&) override;
    bool                  moveUp (int);
    bool                  moveDown (int);
    bool                  moveLeft (int);
    bool                  moveRight (int);
    void                  setSize (const FSize&, bool = true) override;
    bool                  reduceHeight (int);
    bool                  expandHeight (int);
    bool                  reduceWidth (int);
    bool                  expandWidth (int);
    void                  activateDialog();

    // Event handlers
    void                  onKeyPress (FKeyEvent*) override;
    void                  onMouseDown (FMouseEvent*) override;
    void                  onMouseUp (FMouseEvent*) override;
    void                  onMouseMove (FMouseEvent*) override;
    void                  onMouseDoubleClick (FMouseEvent*) override;
    void                  onAccel (FAccelEvent*) override;
    void                  onWindowActive (FEvent*) override;
    void                  onWindowInactive (FEvent*) override;
    void                  onWindowRaised (FEvent*) override;
    void                  onWindowLowered (FEvent*) override;

  protected:
    // Methods
    virtual void          done (int);
    void                  draw() override;
    void                  drawDialogShadow();

    // Event handlers
    void                  onClose (FCloseEvent*) override;

  private:
    // Typedef
    typedef struct
    {
      int         mouse_x;
      int         mouse_y;
      FPoint      termPos;
      std::size_t zoom_btn;
      bool        mouse_over_menu;
    } mouseStates;

    // Constant
    static constexpr std::size_t MENU_BTN = 3;
    static constexpr bool PRINT_WIN_NUMBER = false;  // Only for debug

    // Methods
    void                  init();
    void                  initDialogMenu();
    void                  initMoveSizeMenuItem (FMenu*);
    void                  initZoomMenuItem (FMenu*);
    void                  initCloseMenuItem (FMenu*);
    void                  drawBorder() override;
    void                  drawTitleBar();
    void                  drawBarButton();
    void                  drawZoomButton();
    void                  drawRestoreSizeButton();
    void                  drawZoomedButton();
    void                  drawTextBar();
    void                  restoreOverlaidWindows();
    void                  setCursorToFocusWidget();
    void                  leaveMenu();
    void                  openMenu();
    void                  selectFirstMenuItem();
    void                  setZoomItem();
    std::size_t           getZoomButtonWidth();
    void                  activateZoomButton (const mouseStates&);
    void                  deactivateZoomButton();
    void                  leaveZoomButton (const mouseStates&);
    void                  pressZoomButton (const mouseStates&);
    bool                  isMouseOverMenu (const FPoint&) const;
    void                  passEventToSubMenu (const mouseStates&, const FMouseEvent*);
    void                  moveSizeKey (FKeyEvent*);
    void                  raiseActivateDialog();
    void                  lowerActivateDialog();
    bool                  isOutsideTerminal (const FPoint&) const;
    bool                  isLowerRightResizeCorner (const mouseStates&) const;
    void                  resizeMouseDown (const mouseStates&);
    void                  resizeMouseUpMove (const mouseStates&, bool = false);
    void                  cancelMouseResize();
    void                  acceptMoveSize();
    void                  cancelMoveSize();
    static void           addDialog (FWidget*);
    static void           delDialog (const FWidget*);

    // Callback methods
    void                  cb_move (const FWidget*, const FDataPtr);
    void                  cb_zoom (const FWidget*, const FDataPtr);
    void                  cb_close (const FWidget*, const FDataPtr);

    // Data members
    FString               tb_text{};  // title bar text
    int                   result_code{FDialog::Reject};
    bool                  zoom_button_pressed{false};
    bool                  zoom_button_active{false};
    bool                  setPos_error{false};
    bool                  setSize_error{false};
    FPoint                titlebar_click_pos{};
    FPoint                resize_click_pos{};
    FRect                 save_geometry{};  // required by keyboard move/size
    FMenu*                dialog_menu{nullptr};
    FMenuItem*            dgl_menuitem{nullptr};
    FMenuItem*            move_size_item{nullptr};
    FMenuItem*            zoom_item{nullptr};
    FMenuItem*            close_item{nullptr};
    FToolTip*             tooltip{nullptr};

    // Friend function from FMenu
    friend void FMenu::hideSuperMenus();
};

// FDialog inline functions
//----------------------------------------------------------------------
inline const FString FDialog::getClassName() const
{ return "FDialog"; }

//----------------------------------------------------------------------
inline const FString FDialog::getText() const
{ return tb_text; }

//----------------------------------------------------------------------
inline bool FDialog::setDialogWidget()
{ return setDialogWidget(true); }

//----------------------------------------------------------------------
inline bool FDialog::unsetDialogWidget()
{ return setDialogWidget(false); }

//----------------------------------------------------------------------
inline bool FDialog::setModal()
{ return setModal(true); }

//----------------------------------------------------------------------
inline bool FDialog::unsetModal()
{ return setModal(false); }

//----------------------------------------------------------------------
inline bool FDialog::setScrollable()
{ return setScrollable(true); }

//----------------------------------------------------------------------
inline bool FDialog::unsetScrollable()
{ return setScrollable(false); }

//----------------------------------------------------------------------
inline bool FDialog::setBorder()
{ return setBorder(true); }

//----------------------------------------------------------------------
inline bool FDialog::unsetBorder()
{ return setBorder(false); }

//----------------------------------------------------------------------
inline void FDialog::setText (const FString& txt)
{ tb_text.setString(txt); }

//----------------------------------------------------------------------
inline bool FDialog::isModal() const
{ return getFlags().modal; }

//----------------------------------------------------------------------
inline bool FDialog::isScrollable() const
{ return getFlags().scrollable; }

//----------------------------------------------------------------------
inline bool FDialog::hasBorder() const
{ return ! getFlags().no_border; }

}  // namespace finalcut

#endif  // FDIALOG_H