Base class for all list views with text and icon items. More...

#include <BaseTextIconListView.h>

Inheritance diagram for gui_framework::BaseTextIconListView:

Public Member Functions
	BaseTextIconListView (const std::wstring &listViewName, const utility::ComponentSettings &settings, BaseComposite *parent, utility::iconListViewType type, uint16_t iconsWidth, uint16_t iconsHeight, size_t count=standard_sizes::defaultImagesCount)

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

virtual json::JSONBuilder	getStructure () const override

virtual LRESULT	addTextIconItem (std::string_view localizationKey, const std::filesystem::path &pathToIcon) override final

virtual LRESULT	insertTextIconItem (std::string_view localizationKey, const std::filesystem::path &pathToIcon, size_t index) override final

virtual LRESULT	changeTextIconItem (std::string_view localizationKey, const std::filesystem::path &pathToIcon, size_t index) override final

virtual	~BaseTextIconListView ()=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::ITextIconListView
	ITextIconListView (HWND handle, utility::IconsHolder &icons)

virtual LRESULT	addTextIconItem (std::wstring_view text, const std::filesystem::path &pathToIcon)

virtual LRESULT	insertTextIconItem (std::wstring_view text, const std::filesystem::path &pathToIcon, size_t index)

virtual LRESULT	changeTextIconItem (std::wstring_view text, const std::filesystem::path &pathToIcon, size_t index)

virtual std::tuple< std::wstring, uint16_t, std::filesystem::path >	getTextIconItem (size_t index) const

virtual	~ITextIconListView ()=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

Protected Attributes
utility::IconsHolder	icons

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

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 list views with text and icon items.

Definition at line 10 of file BaseTextIconListView.h.

Constructor & Destructor Documentation

◆ BaseTextIconListView()

gui_framework::BaseTextIconListView::BaseTextIconListView	(	const std::wstring &	listViewName,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent,
		utility::iconListViewType	type,
		uint16_t	iconsWidth,
		uint16_t	iconsHeight,
		size_t	count = standard_sizes::defaultImagesCount )

Definition at line 16 of file BaseTextIconListView.cpp.

◆ ~BaseTextIconListView()

virtual gui_framework::BaseTextIconListView::~BaseTextIconListView ( )

virtualdefault

Member Function Documentation

◆ addTextIconItem()

LRESULT gui_framework::BaseTextIconListView::addTextIconItem	(	std::string_view	localizationKey,
		const std::filesystem::path &	pathToIcon )

finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextIconListView.

Definition at line 62 of file BaseTextIconListView.cpp.

◆ changeTextIconItem()

LRESULT gui_framework::BaseTextIconListView::changeTextIconItem	(	std::string_view	localizationKey,
		const std::filesystem::path &	pathToIcon,
		size_t	index )

finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextIconListView.

Definition at line 76 of file BaseTextIconListView.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseListView.

Implemented in gui_framework::TextIconListView.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseComponent.

Reimplemented in gui_framework::TextIconListView.

Definition at line 30 of file BaseTextIconListView.cpp.

◆ insertTextIconItem()

LRESULT gui_framework::BaseTextIconListView::insertTextIconItem	(	std::string_view	localizationKey,
		const std::filesystem::path &	pathToIcon,
		size_t	index )

finaloverridevirtual

Reimplemented from gui_framework::interfaces::ITextIconListView.

Definition at line 69 of file BaseTextIconListView.cpp.

◆ updateLocalization()

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

overrideprotectedvirtual

Implements gui_framework::interfaces::IMultipleTextLocalized.

Definition at line 9 of file BaseTextIconListView.cpp.

Member Data Documentation

◆ icons

utility::IconsHolder gui_framework::BaseTextIconListView::icons

protected

Definition at line 19 of file BaseTextIconListView.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseTextIconListView()

◆ ~BaseTextIconListView()

Member Function Documentation

◆ addTextIconItem()

◆ changeTextIconItem()

◆ getHash()

◆ getStructure()

◆ insertTextIconItem()

◆ updateLocalization()

Member Data Documentation

◆ icons