finalcut::FVTerm Class Reference

Inheritance diagram for finalcut::FVTerm:

Collaboration diagram for finalcut::FVTerm:

Classes
struct	FShadowBox
struct	FTermRegion
struct	FVTermPreprocessing

Public Types
enum	TerminalUpdate : uInt8 { Stop, Continue, Start }
using	FCharVector = std::vector< FChar >
using	FPreprocessingHandler = void(FVTerm::*)()
using	FPreprocessingFunction = std::function< void()>
using	FPreprocVector = std::vector< std::unique_ptr< FVTermPreprocessing > >
using	FVTermList = std::vector< FVTerm * >
using	FTermRegionList = std::vector< const FTermRegion * >

Public Member Functions
	FVTerm (const FVTerm &)=delete
	FVTerm (FVTerm &&) noexcept=delete
template<typename FOutputType >
	FVTerm (outputClass< FOutputType >)
auto	operator= (const FVTerm &) -> FVTerm &=delete
auto	operator= (FVTerm &&) noexcept -> FVTerm &=delete
template<typename NumT , enable_if_arithmetic_without_char_t< NumT > = nullptr>
auto	operator<< (const NumT &) noexcept -> FVTerm &
template<typename CharT , enable_if_CString_t< CharT > = nullptr>
auto	operator<< (const CharT &) noexcept -> FVTerm &
auto	operator<< (char) noexcept -> FVTerm &
auto	operator<< (wchar_t) noexcept -> FVTerm &
auto	operator<< (const wchar_t *) noexcept -> FVTerm &
auto	operator<< (const UniChar &) noexcept -> FVTerm &
auto	operator<< (const std::string &) noexcept -> FVTerm &
auto	operator<< (const std::wstring &) noexcept -> FVTerm &
auto	operator<< (const FString &) noexcept -> FVTerm &
auto	operator<< (FVTermBuffer &) noexcept -> FVTerm &
auto	operator<< (const FVTermBuffer &) noexcept -> FVTerm &
auto	operator<< (const FChar &) noexcept -> FVTerm &
auto	operator<< (const FCharVector &) noexcept -> FVTerm &
auto	operator<< (const FPoint &) noexcept -> FVTerm &
auto	operator<< (const FStyle &) noexcept -> FVTerm &
auto	operator<< (const FColorPair &) noexcept -> FVTerm &
auto	getClassName () const -> FString override
auto	getVWin () noexcept -> FTermRegion *
auto	getVWin () const noexcept -> const FTermRegion *
auto	getPrintCursor () -> FPoint
void	setTerminalUpdates (TerminalUpdate) const
void	setCursor (const FPoint &) noexcept
void	setVWin (std::unique_ptr< FTermRegion > &&) noexcept
auto	hasPreprocessingHandler (const FVTerm *) noexcept -> bool
virtual void	clearRegion (wchar_t=L' ')
void	createVDesktop (const FSize &size) noexcept
void	createVTerm (const FSize &) noexcept
void	resizeVTerm (const FSize &) const noexcept
void	putVTerm () const
auto	updateTerminal () const -> bool
virtual void	addPreprocessingHandler (const FVTerm *, FPreprocessingFunction &&)
virtual void	delPreprocessingHandler (const FVTerm *)
template<typename... Args>
auto	printf (const FString &, Args &&...) -> int
auto	print (const FString &) noexcept -> int
auto	print (FTermRegion *, const FString &) noexcept -> int
auto	print (const std::vector< FChar > &) noexcept -> int
auto	print (FTermRegion *, const std::vector< FChar > &) noexcept -> int
auto	print (FVTermBuffer &) noexcept -> int
auto	print (const FVTermBuffer &) noexcept -> int
auto	print (FTermRegion *, FVTermBuffer &) const noexcept -> int
auto	print (FTermRegion *, const FVTermBuffer &) const noexcept -> int
auto	print (wchar_t) noexcept -> int
auto	print (FTermRegion *, wchar_t) noexcept -> int
auto	print (const FChar &) noexcept -> int
auto	print (FTermRegion *, const FChar &) const noexcept -> int
virtual void	print (const FPoint &)
auto	print () noexcept -> FVTerm &
void	flush () const
template<typename... Args>
auto	printf (const FString &format, Args &&... args) -> int
Public Member Functions inherited from finalcut::FVTermAttribute
	FVTermAttribute (const FVTermAttribute &)=delete
	FVTermAttribute (FVTermAttribute &&) noexcept=delete
auto	operator= (const FVTermAttribute &) -> FVTermAttribute &=delete
auto	operator= (FVTermAttribute &&) noexcept -> FVTermAttribute &=delete

