finalcut::FTextView Class Reference

Inheritance diagram for finalcut::FTextView:

Collaboration diagram for finalcut::FTextView:

Classes
struct	FTextHighlight
struct	FTextPosition
struct	FTextViewLine

Public Types
using	FTextViewList = std::vector< FTextViewLine >
Public Types inherited from finalcut::FWidget
using	FWidgetList = std::vector< FWidget * >
using	FAcceleratorList = std::vector< FAccelerator >
Public Types inherited from finalcut::FVTerm
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 Types inherited from finalcut::FObject
using	FObjectList = std::vector< FObject * >
using	iterator = FObjectList::iterator
using	reverse_iterator = FObjectList::reverse_iterator
using	const_iterator = FObjectList::const_iterator
using	const_reverse_iterator = FObjectList::const_reverse_iterator
using	reference = FObjectList::reference
using	const_reference = FObjectList::const_reference
using	difference_type = FObjectList::difference_type

Public Member Functions
	FTextView (FWidget *=nullptr)
auto	operator= (const FString &) -> FTextView &
template<typename typeT >
auto	operator<< (const typeT &) -> FTextView &
auto	operator<< (const UniChar &) -> FTextView &
auto	operator<< (const std::string &) -> FTextView &
auto	getClassName () const -> FString override
auto	getColumns () const noexcept -> std::size_t
auto	getRows () const -> std::size_t
auto	getScrollPos () const -> FPoint
auto	getTextVisibleSize () const -> FSize
auto	getText () const -> FString
auto	getSelectedText () const -> FString
auto	getSelectionStart () const -> FTextPosition
auto	getSelectionEnd () const -> FTextPosition
auto	getLine (FTextViewList::size_type) -> FTextViewLine &
auto	getLine (FTextViewList::size_type) const -> const FTextViewLine &
auto	getLines () const &-> const FTextViewList &
void	setSize (const FSize &, bool=true) override
void	setGeometry (const FPoint &, const FSize &, bool=true) override
void	resetColors () override
void	setText (const FString &)
void	addHighlight (std::size_t, const FTextHighlight &)
void	resetHighlight (std::size_t)
void	setSelectionStart (const FTextViewList::size_type, const FString::size_type)
void	setSelectionEnd (const FTextViewList::size_type, const FString::size_type)
void	resetSelection ()
template<typename T >
void	setLines (T &&)
void	setSelectable (bool=true)
void	unsetSelectable ()
void	scrollToX (int)
void	scrollToY (int)
void	scrollTo (const FPoint &)
void	scrollTo (int, int)
void	scrollToBegin ()
void	scrollToEnd ()
void	scrollBy (int, int)
auto	hasSelectedText () const -> bool
auto	isSelectable () const -> bool
void	hide () override
void	clear ()
template<typename T >
void	append (const std::initializer_list< T > &)
void	append (const FString &)
template<typename T >
void	insert (const std::initializer_list< T > &, int)
void	insert (const FString &, int)
void	replaceRange (const FString &, int, int)
void	deleteRange (int, int)
void	deleteLine (int)
void	onKeyPress (FKeyEvent *) override
void	onMouseDown (FMouseEvent *) override
void	onMouseUp (FMouseEvent *) override
void	onMouseMove (FMouseEvent *) override
void	onMouseDoubleClick (FMouseEvent *) override
void	onWheel (FWheelEvent *) override
void	onTimer (FTimerEvent *) override
Public Member Functions inherited from finalcut::FWidget
	FWidget (FWidget *=nullptr)
