finalcut/src/include/final/flabel.h

/***********************************************************************
* flabel.cpp - Widget FLabel                                           *
*                                                                      *
* This file is part of the Final Cut widget toolkit                    *
*                                                                      *
* Copyright 2014-2018 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 ▏
 *       ▕▁▁▁▁▁▁▁▁▁▏
 *            ▲
 *            │
 *       ▕▔▔▔▔▔▔▔▔▏
 *       ▕ FLabel ▏
 *       ▕▁▁▁▁▁▁▁▁▏
 */

#ifndef FLABEL_H
#define FLABEL_H

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

#include <vector>

#include "final/fwidget.h"

namespace finalcut
{

//----------------------------------------------------------------------
// class FLabel
//----------------------------------------------------------------------

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

class FLabel : public FWidget
{
  public:
    // Using-declaration
    using FWidget::setEnable;

    // Constructor
    explicit FLabel (FWidget* = nullptr);
    explicit FLabel (const FString&, FWidget* = nullptr);

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

    // Destructor
    virtual ~FLabel();

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

    // Overloaded operators
    FLabel& operator = (const FString&);
    FLabel& operator << (const FString&);
    FLabel& operator << (fc::SpecialCharacter);
    FLabel& operator << (const wchar_t);
    FLabel& operator << (const uInt);
    FLabel& operator << (const int);
    FLabel& operator << (const uLong);
    FLabel& operator << (const long);
    FLabel& operator << (const float);
    FLabel& operator << (const double);
    FLabel& operator << (const lDouble);
    const FLabel& operator >> (FString&);

    // Accessors
    const char*        getClassName() const;
    FWidget*           getAccelWidget();
    fc::text_alignment getAlignment();
    FString&           getText();

    // Mutators
    void               setAccelWidget (FWidget* = nullptr);
    void               setAlignment(fc::text_alignment);
    bool               setEmphasis(bool);
    bool               setEmphasis();
    bool               unsetEmphasis();
    bool               setReverseMode(bool);
    bool               setReverseMode();
    bool               unsetReverseMode();
    virtual bool       setEnable (bool);
    void               setNumber (uLong);
    void               setNumber (long);
    void               setNumber (float, int = FLT_DIG);
    void               setNumber (double, int = DBL_DIG);
    void               setNumber (lDouble, int = LDBL_DIG);
    void               setText (const FString&);

    // Inquiries
    bool               hasEmphasis();
    bool               hasReverseMode();

    // Methods
    virtual void       hide();
    void               clear();

    // Event handlers
    virtual void       onMouseDown (FMouseEvent*);
    virtual void       onAccel (FAccelEvent*);

    // Callback method
    void               cb_accel_widget_destroyed (FWidget*, data_ptr);

  private:
    // Constants
    static const std::size_t NOT_SET = static_cast<std::size_t>(-1);

    // Methods
    void               init();
    uChar              getHotkey();
    std::size_t        getHotkeyPos (wchar_t[], wchar_t[], std::size_t);
    void               setHotkeyAccelerator();
    std::size_t        getAlignOffset (std::size_t);
    virtual void       draw();
    void               drawMultiLine();
    void               drawSingleLine();
    void               printLine ( wchar_t[], std::size_t
                                 , std::size_t, std::size_t = 0 );

    // Data Members
    FStringList        multiline_text{};
    bool               multiline{false};
    FString            text{};
    fc::text_alignment alignment{fc::alignLeft};
    FColor             emphasis_color{wc.label_emphasis_fg};
    FColor             ellipsis_color{wc.label_ellipsis_fg};
    bool               emphasis{false};
    bool               reverse_mode{false};
    FWidget*           accel_widget{nullptr};
};
#pragma pack(pop)


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

//----------------------------------------------------------------------
inline FWidget* FLabel::getAccelWidget ()
{ return accel_widget; }

//----------------------------------------------------------------------
inline fc::text_alignment FLabel::getAlignment()
{ return alignment; }

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

//----------------------------------------------------------------------
inline bool FLabel::setEmphasis()
{ return setEmphasis(true); }

//----------------------------------------------------------------------
inline bool FLabel::unsetEmphasis()
{ return setEmphasis(false); }

//----------------------------------------------------------------------
inline bool FLabel::setReverseMode()
{ return setReverseMode(true); }

//----------------------------------------------------------------------
inline bool FLabel::unsetReverseMode()
{ return setReverseMode(false); }

//----------------------------------------------------------------------
inline void FLabel::setNumber (uLong num)
{ setText(FString().setNumber(num)); }

//----------------------------------------------------------------------
inline void FLabel::setNumber (long num)
{ setText(FString().setNumber(num)); }

//----------------------------------------------------------------------
inline void FLabel::setNumber (float num, int precision)
{ setText(FString().setNumber(num, precision)); }

//----------------------------------------------------------------------
inline void FLabel::setNumber (double num, int precision)
{ setText(FString().setNumber(num, precision)); }

//----------------------------------------------------------------------
inline void FLabel::setNumber (lDouble num, int precision)
{ setText(FString().setNumber(num, precision)); }

//----------------------------------------------------------------------
inline bool FLabel::hasEmphasis()
{ return emphasis; }

//----------------------------------------------------------------------
inline bool FLabel::hasReverseMode()
{ return reverse_mode; }

//----------------------------------------------------------------------
inline void FLabel::clear()
{ text.clear(); }

}  // namespace finalcut

#endif  // FLABEL_H