Static Public Member Functions
static auto	getFOutput () -> std::shared_ptr< FOutput >
static auto	getWindowList () noexcept -> FVTermList *
static void	setNonBlockingRead (bool=true)
static void	unsetNonBlockingRead ()
static auto	isDrawingFinished () noexcept -> bool
static auto	isTerminalUpdateForced () noexcept -> bool
static auto	areTerminalUpdatesPaused () noexcept -> bool
static auto	hasPendingTerminalUpdates () noexcept -> bool
static void	reduceTerminalLineUpdates (uInt)
Static Public Member Functions inherited from finalcut::FVTermAttribute
static auto	getTermForegroundColor () noexcept -> FColor
static auto	getTermBackgroundColor () noexcept -> FColor
static auto	getAttribute () noexcept -> FChar &
static void	setColor (FColor, FColor) noexcept
static void	setColor (const FColorPair &) noexcept
static void	setNormal () noexcept
static void	setBold (bool) noexcept
static void	setBold () noexcept
static void	unsetBold () noexcept
static void	setDim (bool) noexcept
static void	setDim () noexcept
static void	unsetDim () noexcept
static void	setItalic (bool) noexcept
static void	setItalic () noexcept
static void	unsetItalic () noexcept
static void	setUnderline (bool) noexcept
static void	setUnderline () noexcept
static void	unsetUnderline () noexcept
static void	setBlink (bool) noexcept
static void	setBlink () noexcept
static void	unsetBlink () noexcept
static void	setReverse (bool) noexcept
static void	setReverse () noexcept
static void	unsetReverse () noexcept
static void	setStandout (bool) noexcept
static void	setStandout () noexcept
static void	unsetStandout () noexcept
static void	setInvisible (bool) noexcept
static void	setInvisible () noexcept
static void	unsetInvisible () noexcept
static void	setProtected (bool) noexcept
static void	setProtected () noexcept
static void	unsetProtected () noexcept
static void	setCrossedOut (bool) noexcept
static void	setCrossedOut () noexcept
static void	unsetCrossedOut () noexcept
static void	setDoubleUnderline (bool) noexcept
static void	setDoubleUnderline () noexcept
static void	unsetDoubleUnderline () noexcept
static void	setAltCharset (bool) noexcept
static void	setAltCharset () noexcept
static void	unsetAltCharset () noexcept
static void	setPCcharset (bool) noexcept
static void	setPCcharset () noexcept
static void	unsetPCcharset () noexcept
static void	setTransparent (bool) noexcept
static void	setTransparent () noexcept
static void	unsetTransparent () noexcept
static void	setColorOverlay (bool) noexcept
static void	setColorOverlay () noexcept
static void	unsetColorOverlay () noexcept
static void	setInheritBackground (bool) noexcept
static void	setInheritBackground () noexcept
static void	unsetInheritBackground () noexcept
static auto	isBold () noexcept -> bool
static auto	isDim () noexcept -> bool
static auto	isItalic () noexcept -> bool
static auto	isUnderline () noexcept -> bool
static auto	isBlink () noexcept -> bool
static auto	isReverse () noexcept -> bool
static auto	isStandout () noexcept -> bool
static auto	isInvisible () noexcept -> bool
static auto	isProtected () noexcept -> bool
static auto	isCrossedOut () noexcept -> bool
static auto	isDoubleUnderline () noexcept -> bool
static auto	isAltCharset () noexcept -> bool
static auto	isPCcharset () noexcept -> bool
static auto	isTransparent () noexcept -> bool
static auto	isColorOverlay () noexcept -> bool
static auto	isInheritBackground () noexcept -> bool
static void	initAttribute () noexcept
static void	print (const FStyle &)
static void	print (const FColorPair &) noexcept

Protected Types
using	FChar_iterator = std::vector< FChar >::iterator
using	FChar_const_iterator = std::vector< FChar >::const_iterator

Protected Member Functions
virtual auto	getPrintRegion () -> FTermRegion *
auto	getChildPrintRegion () const noexcept -> FTermRegion *
auto	getCurrentPrintRegion () const noexcept -> FTermRegion *
auto	getVirtualDesktop () const noexcept -> FTermRegion *
auto	getVirtualTerminal () const noexcept -> FTermRegion *
void	setPrintRegion (FTermRegion *) noexcept
void	setChildPrintRegion (FTermRegion *) noexcept
void	setActiveRegion (FTermRegion *) const noexcept
auto	isActive (const FTermRegion *) const noexcept -> bool
auto	hasPrintRegion () const noexcept -> bool
auto	hasChildPrintRegion () const noexcept -> bool
auto	isVirtualWindow () const noexcept -> bool
auto	isCursorHideable () const noexcept -> bool
auto	createRegion (const FShadowBox &) -> std::unique_ptr< FTermRegion >
auto	createRegion (const FRect &) -> std::unique_ptr< FTermRegion >
void	resizeRegion (const FShadowBox &, FTermRegion *) const
void	resizeRegion (const FRect &, FTermRegion *) const
void	restoreVTerm (const FRect &) const noexcept
auto	updateVTermCursor (const FTermRegion *) const noexcept -> bool
void	hideVTermCursor () const noexcept
void	setRegionCursor (const FPoint &, bool, FTermRegion *) const noexcept
void	getRegion (const FPoint &, FTermRegion *) const noexcept
void	getRegion (const FRect &, FTermRegion *) const noexcept
void	addLayer (FTermRegion *) const noexcept
void	putRegion (const FPoint &, FTermRegion *) const noexcept
void	copyRegion (FTermRegion *, const FPoint &, FTermRegion *) const noexcept
void	scrollRegionForward (FTermRegion *)
void	scrollRegionReverse (FTermRegion *)
void	clearRegion (FTermRegion *, wchar_t=L' ') noexcept
void	forceTerminalUpdate () const
auto	processTerminalUpdate () const -> bool
virtual void	initTerminal ()

Static Protected Member Functions
static auto	getLayer (FVTerm &) noexcept -> int
static void	determineWindowLayers () noexcept
static void	startDrawing () noexcept
static void	finishDrawing () noexcept

Friends
void	setPrintRegion (FWidget &, FTermRegion *)
auto	getColumnWidth (const wchar_t wchar) -> std::size_t

---

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

• final/vterm/fvterm.h
• final/vterm/fvterm.cpp