ScrollView properties. ScrollView_skin_childs Skin childs. ScrollView widget description should be here. More...

#include <MyGUI_ScrollView.h>

Inheritance diagram for MyGUI::ScrollView:

Public Types
typedef RTTIBase	Base

typedef ScrollView	RTTIBase

Public Types inherited from MyGUI::Widget
typedef RTTIBase	Base

typedef Widget	RTTIBase

Public Types inherited from MyGUI::IObject
typedef IObject	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 () const

void	setVisibleHScroll (bool _value)

bool	isVisibleHScroll () const

void	setCanvasAlign (Align _value)

Align	getCanvasAlign () const

void	setCanvasSize (const IntSize &_value)

void	setCanvasSize (int _width, int _height)

IntSize	getCanvasSize ()

IntCoord	getViewCoord () const

void	setViewOffset (const IntPoint &_value)

IntPoint	getViewOffset () const

Public Member Functions inherited from MyGUI::Widget
template<typename Type >
bool	isType () const

	Widget ()

Widget *	createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")

Widget *	createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")

Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")

Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")

template<typename T >
T *	createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")

template<typename T >
T *	createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")

template<typename T >
T *	createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")

template<typename T >
T *	createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")

Widget *	createWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

template<typename T >
T *	createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

void	setPosition (int _left, int _top)

void	setSize (int _width, int _height)

void	setCoord (int _left, int _top, int _width, int _height)

void	setRealPosition (const FloatPoint &_value)

void	setRealSize (const FloatSize &_value)

void	setRealCoord (const FloatCoord &_value)

void	setRealPosition (float _left, float _top)

void	setRealSize (float _width, float _height)

void	setRealCoord (float _left, float _top, float _width, float _height)

const std::string &	getName () const
	Get name of widget. More...

virtual void	setVisible (bool _value)

bool	getVisible () const

void	setDepth (int _value)

int	getDepth () const

bool	getInheritedVisible () const

virtual void	setAlign (Align _value)

Align	getAlign () const

void	setAlpha (float _value)

float	getAlpha () const

void	setInheritsAlpha (bool _value)

bool	getInheritsAlpha () const

void	setColour (const Colour &_value)

bool	isRootWidget () const

Widget *	getParent () const

IntSize	getParentSize () const

EnumeratorWidgetPtr	getEnumerator () const

size_t	getChildCount ()

Widget *	getChildAt (size_t _index)

Widget *	findWidget (const std::string &_name)

void	findWidgets (const std::string &_name, VectorWidgetPtr &_result)

virtual void	setEnabled (bool _value)

void	setEnabledSilent (bool _value)

bool	getEnabled () const

bool	getInheritedEnabled () const

IntCoord	getClientCoord ()

Widget *	getClientWidget ()

void	detachFromWidget (const std::string &_layer="")

void	attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")

void	changeWidgetSkin (const std::string &_skinName)

void	setWidgetStyle (WidgetStyle _style, const std::string &_layer="")

WidgetStyle	getWidgetStyle () const

void	setProperty (const std::string &_key, const std::string &_value)

virtual size_t	_getItemIndex (Widget *_item)

void	_forcePick (Widget *_widget)

void	_initialise (WidgetStyle _style, const IntCoord &_coord, const std::string &_skinName, Widget _parent, ICroppedRectangle _croppedParent, const std::string &_name)

void	_shutdown ()

void	_destroyChildWidget (Widget *_widget)

void	_setContainer (Widget *_value)

Widget *	_getContainer ()

void	_setAlign (const IntSize &_oldsize, const IntSize &_newSize)

bool	_checkPoint (int _left, int _top) const

Widget *	_createSkinWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")

virtual void	_resetContainer (bool _update)

bool	_setWidgetState (const std::string &_value)

void	_updateChilds ()

Public Member Functions inherited from MyGUI::IObject
template<typename Type >
bool	isType () const

template<typename Type >
Type *	castType (bool _throw=true)

