class: ewol::widget::Scroll
enum:
Constructor and Destructor:
+ Scroll (void );
+ virtual ~Scroll (void );
Synopsis:
+ const char* const configLimit;
+ void init (ewol::widget::Manager & _widgetManager);
# vec2 m_limit;
+ void setLimit (const vec2 & _limit);
+ const vec2 & getLimit (void ) const;
+ void calculateMinMaxSize (void );
+ virtual void onRegenerateDisplay (void );
+ virtual bool onEventInput (const ewol::event::Input & _event);
+ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
+ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
# virtual void onDraw (void );
# virtual bool onSetConfig (const ewol::object::Config & _conf);
# virtual bool onGetConfig (const char* _config,
std::string & _result) const;
Object Hierarchy:
+ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::Container
+--> ewol::widget::Scroll
Detail:
configLimit
+ const char* const configLimit;
init
+ void init (ewol::widget::Manager & _widgetManager);
m_limit
# vec2 m_limit;
Scroll
+ Scroll (void );
~Scroll
+ virtual ~Scroll (void );
setLimit
+ void setLimit (const vec2 & _limit);
set the limit of scrolling
Note: This permit to scoll element upper the end of the display
Parameter [input]: _limit scrolling limit [0..1] (represent a pourcent)
getLimit
+ const vec2 & getLimit (void ) const;
get the limit of scrolling
Return: scrolling limit
calculateMinMaxSize
+ 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
systemDraw
+ virtual void systemDraw (const ewol::DrawProperty & _displayProp);
{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...])
This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
Parameter [input]: _displayProp properties of the current display
getWidgetAtPos
+ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);
get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
Parameter [input]: _pos gAbsolute position of the requested widget knowledge
Return: NULL No widget found<br/>pointer on the widget found
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
+ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::Container
+--> ewol::widget::Scroll
Detail:
configLimit
+ const char* const configLimit;
init
+ void init (ewol::widget::Manager & _widgetManager);
m_limit
# vec2 m_limit;
Scroll
+ Scroll (void );
~Scroll
+ virtual ~Scroll (void );
setLimit
+ void setLimit (const vec2 & _limit);set the limit of scrolling
Note: This permit to scoll element upper the end of the display
| Parameter [input]: | _limit | scrolling limit [0..1] (represent a pourcent) |
getLimit
+ const vec2 & getLimit (void ) const;get the limit of scrolling
| Return: | scrolling limit |
calculateMinMaxSize
+ 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 |
systemDraw
+ virtual void systemDraw (const ewol::DrawProperty & _displayProp);{SYSTEM} extern interface to request a draw ... (called by the drawing thread [Android, X11, ...]) This function generate a clipping with the viewport openGL system. Like this a widget draw can not draw over an other widget
Note: This function is virtual for the scrolled widget, and the more complicated openGl widget
Note: : INTERNAL EWOL SYSTEM
| Parameter [input]: | _displayProp | properties of the current display |
getWidgetAtPos
+ virtual ewol::Widget* getWidgetAtPos (const vec2 & _pos);get the widget at the specific windows absolute position
Note: : INTERNAL EWOL SYSTEM
| Parameter [input]: | _pos | gAbsolute position of the requested widget knowledge |
| Return: | NULL No widget found<br/>pointer on the widget found |
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 |