Base class for all rich edit controls. More...

#include <BaseRichEdit.h>

Inheritance diagram for gui_framework::BaseRichEdit:

Public Types
enum class	urlDetectEvent { mouseMove = WM_MOUSEMOVE , leftButtonDown , leftButtonUp , leftButtonDoubleClick , rightButtonDown , rightButtonUp , rightButtonDoubleClick , setCursor = WM_SETCURSOR }

Public Member Functions
	BaseRichEdit (const std::wstring &richEditName, const utility::ComponentSettings &settings, BaseComposite *parent, bool isMultiLine=false)

virtual void	addUrlDetectEvent (urlDetectEvent event, const std::function< void(const std::wstring &)> &eventCallback) final

virtual void	addUrlDetectEvent (urlDetectEvent event, const std::string &functionName, const std::string &moduleName) final

virtual void	removeUrlDetectEvent (urlDetectEvent event) final

virtual LRESULT	findSubstring (const std::wstring &subStringToFind, bool isMatchCase=true) final

virtual LRESULT	findString (const std::wstring &stringToFind, bool isMatchCase=true) final

virtual void	setAutoURLDetect (bool autoURLDetect) final

virtual void	setLimitText (uint64_t count) final

virtual bool	getAutoURLDetect () const final

virtual std::wstring	getSelectedText () const final

virtual const std::function< void(const std::wstring &)> &	getCallback (urlDetectEvent event) const final

virtual bool	getIsMultiLine () const final

virtual void	setBackgroundColor (uint8_t red, uint8_t green, uint8_t blue) final override

virtual void	setTextColor (uint8_t red, uint8_t green, uint8_t blue) final override

virtual size_t	getHash () const override=0
	Used as key in creators.

virtual json::JSONBuilder	getStructure () const override

virtual	~BaseRichEdit ()=default

Public Member Functions inherited from gui_framework::BaseComponent
	BaseComponent (std::wstring_view className, std::wstring_view windowName, const utility::ComponentSettings &settings, const interfaces::IStyles &styles, BaseComposite *parent=nullptr, std::string_view windowFunctionName="", std::string_view moduleName="", uint16_t smallIconResource=NULL, uint16_t largeIconResource=NULL)

LRESULT	handleMessages (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed)

bool	destroyComponent ()

bool	asyncDestroyComponent ()

void	enable ()

void	disable ()

bool	isEnabled () const

bool	isDisabled () const

LRESULT	sendRawMessage (UINT message, WPARAM wparam, LPARAM lparam)
	SendMessage WinAPI wrapper.

void	setDesiredWidth (uint16_t desiredWidth)

void	setDesiredHeight (uint16_t desiredHeight)

void	setDesiredX (int desiredX)

void	setDesiredY (int desiredY)

BaseComponent *	getParent () const

HWND	getHandle () const

std::wstring_view	getWindowName () const

std::wstring_view	getClassName () const

uint16_t	getDesiredWidth () const

uint16_t	getDesiredHeight () const

uint16_t	getActualWidth () const

uint16_t	getActualHeight () const

RECT	getActualCoordinates () const

int	getDesiredX () const

int	getDesiredY () const

uint32_t	getId () const

COLORREF	getBackgroundColor () const

COLORREF	getTextColor () const

const smartPointerType< interfaces::IStyles > &	getStyles () const

virtual	~BaseComponent ()

Public Member Functions inherited from gui_framework::interfaces::ISerializable
	ISerializable ()=default

virtual	~ISerializable ()=default

Public Member Functions inherited from gui_framework::interfaces::IResizableComponent
	IResizableComponent (HWND resizeableHandle, HWND parent, bool autoResize=false, bool blockResize=false)

virtual void	resize (uint16_t width, uint16_t height)
	Resize component.

virtual RECT	calculateNewSizes (uint16_t width, uint16_t height) final

virtual void	setBlockResize (bool blockResize) final

virtual void	setAutoResize (bool autoResize) final

virtual bool	getBlockResize () const final

virtual bool	getAutoResize () const final

virtual	~IResizableComponent ()=default

Public Member Functions inherited from gui_framework::interfaces::ITextOperations
	ITextOperations (HWND handle, const std::wstring &text=L"")

	ITextOperations (HWND handle, const std::string &localizationKey)

void	setText (std::wstring_view text)

virtual void	setText (std::string_view localizationKey)

