MyGUI::Button Class Reference

#include <MyGUI_Button.h>

Inheritance diagram for MyGUI::Button:

Public Types
typedef RTTIBase	Base
typedef Button	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
	Button ()
void	setStateSelected (bool _value)
	Set button selected state.
bool	getStateSelected () const
	Get buton selected.
void	setModeImage (bool _value)
bool	getModeImage () const
void	setImageResource (const std::string &_name)
void	setImageGroup (const std::string &_name)
void	setImageName (const std::string &_name)
void	_setMouseFocus (bool _focus)
ImageBox *	_getImageBox ()
Static Public Member Functions
static const std::string &	getClassTypeName ()
Protected Member Functions
virtual void	initialiseOverride ()
virtual void	shutdownOverride ()
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)
virtual void	setPropertyOverride (const std::string &_key, const std::string &_value)

---

Detailed Description

Definition at line 31 of file MyGUI_Button.h.

---

Member Typedef Documentation

typedef RTTIBase MyGUI::Button::Base

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 35 of file MyGUI_Button.h.

typedef Button MyGUI::Button::RTTIBase

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 35 of file MyGUI_Button.h.

---

Constructor & Destructor Documentation

MyGUI::Button::Button

(

)

Definition at line 31 of file MyGUI_Button.cpp.

---

Member Function Documentation

ImageBox * MyGUI::Button::_getImageBox

(

)

Definition at line 220 of file MyGUI_Button.cpp.

void MyGUI::Button::_setMouseFocus

(

bool

_focus

)

Definition at line 134 of file MyGUI_Button.cpp.

bool MyGUI::Button::_setState

(

const std::string &

_value

)

[protected]

Definition at line 155 of file MyGUI_Button.cpp.

void MyGUI::Button::baseUpdateEnable

(

)

[protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 140 of file MyGUI_Button.cpp.

static const std::string& MyGUI::Button::getClassTypeName

(

)

[inline, static]

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 35 of file MyGUI_Button.h.

bool MyGUI::Button::getModeImage

(

)

const

Get Image mode flag

Definition at line 215 of file MyGUI_Button.cpp.

bool MyGUI::Button::getStateSelected

(

)

const

Get buton selected.

Definition at line 210 of file MyGUI_Button.cpp.

virtual const std::string& MyGUI::Button::getTypeName

(

)

const [inline, virtual]

Get type name as string

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 35 of file MyGUI_Button.h.

void MyGUI::Button::initialiseOverride

(

)

[protected, virtual]

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuItem.

Definition at line 40 of file MyGUI_Button.cpp.

template<typename Type >

bool MyGUI::Button::isType

(

)

const [inline]

Compare with selected type

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 35 of file MyGUI_Button.h.

virtual bool MyGUI::Button::isType

(

const std::type_info &

_type

)

const [inline, virtual]

Compare with selected type

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 35 of file MyGUI_Button.h.

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

Reimplemented from MyGUI::WidgetInput.

Definition at line 68 of file MyGUI_Button.cpp.

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

Reimplemented from MyGUI::WidgetInput.

Definition at line 79 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseLostFocus

(

Widget *

_new

)

[protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 61 of file MyGUI_Button.cpp.

void MyGUI::Button::onMouseSetFocus

(

Widget *

_old

)

[protected, virtual]

Reimplemented from MyGUI::WidgetInput.

Definition at line 54 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageGroup

(

const std::string &

_name

)

Definition at line 176 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageName

(

const std::string &

_name

)

Definition at line 183 of file MyGUI_Button.cpp.

void MyGUI::Button::setImageResource

(

const std::string &

_name

)

Definition at line 169 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 149 of file MyGUI_Button.cpp.

void MyGUI::Button::setPropertyOverride	(	const std::string &	_key,
		const std::string &	_value
	)		[protected, virtual]

Properties:

StateSelected is Button property with type bool. Set state selected.

Reimplemented from MyGUI::TextBox.

Reimplemented in MyGUI::MenuItem.

Definition at line 189 of file MyGUI_Button.cpp.

void MyGUI::Button::setStateSelected

(

bool

_value

)

Set button selected state.

Definition at line 125 of file MyGUI_Button.cpp.

void MyGUI::Button::shutdownOverride

(

)

[protected, virtual]

Reimplemented from MyGUI::Widget.

Reimplemented in MyGUI::MenuItem.

Definition at line 47 of file MyGUI_Button.cpp.

---

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

• MyGUI_Button.h
• MyGUI_Button.cpp