cc_item_picture: rework for svg-support, simplified structure

- simplified icon and logohandling in headers
- add svg examples, fix some other tests inside test_menu.cpp
This commit is contained in:
2021-11-13 18:56:47 +01:00
parent 568518c15a
commit 68c8edf09c
6 changed files with 311 additions and 737 deletions

View File

@@ -1,9 +1,9 @@
/*
Based up Neutrino-GUI - Tuxbox-Project
Based up Neutrino-GUI - Tuxbox-Project
Copyright (C) 2001 by Steffen Hehn 'McClean'
Classes for generic GUI-related components.
Copyright (C) 2012-2014, Thilo Graf 'dbt'
Copyright (C) 2012-2021, Thilo Graf 'dbt'
Copyright (C) 2012, Michael Liebmann 'micha-bbg'
License: GPL
@@ -18,182 +18,110 @@
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public
License along with this program; if not, write to the
Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
Boston, MA 02110-1301, USA.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __CC_ITEM_PICTURE_H__
#define __CC_ITEM_PICTURE_H__
#ifndef __CC_ITEM_PICTURE_V2_H__
#define __CC_ITEM_PICTURE_V2_H__
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "cc_base.h"
#include "cc_item.h"
#include "cc_item_shapes.h"
#include <string>
#define NO_SCALE false
#define SCALE true
//! Sub class of CComponentsItem. Shows box with image with assigned attributes.
//! Sub class of CComponentsShapeSquare. Shows box with image with assigned attributes.
/*!
Picture is usable as an object like each other CCItems.
*/
class CComponentsPicture : public CComponentsItem
class CCPictureBase : public CComponentsShapeSquare
{
protected:
///possible image formats
std::vector<std::string> v_ext;
///option to enable disable cache, default = false
bool enable_cache;
///screen cache content for painted image
fb_pixel_t *image_cache;
///current image dimensions
int dx, dy;
///original image dimensions
int dx_orig, dy_orig;
///cached image dimensions
int dxc, dyc;
///property: name of image (without extensionn) full path to image (with extension), icon names to find in /widget/icons.h, icons will paint never scaled
std::string pic_name, pic_name_old;
///indicate that image was sucessful painted
bool is_image_painted;
///sets that image may be painted, default = false
bool do_paint;
///set the transparency of pictures (default = CFrameBuffer::TM_NONE)
int image_transparent;
///set internel paint mode to allow/disallow scale an image, value is assigned with constructor, if defined dimensions w and h = 0, then image scale is enabled
bool do_scale;
///sets internal option for keeping aspect, see also setHeight(), setWidth(), default value = false
bool keep_dx_aspect;
bool keep_dy_aspect;
///helper: indicate for reinit
bool need_init;
///paint item with changed paint and hide effect
void paintTrigger();
void init( const int &x_pos, const int &y_pos, const int &w, const int &h,
const std::string& image_name,
CComponentsForm *parent,
int shadow_mode,
fb_pixel_t color_frame,
fb_pixel_t color_background,
fb_pixel_t color_shadow,
int transparent,
bool allow_scale);
///initialize all required attributes
void initCCItem();
///initialize position of picture object dependendly from settings
void initPosition(int *x_position, int *y_position);
///paint image
void paintPicture();
private:
int dx_orig, dy_orig;
public:
/*!
Constructor for image objects: use this for scaled images.
Dimensions are defined with parameters w (width) and h (height).
Note: only dimension values >0 causes scaling of image!
Note: See also class CComponentsPictureScalable(). That does the same like this, but uses internal value 0 for parameters w (width) and h (height).
If scaling is not required, you should use overloaded version that comes without dimension parameters.
If no dimensions are defined (in constructor or e.g. with setWidth() or setHeight(),
width and height are defined by image itself and are retrievable e.g. with getWidth() or getHeight().
*/
CComponentsPicture( const int &x_pos, const int &y_pos, const int &w, const int &h,
const std::string& image_name,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparent = CFrameBuffer::TM_NONE);
/*!
Constructor for image objects, use this for non scaled images. This is similar with known method paintIcon() from framebuffer class.
Dimensions are defined by image itself.
Note: you can use the dimension setters setWidth() or setHeight() too, but this has only effects for item body, not for image!
If scaling is required, you should use overloaded version above, that comes with dimension parameters or use
class CComponentsPictureScalable().
*/
CComponentsPicture( const int &x_pos, const int &y_pos,
const std::string& image_name,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparent = CFrameBuffer::TM_NONE);
virtual~CComponentsPicture()
{
clearCache();
}
CCPictureBase(const int &x_pos,
const int &y_pos,
const int &w,
const int &h,
const std::string &image,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
const int &transparency_mode = CFrameBuffer::TM_EMPTY);
virtual~CCPictureBase() {};
///sets an image name, full image path or url to an image file
void setPicture(const std::string &name, const int &w = 0, const int &h = 0);
///sets an image name, full image path or url to an image file
void setPicture(const char *name, const int &w = 0, const int &h = 0);
///sets an image name (unscaled icons only), full image path or url to an image file
void setPicture(const std::string& picture_name);
///sets an image name (unscaled icons only), full image path or url to an image file
void setPicture(const char* picture_name);
///returns current assigned image name
std::string getPictureName(){return pic_name;}
std::string getPictureName() {return cc_bg_std_image;}
void SetTransparent(const int &mode) {setBodyBGImageTranparencyMode(mode);}
///set width of object, keep_aspect = true keeps ratio related to height
void setWidth(const int &w, bool keep_aspect = true);
///set height of object, keep_aspect = true keeps ratio related to width
void setHeight(const int &h, bool keep_aspect = true);
///get original image size
void getRealSize(int* dx_orig, int *dy_orig);
///return width of item
int getWidth();
///return height of item
int getHeight();
///set width of object and image, value >0 causes scale of image, parameter keep_aspect = true causes scaling of height with same aspect, default = false
void setWidth(const int& w, bool keep_aspect = false);
///set height of object and image, value >0 causes scale of image, parameter keep_aspect = true causes scaling of width with same aspect, , default = false
void setHeight(const int& h, bool keep_aspect = false);
///set width of object and image related to current screen size, see also CComponentsItem::setWidthP(), parameter as uint8_t
void setWidthP(const uint8_t& w_percent){CComponentsItem::setWidthP(w_percent), do_scale = true; need_init = hasChanges(); initCCItem();}
///set height of object and image related to current screen size, see also CComponentsItem::setHeightP(), parameter as uint8_t
void setHeightP(const uint8_t& h_percent){CComponentsItem::setHeightP(h_percent), do_scale = true; need_init = hasChanges(); initCCItem();}
///set screen x-position, parameter as int
void setXPos(const int& xpos);
///set screen y-position, parameter as int
void setYPos(const int& ypos);
///return paint mode of internal image, true=image was painted, please do not to confuse with isPainted()! isPainted() is related to item itself.
bool isPicPainted(){return is_image_painted;};
/**sets transparency mode if icons
* @param[in] t Transparency mode
* @li t = CFrameBuffer::TM_BLACK : Transparency when black content ('pseudo' transparency)
* @li t = CFrameBuffer::TM_NONE : No 'pseudo' transparency
*/
void SetTransparent(int t){ image_transparent = t; }
///paint item
void paint(const bool &do_save_bg = CC_SAVE_SCREEN_YES);
///hide item, see also CComponents::hide();
void hide();
bool hasChanges();
///remove possible cache
void clearCache();
///enable/disable image cache
void enableCache(bool enable = true){if (enable_cache == enable) return; enable_cache = enable; if (!enable_cache) clearCache();}
///disable image cache, makes clean up too
void disableCache(){enableCache(false);}
void getRealSize(int *dx, int *dy);
};
class CComponentsChannelLogo : public CComponentsPicture
class CComponentsPicture : public CCPictureBase
{
public:
/*!
Use this for non scaled images.
Dimensions are defined by image itself.
If scaling is required, you should use class CComponentsPicture with dimension parameters see next.
width and height are defined by give image dimensions itself and are retrievable e.g. with getWidth() or getHeight().
*/
CComponentsPicture(const int &x_pos,
const int &y_pos,
const std::string &image,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparency_mode = CFrameBuffer::TM_EMPTY)
: CCPictureBase(x_pos, y_pos, 0, 0, image, parent, shadow_mode, color_frame, color_background, color_shadow, transparency_mode) {};
/*!
Use this for scaled images.
Dimensions are defined with parameters w (width) and h (height).
Only dimension values > 0 have a scale effect!
If one of the dimension parameters = 0, the ratio of image will be kept.
If scaling is not required, you should use overloaded class CComponentsPicture without dimension parameters or set values of w and h = 0.
width and height are retrievable e.g. with getWidth() or getHeight().
*/
CComponentsPicture(const int &x_pos,
const int &y_pos,
const int &w,
const int &h,
const std::string &image,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparency_mode = CFrameBuffer::TM_EMPTY)
: CCPictureBase(x_pos, y_pos, w, h, image, parent, shadow_mode, color_frame, color_background, color_shadow, transparency_mode) {};
virtual~CComponentsPicture() {};
};
class CComponentsChannelLogo : public CCPictureBase
{
private:
///channel id
@@ -206,11 +134,11 @@ class CComponentsChannelLogo : public CComponentsPicture
///alternate image file, if no channel logo is available
std::string alt_pic_name;
///indicates that logo is available, after paint or new instance, value = false
bool has_logo;
void init(const uint64_t& channelId, const std::string& channelName, bool allow_scale);
// void init(const uint64_t& channelId, const std::string &channelName, bool allow_scale);
public:
/*!
@@ -219,15 +147,37 @@ class CComponentsChannelLogo : public CComponentsPicture
Requires parameter channel_name or channelId instead image filename
NOTE: channel name string is prefered!
*/
CComponentsChannelLogo( const int &x_pos, const int &y_pos, const int &w, const int &h,
const std::string& channelName = "",
const uint64_t& channelId =0,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparent = CFrameBuffer::TM_BLACK);
CComponentsChannelLogo(const int &x_pos,
const int &y_pos,
const int &w,
const int &h,
const std::string &channelName = "",
const uint64_t &channelId = 0,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
const int &transparency_mode = CFrameBuffer::TM_EMPTY);
virtual~CComponentsChannelLogo() {};
///set channel id and/or channel name, NOTE: channel name is prefered
void setChannel(const uint64_t &channelId, const std::string &channelName, const int &w = 0, const int &h = 0);
uint64_t getChannelID() {return channel_id;}
///set an alternate logo if no logo is available NOTE: value of has_logo will set to true
void setAltLogo(const std::string &name, const int &w = 0, const int &h = 0);
///set an alternate logo if no logo is available, NOTE: value of has_logo will set to true
void setAltLogo(const char *name, const int &w = 0, const int &h = 0);
///enable/disable eventlogo
void enableEventLogo(bool enable = true) {enable_event_logo = enable;}
void disableEventLogo() {enableEventLogo(false);}
///returns true, if any logo is available, also if an alternate logo was defined
bool hasLogo() {return has_logo;}
/*!
Constructor for channel image objects: use this for non scaled channel logos.
@@ -235,57 +185,17 @@ class CComponentsChannelLogo : public CComponentsPicture
Requires parameter channel_name or channelId instead image filename
NOTE: channel name string is prefered!
*/
CComponentsChannelLogo( const int &x_pos, const int &y_pos,
const std::string& channelName = "",
const uint64_t& channelId =0,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparent = CFrameBuffer::TM_BLACK);
///set channel id and/or channel name, NOTE: channel name is prefered
void setChannel(const uint64_t& channelId, const std::string& channelName);
uint64_t getChannelID(){return channel_id;}
///set an alternate logo if no logo is available NOTE: value of has_logo will set to true
void setAltLogo(const std::string& picture_name);
///set an alternate logo if no logo is available, NOTE: value of has_logo will set to true
void setAltLogo(const char* picture_name);
///enable/disable eventlogo
void enableEventLogo(bool enable = true){enable_event_logo = enable;}
void disableEventLogo(){enableEventLogo(false);}
///returns true, if any logo is available, also if an alternate logo was setted
bool hasLogo(){return has_logo;};
CComponentsChannelLogo(const int &x_pos,
const int &y_pos,
const std::string &channelName = "",
const uint64_t &channelId = 0,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
const int &transparency_mode = CFrameBuffer::TM_EMPTY)
: CComponentsChannelLogo(x_pos, y_pos, 0, 0, channelName, channelId, parent, shadow_mode, color_frame, color_background, color_shadow, transparency_mode) {};
};
class CComponentsChannelLogoScalable : public CComponentsChannelLogo
{
public:
/*!
Constructor for channel image objects: use this for scaled channel logos.
Does the same like class CComponentsPictureScalable(), see above!
Requires parameter channel_name or channelId instead image filename.
NOTE: channel name string is prefered!
*/
CComponentsChannelLogoScalable( const int &x_pos, const int &y_pos,
const std::string& channelName = "",
const uint64_t& channelId =0,
CComponentsForm *parent = NULL,
int shadow_mode = CC_SHADOW_OFF,
fb_pixel_t color_frame = COL_FRAME_PLUS_0,
fb_pixel_t color_background = 0,
fb_pixel_t color_shadow = COL_SHADOW_PLUS_0,
int transparent = CFrameBuffer::TM_BLACK)
: CComponentsChannelLogo(x_pos, y_pos, 0, 0, channelName, channelId, parent, shadow_mode, color_frame, color_background, color_shadow, transparent)
{
cc_item_type.id = CC_ITEMTYPE_CHANNEL_LOGO_SCALABLE;
cc_item_type.name = "cc_scalable_channellogo_box";
};
};
#endif
#endif //__CC_ITEM_PICTURE_V2_H__