GUIFramework 1.1.0
Framework for desktop GUI applications in C++.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
gui_framework::utility::IconsHolder Class Referencefinal

Icons loader. More...

#include <IconsHolder.h>

Inheritance diagram for gui_framework::utility::IconsHolder:
gui_framework::utility::BaseLoadableHolder gui_framework::interfaces::IIterable< std::filesystem::path, iterators::loadable_forward_iterator, iterators::loadable_const_forward_iterator > gui_framework::interfaces::ISerializable

Public Member Functions

 IconsHolder (uint16_t imagesWidth, uint16_t imagesHeight, size_t count=standard_sizes::defaultImagesCount)
 
HICON getIcon (const std::filesystem::path &pathToIcon) const
 
HICON getIcon (uint16_t iconIndex) const
 
uint16_t addImage (const std::filesystem::path &pathToIcon) override
 
 ~IconsHolder ()=default
 
- Public Member Functions inherited from gui_framework::utility::BaseLoadableHolder
 BaseLoadableHolder (uint16_t imagesWidth, uint16_t imagesHeight, size_t count=standard_sizes::defaultImagesCount)
 
virtual void removeImage (const std::filesystem::path &pathToImage) final
 
virtual void removeImage (uint16_t imageIndex) final
 
virtual bool contains (const std::filesystem::path &pathToImage) const final
 
virtual uint16_t getImagesWidth () const final
 
virtual uint16_t getImagesHeight () const final
 
virtual uint16_t getImageIndex (const std::filesystem::path &pathToImage) const final
 
virtual imageType getImageType (const std::filesystem::path &pathToImage) const final
 
virtual imageType getImageType (uint16_t imageIndex) const final
 
virtual HIMAGELIST getImageList () const final
 
virtual uint16_t operator[] (const std::filesystem::path &pathToImage) const final
 
virtual std::filesystem::path operator[] (uint16_t index) const final
 
virtual iterators::loadable_forward_iterator begin () noexcept final override
 Can't be modified.
 
virtual iterators::loadable_const_forward_iterator cbegin () const noexcept final override
 
virtual iterators::loadable_forward_iterator end () noexcept final override
 
virtual iterators::loadable_const_forward_iterator cend () const noexcept final override
 
virtual std::pair< std::string, json::utility::jsonObject::variantType > & loadBaseLoadableHolderStructure (json::utility::jsonObject &current) const final
 
virtual ~BaseLoadableHolder ()
 
- Public Member Functions inherited from gui_framework::interfaces::IIterable< std::filesystem::path, iterators::loadable_forward_iterator, iterators::loadable_const_forward_iterator >
 IIterable ()=default
 
virtual ~IIterable ()=default
 
- Public Member Functions inherited from gui_framework::interfaces::ISerializable
 ISerializable ()=default
 
virtual ~ISerializable ()=default
 

Additional Inherited Members

- Public Types inherited from gui_framework::utility::BaseLoadableHolder
enum class  imageType : uint32_t { bitmap , icon , cursor }
 
- Static Public Member Functions inherited from gui_framework::interfaces::ISerializable
static uint32_t getCodepage ()
 
- Protected Member Functions inherited from gui_framework::utility::BaseLoadableHolder
virtual uint16_t insertImage (const std::filesystem::path &pathToImage, imageType type) final
 
- Protected Attributes inherited from gui_framework::utility::BaseLoadableHolder
HIMAGELIST imageList
 
std::unordered_map< std::wstring, imageData > images
 
uint16_t imagesWidth
 
uint16_t imagesHeight
 

Detailed Description

Icons loader.

Definition at line 10 of file IconsHolder.h.

Constructor & Destructor Documentation

◆ IconsHolder()

gui_framework::utility::IconsHolder::IconsHolder ( uint16_t imagesWidth,
uint16_t imagesHeight,
size_t count = standard_sizes::defaultImagesCount )

Definition at line 9 of file IconsHolder.cpp.

◆ ~IconsHolder()

gui_framework::utility::IconsHolder::~IconsHolder ( )
default

Member Function Documentation

◆ addImage()

uint16_t gui_framework::utility::IconsHolder::addImage ( const std::filesystem::path & pathToIcon)
overridevirtual
Parameters
pathToIcon
Returns
Index of newly added icon

Implements gui_framework::utility::BaseLoadableHolder.

Definition at line 45 of file IconsHolder.cpp.

◆ getIcon() [1/2]

HICON gui_framework::utility::IconsHolder::getIcon ( const std::filesystem::path & pathToIcon) const
Parameters
pathToIcon
Returns
Exceptions
std::out_of_range

◆ getIcon() [2/2]

HICON gui_framework::utility::IconsHolder::getIcon ( uint16_t iconIndex) const
Parameters
iconIndex
Returns
Exceptions
std::out_of_range

Definition at line 25 of file IconsHolder.cpp.

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