class: ewol::widget::Image
Constructor and Destructor:
+ Image ();
+ virtual ~Image ();
Synopsis:
+ ewol::object::Signal<void> signalPressed;
# ewol::compositing::Image m_compositing;
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;
# int32_t m_colorId;
+ void init (const std::string & _file,
const ewol::Dimension & _border);
+ DECLARE_WIDGET_FACTORY (Image ,
"Image" );
+ void set (const std::string & _file,
const ewol::Dimension & _border);
# ewol::object::Param<std::string> m_fileName;
+ void setFile (const std::string & _file);
+ const std::string & getFile () const;
# ewol::object::Param<ewol::Dimension> m_border;
+ void setBorder (const ewol::Dimension & _border);
+ const ewol::Dimension & getBorder () const;
# ewol::object::Param<ewol::Dimension> m_imageSize;
+ void setImageSize (const ewol::Dimension & _size);
+ const ewol::Dimension & getImageSize () const;
# ewol::object::Param<bool> m_keepRatio;
+ void setKeepRatio (bool _keep);
+ bool getKeepRatio () const;
# ewol::object::ParamRange<vec2> m_posStart;
+ void setStartPos (const vec2 & _pos);
+ vec2 getStartPos () const;
# ewol::object::ParamRange<vec2> m_posStop;
+ void setStopPos (const vec2 & _pos);
+ vec2 getStopPos () const;
+ ewol::object::Param<bool> m_distanceFieldMode;
+ void setDistanceField (bool _df);
+ bool getDistanceField () const;
# virtual void onDraw ();
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
+ virtual void calculateMinMaxSize ();
+ virtual void onRegenerateDisplay ();
+ virtual bool onEventInput (const ewol::event::Input & _event);
+ virtual bool loadXML (exml::Element* _node);
Object Hierarchy:
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Image
Detail:
signalPressed
+ ewol::object::Signal<void> signalPressed;
m_compositing
# ewol::compositing::Image m_compositing;
compositing element of the image.
m_colorProperty
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;
theme color property
m_colorId
# int32_t m_colorId;
Color of the image.
Image
+ Image ();
init
+ void init (const std::string & _file,
const ewol::Dimension & _border);
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (Image ,
"Image" );
~Image
+ virtual ~Image ();
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
# ewol::object::Param<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 () const;
get the file displayed
Return: the filename of the image
m_border
# ewol::object::Param<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 () const;
get the current border request at the image
Return: the border size
m_imageSize
# ewol::object::Param<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 () const;
get the current border request at the image
Return: the border size
m_keepRatio
# ewol::object::Param<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 () const;
get the current status of keeping ratio.
Return: The status of keeping the ratio of this image.
m_posStart
# ewol::object::ParamRange<vec2> m_posStart;
position in the image to start the sisplay (when we want not to display all the image)
setStartPos
+ void setStartPos (const vec2 & _pos);
set the current 'start' position in the image to display.
Parameter [input]: _keep The new position in the image vec2([0..1],[0..1])
getStartPos
+ vec2 getStartPos () const;
get the current 'start' position in the image to display.
Return: The Position of the display in image
m_posStop
# ewol::object::ParamRange<vec2> m_posStop;
position in the image to start the sisplay (when we want not to display all the image)
setStopPos
+ void setStopPos (const vec2 & _pos);
set the current 'stop' position in the image to display.
Parameter [input]: _keep The new position in the image vec2([0..1],[0..1])
getStopPos
+ vec2 getStopPos () const;
get the current 'stop' position in the image to display.
Return: The Position of the display in image
m_distanceFieldMode
+ ewol::object::Param<bool> m_distanceFieldMode;
to have a parameter
setDistanceField
+ void setDistanceField (bool _df);
Set distance field rendering mode
Parameter [input]: _df enable distance field
getDistanceField
+ bool getDistanceField () const;
Get the distance field render mode.
Return: Status of the distance field render mode.
onDraw
# virtual void onDraw ();
Common widget drawing function (called by the drawing thread [Android, X11, ...])
onParameterChangeValue
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
calculateMinMaxSize
+ virtual void calculateMinMaxSize ();
calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
onRegenerateDisplay
+ virtual void onRegenerateDisplay ();
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.
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> ewol::widget::Image
Detail:
signalPressed
+ ewol::object::Signal<void> signalPressed;
m_compositing
# ewol::compositing::Image m_compositing;compositing element of the image.
m_colorProperty
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;theme color property
m_colorId
# int32_t m_colorId;Color of the image.
Image
+ Image ();
init
+ void init (const std::string & _file,
const ewol::Dimension & _border);
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (Image ,
"Image" );
~Image
+ virtual ~Image ();
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
# ewol::object::Param<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 () const;get the file displayed
| Return: | the filename of the image |
m_border
# ewol::object::Param<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 () const;get the current border request at the image
| Return: | the border size |
m_imageSize
# ewol::object::Param<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 () const;get the current border request at the image
| Return: | the border size |
m_keepRatio
# ewol::object::Param<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 () const;get the current status of keeping ratio.
| Return: | The status of keeping the ratio of this image. |
m_posStart
# ewol::object::ParamRange<vec2> m_posStart;position in the image to start the sisplay (when we want not to display all the image)
setStartPos
+ void setStartPos (const vec2 & _pos);set the current 'start' position in the image to display.
| Parameter [input]: | _keep | The new position in the image vec2([0..1],[0..1]) |
getStartPos
+ vec2 getStartPos () const;get the current 'start' position in the image to display.
| Return: | The Position of the display in image |
m_posStop
# ewol::object::ParamRange<vec2> m_posStop;position in the image to start the sisplay (when we want not to display all the image)
setStopPos
+ void setStopPos (const vec2 & _pos);set the current 'stop' position in the image to display.
| Parameter [input]: | _keep | The new position in the image vec2([0..1],[0..1]) |
getStopPos
+ vec2 getStopPos () const;get the current 'stop' position in the image to display.
| Return: | The Position of the display in image |
m_distanceFieldMode
+ ewol::object::Param<bool> m_distanceFieldMode;to have a parameter
setDistanceField
+ void setDistanceField (bool _df);Set distance field rendering mode
| Parameter [input]: | _df | enable distance field |
getDistanceField
+ bool getDistanceField () const;Get the distance field render mode.
| Return: | Status of the distance field render mode. |
onDraw
# virtual void onDraw ();Common widget drawing function (called by the drawing thread [Android, X11, ...])
onParameterChangeValue
# virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
calculateMinMaxSize
+ virtual void calculateMinMaxSize ();calculate the minimum and maximum size (need to estimate expend properties of the widget)
Note: : INTERNAL EWOL SYSTEM
onRegenerateDisplay
+ virtual void onRegenerateDisplay ();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. |