template<typename Type >
const Type *	castType (bool _throw=true) const

	IObject ()

virtual	~IObject ()

Public Member Functions inherited from MyGUI::ICroppedRectangle
	ICroppedRectangle ()

virtual	~ICroppedRectangle ()

ICroppedRectangle *	getCroppedParent ()

IntPoint	getPosition () const

IntSize	getSize () const

const IntCoord &	getCoord () const

const IntPoint &	getAbsolutePosition () const

IntRect	getAbsoluteRect () const

IntCoord	getAbsoluteCoord () const

int	getAbsoluteLeft () const

int	getAbsoluteTop () const

int	getLeft () const

int	getRight () const

int	getTop () const

int	getBottom () const

int	getWidth () const

int	getHeight () const

bool	_isMargin () const

int	_getViewLeft () const

int	_getViewRight () const

int	_getViewTop () const

int	_getViewBottom () const

int	_getViewWidth () const

int	_getViewHeight () const

void	_setCroppedParent (ICroppedRectangle *_parent)

const IntRect &	_getMargin () const

int	_getMarginLeft () const

int	_getMarginRight () const

int	_getMarginTop () const

int	_getMarginBottom () const

Public Member Functions inherited from MyGUI::UserData
	UserData ()

virtual	~UserData ()

void	setUserString (const std::string &_key, const std::string &_value)

const std::string &	getUserString (const std::string &_key) const

const MapString &	getUserStrings () const

bool	clearUserString (const std::string &_key)

bool	isUserString (const std::string &_key) const

void	clearUserStrings ()

void	setUserData (Any _data)

template<typename ValueType >
ValueType *	getUserData (bool _throw=true) const

void	_setInternalData (Any _data)

template<typename ValueType >
ValueType *	_getInternalData (bool _throw=true) const

Public Member Functions inherited from MyGUI::WidgetInput
	WidgetInput ()

virtual	~WidgetInput ()

void	setNeedToolTip (bool _value)

bool	getNeedToolTip () const

void	setPointer (const std::string &_value)

const std::string &	getPointer () const

void	setNeedKeyFocus (bool _value)

bool	getNeedKeyFocus () const

void	setNeedMouseFocus (bool _value)

bool	getNeedMouseFocus () const

void	setInheritsPick (bool _value)

bool	getInheritsPick () const

void	setMaskPick (const std::string &_filename)

void	setMaskPick (const MaskPickInfo &_info)

bool	isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const

bool	getRootMouseFocus () const

bool	getRootKeyFocus () const

void	_riseMouseLostFocus (Widget *_new)

void	_riseMouseSetFocus (Widget *_old)

void	_riseMouseDrag (int _left, int _top, MouseButton _id)

void	_riseMouseMove (int _left, int _top)

void	_riseMouseWheel (int _rel)

void	_riseMouseButtonPressed (int _left, int _top, MouseButton _id)

void	_riseMouseButtonReleased (int _left, int _top, MouseButton _id)

void	_riseMouseButtonClick ()

void	_riseMouseButtonDoubleClick ()

void	_riseKeyLostFocus (Widget *_new)

void	_riseKeySetFocus (Widget *_old)

void	_riseKeyButtonPressed (KeyCode _key, Char _char)

void	_riseKeyButtonReleased (KeyCode _key)

void	_riseMouseChangeRootFocus (bool _focus)

void	_riseKeyChangeRootFocus (bool _focus)

void	_setRootMouseFocus (bool _value)

void	_setRootKeyFocus (bool _value)

Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual	~IDelegateUnlink ()

	IDelegateUnlink ()

bool	compare (IDelegateUnlink *_unlink) const

Public Member Functions inherited from MyGUI::SkinItem
	SkinItem ()

ISubWidgetText *	getSubWidgetText ()

ISubWidgetRect *	getSubWidgetMain ()

void	_setTextureName (const std::string &_texture)

const std::string &	_getTextureName () const

Public Member Functions inherited from MyGUI::LayerItem
	LayerItem ()

