MyGUI::Button Class Reference

#include <MyGUI_Button.h>

Inheritance diagram for MyGUI::Button:

[legend]

Public Member Functions
	Button ()
void	setButtonPressed (bool _value)
	OLD Set button check state.
bool	getButtonPressed ()
	OLD Get buton check.
void	setStateCheck (bool _value)
	Set button check state.
bool	getStateCheck ()
	Get buton check.
void	setImageIndex (size_t _value)
	Set image index (image should be defined in skin).
size_t	getImageIndex ()
	Get image index.
void	setModeImage (bool _value)
bool	getModeImage ()
StaticImage *	getStaticImage ()
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	_setMouseFocus (bool _focus)
Protected Member Functions
virtual	~Button ()
virtual void	baseChangeWidgetSkin (ResourceSkin *_info)
virtual void	onMouseLostFocus (Widget *_new)
virtual void	onMouseSetFocus (Widget *_old)
virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void	baseUpdateEnable ()
bool	_setState (const std::string &_value)
void	setImageResource (const std::string &_name)

---

Detailed Description

Definition at line 32 of file MyGUI_Button.h.

---

Constructor & Destructor Documentation

MyGUI::Button::Button

(

)

Definition at line 32 of file MyGUI_Button.cpp.

MyGUI::Button::~Button

(

)

[protected, virtual]

Definition at line 48 of file MyGUI_Button.cpp.

---

Member Function Documentation

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

Reimplemented from MyGUI::StaticText.

Reimplemented in MyGUI::MenuItem.

Definition at line 41 of file MyGUI_Button.cpp.

void MyGUI::Button::_setMouseFocus

(

bool

_focus

)

Definition at line 161 of file MyGUI_Button.cpp.

bool MyGUI::Button::_setState

(

const std::string &

_value

)

[protected]

Definition at line 196 of file MyGUI_Button.cpp.

void MyGUI::Button::baseChangeWidgetSkin

(

ResourceSkin *

_info

)

[protected, virtual]

Reimplemented from MyGUI::StaticText.

Reimplemented in MyGUI::MenuItem.

Definition at line 53 of file MyGUI_Button.cpp.

void MyGUI::Button::baseUpdateEnable

(

)

[protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 181 of file MyGUI_Button.cpp.

bool MyGUI::Button::getButtonPressed

(

)

[inline]

OLD Get buton check.

Definition at line 43 of file MyGUI_Button.h.

size_t MyGUI::Button::getImageIndex

(

)

Get image index.

Definition at line 130 of file MyGUI_Button.cpp.

bool MyGUI::Button::getModeImage

(

)

[inline]

Get Image mode flag

Definition at line 62 of file MyGUI_Button.h.

bool MyGUI::Button::getStateCheck

(

)

[inline]

Get buton check.

Definition at line 49 of file MyGUI_Button.h.

StaticImage* MyGUI::Button::getStaticImage

(

)

[inline]

Get pointer to glyph image for this button (if it exist in button skin)

Definition at line 65 of file MyGUI_Button.h.

void MyGUI::Button::onMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)			[protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 103 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseButtonReleased	(	int	_left,
		int	_top,
		MouseButton	_id
	)			[protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 114 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseLostFocus

(

Widget *

_new

)

[protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 96 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseSetFocus

(

Widget *

_old

)

[protected, virtual]

Reimplemented from MyGUI::WidgetEvent.

Definition at line 89 of file MyGUI_Button.cpp.

void MyGUI::Button::setButtonPressed

(

bool

_value

)

[inline]

OLD Set button check state.

Definition at line 41 of file MyGUI_Button.h.

void MyGUI::Button::setImageIndex

(

size_t

_value

)

Set image index (image should be defined in skin).

Definition at line 125 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageResource

(

const std::string &

_name

)

[protected]

Definition at line 210 of file MyGUI_Button.cpp.

void MyGUI::Button::setModeImage

(

bool

_value

)

Enable or disable Image mode
Image mode: when button state changed Image on button also change it's picture.
Disabled (false) by default.

Definition at line 190 of file MyGUI_Button.cpp.

void MyGUI::Button::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

Properties:

Button_Pressed is Button property with type bool. Set pressed state.

Reimplemented from MyGUI::StaticText.

Reimplemented in MyGUI::MenuItem.

Definition at line 167 of file MyGUI_Button.cpp.

void MyGUI::Button::setStateCheck

(

bool

_value

)

Set button check state.

Definition at line 154 of file MyGUI_Button.cpp.

---

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

• MyGUI_Button.h
• MyGUI_Button.cpp