Base class for all list views with text items only. More...

#include <BaseTextListView.h>

Inheritance diagram for gui_framework::BaseTextListView:

Public Member Functions
	BaseTextListView (const std::wstring &listViewName, const utility::ComponentSettings &settings, BaseComposite *parent)

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

virtual json::JSONBuilder	getStructure () const override

virtual LRESULT	addTextItem (std::string_view localizationKey) final override

virtual LRESULT	insertTextItem (std::string_view localizationKey, size_t index) final override

virtual LRESULT	changeTextItem (std::string_view localizationKey, size_t index) final override

virtual	~BaseTextListView ()=default

Public Member Functions inherited from gui_framework::interfaces::IMultipleTextLocalized
	IMultipleTextLocalized (bool autoUpdate=true)

void	addLocalizationKey (std::string_view localizationKey)

void	insertLocalizationKey (size_t index, const std::string &localizationKey)

void	insertLocalizationKey (size_t index, std::string &&localizationKey) noexcept

void	removeLocalizationKey (size_t index)

void	removeLocalizationKey (std::string_view localizationKey)

const std::vector< std::string > &	getLocalizationKeys () const

virtual bool	updateLocalizationEvent () final override

virtual	~IMultipleTextLocalized ()=default

Public Member Functions inherited from gui_framework::interfaces::ITextLocalized
	ITextLocalized (bool autoUpdate=true)

virtual void	setAutoUpdate (bool autoUpdate) final

virtual bool	getAutoUpdate () const final

virtual	~ITextLocalized ()=default

Public Member Functions inherited from gui_framework::BaseListView
	BaseListView (const std::wstring &listViewName, const utility::ComponentSettings &settings, const styles::ListViewStyles &styles, BaseComposite *parent)

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) override

virtual	~BaseListView ()=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::ITextListView
	ITextListView (HWND handle)

virtual LRESULT	addTextItem (const std::wstring &text)

virtual LRESULT	insertTextItem (std::wstring_view text, size_t index)

virtual LRESULT	changeTextItem (std::wstring_view text, size_t index)

virtual std::wstring	getItemText (size_t index) const

virtual	~ITextListView ()=default

Public Member Functions inherited from gui_framework::interfaces::IBaseListViewOperations
	IBaseListViewOperations (HWND handle)

virtual bool	removeItem (size_t index) final

virtual size_t	size () const final

virtual	~IBaseListViewOperations ()=default

Protected Member Functions
virtual void	updateLocalization (size_t index, std::wstring_view localizedText) override

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

virtual LRESULT	windowMessagesHandle (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 Member Functions inherited from gui_framework::interfaces::IBaseListViewOperations
virtual LRESULT	addItem (const LVITEMW &item)

virtual LRESULT	setItem (const LVITEMW &item)

virtual void	getItem (LVITEMW &item) const

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 ()

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

Detailed Description

Base class for all list views with text items only.

Definition at line 10 of file BaseTextListView.h.

Constructor & Destructor Documentation

◆ BaseTextListView()

gui_framework::BaseTextListView::BaseTextListView	(	const std::wstring &	listViewName,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent )

Definition at line 14 of file BaseTextListView.cpp.

◆ ~BaseTextListView()

virtual gui_framework::BaseTextListView::~BaseTextListView ( )

virtualdefault

Member Function Documentation

◆ addTextItem()

LRESULT gui_framework::BaseTextListView::addTextItem ( std::string_view localizationKey )

finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextListView.

Definition at line 50 of file BaseTextListView.cpp.

◆ changeTextItem()

LRESULT gui_framework::BaseTextListView::changeTextItem	(	std::string_view	localizationKey,
		size_t	index )

finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextListView.

Definition at line 64 of file BaseTextListView.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseListView.

Implemented in gui_framework::TextListView.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseComponent.

Reimplemented in gui_framework::TextListView.

Definition at line 27 of file BaseTextListView.cpp.

◆ insertTextItem()

LRESULT gui_framework::BaseTextListView::insertTextItem	(	std::string_view	localizationKey,
		size_t	index )

finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextListView.

Definition at line 57 of file BaseTextListView.cpp.

◆ updateLocalization()

void gui_framework::BaseTextListView::updateLocalization	(	size_t	index,
		std::wstring_view	localizedText )

overrideprotectedvirtual

Implements gui_framework::interfaces::IMultipleTextLocalized.

Definition at line 9 of file BaseTextListView.cpp.

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

GUIFramework/src/BaseComponents/StandardComponents/ListViews/BaseTextListView.h
GUIFramework/src/BaseComponents/StandardComponents/ListViews/BaseTextListView.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseTextListView()

◆ ~BaseTextListView()

Member Function Documentation

◆ addTextItem()

◆ changeTextItem()

◆ getHash()

◆ getStructure()

◆ insertTextItem()

◆ updateLocalization()