auto	getRootWidget () const -> FWidget *
auto	getParentWidget () const -> FWidget *
auto	getAcceleratorList () const &-> const FAcceleratorList &
auto	getStatusBarMessage () const -> FString
auto	getForegroundColor () const noexcept -> FColor
auto	getBackgroundColor () const noexcept -> FColor
auto	doubleFlatLine_ref (Side) -> std::vector< bool > &
auto	getX () const -> int
auto	getY () const -> int
auto	getPos () const -> FPoint
auto	getTermX () const -> int
auto	getTermY () const -> int
auto	getTermPos () const -> FPoint
auto	getWidth () const -> std::size_t
auto	getHeight () const -> std::size_t
auto	getSize () const -> FSize
auto	getTopPadding () const noexcept -> int
auto	getLeftPadding () const noexcept -> int
auto	getBottomPadding () const noexcept -> int
auto	getRightPadding () const noexcept -> int
auto	getClientWidth () const -> std::size_t
auto	getClientHeight () const -> std::size_t
auto	getClientSize () const -> FSize
auto	getMaxWidth () const -> std::size_t
auto	getMaxHeight () const -> std::size_t
auto	getShadow () const &-> const FSize &
auto	getGeometry () const &-> const FRect &
auto	getGeometryWithShadow () &-> const FRect &
auto	getTermGeometry () &-> const FRect &
auto	getTermGeometryWithShadow () &-> const FRect &
auto	getDesktopWidth () const -> std::size_t
auto	getDesktopHeight () const -> std::size_t
auto	getFlags () const &-> const FWidgetFlags &
auto	getCursorPos () const -> FPoint
auto	getPrintPos () -> FPoint
auto	setAcceleratorList () &-> FAcceleratorList &
virtual void	setStatusBarMessage (const FString &)
void	setVisible (bool=true)
void	unsetVisible ()
virtual void	setEnable (bool=true)
virtual void	unsetEnable ()
virtual void	setDisable ()
virtual void	setVisibleCursor (bool=true)
virtual void	unsetVisibleCursor ()
virtual auto	setFocus (bool=true, FocusTypes=FocusTypes::DefiniteWidget) -> bool
virtual auto	unsetFocus () -> bool
void	setFocusable (bool=true)
void	unsetFocusable ()
auto	ignorePadding (bool=true) -> bool
auto	acceptPadding () -> bool
virtual void	setForegroundColor (FColor)
virtual void	setBackgroundColor (FColor)
void	useParentWidgetColor ()
void	setColor () const
auto	setFlags () &-> FWidgetFlags &
virtual void	setX (int, bool=true)
virtual void	setY (int, bool=true)
virtual void	setPos (const FPoint &, bool=true)
virtual void	setWidth (std::size_t, bool=true)
virtual void	setHeight (std::size_t, bool=true)
void	setTopPadding (int, bool=true)
void	setLeftPadding (int, bool=true)
void	setBottomPadding (int, bool=true)
void	setRightPadding (int, bool=true)
void	setTerminalSize (const FSize &) const
virtual void	setGeometry (const FRect &, bool=true)
virtual void	setShadowSize (const FSize &)
void	setMinimumWidth (std::size_t)
void	setMinimumHeight (std::size_t)
void	setMinimumSize (const FSize &)
void	setMaximumWidth (std::size_t)
void	setMaximumHeight (std::size_t)
void	setMaximumSize (const FSize &)
void	setFixedSize (const FSize &)
virtual auto	setCursorPos (const FPoint &) -> bool
void	unsetCursorPos ()
virtual void	setPrintPos (const FPoint &)
void	setMergingBorder (Side, bool=true)
void	unsetMergingBorder (Side)
void	setMergingBorder (Side, int, bool=true)
void	unsetMergingBorder (Side, int)
auto	isRootWidget () const -> bool
auto	isWindowWidget () const -> bool
auto	isDialogWidget () const -> bool
auto	isMenuWidget () const -> bool
auto	isVisible () const -> bool
auto	isShown () const -> bool
auto	isHidden () const -> bool
auto	isEnabled () const -> bool
auto	hasVisibleCursor () const -> bool
auto	hasFocus () const -> bool
auto	acceptFocus () const -> bool
auto	isPaddingIgnored () const -> bool
auto	childWidgetAt (const FPoint &) &-> FWidget *
auto	numOfFocusableChildren () &-> int
virtual auto	close () -> bool
void	clearStatusBarMessage ()
template<typename... Args>
void	addCallback (FString &&, Args &&...) &noexcept
template<typename... Args>
void	delCallback (Args &&...) &noexcept
void	emitCallback (const FString &) const &
void	addAccelerator (FKey) &
virtual void	addAccelerator (FKey, FWidget *) &
void	delAccelerator () &
virtual void	delAccelerator (FWidget *) &
virtual void	flushChanges ()
virtual void	redraw ()
virtual void	resize ()
virtual void	show ()
virtual auto	focusNextChild () -> bool
virtual auto	focusPrevChild () -> bool
virtual auto	focusFirstChild () &-> bool
virtual auto	focusLastChild () &-> bool
auto	termToWidgetPos (const FPoint &) const -> FPoint
void	print (const FPoint &) override
virtual void	move (const FPoint &)
template<typename... Args>
void	addCallback (FString &&cb_signal, Args &&... args) &noexcept
template<typename... Args>
void	delCallback (Args &&... args) &noexcept
Public Member Functions inherited from finalcut::FVTerm
	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	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
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
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
Public Member Functions inherited from finalcut::FObject
	FObject (FObject *=nullptr)
	FObject (const FObject &)=delete
	FObject (FObject &&) noexcept=delete
auto	operator= (const FObject &) -> FObject &=delete
auto	operator= (FObject &&) noexcept -> FObject &=delete
auto	getSelf () const noexcept -> FObject *
auto	getParent () const noexcept -> FObject *
auto	getChild (int) const -> FObject *
auto	getChildren () noexcept -> FObjectList &
auto	getChildren () const noexcept -> const FObjectList &
auto	getMaxChildren () const noexcept -> std::size_t
auto	numOfChildren () const noexcept -> std::size_t
auto	begin () noexcept -> iterator
auto	end () noexcept -> iterator
auto	begin () const noexcept -> const_iterator
auto	end () const noexcept -> const_iterator
auto	cbegin () const noexcept -> const_iterator
auto	cend () const noexcept -> const_iterator
auto	rbegin () noexcept -> reverse_iterator
auto	rend () noexcept -> reverse_iterator
auto	rbegin () const noexcept -> const_reverse_iterator
auto	rend () const noexcept -> const_reverse_iterator
auto	crbegin () const noexcept -> const_reverse_iterator
auto	crend () const noexcept -> const_reverse_iterator
auto	front () -> reference
auto	back () -> reference
auto	front () const -> const_reference
auto	back () const -> const_reference
void	setMaxChildren (std::size_t) noexcept
auto	hasParent () const noexcept -> bool
auto	hasChildren () const noexcept -> bool
auto	isChild (const FObject *) const -> bool
auto	isDirectChild (const FObject *) const noexcept -> bool
auto	isWidget () const noexcept -> bool
auto	isInstanceOf (const FString &) const -> bool
void	removeParent ()
void	addChild (FObject *)
void	delChild (FObject *)
void	setParent (FObject *)
Public Member Functions inherited from finalcut::FObjectTimer
auto	addTimer (int interval) -> int
auto	delTimer (int id) const -> bool
auto	delOwnTimers () const -> bool
auto	delAllTimers () const -> bool

