Base class for all multiple select list boxes. More...

#include <BaseMultipleSelectListBox.h>

Inheritance diagram for gui_framework::BaseMultipleSelectListBox:

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

LRESULT	getCurrentSelections () const

std::vector< std::wstring >	getSelectedItems () const

void	selectMultipleItems (WPARAM firstItemIndex, LPARAM lastItemIndex) const

virtual LRESULT	setCurrentSelection (LRESULT index) const final override

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

virtual json::JSONBuilder	getStructure () const override

virtual	~BaseMultipleSelectListBox ()=default

Public Member Functions inherited from gui_framework::BaseListBox
	BaseListBox (std::wstring_view listBoxName, const utility::ComponentSettings &settings, const styles::ListBoxStyles &styles, BaseComposite *parent)

LRESULT	addValue (std::wstring_view value)

LRESULT	addValue (std::string_view localizationKey)

LRESULT	removeValue (size_t index)

virtual LRESULT	insertValue (std::wstring_view value, LRESULT index)

LRESULT	insertValue (std::string_view localizationKey, LRESULT index)

virtual LRESULT	changeValue (std::wstring_view newValue, LRESULT index)

LRESULT	changeValue (std::string_view localizationKey, LRESULT index)

LRESULT	findSubstring (std::wstring_view subStringToFind)

LRESULT	findString (std::wstring_view stringToFind)

std::wstring	getValue (size_t index) const

LRESULT	getCurrentSelectionIndex () const

LRESULT	size () const

void	clear ()

LRESULT	setItemsHeight (uint8_t height)

LRESULT	setColumnsWidth (uint8_t width)

LRESULT	getItemsHeight () const

uint8_t	getColumnsWidth () const

virtual void	resize (uint16_t width, uint16_t height) override

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

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

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

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

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 Member Functions inherited from gui_framework::BaseListBox
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 Attributes inherited from gui_framework::BaseListBox
SIZE	requiredSize

uint8_t	columnsWidth

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

Detailed Description

Base class for all multiple select list boxes.

Definition at line 8 of file BaseMultipleSelectListBox.h.

Constructor & Destructor Documentation

◆ BaseMultipleSelectListBox()

gui_framework::BaseMultipleSelectListBox::BaseMultipleSelectListBox	(	const std::wstring &	listBoxName,
		const utility::ComponentSettings &	settings,
		BaseComposite *	parent )

Definition at line 13 of file BaseMultipleSelectListBox.cpp.

◆ ~BaseMultipleSelectListBox()

virtual gui_framework::BaseMultipleSelectListBox::~BaseMultipleSelectListBox ( )

virtualdefault

Member Function Documentation

◆ getCurrentSelections()

LRESULT gui_framework::BaseMultipleSelectListBox::getCurrentSelections ( ) const

Definition at line 25 of file BaseMultipleSelectListBox.cpp.

◆ getHash()

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

overridepure virtual

Used as key in creators.

Returns: typeid().hash_code()

Implements gui_framework::BaseListBox.

Implemented in gui_framework::MultipleSelectListBox.

◆ getSelectedItems()

vector< wstring > gui_framework::BaseMultipleSelectListBox::getSelectedItems ( ) const

Definition at line 37 of file BaseMultipleSelectListBox.cpp.

◆ getStructure()

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

overridevirtual

Reimplemented from gui_framework::BaseListBox.

Reimplemented in gui_framework::MultipleSelectListBox.

Definition at line 80 of file BaseMultipleSelectListBox.cpp.

◆ selectMultipleItems()

void gui_framework::BaseMultipleSelectListBox::selectMultipleItems	(	WPARAM	firstItemIndex,
		LPARAM	lastItemIndex ) const

Definition at line 60 of file BaseMultipleSelectListBox.cpp.

◆ setCurrentSelection()

LRESULT gui_framework::BaseMultipleSelectListBox::setCurrentSelection ( LRESULT index ) const

finaloverridevirtual

Parameters

index

Returns

Exceptions

SelectListException