virtual std::wstring	getText () const final
	Get text from control.

virtual	~ITextOperations ()=default

Static Public Attributes
static constexpr uint8_t	urlDetectEventSize = 8

Protected Member Functions
virtual LRESULT	windowMessagesHandle (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed) override

Protected Member Functions inherited from gui_framework::BaseComponent
virtual LRESULT	preWindowMessagesHandle (HWND handle, UINT message, WPARAM wparam, LPARAM lparam, bool &isUsed)

virtual void	setLocalizationKeys (interfaces::ITextLocalized *localized, const std::vector< std::string > &localizationKeys)
	Override for custom localization.

Protected Attributes
std::array< std::function< void(const std::wstring &)>, urlDetectEventSize >	callbacks

std::array< std::pair< std::string, std::string >, urlDetectEventSize >	callbacksFunctionNamesAndModules

bool	isMultiLine

uint64_t	limitTextCount

Protected Attributes inherited from gui_framework::BaseComponent
BaseComposite *	parent

const std::wstring	className

const std::wstring	windowName

HWND	handle

uint16_t	desiredWidth

uint16_t	desiredHeight

int	desiredX

int	desiredY

uint32_t	id

COLORREF	backgroundColor

COLORREF	textColor

smartPointerType< interfaces::IStyles >	styles

Protected Attributes inherited from gui_framework::interfaces::IResizableComponent
bool	blockResize

bool	autoResize

int	initX

int	initY

uint16_t	initWidth

uint16_t	initHeight

uint16_t	parentWidth

uint16_t	parentHeight

Protected Attributes inherited from gui_framework::interfaces::ITextOperations
HWND	textHandle

Additional Inherited Members
Static Public Member Functions inherited from gui_framework::BaseComponent
static void	runFunctionAsync (const std::function< void()> &callable, const std::function< void()> &callback=nullptr) noexcept
	Add task to thread pool.

static void	runFunctionAsync (std::function< void()> &&callable, const std::function< void()> &callback=nullptr) noexcept
	Add task to thread pool.

Static Public Member Functions inherited from gui_framework::interfaces::ISerializable
static uint32_t	getCodepage ()

Detailed Description

Base class for all rich edit controls.

Definition at line 12 of file BaseRichEdit.h.

Member Enumeration Documentation

◆ urlDetectEvent

enum class gui_framework::BaseRichEdit::urlDetectEvent

strong

Enumerator
mouseMove
leftButtonDown
leftButtonUp
leftButtonDoubleClick
rightButtonDown
rightButtonUp
rightButtonDoubleClick
setCursor

Definition at line 18 of file BaseRichEdit.h.

Constructor & Destructor Documentation

◆ BaseRichEdit()

gui_framework::BaseRichEdit::BaseRichEdit	(	const std::wstring &	richEditName,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent,
		bool	isMultiLine = false )

Definition at line 63 of file BaseRichEdit.cpp.

◆ ~BaseRichEdit()

virtual gui_framework::BaseRichEdit::~BaseRichEdit ( )

virtualdefault

Member Function Documentation

◆ addUrlDetectEvent() [1/2]

virtual void gui_framework::BaseRichEdit::addUrlDetectEvent	(	urlDetectEvent	event,
		const std::function< void(const std::wstring &)> &	eventCallback )

finalvirtual

◆ addUrlDetectEvent() [2/2]

virtual void gui_framework::BaseRichEdit::addUrlDetectEvent	(	urlDetectEvent	event,
		const std::string &	functionName,
		const std::string &	moduleName )

finalvirtual

◆ findString()

LRESULT gui_framework::BaseRichEdit::findString	(	const std::wstring &	stringToFind,
		bool	isMatchCase = true )

finalvirtual

Definition at line 136 of file BaseRichEdit.cpp.

◆ findSubstring()

LRESULT gui_framework::BaseRichEdit::findSubstring	(	const std::wstring &	subStringToFind,
		bool	isMatchCase = true )

finalvirtual

Definition at line 124 of file BaseRichEdit.cpp.

◆ getAutoURLDetect()

bool gui_framework::BaseRichEdit::getAutoURLDetect ( ) const

finalvirtual

Definition at line 171 of file BaseRichEdit.cpp.

◆ getCallback()

const function< void(const wstring &)> & gui_framework::BaseRichEdit::getCallback ( urlDetectEvent event ) const

