#include <MyGUI_ScrollView.h>

Inheritance diagram for MyGUI::ScrollView:

Public Types
typedef RTTIBase	Base
typedef ScrollView	RTTIBase
Public Member Functions
virtual const std::string &	getTypeName () const
virtual bool	isType (const std::type_info &_type) const
template<typename Type >
bool	isType () const
	ScrollView ()
virtual void	setPosition (const IntPoint &_value)
virtual void	setSize (const IntSize &_value)
virtual void	setCoord (const IntCoord &_value)
void	setPosition (int _left, int _top)
void	setSize (int _width, int _height)
void	setCoord (int _left, int _top, int _width, int _height)
void	setVisibleVScroll (bool _value)
bool	isVisibleVScroll ()
void	setVisibleHScroll (bool _value)
bool	isVisibleHScroll ()
void	setCanvasAlign (Align _value)
Align	getCanvasAlign ()
void	setCanvasSize (const IntSize &_value)
void	setCanvasSize (int _width, int _height)
IntSize	getCanvasSize ()
const IntCoord &	getClientCoord ()
virtual void	setProperty (const std::string &_key, const std::string &_value)
virtual void	_initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin _info, Widget _parent, ICroppedRectangle _croppedParent, IWidgetCreator _creator, const std::string &_name)
void	setPosition (const IntCoord &_coord)
void	setPosition (int _left, int _top, int _width, int _height)
void	showVScroll (bool _visible)
bool	isShowVScroll ()
void	showHScroll (bool _visible)
bool	isShowHScroll ()
Static Public Member Functions
static const std::string &	getClassTypeName ()
Protected Member Functions
virtual	~ScrollView ()
void	baseChangeWidgetSkin (ResourceSkin *_info)
virtual Widget *	baseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name)
void	notifyMouseSetFocus (Widget _sender, Widget _old)
void	notifyMouseLostFocus (Widget _sender, Widget _new)
void	notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id)
void	notifyMouseReleased (Widget *_sender, int _left, int _top, MouseButton _id)
void	notifyScrollChangePosition (VScroll *_sender, size_t _position)
void	notifyMouseWheel (Widget *_sender, int _rel)
virtual void	onKeyLostFocus (Widget *_new)
virtual void	onKeySetFocus (Widget *_old)
void	updateScrollViewState ()
void	updateView ()
Protected Attributes
bool	mIsFocus
bool	mIsPressed
Widget *	mScrollClient
Align	mContentAlign

Detailed Description

Definition at line 33 of file MyGUI_ScrollView.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::ScrollView::Base

Definition at line 37 of file MyGUI_ScrollView.h.

typedef ScrollView MyGUI::ScrollView::RTTIBase

Reimplemented from MyGUI::Widget.

Definition at line 37 of file MyGUI_ScrollView.h.

Constructor & Destructor Documentation

MyGUI::ScrollView::ScrollView ( )

Definition at line 36 of file MyGUI_ScrollView.cpp.

MyGUI::ScrollView::~ScrollView ( ) [protected, virtual]

Definition at line 53 of file MyGUI_ScrollView.cpp.

Member Function Documentation

void MyGUI::ScrollView::_initialise	(	WidgetStyle	_style,
		const IntCoord &	_coord,
		Align	_align,
		ResourceSkin *	_info,
		Widget *	_parent,
		ICroppedRectangle *	_croppedParent,
		IWidgetCreator *	_creator,
		const std::string &	_name
	)		`[virtual]`

Reimplemented from MyGUI::Widget.

