finalcut/src/include/final/ftooltip.h
2020-10-04 00:59:21 +02:00

141 lines
4.7 KiB
C++

/***********************************************************************
* ftooltip.h - Widget FToolTip *
* *
* This file is part of the FINAL CUT widget toolkit *
* *
* Copyright 2016-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 ▏
* ▕▁▁▁▁▁▁▁▁▁▏
* ▲
* │
* ▕▔▔▔▔▔▔▔▔▔▔▏
* ▕ FToolTip ▏
* ▕▁▁▁▁▁▁▁▁▁▁▏
*/
#ifndef FTOOLTIP_H
#define FTOOLTIP_H
#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
#error "Only <final/final.h> can be included directly."
#endif
#include <vector>
#include "final/fwindow.h"
namespace finalcut
{
//----------------------------------------------------------------------
// class FToolTip
//----------------------------------------------------------------------
class FToolTip : public FWindow
{
public:
// Constructors
explicit FToolTip (FWidget* = nullptr);
explicit FToolTip (const FString&, FWidget* = nullptr);
// Disable copy constructor
FToolTip (const FToolTip&) = delete;
// Destructor
~FToolTip () override;
// Disable copy assignment operator (=)
FToolTip& operator = (const FToolTip&) = delete;
// Accessors
FString getClassName() const override;
FString getText() const;
// Mutators
void setText (const FString&);
void resetColors() override;
bool setBorder (bool);
bool setBorder();
bool unsetBorder();
// Inquiries
bool hasBorder() const;
// Methods
void show() override;
// Event handler
void onMouseDown (FMouseEvent*) override;
private:
// Methods
void init();
void draw() override;
void calculateDimensions();
void adjustSize() override;
// Data members
FString text{};
FStringList text_components{};
std::size_t max_line_width{0};
std::size_t text_num_lines{0};
};
// FToolTip inline functions
//----------------------------------------------------------------------
inline FString FToolTip::getClassName() const
{ return "FToolTip"; }
//----------------------------------------------------------------------
inline FString FToolTip::getText() const
{ return text; }
//----------------------------------------------------------------------
inline bool FToolTip::setBorder()
{ return setBorder(true); }
//----------------------------------------------------------------------
inline bool FToolTip::unsetBorder()
{ return setBorder(false); }
//----------------------------------------------------------------------
inline bool FToolTip::hasBorder() const
{ return ! getFlags().no_border; }
} // namespace finalcut
#endif // FTOOLTIP_H