Protected Member Functions
void	initLayout () override
void	adjustSize () override
auto	isHorizontallyScrollable () const -> bool
auto	isVerticallyScrollable () const -> bool
auto	getTextHeight () const -> std::size_t
auto	getTextWidth () const -> std::size_t
Protected Member Functions inherited from finalcut::FWidget
auto	getPrintRegion () -> FTermRegion *override
void	addPreprocessingHandler (const FVTerm *, FPreprocessingFunction &&) override
void	delPreprocessingHandler (const FVTerm *) override
auto	isChildPrintRegion () const -> bool
virtual void	setStatusBar (FStatusBar *)
virtual void	setMenuBar (FMenuBar *)
void	setParentOffset ()
void	setTermOffset ()
void	setTermOffsetWithPadding ()
void	initTerminal () override
void	initDesktop ()
void	adjustSizeGlobal ()
void	hideRegion (const FSize &)
auto	event (FEvent *) -> bool override
virtual void	onKeyUp (FKeyEvent *)
virtual void	onKeyDown (FKeyEvent *)
virtual void	onFocusIn (FFocusEvent *)
virtual void	onFocusOut (FFocusEvent *)
virtual void	onChildFocusIn (FFocusEvent *)
virtual void	onChildFocusOut (FFocusEvent *)
virtual void	onTermFocusIn (FFocusEvent *)
virtual void	onTermFocusOut (FFocusEvent *)
virtual void	onFailAtChildFocus (FFocusEvent *)
virtual void	onAccel (FAccelEvent *)
virtual void	onResize (FResizeEvent *)
virtual void	onShow (FShowEvent *)
virtual void	onHide (FHideEvent *)
virtual void	onClose (FCloseEvent *)
Protected Member Functions inherited from finalcut::FVTerm
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
Protected Member Functions inherited from finalcut::FObject
void	setWidgetProperty (bool=true) noexcept
virtual void	onUserEvent (FUserEvent *)
Protected Member Functions inherited from finalcut::FObjectTimer
auto	getTimerList () const noexcept -> FTimer< FObject >::FTimerList *
auto	processTimerEvent () -> uInt

Additional Inherited Members
Static Public Member Functions inherited from finalcut::FWidget
static auto	getMainWidget () -> FWidget *&
static auto	getActiveWindow () -> FWidget *&
static auto	getFocusWidget () -> FWidget *&
static auto	getClickedWidget () -> FWidget *&
static auto	getOpenMenu () -> FWidget *&
static auto	getMoveResizeWidget () -> FWidget *&
static auto	getMenuBar () -> FMenuBar *
static auto	getStatusBar () -> FStatusBar *
static auto	getColorTheme () -> std::shared_ptr< FWidgetColors > &
static void	setMainWidget (FWidget *)
static void	setFocusWidget (FWidget *)
static void	setClickedWidget (FWidget *)
static void	setMoveSizeWidget (FWidget *)
static void	setActiveWindow (FWidget *)
static void	setOpenMenu (FWidget *)
template<typename ClassT >
static void	setColorTheme ()
static void	quit ()
Static Public Member Functions inherited from finalcut::FVTerm
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
Static Public Member Functions inherited from finalcut::FObjectTimer
static auto	getCurrentTime () noexcept -> TimeValue
static auto	isTimeout (const TimeValue &time, uInt64 timeout) noexcept -> bool
Static Public Attributes inherited from finalcut::FObject
static constexpr auto	UNLIMITED = static_cast<std::size_t>(-1)
Protected Types inherited from finalcut::FVTerm
using	FChar_iterator = std::vector< FChar >::iterator
using	FChar_const_iterator = std::vector< FChar >::const_iterator
Static Protected Member Functions inherited from finalcut::FWidget
static auto	getModalDialogCounter () -> uInt
static auto	getDialogList () -> FWidgetList *&
static auto	getAlwaysOnTopList () -> FWidgetList *&
static auto	getWidgetCloseList () -> FWidgetList *&
static auto	setModalDialogCounter () -> uInt &
Static Protected Member Functions inherited from finalcut::FVTerm
static auto	getLayer (FVTerm &) noexcept -> int
static void	determineWindowLayers () noexcept
static void	startDrawing () noexcept
static void	finishDrawing () noexcept

---

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

• final/widget/ftextview.h