swift
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
swift::gui::COverlayMessagesBase< WIDGET > Class Template Reference

Base class to display overlay messages in different widgets (nested in this widget). More...

Inheritance diagram for swift::gui::COverlayMessagesBase< WIDGET >:
[legend]

Public Member Functions

virtual ~COverlayMessagesBase ()
 Destructor.
 
void initOverlayMessages (QSize inner={})
 Init, normally we use lazy init, but by calling init explicitly we can force initalization. More...
 
void activateTextMessages (bool activate)
 Active send/receive of text messages. More...
 
void showStatusMessagesFrame ()
 Show the inner frame.
 
void setOverlaySizeFactors (double widthFactor, double heightFactor, double middleFactor=2)
 Set the size factors.
 
void setForceSmall (bool force)
 Force small (smaller layout) More...
 
void setReducedInfo (bool reduced)
 Display reduced information. More...
 
void showOverlayMessagesWithConfirmation (const swift::misc::CStatusMessageList &messages, bool appendOldMessages, const QString &confirmationMessage, std::function< void()> okLambda, QMessageBox::StandardButton defaultButton=QMessageBox::Cancel, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Show multiple messages with confirmation bar. More...
 
void clearOverlayMessages ()
 Clear the overlay messages. More...
 
void closeOverlay ()
 Close button clicked. More...
 
void showOverlayMessages (const swift::misc::CStatusMessageList &messages, bool appendOldMessages=false, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Show multiple messages. More...
 
void showOverlayMessagesOrSingleMessage (const swift::misc::CStatusMessageList &messages, bool appendOldMessages=false, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Show multiple messages or a single message. More...
 
void showOverlayMessagesOrHTMLMessage (const swift::misc::CStatusMessageList &messages, bool appendOldMessages=false, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Show multiple messages or a single message (HTML) More...
 
void sortOverlayMessages (const swift::misc::CPropertyIndex &property, Qt::SortOrder order)
 Sort of overlay messages. More...
 
void setOverlayMessagesSorting (const swift::misc::CPropertyIndex &property, Qt::SortOrder order)
 Set sorting of overlay messages. More...
 
bool showOverlayMessage (const swift::misc::CStatusMessage &message, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Show single message. More...
 
bool showOverlayTextMessage (const swift::misc::network::CTextMessage &textMessage, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Info message, based on text message. More...
 
void showOverlayVariant (const swift::misc::CVariant &variant, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Display one of the supported types. More...
 
void showOverlayImage (const swift::misc::CPixmap &pixmap, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Image. More...
 
bool showOverlayHTMLMessage (const QString &htmlMessage, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 HTML message. More...
 
bool showOverlayHTMLMessage (const swift::misc::CStatusMessage &message, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 HTML message. More...
 
void showDownloadProgress (int progress, qint64 current, qint64 max, const QUrl &url, std::chrono::milliseconds timeout=std::chrono::milliseconds(0))
 Download progress. More...
 
void showOverlayInlineTextMessage (components::TextMessageTab tab)
 Image. More...
 
void showOverlayInlineTextMessage (const swift::misc::aviation::CCallsign &callsign)
 Image. More...
 

Protected Member Functions

 COverlayMessagesBase (QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())
 Constructor.
 
void initInnerFrame (double widthFactor=-1, double heightFactor=-1)
 Init the inner frame (if not yet initialized)
 
void initMinimalFrame (int lines=4)
 Init a minimal frame (smaller as the normal one)
 
bool hasMinimumSize (int w, int h) const
 Check minimum height/width.
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void resizeEvent (QResizeEvent *event)
 

Protected Attributes

COverlayMessagesm_overlayMessages = nullptr
 embedded QFrame with status messages
 

Detailed Description

template<class WIDGET>
class swift::gui::COverlayMessagesBase< WIDGET >

Base class to display overlay messages in different widgets (nested in this widget).

Fixme:
KB 2017-12 all header version, if someone manages to create a cpp version go ahead, I failed on gcc with "undefined reference to `swift::gui::COverlayMessagesBase<QFrame>::showOverlayMessages`"

Definition at line 47 of file overlaymessagesframe.h.

Member Function Documentation

◆ activateTextMessages()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::activateTextMessages ( bool  activate)
inline

Active send/receive of text messages.

Definition at line 67 of file overlaymessagesframe.h.

◆ clearOverlayMessages()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::clearOverlayMessages ( )
inline

Clear the overlay messages.

Definition at line 114 of file overlaymessagesframe.h.

◆ closeOverlay()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::closeOverlay ( )
inline

Close button clicked.

Definition at line 121 of file overlaymessagesframe.h.

◆ initOverlayMessages()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::initOverlayMessages ( QSize  inner = {})
inline

Init, normally we use lazy init, but by calling init explicitly we can force initalization.

Remarks
usefule for text messages, as history will be already available

Definition at line 55 of file overlaymessagesframe.h.

◆ keyPressEvent()

template<class WIDGET >
virtual void swift::gui::COverlayMessagesBase< WIDGET >::keyPressEvent ( QKeyEvent *  event)
inlineprotectedvirtual

Reimplemented in swift::gui::CDockWidget.

Definition at line 335 of file overlaymessagesframe.h.

◆ resizeEvent()

template<class WIDGET >
virtual void swift::gui::COverlayMessagesBase< WIDGET >::resizeEvent ( QResizeEvent *  event)
inlineprotectedvirtual

Reimplemented in swift::gui::views::CViewBaseNonTemplate.

Definition at line 346 of file overlaymessagesframe.h.

◆ setForceSmall()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::setForceSmall ( bool  force)
inline

Force small (smaller layout)

Definition at line 85 of file overlaymessagesframe.h.

◆ setOverlayMessagesSorting()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::setOverlayMessagesSorting ( const swift::misc::CPropertyIndex property,
Qt::SortOrder  order 
)
inline

Set sorting of overlay messages.

Definition at line 166 of file overlaymessagesframe.h.

◆ setReducedInfo()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::setReducedInfo ( bool  reduced)
inline

Display reduced information.

Definition at line 92 of file overlaymessagesframe.h.

◆ showDownloadProgress()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showDownloadProgress ( int  progress,
qint64  current,
qint64  max,
const QUrl &  url,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Download progress.

Definition at line 239 of file overlaymessagesframe.h.

◆ showOverlayHTMLMessage() [1/2]

template<class WIDGET >
bool swift::gui::COverlayMessagesBase< WIDGET >::showOverlayHTMLMessage ( const QString &  htmlMessage,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

HTML message.

Definition at line 219 of file overlaymessagesframe.h.

◆ showOverlayHTMLMessage() [2/2]

template<class WIDGET >
bool swift::gui::COverlayMessagesBase< WIDGET >::showOverlayHTMLMessage ( const swift::misc::CStatusMessage message,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

HTML message.

Definition at line 229 of file overlaymessagesframe.h.

◆ showOverlayImage()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayImage ( const swift::misc::CPixmap pixmap,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Image.

Definition at line 210 of file overlaymessagesframe.h.

◆ showOverlayInlineTextMessage() [1/2]

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayInlineTextMessage ( components::TextMessageTab  tab)
inline

Image.

Definition at line 248 of file overlaymessagesframe.h.

◆ showOverlayInlineTextMessage() [2/2]

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayInlineTextMessage ( const swift::misc::aviation::CCallsign callsign)
inline

Image.

Definition at line 257 of file overlaymessagesframe.h.

◆ showOverlayMessage()

template<class WIDGET >
bool swift::gui::COverlayMessagesBase< WIDGET >::showOverlayMessage ( const swift::misc::CStatusMessage message,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Show single message.

Definition at line 172 of file overlaymessagesframe.h.

◆ showOverlayMessages()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayMessages ( const swift::misc::CStatusMessageList messages,
bool  appendOldMessages = false,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Show multiple messages.

Definition at line 128 of file overlaymessagesframe.h.

◆ showOverlayMessagesOrHTMLMessage()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayMessagesOrHTMLMessage ( const swift::misc::CStatusMessageList messages,
bool  appendOldMessages = false,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Show multiple messages or a single message (HTML)

Definition at line 149 of file overlaymessagesframe.h.

◆ showOverlayMessagesOrSingleMessage()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayMessagesOrSingleMessage ( const swift::misc::CStatusMessageList messages,
bool  appendOldMessages = false,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Show multiple messages or a single message.

Definition at line 138 of file overlaymessagesframe.h.

◆ showOverlayMessagesWithConfirmation()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayMessagesWithConfirmation ( const swift::misc::CStatusMessageList messages,
bool  appendOldMessages,
const QString &  confirmationMessage,
std::function< void()>  okLambda,
QMessageBox::StandardButton  defaultButton = QMessageBox::Cancel,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Show multiple messages with confirmation bar.

Definition at line 99 of file overlaymessagesframe.h.

◆ showOverlayTextMessage()

template<class WIDGET >
bool swift::gui::COverlayMessagesBase< WIDGET >::showOverlayTextMessage ( const swift::misc::network::CTextMessage textMessage,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Info message, based on text message.

Definition at line 183 of file overlaymessagesframe.h.

◆ showOverlayVariant()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::showOverlayVariant ( const swift::misc::CVariant variant,
std::chrono::milliseconds  timeout = std::chrono::milliseconds(0) 
)
inline

Display one of the supported types.

Definition at line 194 of file overlaymessagesframe.h.

◆ sortOverlayMessages()

template<class WIDGET >
void swift::gui::COverlayMessagesBase< WIDGET >::sortOverlayMessages ( const swift::misc::CPropertyIndex property,
Qt::SortOrder  order 
)
inline

Sort of overlay messages.

Definition at line 160 of file overlaymessagesframe.h.


The documentation for this class was generated from the following file: