MyGUI::Window Class Reference

#include <MyGUI_Window.h>

Inheritance diagram for MyGUI::Window:

Public Member Functions
	Window ()
virtual void	setVisible (bool _value)
void	setVisibleSmooth (bool _value)
void	destroySmooth ()
void	setAutoAlpha (bool _value)
bool	getAutoAlpha ()
virtual void	setCaption (const UString &_value)
virtual const UString &	getCaption ()
Widget *	getCaptionWidget ()
void	setMinSize (const IntSize &_value)
void	setMinSize (int _width, int _height)
IntSize	getMinSize ()
void	setMaxSize (const IntSize &_value)
void	setMaxSize (int _width, int _height)
IntSize	getMaxSize ()
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)
bool	getSnap ()
void	setSnap (bool _value)
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	showSmooth (bool _reset=false)
void	hideSmooth ()
	MYGUI_OBSOLETE ("use : void setMinSize(const IntSize& _min) , void setMaxSize(const IntSize& _min)") void setMinMax(const IntRect &_minmax)
	MYGUI_OBSOLETE ("use : void setMinSize(const IntSize& _min) , void setMaxSize(const IntSize& _min)") void setMinMax(int _min_w
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	onMouseChangeRootFocus (bool _focus)
void	onKeyChangeRootFocus (bool _focus)
void	onMouseDrag (int _left, int _top)
void	onMouseButtonPressed (int _left, int _top, MouseButton _id)
void	notifyMousePressed (MyGUI::Widget *_sender, int _left, int _top, MouseButton _id)
void	notifyPressedButtonEvent (MyGUI::Widget *_sender)
void	notifyMouseDrag (MyGUI::Widget *_sender, int _left, int _top)
void	updateAlpha ()
void	animateStop (Widget *_widget)
Data Fields
EventPair < EventHandle_WidgetString, EventHandle_WindowPtrCStringRef >	eventWindowButtonPressed
EventPair < EventHandle_WidgetVoid, EventHandle_WindowPtr >	eventWindowChangeCoord
int	_min_h
int int	_max_w

Detailed Description

Definition at line 39 of file MyGUI_Window.h.

Constructor & Destructor Documentation

MyGUI::Window::Window ( )

Definition at line 42 of file MyGUI_Window.cpp.

Member Function Documentation

void MyGUI::Window::_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.

Reimplemented in MyGUI::Message.

Definition at line 52 of file MyGUI_Window.cpp.

void MyGUI::Window::animateStop ( Widget * _widget )

Definition at line 334 of file MyGUI_Window.cpp.

void MyGUI::Window::baseChangeWidgetSkin ( ResourceSkin * _info ) [virtual]

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::Message.

Type Constraints

Definition at line 64 of file MyGUI_Window.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 134 of file MyGUI_Window.cpp.

void MyGUI::Window::destroySmooth ( )

Hide window smooth and then destroy it

Definition at line 327 of file MyGUI_Window.cpp.

bool MyGUI::Window::getAutoAlpha ( ) [inline]

Get auto alpha mode flag

Definition at line 58 of file MyGUI_Window.h.

const UString & MyGUI::Window::getCaption ( ) [virtual]

Get window caption

Reimplemented from MyGUI::Widget.

Definition at line 321 of file MyGUI_Window.cpp.

Widget* MyGUI::Window::getCaptionWidget ( ) [inline]

Get window caption widget

Definition at line 66 of file MyGUI_Window.h.

IntSize MyGUI::Window::getMaxSize ( )

Get maximal possible window size

Definition at line 432 of file MyGUI_Window.cpp.

IntSize MyGUI::Window::getMinSize ( )

Get minimal possible window size

Definition at line 421 of file MyGUI_Window.cpp.

bool MyGUI::Window::getSnap ( ) [inline]

Get snap to borders mode flag

Definition at line 97 of file MyGUI_Window.h.

void MyGUI::Window::hideSmooth ( ) [inline]

Definition at line 131 of file MyGUI_Window.h.

MyGUI::Window::MYGUI_OBSOLETE	(	"use : void setMinSize(const IntSize& _min)	,
		void setMaxSize(const IntSize &_min)"
	)

MyGUI::Window::MYGUI_OBSOLETE	(	"use : void setMinSize(const IntSize& _min)	,
		void setMaxSize(const IntSize &_min)"
	)			const `[inline]`

Definition at line 132 of file MyGUI_Window.h.

void MyGUI::Window::notifyMouseDrag	(	MyGUI::Widget *	_sender,
		int	_left,
		int	_top
	)

Definition at line 186 of file MyGUI_Window.cpp.

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

Definition at line 172 of file MyGUI_Window.cpp.

void MyGUI::Window::notifyPressedButtonEvent ( MyGUI::Widget * _sender )

Definition at line 181 of file MyGUI_Window.cpp.

void MyGUI::Window::onKeyChangeRootFocus ( bool _focus ) [virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 149 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)			`[virtual]`

Reimplemented from MyGUI::WidgetEvent.

Definition at line 165 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseChangeRootFocus ( bool _focus ) [virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 141 of file MyGUI_Window.cpp.

void MyGUI::Window::onMouseDrag	(	int	_left,
		int	_top
	)			`[virtual]`

Reimplemented from MyGUI::WidgetEvent.

Definition at line 157 of file MyGUI_Window.cpp.

void MyGUI::Window::setAutoAlpha ( bool _value )

Enable or disable auto alpha mode

Definition at line 220 of file MyGUI_Window.cpp.

void MyGUI::Window::setCaption ( const UString & _value ) [virtual]

Set window caption

Reimplemented from MyGUI::Widget.

Definition at line 315 of file MyGUI_Window.cpp.

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

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 94 of file MyGUI_Window.h.

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

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 267 of file MyGUI_Window.cpp.

void MyGUI::Window::setMaxSize	(	int	_width,
		int	_height
	)			`[inline]`

Set maximal possible window size

Definition at line 78 of file MyGUI_Window.h.

void MyGUI::Window::setMaxSize ( const IntSize & _value )

Set maximal possible window size

Definition at line 426 of file MyGUI_Window.cpp.

void MyGUI::Window::setMinSize	(	int	_width,
		int	_height
	)			`[inline]`

Set minimal possible window size

Definition at line 71 of file MyGUI_Window.h.

void MyGUI::Window::setMinSize ( const IntSize & _value )

Set minimal possible window size

Definition at line 415 of file MyGUI_Window.cpp.

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

Reimplemented from MyGUI::Widget.

Definition at line 127 of file MyGUI_Window.h.

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

Reimplemented from MyGUI::Widget.

Definition at line 125 of file MyGUI_Window.h.

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

See Widget::setPosition(const IntPoint& _pos)

Reimplemented from MyGUI::Widget.

Definition at line 90 of file MyGUI_Window.h.

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

Set widget position (position of left top corner)

Reimplemented from MyGUI::Widget.

Definition at line 232 of file MyGUI_Window.cpp.

void MyGUI::Window::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.

Reimplemented in MyGUI::Message.

Definition at line 437 of file MyGUI_Window.cpp.

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

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 92 of file MyGUI_Window.h.

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

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 246 of file MyGUI_Window.cpp.

void MyGUI::Window::setSnap ( bool _value ) [inline]

Enable or disable snap to borders mode

Definition at line 99 of file MyGUI_Window.h.

void MyGUI::Window::setVisible ( bool _value ) [virtual]

Hide or show widget

Reimplemented from MyGUI::Widget.

Definition at line 343 of file MyGUI_Window.cpp.

void MyGUI::Window::setVisibleSmooth ( bool _value )

Hide or show window smooth

Definition at line 377 of file MyGUI_Window.cpp.

void MyGUI::Window::showSmooth ( bool _reset = false ) [inline]

Definition at line 129 of file MyGUI_Window.h.

void MyGUI::Window::updateAlpha ( )

Definition at line 207 of file MyGUI_Window.cpp.

Field Documentation

int int MyGUI::Window::_max_w

Definition at line 135 of file MyGUI_Window.h.

int MyGUI::Window::_min_h

Definition at line 135 of file MyGUI_Window.h.

EventPair<EventHandle_WidgetString, EventHandle_WindowPtrCStringRef> MyGUI::Window::eventWindowButtonPressed

Event : Window button pressed.
signature : void method(MyGUI::Window* _sender, const std::string& _name)

Parameters:

	_sender	widget that called this event
	_name	of pressed button

Definition at line 110 of file MyGUI_Window.h.

EventPair<EventHandle_WidgetVoid, EventHandle_WindowPtr> MyGUI::Window::eventWindowChangeCoord

Event : Window coordinate changed (window was resized or moved).
signature : void method(MyGUI::Window* _sender)

Parameters:

_sender

widget that called this event

Definition at line 116 of file MyGUI_Window.h.

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

MyGUI::Window Class Reference

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation