#include <WidgetScrolled.hpp>

Inheritance diagram for ewol::widget::WidgetScrolled:

Public Types
enum	scrollingMode { scroolModeNormal, scroolModeCenter, scroolModeGame }

Public Member Functions
void	setSingleFinger (bool _status)

bool	getSingleFinger ()

	DECLARE_WIDGET_FACTORY (WidgetScrolled, "WidgetScrolled")

virtual	~WidgetScrolled ()

void	onRegenerateDisplay () override

bool	onEventInput (const ewol::event::Input &_event) override

void	systemDraw (const ewol::DrawProperty &_displayProp) override

Public Member Functions inherited from ewol::Widget
virtual	~Widget ()

virtual vec2	relativePosition (const vec2 &_pos)

virtual void	onChangeSize ()

virtual void	calculateSize ()

virtual vec2	getSize ()

virtual void	setSize (const vec2 &_value)

virtual void	calculateMinMaxSize ()

virtual vec2	getCalculateMinSize ()

virtual vec2	getCalculateMaxSize ()

virtual void	setOffset (const vec2 &_newVal)

virtual const vec2 &	getOffset ()

virtual void	setZoom (float _newVal)

virtual float	getZoom ()

virtual void	changeZoom (float _range)

virtual void	setOrigin (const vec2 &_pos)

virtual vec2	getOrigin ()

void	setNoMinSize ()

virtual void	checkMinSize ()

void	setNoMaxSize ()

virtual void	checkMaxSize ()

virtual bvec2	canExpand ()

const bvec2 &	canFill ()

virtual bool	getFocus ()

virtual bool	setFocus ()

virtual bool	rmFocus ()

virtual void	keepFocus ()

virtual int32_t	getMouseLimit ()

virtual void	setMouseLimit (int32_t _numberState)

virtual bool	getKeyboardRepeate ()

virtual ewol::WidgetShared	getWidgetAtPos (const vec2 &_pos)

virtual bool	systemEventInput (ewol::event::InputSystem &_event)

virtual bool	systemEventEntry (ewol::event::EntrySystem &_event)

virtual void	onEventClipboard (enum gale::context::clipBoard::clipboardListe _clipboardID)

virtual bool	onEventShortCut (const gale::key::Special &_special, char32_t _unicodeValue, enum gale::key::keyboard _kbMove, bool _isDown)

virtual void	grabCursor ()

virtual void	unGrabCursor ()

virtual bool	getGrabStatus ()

virtual void	setCursor (enum gale::context::cursor _newCursor)

virtual enum gale::context::cursor	getCursor ()

virtual bool	loadXML (const exml::Element &_node) override

void	requestUpdateSize ()

ewol::widget::Manager &	getWidgetManager ()

ememory::SharedPtr< ewol::widget::Windows >	getWindows ()

void	setAnnimationType (enum ewol::Widget::annimationMode _mode, const std::string &_type)

void	setAnnimationTime (enum ewol::Widget::annimationMode _mode, float _time)

bool	startAnnimation (enum ewol::Widget::annimationMode _mode)

bool	stopAnnimation ()

Public Member Functions inherited from ewol::Object
	DECLARE_FACTORY (Object)

virtual	~Object ()

bool	objectHasBeenCorectlyInit ()

virtual void	destroy ()

bool	isDestroyed () const

virtual void	setParent (const ewol::ObjectShared &_newParent)

virtual void	removeParent ()

const char *const	getObjectType () const

std::string	getTypeDescription () const

bool	isTypeCompatible (const std::string &_type) const

bool	getStatic ()

int32_t	getId ()

bool	propertySetOnWidgetNamed (const std::string &_objectName, const std::string &_config, const std::string &_value)

virtual bool	storeXML (exml::Element &_node) const

void	setStatusResource (bool _val)

bool	getStatusResource () const

virtual ewol::ObjectShared	getSubObjectNamed (const std::string &_objectName)

Public Member Functions inherited from ememory::EnableSharedFromThis< Object >
ememory::SharedPtr< EMEMORY_TYPE >	sharedFromThis ()

const ememory::SharedPtr< EMEMORY_TYPE >	sharedFromThis () const

ememory::WeakPtr< EMEMORY_TYPE >	weakFromThis ()

const ememory::WeakPtr< EMEMORY_TYPE >	weakFromThis () const

Public Attributes
eproperty::Value< std::string >	propertyShapeVert

eproperty::Value< std::string >	propertyShapeHori