Definition at line 46 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::baseChangeWidgetSkin ( ResourceSkin * _info ) [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 58 of file MyGUI_ScrollView.cpp.

Widget * MyGUI::ScrollView::baseCreateWidget	(	WidgetStyle	_style,
		const std::string &	_type,
		const std::string &	_skin,
		const IntCoord &	_coord,
		Align	_align,
		const std::string &	_layer,
		const std::string &	_name
	)		`[protected, virtual]`

Reimplemented from MyGUI::Widget.

Definition at line 251 of file MyGUI_ScrollView.cpp.

Align MyGUI::ScrollView::getCanvasAlign ( ) [inline]

Get canvas align

Definition at line 69 of file MyGUI_ScrollView.h.

IntSize MyGUI::ScrollView::getCanvasSize ( )

Get canvas size

Definition at line 352 of file MyGUI_ScrollView.cpp.

static const std::string& MyGUI::ScrollView::getClassTypeName ( ) [inline, static]

Reimplemented from MyGUI::Widget.

Definition at line 37 of file MyGUI_ScrollView.h.

const IntCoord & MyGUI::ScrollView::getClientCoord ( )

Get rect where child widgets placed

Reimplemented from MyGUI::Widget.

Definition at line 347 of file MyGUI_ScrollView.cpp.

virtual const std::string& MyGUI::ScrollView::getTypeName ( ) const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 37 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isShowHScroll ( ) [inline]

Deprecated:: "use : bool ScrollView::isVisibleHScroll()"

Definition at line 102 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isShowVScroll ( ) [inline]

Deprecated:: "use : bool ScrollView::isVisibleVScroll()"

Definition at line 98 of file MyGUI_ScrollView.h.

template<typename Type >

bool MyGUI::ScrollView::isType ( ) const [inline]

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 37 of file MyGUI_ScrollView.h.

virtual bool MyGUI::ScrollView::isType ( const std::type_info & _type ) const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 37 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isVisibleHScroll ( ) [inline]

Get Show HScroll flag

Definition at line 64 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isVisibleVScroll ( ) [inline]

Get Show VScroll flag

Definition at line 59 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::notifyMouseLostFocus	(	Widget *	_sender,
		Widget *	_new
	)		`[protected]`

Definition at line 123 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyMousePressed	(	Widget *	_sender,
		int	_left,
		int	_top,
		MouseButton	_id
	)		`[protected]`

void MyGUI::ScrollView::notifyMouseReleased	(	Widget *	_sender,
		int	_left,
		int	_top,
		MouseButton	_id
	)		`[protected]`

void MyGUI::ScrollView::notifyMouseSetFocus	(	Widget *	_sender,
		Widget *	_old
	)		`[protected]`

Definition at line 114 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyMouseWheel	(	Widget *	_sender,
		int	_rel
	)		`[protected]`

Definition at line 204 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyScrollChangePosition	(	VScroll *	_sender,
		size_t	_position
	)		`[protected]`

Definition at line 185 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::onKeyLostFocus ( Widget * _new ) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 143 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::onKeySetFocus ( Widget * _old ) [protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 132 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCanvasAlign ( Align _value )

Set canvas align

Definition at line 307 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCanvasSize	(	int	_width,
		int	_height
	)		`[inline]`

Set canvas size

Definition at line 74 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setCanvasSize ( const IntSize & _value )

Set canvas size

Definition at line 313 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCoord	(	int	_left,
		int	_top,
		int	_width,
		int	_height
	)		`[inline]`

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 54 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setCoord ( const IntCoord & _value ) [virtual]

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 178 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setPosition ( const IntPoint & _value ) [virtual]

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 166 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setPosition ( const IntCoord & _coord ) [inline]

Deprecated:: "use : void Widget::setCoord(const IntCoord& _coord)"

Reimplemented from MyGUI::Widget.

Definition at line 91 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setPosition	(	int	_left,
		int	_top,
		int	_width,
		int	_height
	)		`[inline]`

Deprecated:: "use : void Widget::setCoord(int _left, int _top, int _width, int _height)"

Reimplemented from MyGUI::Widget.

Definition at line 93 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setPosition	(	int	_left,
		int	_top
	)		`[inline]`

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 50 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setProperty	(	const std::string &	_key,
		const std::string &	_value
	)		`[virtual]`

Set any widget property

Parameters:

_key	Property name (for example Widget_Alpha or Edit_MultiLine)
_value	Value converted to string

Reimplemented from MyGUI::Widget.

Definition at line 319 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setSize	(	int	_width,
		int	_height
	)		`[inline]`

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 52 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::setSize ( const IntSize & _value ) [virtual]

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 171 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setVisibleHScroll ( bool _value )

Show HScroll when text size larger than Edit

Definition at line 301 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setVisibleVScroll ( bool _value )

Show VScroll when text size larger than Edit

Definition at line 295 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::showHScroll ( bool _visible ) [inline]

Deprecated:: "use : void ScrollView::setVisibleHScroll(bool _visible)"

Definition at line 100 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::showVScroll ( bool _visible ) [inline]

Deprecated:: "use : void ScrollView::setVisibleVScroll(bool _visible)"

Definition at line 96 of file MyGUI_ScrollView.h.

void MyGUI::ScrollView::updateScrollViewState ( ) [protected]

Definition at line 154 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::updateView ( ) [protected]

Definition at line 289 of file MyGUI_ScrollView.cpp.

Field Documentation

Align MyGUI::ScrollView::mContentAlign [protected]

Definition at line 150 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::mIsFocus [protected]

Definition at line 146 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::mIsPressed [protected]

Definition at line 147 of file MyGUI_ScrollView.h.

Widget* MyGUI::ScrollView::mScrollClient [protected]

Definition at line 149 of file MyGUI_ScrollView.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation