hellorge / qtsvgiconengine

Qt based svg icon engine, to manage dynamic color and size of svg files while using them as icons.

Demo uses the beautiful open source ionicons

Merge requests are welcome, I'll only work on or add functionality I deem required while working on other projects of mine.

Note

The CMakeLists.txt bundles all .svg files present in provided directory in a resource file resources.qrc located inside your build folder.

Usage

SvgIconEngine iconEngine(<path/to/svg/files/directory>, <options>);

SvgIcon icon = iconEngine.getIcon(<style>, <icon_name>, <options>);
// to get an icon

iconEngine.setDefaults(<options>);
// set new default options

iconEngine.setCachePolicy(CachePolicy::<policy>);
// {ALL, NONE, LRU}
// ALL: cache all, NONE: no caching, LRU: 100 pixmaps will be cache at once

iconEngine.clearCache();
// clear pixmap cache, without cache pixmaps are generated from svg paths again.

Arguments

1. SvgIconEngine::SvgIconEngine SvgIconEngine constructor

   • path/to/svg/files/directory | QString | Required

     Folders path where icons are located,

   • options | QVariantMap

     Set default options for all new icons

   • policy | CachePolicy

     Set cache policy for SvgIconEngine, possible values are: ALL, NONE, LRU

2. SvgIconEngine::getIcon get an icon

   • style | QString | Required

     Folders path between <path/to/svg/files/directory> and svg file,

   • icon_name | QString | Required

     Svg filename without extension

   • options | QVariantMap

     Set options for required icon

<options>

QVariant	Value Type	Default Value	Ex. Value	Use
color	QColor	QApplication::palette().text().color()	QColor(Qt::red)	Color used to fill icon
size	QSize	QSvgRenderer.defaultSize()	QSize(64, 64)	Icon size
default_colors	bool	false	true/false	If icon colors remain as in svg file
background	QColor	Qt::transparent	QColor(Qt::red)	Background fill for icons
opacity	int	1	QColor(Qt::red)	Icon opacity
border_color	QColor	QApplication::palette().text().color()	QColor(Qt::black)	Color for border around icon
border_width	int	0	10	Border width

Example

An svg file at /home/user/pictures/svgs/regular/calendar.svg

path/to/svg/files/directory = "/home/user/pictures/svgs"
style = "regular"
icon_name = "calendar"