virtual	~LayerItem ()

ILayer *	getLayer () const

ILayerNode *	getLayerNode () const

virtual void	attachItemToNode (ILayer _layer, ILayerNode _node)

virtual void	detachFromLayer ()

virtual void	upLayerItem ()

void	setRenderItemTexture (ITexture *_texture)

void	addChildItem (LayerItem *_item)

void	removeChildItem (LayerItem *_item)

void	addChildNode (LayerItem *_item)

void	removeChildNode (LayerItem *_item)

void	addRenderItem (ISubWidget *_item)

void	removeAllRenderItems ()

void	saveLayerItem ()

void	restoreLayerItem ()

Public Member Functions inherited from MyGUI::ILayerItem
virtual	~ILayerItem ()

Public Member Functions inherited from MyGUI::MemberObsolete< Widget >
bool	isEnabled ()

bool	isInheritsAlpha ()

bool	isNeedKeyFocus ()

bool	isNeedMouseFocus ()

bool	isInheritsPick ()

bool	isVisible ()

Public Member Functions inherited from MyGUI::MemberObsolete< ScrollView >
void	showVScroll (bool _visible)

bool	isShowVScroll ()

void	showHScroll (bool _visible)

bool	isShowHScroll ()

Static Public Member Functions
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::Widget
static const std::string &	getClassTypeName ()

Static Public Member Functions inherited from MyGUI::IObject
static const std::string &	getClassTypeName ()

Protected Member Functions
virtual void	initialiseOverride ()

virtual void	shutdownOverride ()

void	notifyMousePressed (Widget *_sender, int _left, int _top, MouseButton _id)

void	notifyMouseReleased (Widget *_sender, int _left, int _top, MouseButton _id)

void	notifyScrollChangePosition (ScrollBar *_sender, size_t _position)

void	notifyMouseWheel (Widget *_sender, int _rel)

void	updateView ()

virtual void	setPropertyOverride (const std::string &_key, const std::string &_value)

ScrollBar *	getVScroll ()

Protected Member Functions inherited from MyGUI::Widget
virtual	~Widget ()

void	_updateView ()

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, bool _template)

void	_destroyAllChildWidget ()

virtual size_t	_getContainerIndex (const IntPoint &_point)

virtual void	baseUpdateEnable ()

virtual ILayerItem *	getLayerItemByPoint (int _left, int _top) const

virtual const IntCoord &	getLayerItemCoord () const

template<typename T >
void	assignWidget (T *&_widget, const std::string &_name)

VectorWidgetPtr	getSkinWidgetsByName (const std::string &_name)

void	destroySkinWidget (Widget *_widget)

virtual void	onWidgetCreated (Widget *_widget)

virtual void	onWidgetDestroy (Widget *_widget)

void	setWidgetClient (Widget *_widget)

Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool	_checkMargin ()

bool	_checkOutside () const

Protected Member Functions inherited from MyGUI::WidgetInput
virtual void	onMouseLostFocus (Widget *_new)

virtual void	onMouseSetFocus (Widget *_old)

virtual void	onMouseDrag (int _left, int _top, MouseButton _id)

virtual void	onMouseMove (int _left, int _top)

virtual void	onMouseWheel (int _rel)

virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)

virtual void	onMouseButtonClick ()

virtual void	onMouseButtonDoubleClick ()

virtual void	onKeyLostFocus (Widget *_new)

virtual void	onKeySetFocus (Widget *_old)

virtual void	onKeyButtonPressed (KeyCode _key, Char _char)

virtual void	onKeyButtonReleased (KeyCode _key)

virtual void	onMouseChangeRootFocus (bool _focus)

virtual void	onKeyChangeRootFocus (bool _focus)

Protected Member Functions inherited from MyGUI::SkinItem
void	_createSkinItem (ResourceSkin *_info)

void	_deleteSkinItem ()

void	_setSkinItemAlign (const IntSize &_size)

void	_setSkinItemVisible (bool _value)