finalvirtual

Definition at line 185 of file BaseRichEdit.cpp.

◆ getHash()

virtual size_t gui_framework::BaseRichEdit::getHash ( ) const

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseComponent.

Implemented in gui_framework::RichEdit.

◆ getIsMultiLine()

bool gui_framework::BaseRichEdit::getIsMultiLine ( ) const

finalvirtual

Definition at line 195 of file BaseRichEdit.cpp.

◆ getSelectedText()

wstring gui_framework::BaseRichEdit::getSelectedText ( ) const

finalvirtual

Definition at line 176 of file BaseRichEdit.cpp.

◆ getStructure()

json::JSONBuilder gui_framework::BaseRichEdit::getStructure ( ) const

overridevirtual

Reimplemented from gui_framework::BaseComponent.

Reimplemented in gui_framework::RichEdit.

Definition at line 221 of file BaseRichEdit.cpp.

◆ removeUrlDetectEvent()

void gui_framework::BaseRichEdit::removeUrlDetectEvent ( urlDetectEvent event )

finalvirtual

Definition at line 108 of file BaseRichEdit.cpp.

◆ setAutoURLDetect()

void gui_framework::BaseRichEdit::setAutoURLDetect ( bool autoURLDetect )

finalvirtual

Definition at line 148 of file BaseRichEdit.cpp.

◆ setBackgroundColor()

void gui_framework::BaseRichEdit::setBackgroundColor	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue )

finaloverridevirtual

Reimplemented from gui_framework::BaseComponent.

Definition at line 200 of file BaseRichEdit.cpp.

◆ setLimitText()

void gui_framework::BaseRichEdit::setLimitText ( uint64_t count )

finalvirtual

Definition at line 164 of file BaseRichEdit.cpp.

◆ setTextColor()

void gui_framework::BaseRichEdit::setTextColor	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue )

finaloverridevirtual

Reimplemented from gui_framework::BaseComponent.

Definition at line 207 of file BaseRichEdit.cpp.

◆ windowMessagesHandle()

LRESULT gui_framework::BaseRichEdit::windowMessagesHandle	(	HWND	handle,
		UINT	message,
		WPARAM	wparam,
		LPARAM	lparam,
		bool &	isUsed )

overrideprotectedvirtual

Reimplemented from gui_framework::BaseComponent.

Definition at line 28 of file BaseRichEdit.cpp.

Member Data Documentation

◆ callbacks

std::array<std::function<void(const std::wstring&)>, urlDetectEventSize> gui_framework::BaseRichEdit::callbacks

protected

Definition at line 33 of file BaseRichEdit.h.

◆ callbacksFunctionNamesAndModules

std::array<std::pair<std::string, std::string>, urlDetectEventSize> gui_framework::BaseRichEdit::callbacksFunctionNamesAndModules

protected

Definition at line 34 of file BaseRichEdit.h.

◆ isMultiLine

bool gui_framework::BaseRichEdit::isMultiLine

protected

Definition at line 35 of file BaseRichEdit.h.

◆ limitTextCount

uint64_t gui_framework::BaseRichEdit::limitTextCount

protected

Definition at line 36 of file BaseRichEdit.h.

◆ urlDetectEventSize

uint8_t gui_framework::BaseRichEdit::urlDetectEventSize = 8

staticconstexpr

Definition at line 30 of file BaseRichEdit.h.

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

GUIFramework/src/BaseComponents/StandardComponents/BaseRichEdit.h
GUIFramework/src/BaseComponents/StandardComponents/BaseRichEdit.cpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ urlDetectEvent

Constructor & Destructor Documentation

◆ BaseRichEdit()

◆ ~BaseRichEdit()

Member Function Documentation

◆ addUrlDetectEvent() [1/2]

◆ addUrlDetectEvent() [2/2]

◆ findString()

◆ findSubstring()

◆ getAutoURLDetect()

◆ getCallback()

◆ getHash()

◆ getIsMultiLine()

◆ getSelectedText()

◆ getStructure()

◆ removeUrlDetectEvent()

◆ setAutoURLDetect()

◆ setBackgroundColor()

◆ setLimitText()

◆ setTextColor()

◆ windowMessagesHandle()

Member Data Documentation

◆ callbacks

◆ callbacksFunctionNamesAndModules

◆ isMultiLine

◆ limitTextCount

◆ urlDetectEventSize