finalcut/src/include/final/fcheckbox.h

/***********************************************************************
* fcheckbox.h - Widget FCheckBox                                       *
*                                                                      *
* This file is part of the Final Cut widget toolkit                    *
*                                                                      *
* Copyright 2014-2019 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 ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 *            ▲
 *            │
 *    ▕▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▏
 *    ▕ FToggleButton ▏
 *    ▕▁▁▁▁▁▁▁▁▁▁▁▁▁▁▁▏
 *            ▲
 *            │
 *      ▕▔▔▔▔▔▔▔▔▔▔▔▏
 *      ▕ FCheckBox ▏
 *      ▕▁▁▁▁▁▁▁▁▁▁▁▏
 */

#ifndef FCHECKBOX_H
#define FCHECKBOX_H

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

#include "final/ftogglebutton.h"

namespace finalcut
{

//----------------------------------------------------------------------
// class FCheckBox
//----------------------------------------------------------------------

class FCheckBox : public FToggleButton
{
  public:
    // Constructors
    explicit FCheckBox (FWidget* = nullptr);
    explicit FCheckBox (const FString&, FWidget* = nullptr);

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

    // Destructor
    virtual ~FCheckBox();

    // Disable assignment operator (=)
    FCheckBox& operator = (const FCheckBox&) = delete;

    // Accessor
    const FString getClassName() const override;

  private:
    // Methods
    void          init();
    void          draw() override;
    void          drawCheckButton();
    void          drawChecked();
    void          drawUnchecked();
};

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

}  // namespace finalcut

#endif  // FCHECKBOX_H