void	_setSkinItemColour (const Colour &_value)

void	_setSkinItemAlpha (float _value)

void	_correctSkinItemView ()

void	_updateSkinItemView ()

bool	_setSkinItemState (const std::string &_state)

void	_setSubSkinVisible (bool _visible)

Protected Member Functions inherited from MyGUI::LayerItem
void	attachToLayerItemNode (ILayerNode *_node, bool _deep)

void	detachFromLayerItemNode (bool _deep)

Protected Member Functions inherited from MyGUI::ScrollViewBase
	ScrollViewBase ()

virtual	~ScrollViewBase ()

void	updateScrollSize ()

void	updateScrollPosition ()

virtual void	eraseContent ()

Protected Member Functions inherited from MyGUI::MemberObsolete< ScrollView >
void	showVScroll (bool _visible)

bool	isShowVScroll ()

void	showHScroll (bool _visible)

bool	isShowHScroll ()

Protected Attributes
Align	mContentAlign

Widget *	mRealClient

Protected Attributes inherited from MyGUI::ICroppedRectangle
IntRect	mMargin

IntCoord	mCoord

IntPoint	mAbsolutePosition

bool	mIsMargin

ICroppedRectangle *	mCroppedParent

Protected Attributes inherited from MyGUI::ScrollViewBase
ScrollBar *	mVScroll

ScrollBar *	mHScroll

Widget *	mClient

bool	mVisibleHScroll

bool	mVisibleVScroll

size_t	mVRange

size_t	mHRange

bool	mChangeContentByResize

Additional Inherited Members
Data Fields inherited from MyGUI::Widget
EventHandle_WidgetStringString	eventChangeProperty

EventHandle_WidgetVoid	eventChangeCoord

Data Fields inherited from MyGUI::WidgetInput
EventHandle_WidgetWidget	eventMouseLostFocus

EventHandle_WidgetWidget	eventMouseSetFocus

EventPairAddParameter< EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButton >	eventMouseDrag

EventHandle_WidgetIntInt	eventMouseMove

EventHandle_WidgetInt	eventMouseWheel

EventHandle_WidgetIntIntButton	eventMouseButtonPressed

EventHandle_WidgetIntIntButton	eventMouseButtonReleased

EventHandle_WidgetVoid	eventMouseButtonClick

EventHandle_WidgetVoid	eventMouseButtonDoubleClick

EventHandle_WidgetWidget	eventKeyLostFocus

EventHandle_WidgetWidget	eventKeySetFocus

EventHandle_WidgetKeyCodeChar	eventKeyButtonPressed

EventHandle_WidgetKeyCode	eventKeyButtonReleased

EventHandle_WidgetBool	eventRootMouseChangeFocus

EventHandle_WidgetBool	eventRootKeyChangeFocus

EventHandle_WidgetToolTip	eventToolTip

Detailed Description

ScrollView properties. ScrollView_skin_childs Skin childs. ScrollView widget description should be here.

Definition at line 20 of file MyGUI_ScrollView.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::ScrollView::Base

Definition at line 25 of file MyGUI_ScrollView.h.

typedef ScrollView MyGUI::ScrollView::RTTIBase

Definition at line 25 of file MyGUI_ScrollView.h.

Constructor & Destructor Documentation

MyGUI::ScrollView::ScrollView ( )

Definition at line 19 of file MyGUI_ScrollView.cpp.

Member Function Documentation

Align MyGUI::ScrollView::getCanvasAlign ( ) const

Get canvas align

Definition at line 278 of file MyGUI_ScrollView.cpp.

IntSize MyGUI::ScrollView::getCanvasSize ( )

Get canvas size

Definition at line 221 of file MyGUI_ScrollView.cpp.

static const std::string& MyGUI::ScrollView::getClassTypeName ( )

inlinestatic

Definition at line 25 of file MyGUI_ScrollView.h.

virtual const std::string& MyGUI::ScrollView::getTypeName ( ) const

