From 524fd057fede5bcdb56ce8bb9016197c2d5c12a0 Mon Sep 17 00:00:00 2001 From: Adam Honse Date: Sun, 29 Aug 2021 14:27:10 -0500 Subject: [PATCH] Add tab icon fields (string and image) to the plugin information and add comments to make it easier for plugin developers to fill in information structure --- OpenRGBPluginInterface.h | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/OpenRGBPluginInterface.h b/OpenRGBPluginInterface.h index 271277e3..3552bf33 100644 --- a/OpenRGBPluginInterface.h +++ b/OpenRGBPluginInterface.h @@ -20,16 +20,23 @@ struct OpenRGBPluginInfo { - std::string Name; - std::string Description; - std::string Version; - std::string Commit; - std::string URL; + /*-------------------------------------------------------------------------------------------------*\ + | Plugin Details | + \*------------------------------------------------------------------------------------------------ */ + std::string Name; /* Plugin name string */ + std::string Description; /* Plugin description string */ + std::string Version; /* Plugin version string */ + std::string Commit; /* Plugin commit (git or otherwise) string */ + std::string URL; /* Plugin project URL string */ + QImage Icon; /* Icon image (displayed 64x64) */ - std::string Location; - std::string Label; - - QImage Icon; + /*-------------------------------------------------------------------------------------------------*\ + | Plugin Tab Configuration | + \*-------------------------------------------------------------------------------------------------*/ + std::string Location; /* Plugin tab location, such as "TopTabBar" */ + std::string Label; /* Plugin tab label string */ + std::string TabIconString; /* Plugin tab icon string, leave empty to use custom */ + QImage TabIcon; /* Custom tab icon image (displayed 16x16) */ }; class OpenRGBPluginInterface