ewol library

   [ sources ]

API:

Documentation:

Tutorials:


Associate libraries:







class: ewol::widget::WidgetScrolled

Description:

Widget to integrate a scrool bar in a widget. This is not a stadalone widget.

enum:

Constructor and Destructor:

#                                   WidgetScrolled              ();
+ virtual                           ~WidgetScrolled             ();

Synopsis:

#         vec2                      m_originScrooled;
#         vec2                      m_maxSize;
#         float                     m_limitScrolling;
+         void                      setSingleFinger             (bool _status);
+         bool                      getSingleFinger             ();
#         void                      init                        (const std::string & _shaperName);
+                                   DECLARE_WIDGET_FACTORY      (WidgetScrolled ,
                                                                 "WidgetScrolled" );
# virtual void                      onDraw                      ();
+ virtual void                      onRegenerateDisplay         ();
+ virtual bool                      onEventInput                (const ewol::event::Input & _event);
+ virtual void                      systemDraw                  (const ewol::DrawProperty & _displayProp);
#         void                      setScrollingSize            (float _nbPixel);
#         void                      scroolingMode               (enum scrollingMode _newMode);
#         void                      setMaxSize                  (const vec2 & _localSize);
#         void                      setScrollingPositionDynamic (vec2 _borderWidth,
                                                                 const vec2 & _currentPosition,
                                                                 bool _center);
#         void                      setLimitScrolling           (float _poucentageLimit);

Object Hierarchy:

+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
  +--> +ewol::Object
         +--> +ewol::Widget
                +--> ewol::widget::WidgetScrolled
                       +--> ewol::widget::List
                       +--> ewol::widget::ParameterList

Detail:

m_originScrooled

# vec2 m_originScrooled;
pixel distance from the origin of the display (Bottum left)

m_maxSize

# vec2 m_maxSize;
Maximum size of the Widget ==> to display scrollbar

m_limitScrolling

# float m_limitScrolling;
Mimit scrolling represent the propertion of the minimel scrolling activate (0.2 ==> 20% migt all time be visible) mode of management of the scrooling

setSingleFinger

+ void setSingleFinger (bool _status);
Set the single finger capabilities/

getSingleFinger

+ bool getSingleFinger ();
Get the single finger capabilities

WidgetScrolled

#  WidgetScrolled ();
Scroll Widget main constructor to be herited from an other widget (this is not a stand-alone widget)

init

# void init (const std::string & _shaperName);


DECLARE_WIDGET_FACTORY

+  DECLARE_WIDGET_FACTORY (WidgetScrolled ,
                           "WidgetScrolled" );


~WidgetScrolled

+ virtual  ~WidgetScrolled ();
Scroll widget destructor.

onDraw

# virtual void onDraw ();
Common widget drawing function (called by the drawing thread [Android, X11, ...])

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)

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

setScrollingSize

# void setScrollingSize (float _nbPixel);
For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled

scroolingMode

# void scroolingMode (enum scrollingMode _newMode);
Specify the mode of scrolling for this windows

setMaxSize

# void setMaxSize (const vec2 & _localSize);
set the specific mawimum size of the widget

setScrollingPositionDynamic

# void setScrollingPositionDynamic (vec2 _borderWidth,
                                    const vec2 & _currentPosition,
                                    bool _center);
Request a specific position for the scrolling of the current windows.

setLimitScrolling

# void setLimitScrolling (float _poucentageLimit);
set the scrolling limit when arriving at he end of the widget