inlinevirtual

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

IntCoord MyGUI::ScrollView::getViewCoord ( ) const

Get view area coordinates.

Definition at line 336 of file MyGUI_ScrollView.cpp.

IntPoint MyGUI::ScrollView::getViewOffset ( ) const

Get view area offset.

Definition at line 331 of file MyGUI_ScrollView.cpp.

ScrollBar * MyGUI::ScrollView::getVScroll ( )

protected

Definition at line 341 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::initialiseOverride ( )

protectedvirtual

skin clilds:: Client is child widget with type Widget. Клиентская зона.

skin clilds:: VScroll is child widget with type ScrollBar. Вертикальная полоса прокрутки.

skin clilds:: HScroll is child widget with type ScrollBar. Горизонтальная полоса прокрутки.

Reimplemented from MyGUI::Widget.

Definition at line 26 of file MyGUI_ScrollView.cpp.

template<typename Type >

bool MyGUI::ScrollView::isType ( ) const

inline

Compare with selected type

Definition at line 25 of file MyGUI_ScrollView.h.

virtual bool MyGUI::ScrollView::isType ( const std::type_info & _type ) const

inlinevirtual

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 25 of file MyGUI_ScrollView.h.

bool MyGUI::ScrollView::isVisibleHScroll ( ) const

Get Show HScroll flag

Definition at line 273 of file MyGUI_ScrollView.cpp.

bool MyGUI::ScrollView::isVisibleVScroll ( ) const

Get Show VScroll flag

Definition at line 268 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::notifyMouseWheel	(	Widget *	_sender,
		int	_rel
	)

protected

Definition at line 112 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::notifyScrollChangePosition	(	ScrollBar *	_sender,
		size_t	_position
	)

protected

Definition at line 93 of file MyGUI_ScrollView.cpp.

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

Set canvas align

Definition at line 208 of file MyGUI_ScrollView.cpp.

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

Set canvas size

Definition at line 214 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCanvasSize	(	int	_width,
		int	_height
	)

Set canvas size

Definition at line 283 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCoord ( const IntCoord & _value )

virtual

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 86 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setCoord	(	int	_left,
		int	_top,
		int	_width,
		int	_height
	)

See Widget::setCoord(const IntCoord& _coord)

Definition at line 263 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 74 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setPosition	(	int	_left,
		int	_top
	)

See Widget::setPosition(const IntPoint& _pos)

Definition at line 253 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setPropertyOverride	(	const std::string &	_key,
		const std::string &	_value
	)

protectedvirtual

Properties:: VisibleVScroll is ScrollView property with type bool. Видимость вертикальной полосы прокрутки.

Properties:: VisibleHScroll is ScrollView property with type bool. Видимость горизонтальной полосы прокрутки.

Properties:: CanvasAlign is ScrollView property with type Align. Выравнивание содержимого.

Properties:: CanvasSize is ScrollView property with type int int. Размер содержимого.

Reimplemented from MyGUI::Widget.

Definition at line 226 of file MyGUI_ScrollView.cpp.

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

virtual

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 79 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setSize	(	int	_width,
		int	_height
	)

See Widget::setSize(const IntSize& _size)

Definition at line 258 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::setViewOffset ( const IntPoint & _value )

Set view area offset.

Definition at line 293 of file MyGUI_ScrollView.cpp.

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

Show HScroll when content size larger than view

Definition at line 202 of file MyGUI_ScrollView.cpp.

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

Show VScroll when content size larger than view

Definition at line 196 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::shutdownOverride ( )

protectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 64 of file MyGUI_ScrollView.cpp.

void MyGUI::ScrollView::updateView ( )

protected

Definition at line 190 of file MyGUI_ScrollView.cpp.

Field Documentation

Align MyGUI::ScrollView::mContentAlign

protected

Definition at line 105 of file MyGUI_ScrollView.h.

Widget* MyGUI::ScrollView::mRealClient

protected

Definition at line 106 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

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation