LeechCraft 0.6.70-18808-g3467692359
Modular cross-platform feature rich live environment.
Loading...
Searching...
No Matches
IRecoverableTab Class Referenceabstract

Interface for a single tab that may be recovered. More...

#include "ihaverecoverabletabs.h"

Public Member Functions

virtual std::optional< LC::TabSaveInfoGetTabSaveInfo () const =0
 Returns the tab's save information.

Protected Member Functions

virtual ~IRecoverableTab ()=default
virtual void tabRecoverDataChanged ()=0
 Notifies that tab state's changed.

Detailed Description

Interface for a single tab that may be recovered.

This interface should be implemented by tabs that may be recovered across LeechCraft runs or after closing. For example, a web browser tab with a web page or a chat window may be recovered either on next LeechCraft start or after being closed.

The tab's info is returned by the GetTabSaveInfo() function. Whenever the tab state changes, it emits the tabRecoverDataChanged() signal.

See also
IHaveRecoverableTabs

Definition at line 65 of file ihaverecoverabletabs.h.

Constructor & Destructor Documentation

◆ ~IRecoverableTab()

virtual IRecoverableTab::~IRecoverableTab ( )
protectedvirtualdefault

Member Function Documentation

◆ GetTabSaveInfo()

virtual std::optional< LC::TabSaveInfo > IRecoverableTab::GetTabSaveInfo ( ) const
pure virtual

Returns the tab's save information.

An empty optional means the tab is not worth saving.

Returns
The tab's save information or an empty optional.
See also
LC::TabSaveInfo

◆ tabRecoverDataChanged()

virtual void IRecoverableTab::tabRecoverDataChanged ( )
protectedpure virtual

Notifies that tab state's changed.

This signal should be emitted whenever the tab state changes so that tab session managers could have a chance to update their saved state.

Note
This function is expected to be a signal.

The documentation for this class was generated from the following file:
  • /home/abuild/rpmbuild/BUILD/leechcraft-doc-0.6.70+git.18808.g3467692359-build/leechcraft-0.6.70-18808-g3467692359/src/interfaces/ihaverecoverabletabs.h