Public Attributes inherited from ewol::Widget
eproperty::Value< gale::Dimension >	propertyMinSize

eproperty::Value< gale::Dimension >	propertyMaxSize

eproperty::Value< bvec2 >	propertyExpand

eproperty::Value< bvec2 >	propertyFill

eproperty::Value< bool >	propertyHide

eproperty::List< enum ewol::gravity >	propertyGravity

eproperty::Value< bool >	propertyCanFocus

esignal::Signal< std::string >	signalShortcut

esignal::Signal	signalAnnimationStart

esignal::Signal< float >	signalAnnimationRatio

esignal::Signal	signalAnnimationStop

Public Attributes inherited from ewol::Object
eproperty::Value< std::string >	propertyName

Public Attributes inherited from eproperty::Interface
eproperty::InterfaceData	properties

Protected Member Functions
	WidgetScrolled ()

void	init () override

void	onDraw () override

void	setScrollingSize (float _nbPixel)

void	scroolingMode (enum scrollingMode _newMode)

void	setMaxSize (const vec2 &_localSize)

void	setScrollingPositionDynamic (vec2 _borderWidth, const vec2 &_currentPosition, bool _center=false)

void	setLimitScrolling (float _poucentageLimit)

virtual void	onChangePropertyShapeVert ()

virtual void	onChangePropertyShapeHori ()

Protected Member Functions inherited from ewol::Widget
	Widget ()

virtual void	onGetFocus ()

virtual void	onLostFocus ()

virtual void	setKeyboardRepeate (bool _state)

virtual void	showKeyboard ()

virtual void	hideKeyboard ()

virtual bool	onEventEntry (const ewol::event::Entry &_event)

virtual void	shortCutAdd (const std::string &_descriptiveString, const std::string &_message="")

virtual void	shortCutClean ()

virtual void	shortCutRemove (const std::string &_message)

virtual void	markToRedraw ()

virtual bool	needRedraw ()

void	addAnnimationType (enum ewol::Widget::annimationMode _mode, const char *_type)

virtual bool	onStartAnnimation (enum ewol::Widget::annimationMode _mode)

virtual void	onStopAnnimation ()

virtual void	onChangePropertyCanFocus ()

virtual void	onChangePropertyGravity ()

virtual void	onChangePropertyHide ()

virtual void	onChangePropertyFill ()

virtual void	onChangePropertyExpand ()

virtual void	onChangePropertyMaxSize ()

virtual void	onChangePropertyMinSize ()

Protected Member Functions inherited from ewol::Object
	Object ()

virtual void	autoDestroy ()

virtual void	requestDestroyFromChild (const ewol::ObjectShared &_child)

void	addObjectType (const char *_type)

Protected Attributes
vec2	m_originScrooled

vec2	m_maxSize

float	m_limitScrolling

Protected Attributes inherited from ewol::Widget
vec2	m_size

vec2	m_minSize

vec2	m_maxSize

vec2	m_offset

float	m_zoom

vec2	m_origin

bool	m_needRegenerateDisplay

enum annimationMode	m_annimationMode

float	m_annimationratio

eproperty::List< int32_t >	propertyAnnimationTypeStart

eproperty::Range< float >	propertyAnnimationTimeStart

eproperty::List< int32_t >	propertyAnnimationTypeStop

eproperty::Range< float >	propertyAnnimationTimeStop

Protected Attributes inherited from ewol::Object
ewol::ObjectWeak	m_parent

bool	m_destroy

bool	m_static

Additional Inherited Members
Static Public Member Functions inherited from ewol::Object
static ewol::object::Manager &	getObjectManager ()

static ewol::Context &	getContext ()

static ewol::ObjectShared	getObjectNamed (const std::string &_objectName)

Protected Types inherited from ewol::Widget
enum	annimationMode { annimationModeEnableAdd, annimationModeEnableRemove, annimationModeDisable }

Detailed Description

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

Member Enumeration Documentation

§ scrollingMode

enum ewol::widget::WidgetScrolled::scrollingMode

Enumerator
scroolModeNormal	No Zoom , can UP and down, left and right.
scroolModeCenter	Zoom enable, no move left and right.
scroolModeGame	Zoom enable, no move left and right.

Constructor & Destructor Documentation

§ WidgetScrolled()

ewol::widget::WidgetScrolled::WidgetScrolled ( )

protected

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

Parameters

[in] _shaperName Shaper name if the scrolled widget.

§ ~WidgetScrolled()

