class: ewol::widget::Image
Constructor and Destructor:
+ Image (const std::string & _file,
const ewol::Dimension & _border);
+ virtual ~Image (void );
Synopsis:
+ const char* const eventPressed;
+ const char* const configRatio;
+ const char* const configSize;
+ const char* const configBorder;
+ const char* const configSource;
+ void init (ewol::widget::Manager & _widgetManager);
# ewol::compositing::Image m_compositing;
+ void set (const std::string & _file,
const ewol::Dimension & _border);
# std::string m_fileName;
+ void setFile (const std::string & _file);
+ const std::string & getFile (void ) const;
# ewol::Dimension m_border;
+ void setBorder (const ewol::Dimension & _border);
+ const ewol::Dimension & getBorder (void ) const;
# ewol::Dimension m_imageSize;
+ void setImageSize (const ewol::Dimension & _size);
+ const ewol::Dimension & getImageSize (void ) const;
# bool m_keepRatio;
+ void setKeepRatio (bool _keep);
+ bool getKeepRatio (void ) const;
# virtual void onDraw (void );
# virtual bool onSetConfig (const ewol::object::Config & _conf);
# virtual bool onGetConfig (const char* _config,
std::string & _result) const;
+ virtual void calculateMinMaxSize (void );
+ virtual void onRegenerateDisplay (void );
+ virtual bool onEventInput (const ewol::event::Input & _event);
+ virtual bool loadXML (exml::Element* _node);
Object Hierarchy:
+ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Image
Detail:
eventPressed
+ const char* const eventPressed;
configRatio
+ const char* const configRatio;
configSize
+ const char* const configSize;
configBorder
+ const char* const configBorder;
configSource
+ const char* const configSource;
init
+ void init (ewol::widget::Manager & _widgetManager);
Main call of recording the widget on the List of "widget named creator"
m_compositing
# ewol::compositing::Image m_compositing;
compositing element of the image.
Image
+ Image (const std::string & _file,
const ewol::Dimension & _border);
~Image
+ virtual ~Image (void );
set
+ void set (const std::string & _file,
const ewol::Dimension & _border);
set All the configuration of the current image
Parameter [input]: _file Filaneme of the new image
Parameter [input]: _border New border size to set
m_fileName
# std::string m_fileName;
file name of the image.
setFile
+ void setFile (const std::string & _file);
set the new filename
Parameter [input]: _file Filaneme of the new image
getFile
+ const std::string & getFile (void ) const;
get the file displayed
Return: the filename of the image
m_border
# ewol::Dimension m_border;
border to add at the image.
setBorder
+ void setBorder (const ewol::Dimension & _border);
set tge Border size around the image
Parameter [input]: _border New border size to set
getBorder
+ const ewol::Dimension & getBorder (void ) const;
get the current border request at the image
Return: the border size
m_imageSize
# ewol::Dimension m_imageSize;
border to add at the image.
setImageSize
+ void setImageSize (const ewol::Dimension & _size);
set tge Border size around the image
Parameter [input]: _size New border size to set
getImageSize
+ const ewol::Dimension & getImageSize (void ) const;
get the current border request at the image
Return: the border size
m_keepRatio
# bool m_keepRatio;
keep the image ratio between width and hight
setKeepRatio
+ void setKeepRatio (bool _keep);
set the current status of keeping ratio.
Parameter [input]: _keep The new status of keeping the ratio of this image.
getKeepRatio
+ bool getKeepRatio (void ) const;
get the current status of keeping ratio.
Return: The status of keeping the ratio of this image.
onDraw
# virtual void onDraw (void );
Common widget drawing function (called by the drawing thread [Android, X11, ...])
onSetConfig
# virtual bool onSetConfig (const ewol::object::Config & _conf);
Configuration requested to the curent Object
Parameter [input]: _conf Configuration handle.
Return: true if the parametere has been used
onGetConfig
# virtual bool onGetConfig (const char* _config,
std::string & _result) const;
Receive a configuration message from an other element system or from the curent Object
Parameter [input]: _config Configuration name.
Parameter [output]: _result Result of the request.
Return: true if the config is set
calculateMinMaxSize
+ virtual void calculateMinMaxSize (void );
calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
onRegenerateDisplay
+ virtual void onRegenerateDisplay (void );
Event generated when a redraw is needed
onEventInput
+ virtual bool onEventInput (const ewol::event::Input & _event);
Event on an input of this Widget (finger, mouse, stilet)
Parameter [input]: _event Event properties
Return: true the event is used<br/>false the event is not used
loadXML
+ virtual bool loadXML (exml::Element* _node);
load properties with an XML node.
Parameter [input]: _node Pointer on the tinyXML node.
Return: true : All has been done corectly.<br/>false : An error occured.
+ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Image
Detail:
eventPressed
+ const char* const eventPressed;
configRatio
+ const char* const configRatio;
configSize
+ const char* const configSize;
configBorder
+ const char* const configBorder;
configSource
+ const char* const configSource;
init
+ void init (ewol::widget::Manager & _widgetManager);Main call of recording the widget on the List of "widget named creator"
m_compositing
# ewol::compositing::Image m_compositing;compositing element of the image.
Image
+ Image (const std::string & _file,
const ewol::Dimension & _border);
~Image
+ virtual ~Image (void );
set
+ void set (const std::string & _file,set All the configuration of the current image
const ewol::Dimension & _border);
| Parameter [input]: | _file | Filaneme of the new image | Parameter [input]: | _border | New border size to set |
m_fileName
# std::string m_fileName;file name of the image.
setFile
+ void setFile (const std::string & _file);set the new filename
| Parameter [input]: | _file | Filaneme of the new image |
getFile
+ const std::string & getFile (void ) const;get the file displayed
| Return: | the filename of the image |
m_border
# ewol::Dimension m_border;border to add at the image.
setBorder
+ void setBorder (const ewol::Dimension & _border);set tge Border size around the image
| Parameter [input]: | _border | New border size to set |
getBorder
+ const ewol::Dimension & getBorder (void ) const;get the current border request at the image
| Return: | the border size |
m_imageSize
# ewol::Dimension m_imageSize;border to add at the image.
setImageSize
+ void setImageSize (const ewol::Dimension & _size);set tge Border size around the image
| Parameter [input]: | _size | New border size to set |
getImageSize
+ const ewol::Dimension & getImageSize (void ) const;get the current border request at the image
| Return: | the border size |
m_keepRatio
# bool m_keepRatio;keep the image ratio between width and hight
setKeepRatio
+ void setKeepRatio (bool _keep);set the current status of keeping ratio.
| Parameter [input]: | _keep | The new status of keeping the ratio of this image. |
getKeepRatio
+ bool getKeepRatio (void ) const;get the current status of keeping ratio.
| Return: | The status of keeping the ratio of this image. |
onDraw
# virtual void onDraw (void );Common widget drawing function (called by the drawing thread [Android, X11, ...])
onSetConfig
# virtual bool onSetConfig (const ewol::object::Config & _conf);Configuration requested to the curent Object
| Parameter [input]: | _conf | Configuration handle. |
| Return: | true if the parametere has been used |
onGetConfig
# virtual bool onGetConfig (const char* _config,Receive a configuration message from an other element system or from the curent Object
std::string & _result) const;
| Parameter [input]: | _config | Configuration name. | Parameter [output]: | _result | Result of the request. |
| Return: | true if the config is set |
calculateMinMaxSize
+ virtual void calculateMinMaxSize (void );calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
onRegenerateDisplay
+ virtual void onRegenerateDisplay (void );Event generated when a redraw is needed
onEventInput
+ virtual bool onEventInput (const ewol::event::Input & _event);Event on an input of this Widget (finger, mouse, stilet)
| Parameter [input]: | _event | Event properties |
| Return: | true the event is used<br/>false the event is not used |
loadXML
+ virtual bool loadXML (exml::Element* _node);load properties with an XML node.
| Parameter [input]: | _node | Pointer on the tinyXML node. |
| Return: | true : All has been done corectly.<br/>false : An error occured. |