virtual ewol::widget::WidgetScrolled::~WidgetScrolled ( )

virtual

Scroll widget destructor.

Member Function Documentation

§ getSingleFinger()

bool ewol::widget::WidgetScrolled::getSingleFinger ( )

inline

Get the single finger capabilities.

Returns: true The single finger mode is active; false The To finger mode is active

§ onDraw()

void ewol::widget::WidgetScrolled::onDraw ( )

overrideprotectedvirtual

Common widget drawing function (called by the drawing thread [Android, X11, ...])

Reimplemented from ewol::Widget.

§ onEventInput()

bool ewol::widget::WidgetScrolled::onEventInput ( const ewol::event::Input & _event )

overridevirtual

Event on an input of this Widget (finger, mouse, stilet)

Parameters

[in] _event Event properties

Returns: true the event is used; false the event is not used

Reimplemented from ewol::Widget.

§ onRegenerateDisplay()

void ewol::widget::WidgetScrolled::onRegenerateDisplay ( )

overridevirtual

Event generated when a redraw is needed.

Reimplemented from ewol::Widget.

§ scroolingMode()

void ewol::widget::WidgetScrolled::scroolingMode ( enum scrollingMode _newMode )

protected

Specify the mode of scrolling for this windows.

Parameters

[in] _newMode the selected mode for the scrolling...

§ setLimitScrolling()

void ewol::widget::WidgetScrolled::setLimitScrolling ( float _poucentageLimit )

inlineprotected

set the scrolling limit when arriving at he end of the widget

Parameters

[in] _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end ...

§ setMaxSize()

void ewol::widget::WidgetScrolled::setMaxSize ( const vec2 & _localSize )

inlineprotected

set the specific mawimum size of the widget

Parameters

[in] _localSize new Maximum size

§ setScrollingPositionDynamic()

void ewol::widget::WidgetScrolled::setScrollingPositionDynamic	(	vec2	_borderWidth,
		const vec2 &	_currentPosition,
		bool	_center = `false`
	)

protected

Request a specific position for the scrolling of the current windows.

Parameters

[in]	_borderWidth	size of the border that requested the element might not to be
[in]	_currentPosition	Position that is requested to view
[in]	_center	True if the position might be at the center of the widget

§ setScrollingSize()

void ewol::widget::WidgetScrolled::setScrollingSize ( float _nbPixel )

inlineprotected

For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled.

Parameters

[in] _nbPixel number of pixel scrolling

§ setSingleFinger()

void ewol::widget::WidgetScrolled::setSingleFinger ( bool _status )

Set the single finger capabilities/.

Parameters

[in] _status True if single inger mode, two otherwise/

§ systemDraw()

void ewol::widget::WidgetScrolled::systemDraw ( const ewol::DrawProperty & _displayProp )

overridevirtual

{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

Parameters

[in] _displayProp properties of the current display

Note: : INTERNAL EWOL SYSTEM

Reimplemented from ewol::Widget.

Member Data Documentation

§ m_limitScrolling

float ewol::widget::WidgetScrolled::m_limitScrolling

protected

Mimit scrolling represent the propertion of the minimel scrolling activate (0.2 ==> 20% migt all time be visible)

§ m_maxSize

vec2 ewol::widget::WidgetScrolled::m_maxSize

protected

Maximum size of the Widget ==> to display scrollbar.

§ m_originScrooled

vec2 ewol::widget::WidgetScrolled::m_originScrooled

protected

pixel distance from the origin of the display (Bottum left)

§ propertyShapeHori

eproperty::Value<std::string> ewol::widget::WidgetScrolled::propertyShapeHori

Horizontal shaper name.

§ propertyShapeVert

eproperty::Value<std::string> ewol::widget::WidgetScrolled::propertyShapeVert

Vertical shaper name.

The documentation for this class was generated from the following file:

framework/atria-soft/ewol/ewol/widget/WidgetScrolled.hpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

§ scrollingMode

Constructor & Destructor Documentation

§ WidgetScrolled()

§ ~WidgetScrolled()

Member Function Documentation

§ getSingleFinger()

§ onDraw()

§ onEventInput()

§ onRegenerateDisplay()

§ scroolingMode()

§ setLimitScrolling()

§ setMaxSize()

§ setScrollingPositionDynamic()

§ setScrollingSize()

§ setSingleFinger()

§ systemDraw()

Member Data Documentation

§ m_limitScrolling

§ m_maxSize

§ m_originScrooled

§ propertyShapeHori

§ propertyShapeVert